| Class | Description |
|---|---|
| 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.
|
| 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.
|
| CreateConfigurationSetEventDestinationRequest |
A request to add an event destination to a configuration set.
|
| CreateConfigurationSetEventDestinationResult |
An HTTP 200 response if the request succeeds, or an error message if the request fails.
|
| CreateConfigurationSetRequest |
A request to create a configuration set.
|
| CreateConfigurationSetResult |
An HTTP 200 response if the request succeeds, or an error message if the request fails.
|
| CreateDedicatedIpPoolRequest |
A request to create a new dedicated IP pool.
|
| CreateDedicatedIpPoolResult |
An HTTP 200 response if the request succeeds, or an error message if the request fails.
|
| CreateDeliverabilityTestReportRequest |
A request to perform a predictive inbox placement test.
|
| CreateDeliverabilityTestReportResult |
Information about the predictive inbox placement test that you created.
|
| CreateEmailIdentityRequest |
A request to begin the verification process for an email identity (an email address or domain).
|
| CreateEmailIdentityResult |
If the email identity is a domain, this object contains tokens that you can use to create a set of CNAME records.
|
| 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.
|
| DeleteConfigurationSetEventDestinationRequest |
A request to delete an event destination from a configuration set.
|
| DeleteConfigurationSetEventDestinationResult |
An HTTP 200 response if the request succeeds, or an error message if the request fails.
|
| DeleteConfigurationSetRequest |
A request to delete a configuration set.
|
| DeleteConfigurationSetResult |
An HTTP 200 response if the request succeeds, or an error message if the request fails.
|
| DeleteDedicatedIpPoolRequest |
A request to delete a dedicated IP pool.
|
| DeleteDedicatedIpPoolResult |
An HTTP 200 response if the request succeeds, or an error message if the request fails.
|
| DeleteEmailIdentityRequest |
A request to delete an existing email identity.
|
| DeleteEmailIdentityResult |
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.
|
| 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.
|
| 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.
|
| EventDestination |
In Amazon Pinpoint, events include message sends, deliveries, opens, clicks, bounces, and complaints.
|
| EventDestinationDefinition |
An object that defines the event destination.
|
| GetAccountRequest |
A request to obtain information about the email-sending capabilities of your Amazon Pinpoint account.
|
| GetAccountResult |
A list of details about the email-sending capabilities of your Amazon Pinpoint account in the current AWS Region.
|
| GetBlacklistReportsRequest |
A request to retrieve a list of the blacklists that your dedicated IP addresses appear on.
|
| GetBlacklistReportsResult |
An object that contains information about blacklist events.
|
| GetConfigurationSetEventDestinationsRequest |
A request to obtain information about the event destinations for a configuration set.
|
| GetConfigurationSetEventDestinationsResult |
Information about an event destination for a configuration set.
|
| GetConfigurationSetRequest |
A request to obtain information about a configuration set.
|
| GetConfigurationSetResult |
Information about a configuration set.
|
| GetDedicatedIpRequest |
A request to obtain more information about a dedicated IP address.
|
| GetDedicatedIpResult |
Information about a dedicated IP address.
|
| GetDedicatedIpsRequest |
A request to obtain more information about dedicated IP pools.
|
| GetDedicatedIpsResult |
Information about the dedicated IP addresses that are associated with your Amazon Pinpoint account.
|
| GetDeliverabilityDashboardOptionsRequest |
Retrieve information about the status of the Deliverability dashboard for your Amazon Pinpoint account.
|
| GetDeliverabilityDashboardOptionsResult |
An object that shows the status of the Deliverability dashboard for your Amazon Pinpoint account.
|
| GetDeliverabilityTestReportRequest |
A request to retrieve the results of a predictive inbox placement test.
|
| GetDeliverabilityTestReportResult |
The results of the predictive inbox placement test.
|
| GetDomainDeliverabilityCampaignRequest |
Retrieve all the deliverability data for a specific campaign.
|
| GetDomainDeliverabilityCampaignResult |
An object that contains all the deliverability data for a specific campaign.
|
| GetDomainStatisticsReportRequest |
A request to obtain deliverability metrics for a domain.
|
| GetDomainStatisticsReportResult |
An object that includes statistics that are related to the domain that you specified.
|
| GetEmailIdentityRequest |
A request to return details about an email identity.
|
| GetEmailIdentityResult |
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.
|
| 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.
|
| ListConfigurationSetsRequest |
A request to obtain a list of configuration sets for your Amazon Pinpoint account in the current AWS Region.
|
| ListConfigurationSetsResult |
A list of configuration sets in your Amazon Pinpoint account in the current AWS Region.
|
| ListDedicatedIpPoolsRequest |
A request to obtain a list of dedicated IP pools.
|
| ListDedicatedIpPoolsResult |
A list of dedicated IP pools.
|
| ListDeliverabilityTestReportsRequest |
A request to list all of the predictive inbox placement tests that you've performed.
|
| ListDeliverabilityTestReportsResult |
A list of the predictive inbox placement test reports that are available for your account, regardless of whether or
not those tests are complete.
|
| ListDomainDeliverabilityCampaignsRequest |
Retrieve deliverability data for all the campaigns that used a specific domain to send email during a specified time
range.
|
| ListDomainDeliverabilityCampaignsResult |
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.
|
| ListEmailIdentitiesRequest |
A request to list all of the email identities associated with your Amazon Pinpoint account.
|
| ListEmailIdentitiesResult |
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.
|
| ListTagsForResourceRequest | |
| ListTagsForResourceResult | |
| MailFromAttributes |
A list of attributes that are associated with a MAIL FROM domain.
|
| Message |
Represents the email message that you're sending.
|
| MessageTag |
Contains the name and value of a tag that you apply to an email.
|
| 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.
|
| PlacementStatistics |
An object that contains inbox placement data for an email provider.
|
| PutAccountDedicatedIpWarmupAttributesRequest |
A request to enable or disable the automatic IP address warm-up feature.
|
| PutAccountDedicatedIpWarmupAttributesResult |
An HTTP 200 response if the request succeeds, or an error message if the request fails.
|
| PutAccountSendingAttributesRequest |
A request to change the ability of your account to send email.
|
| PutAccountSendingAttributesResult |
An HTTP 200 response if the request succeeds, or an error message if the request fails.
|
| PutConfigurationSetDeliveryOptionsRequest |
A request to associate a configuration set with a dedicated IP pool.
|
| PutConfigurationSetDeliveryOptionsResult |
An HTTP 200 response if the request succeeds, or an error message if the request fails.
|
| PutConfigurationSetReputationOptionsRequest |
A request to enable or disable tracking of reputation metrics for a configuration set.
|
| PutConfigurationSetReputationOptionsResult |
An HTTP 200 response if the request succeeds, or an error message if the request fails.
|
| PutConfigurationSetSendingOptionsRequest |
A request to enable or disable the ability of Amazon Pinpoint to send emails that use a specific configuration set.
|
| PutConfigurationSetSendingOptionsResult |
An HTTP 200 response if the request succeeds, or an error message if the request fails.
|
| PutConfigurationSetTrackingOptionsRequest |
A request to add a custom domain for tracking open and click events to a configuration set.
|
| PutConfigurationSetTrackingOptionsResult |
An HTTP 200 response if the request succeeds, or an error message if the request fails.
|
| PutDedicatedIpInPoolRequest |
A request to move a dedicated IP address to a dedicated IP pool.
|
| PutDedicatedIpInPoolResult |
An HTTP 200 response if the request succeeds, or an error message if the request fails.
|
| PutDedicatedIpWarmupAttributesRequest |
A request to change the warm-up attributes for a dedicated IP address.
|
| PutDedicatedIpWarmupAttributesResult |
An HTTP 200 response if the request succeeds, or an error message if the request fails.
|
| PutDeliverabilityDashboardOptionRequest |
Enable or disable the Deliverability dashboard for your Amazon Pinpoint account.
|
| PutDeliverabilityDashboardOptionResult |
A response that indicates whether the Deliverability dashboard is enabled for your Amazon Pinpoint account.
|
| PutEmailIdentityDkimAttributesRequest |
A request to enable or disable DKIM signing of email that you send from an email identity.
|
| PutEmailIdentityDkimAttributesResult |
An HTTP 200 response if the request succeeds, or an error message if the request fails.
|
| PutEmailIdentityFeedbackAttributesRequest |
A request to set the attributes that control how bounce and complaint events are processed.
|
| PutEmailIdentityFeedbackAttributesResult |
An HTTP 200 response if the request succeeds, or an error message if the request fails.
|
| PutEmailIdentityMailFromAttributesRequest |
A request to configure the custom MAIL FROM domain for a verified identity.
|
| PutEmailIdentityMailFromAttributesResult |
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.
|
| SendEmailRequest |
A request to send an email message.
|
| SendEmailResult |
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.
|
| Tag |
An object that defines the tags that are associated with a resource.
|
| TagResourceRequest | |
| TagResourceResult | |
| Template | |
| TrackingOptions |
An object that defines the tracking options for a configuration set.
|
| UntagResourceRequest | |
| UntagResourceResult | |
| UpdateConfigurationSetEventDestinationRequest |
A request to change the settings for an event destination for a configuration set.
|
| UpdateConfigurationSetEventDestinationResult |
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.
|
| Enum | Description |
|---|---|
| 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.
|
| DeliverabilityDashboardAccountStatus |
The current status of your Deliverability dashboard subscription.
|
| DeliverabilityTestStatus |
The status of a predictive inbox placement test.
|
| DimensionValueSource |
The location where Amazon Pinpoint finds the value of a dimension to publish to Amazon CloudWatch.
|
| DkimStatus |
The DKIM authentication status of the identity.
|
| EventType |
An email sending event type.
|
| IdentityType |
The email identity type.
|
| MailFromDomainStatus |
The status of the MAIL FROM domain.
|
| TlsPolicy |
Specifies whether messages that use the configuration set are required to use Transport Layer Security (TLS).
|
| WarmupStatus |
The warmup status of a dedicated IP.
|
| Exception | Description |
|---|---|
| AccountSuspendedException |
The message can't be sent because the account's ability to send email has been permanently restricted.
|
| AlreadyExistsException |
The resource specified in your request already exists.
|
| AmazonPinpointEmailException |
Base exception for all service exceptions thrown by Amazon Pinpoint Email Service
|
| BadRequestException |
The input you provided is invalid.
|
| ConcurrentModificationException |
The resource is being modified by another operation or thread.
|
| LimitExceededException |
There are too many instances of the specified resource type.
|
| MailFromDomainNotVerifiedException |
The message can't be sent because the sending domain isn't verified.
|
| MessageRejectedException |
The message can't be sent because it contains invalid content.
|
| NotFoundException |
The resource you attempted to access doesn't exist.
|
| SendingPausedException |
The message can't be sent because the account's ability to send email is currently paused.
|
| TooManyRequestsException |
Too many requests have been made to the operation.
|