pinpoint-email-2018-07-26 library

Classes

AwsClientCredentials
AWS credentials.
BlacklistEntry
An object that contains information about a blacklisting event that impacts one of the dedicated IP addresses that is associated with your account.
Body
Represents the body of the email message.
CloudWatchDestination
An object that defines an Amazon CloudWatch destination for email events. You can use Amazon CloudWatch to monitor and gain insights on your email sending metrics.
CloudWatchDimensionConfiguration
An object that defines the dimension configuration to use when you send Amazon Pinpoint email events to Amazon CloudWatch.
Content
An object that represents the content of the email, and optionally a character set specification.
CreateConfigurationSetEventDestinationResponse
An HTTP 200 response if the request succeeds, or an error message if the request fails.
CreateConfigurationSetResponse
An HTTP 200 response if the request succeeds, or an error message if the request fails.
CreateDedicatedIpPoolResponse
An HTTP 200 response if the request succeeds, or an error message if the request fails.
CreateDeliverabilityTestReportResponse
Information about the predictive inbox placement test that you created.
CreateEmailIdentityResponse
If the email identity is a domain, this object contains tokens that you can use to create a set of CNAME records. To sucessfully verify your domain, you have to add these records to the DNS configuration for your domain.
DailyVolume
An object that contains information about the volume of email sent on each day of the analysis period.
DedicatedIp
Contains information about a dedicated IP address that is associated with your Amazon Pinpoint account.
DeleteConfigurationSetEventDestinationResponse
An HTTP 200 response if the request succeeds, or an error message if the request fails.
DeleteConfigurationSetResponse
An HTTP 200 response if the request succeeds, or an error message if the request fails.
DeleteDedicatedIpPoolResponse
An HTTP 200 response if the request succeeds, or an error message if the request fails.
DeleteEmailIdentityResponse
An HTTP 200 response if the request succeeds, or an error message if the request fails.
DeliverabilityTestReport
An object that contains metadata related to a predictive inbox placement test.
DeliveryOptions
Used to associate a configuration set with a dedicated IP pool.
Destination
An object that describes the recipients for an email.
DkimAttributes
An object that contains information about the DKIM configuration for an email identity.
DomainDeliverabilityCampaign
An object that contains 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).
DomainDeliverabilityTrackingOption
An object that contains information about the Deliverability dashboard subscription for a verified domain that you use to send email and currently has an active Deliverability dashboard subscription. If a Deliverability dashboard subscription is active for a domain, you gain access to reputation, inbox placement, and other metrics for the domain.
DomainIspPlacement
An object that contains inbox placement data for email sent from one of your email domains to a specific email provider.
EmailContent
An object that defines the entire content of the email, including the message headers and the body content. You can create a simple email message, in which you specify the subject and the text and HTML versions of the message body. You can also create raw messages, in which you specify a complete MIME-formatted message. Raw messages can include attachments and custom headers.
EventDestination
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.
EventDestinationDefinition
An object that defines the event destination. Specifically, it defines which services receive events from emails sent using the configuration set that the event destination is associated with. Also defines the types of events that are sent to the event destination.
GetAccountResponse
A list of details about the email-sending capabilities of your Amazon Pinpoint account in the current AWS Region.
GetBlacklistReportsResponse
An object that contains information about blacklist events.
GetConfigurationSetEventDestinationsResponse
Information about an event destination for a configuration set.
GetConfigurationSetResponse
Information about a configuration set.
GetDedicatedIpResponse
Information about a dedicated IP address.
GetDedicatedIpsResponse
Information about the dedicated IP addresses that are associated with your Amazon Pinpoint account.
GetDeliverabilityDashboardOptionsResponse
An object that shows the status of the Deliverability dashboard for your Amazon Pinpoint account.
GetDeliverabilityTestReportResponse
The results of the predictive inbox placement test.
GetDomainDeliverabilityCampaignResponse
An object that contains 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).
GetDomainStatisticsReportResponse
An object that includes statistics that are related to the domain that you specified.
GetEmailIdentityResponse
Details about an email identity.
IdentityInfo
Information about an email identity.
InboxPlacementTrackingOption
An object that contains information about the inbox placement data settings for a verified domain that’s associated with your AWS account. This data is available only if you enabled the Deliverability dashboard for the domain (PutDeliverabilityDashboardOption operation).
IspPlacement
An object that describes how email sent during the predictive inbox placement test was handled by a certain email provider.
KinesisFirehoseDestination
An object that defines an Amazon Kinesis Data Firehose destination for email events. You can use Amazon Kinesis Data Firehose to stream data to other services, such as Amazon S3 and Amazon Redshift.
ListConfigurationSetsResponse
A list of configuration sets in your Amazon Pinpoint account in the current AWS Region.
ListDedicatedIpPoolsResponse
A list of dedicated IP pools.
ListDeliverabilityTestReportsResponse
A list of the predictive inbox placement test reports that are available for your account, regardless of whether or not those tests are complete.
ListDomainDeliverabilityCampaignsResponse
An array of objects that provide 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.
ListEmailIdentitiesResponse
A list of all of the identities that you've attempted to verify for use with Amazon Pinpoint, regardless of whether or not those identities were successfully verified.
ListTagsForResourceResponse
MailFromAttributes
A list of attributes that are associated with a MAIL FROM domain.
Message
Represents the email message that you're sending. The Message object consists of a subject line and a message body.
MessageTag
Contains the name and value of a tag that you apply to an email. You can use message tags when you publish email sending events.
OverallVolume
An object that contains information about email that was sent from the selected domain.
PinpointDestination
An object that defines a Amazon Pinpoint destination for email events. You can use Amazon Pinpoint events to create attributes in Amazon Pinpoint projects. You can use these attributes to create segments for your campaigns.
PinpointEmail
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.
PlacementStatistics
An object that contains inbox placement data for an email provider.
PutAccountDedicatedIpWarmupAttributesResponse
An HTTP 200 response if the request succeeds, or an error message if the request fails.
PutAccountSendingAttributesResponse
An HTTP 200 response if the request succeeds, or an error message if the request fails.
PutConfigurationSetDeliveryOptionsResponse
An HTTP 200 response if the request succeeds, or an error message if the request fails.
PutConfigurationSetReputationOptionsResponse
An HTTP 200 response if the request succeeds, or an error message if the request fails.
PutConfigurationSetSendingOptionsResponse
An HTTP 200 response if the request succeeds, or an error message if the request fails.
PutConfigurationSetTrackingOptionsResponse
An HTTP 200 response if the request succeeds, or an error message if the request fails.
PutDedicatedIpInPoolResponse
An HTTP 200 response if the request succeeds, or an error message if the request fails.
PutDedicatedIpWarmupAttributesResponse
An HTTP 200 response if the request succeeds, or an error message if the request fails.
PutDeliverabilityDashboardOptionResponse
A response that indicates whether the Deliverability dashboard is enabled for your Amazon Pinpoint account.
PutEmailIdentityDkimAttributesResponse
An HTTP 200 response if the request succeeds, or an error message if the request fails.
PutEmailIdentityFeedbackAttributesResponse
An HTTP 200 response if the request succeeds, or an error message if the request fails.
PutEmailIdentityMailFromAttributesResponse
An HTTP 200 response if the request succeeds, or an error message if the request fails.
RawMessage
The raw email message.
ReputationOptions
Enable or disable collection of reputation metrics for emails that you send using this configuration set in the current AWS Region.
SendEmailResponse
A unique message ID that you receive when Amazon Pinpoint accepts an email for sending.
SendingOptions
Used to enable or disable email sending for messages that use this configuration set in the current AWS Region.
SendQuota
An object that contains information about the per-day and per-second sending limits for your Amazon Pinpoint account in the current AWS Region.
SnsDestination
An object that defines an Amazon SNS destination for email events. You can use Amazon SNS to send notification when certain email events occur.
Tag
An object that defines the tags that are associated with a 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.
TagResourceResponse
Template
TrackingOptions
An object that defines the tracking options for a configuration set. When you use Amazon Pinpoint to send an email, it contains an invisible image that's used to track when recipients open your email. If your email contains links, those links are changed slightly in order to track when recipients click them.
UntagResourceResponse
UpdateConfigurationSetEventDestinationResponse
An HTTP 200 response if the request succeeds, or an error message if the request fails.
VolumeStatistics
An object that contains information about the amount of email that was delivered to recipients.

Enums

BehaviorOnMxFailure
The action that you want Amazon Pinpoint to take if it can't read the required MX record for a custom MAIL FROM domain. When you set this value to UseDefaultValue, Amazon Pinpoint uses amazonses.com as the MAIL FROM domain. When you set this value to RejectMessage, Amazon Pinpoint returns a MailFromDomainNotVerified error, and doesn't attempt to deliver the email.
DeliverabilityDashboardAccountStatus
The current status of your Deliverability dashboard subscription. If this value is PENDING_EXPIRATION, your subscription is scheduled to expire at the end of the current calendar month.
DeliverabilityTestStatus
The status of a predictive inbox placement test. If the status is IN_PROGRESS, then the predictive inbox placement test is currently running. Predictive inbox placement tests are usually complete within 24 hours of creating the test. If the status is COMPLETE, then the test is finished, and you can use the GetDeliverabilityTestReport operation to view the results of the test.
DimensionValueSource
The location where Amazon Pinpoint finds the value of a dimension to publish to Amazon CloudWatch. If you want Amazon Pinpoint to use the message tags that you specify using an X-SES-MESSAGE-TAGS header or a parameter to the SendEmail/SendRawEmail API, choose messageTag. If you want Amazon Pinpoint to use your own email headers, choose emailHeader. If you want Amazon Pinpoint to use link tags, choose linkTags.
DkimStatus
The DKIM authentication status of the identity. The status can be one of the following:
EventType
An email sending event type. For example, email sends, opens, and bounces are all email events.
IdentityType
The email identity type. The identity type can be one of the following:
MailFromDomainStatus
The status of the MAIL FROM domain. This status can have the following values:
TlsPolicy
Specifies whether messages that use the configuration set are required to use Transport Layer Security (TLS). If the value is Require, messages are only delivered if a TLS connection can be established. If the value is Optional, messages can be delivered in plain text if a TLS connection can't be established.
WarmupStatus
The warmup status of a dedicated IP.