Expand description

Data structures used by operation inputs/outputs.

Modules

Structs

An object that contains information about a blacklisting event that impacts one of the dedicated IP addresses that is associated with your account.

Represents the body of the email message.

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.

An object that defines the dimension configuration to use when you send Amazon Pinpoint email events to Amazon CloudWatch.

An object that represents the content of the email, and optionally a character set specification.

An object that contains information about the volume of email sent on each day of the analysis period.

Contains information about a dedicated IP address that is associated with your Amazon Pinpoint account.

An object that contains metadata related to a predictive inbox placement test.

Used to associate a configuration set with a dedicated IP pool.

An object that describes the recipients for an email.

An object that contains information about the DKIM configuration for an email identity.

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).

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.

An object that contains inbox placement data for email sent from one of your email domains to a specific email provider.

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.

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.

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.

Information about an email identity.

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).

An object that describes how email sent during the predictive inbox placement test was handled by a certain email provider.

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.

A list of attributes that are associated with a MAIL FROM domain.

Represents the email message that you're sending. The Message object consists of a subject line and a message body.

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.

An object that contains information about email that was sent from the selected domain.

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.

An object that contains inbox placement data for an email provider.

The raw email message.

Enable or disable collection of reputation metrics for emails that you send using this configuration set in the current AWS Region.

An object that contains information about the per-day and per-second sending limits for your Amazon Pinpoint account in the current AWS Region.

Used to enable or disable email sending for messages that use this configuration set in the current AWS Region.

An object that defines an Amazon SNS destination for email events. You can use Amazon SNS to send notification when certain email events occur.

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.

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.

An object that contains information about the amount of email that was delivered to recipients.

Enums

The action that you want Amazon Pinpoint to take if it can't read the required MX record for a

The current status of your Deliverability dashboard subscription. If this value is

The status of a predictive inbox placement test. If the status is IN_PROGRESS, then the predictive inbox placement test is

The location where Amazon Pinpoint finds the value of a dimension to publish to Amazon CloudWatch. If you

The DKIM authentication status of the identity. The status can be one of the

An email sending event type. For example, email sends, opens, and bounces are all

The email identity type. The identity type can be one of the following:

The status of the MAIL FROM domain. This status can have the following values:

Specifies whether messages that use the configuration set are required to use

The warmup status of a dedicated IP.