// ================================================================= // // * WARNING * // // This file is generated! // // Changes made to this file will be overwritten. If changes are // required to the generated code, the service_crategen project // must be updated to generate the changes. // // ================================================================= use std::error::Error; use std::fmt; use async_trait::async_trait; use rusoto_core::credential::ProvideAwsCredentials; use rusoto_core::region; use rusoto_core::request::{BufferedHttpResponse, DispatchSignedRequest}; use rusoto_core::{Client, RusotoError}; use rusoto_core::param::{Params, ServiceParams}; use rusoto_core::proto; use rusoto_core::signature::SignedRequest; #[allow(unused_imports)] use serde::{Deserialize, Serialize}; use serde_json; ///
An object that contains information about a blacklisting event that impacts one of the dedicated IP addresses that is associated with your account.
#[derive(Clone, Debug, Default, Deserialize, PartialEq)] #[cfg_attr(any(test, feature = "serialize_structs"), derive(Serialize))] pub struct BlacklistEntry { ///Additional information about the blacklisting event, as provided by the blacklist maintainer.
#[serde(rename = "Description")] #[serde(skip_serializing_if = "Option::is_none")] pub description: OptionThe time when the blacklisting event occurred, shown in Unix time format.
#[serde(rename = "ListingTime")] #[serde(skip_serializing_if = "Option::is_none")] pub listing_time: OptionThe name of the blacklist that the IP address appears on.
#[serde(rename = "RblName")] #[serde(skip_serializing_if = "Option::is_none")] pub rbl_name: OptionRepresents the body of the email message.
#[derive(Clone, Debug, Default, PartialEq, Serialize)] #[cfg_attr(feature = "deserialize_structs", derive(Deserialize))] pub struct Body { ///An object that represents the version of the message that is displayed in email clients that support HTML. HTML messages can include formatted text, hyperlinks, images, and more.
#[serde(rename = "Html")] #[serde(skip_serializing_if = "Option::is_none")] pub html: OptionAn object that represents the version of the message that is displayed in email clients that don't support HTML, or clients where the recipient has disabled HTML rendering.
#[serde(rename = "Text")] #[serde(skip_serializing_if = "Option::is_none")] pub text: OptionAn 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.
#[derive(Clone, Debug, Default, Deserialize, PartialEq, Serialize)] pub struct CloudWatchDestination { ///An array of objects that define the dimensions to use when you send email events to Amazon CloudWatch.
#[serde(rename = "DimensionConfigurations")] pub dimension_configurations: VecAn object that defines the dimension configuration to use when you send Amazon Pinpoint email events to Amazon CloudWatch.
#[derive(Clone, Debug, Default, Deserialize, PartialEq, Serialize)] pub struct CloudWatchDimensionConfiguration { ///The default value of the dimension that is published to Amazon CloudWatch if you don't provide the value of the dimension when you send an email. This value has to meet the following criteria:
It can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).
It can contain no more than 256 characters.
The name of an Amazon CloudWatch dimension associated with an email sending metric. The name has to meet the following criteria:
It can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).
It can contain no more than 256 characters.
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
.
An object that represents the content of the email, and optionally a character set specification.
#[derive(Clone, Debug, Default, PartialEq, Serialize)] #[cfg_attr(feature = "deserialize_structs", derive(Deserialize))] pub struct Content { ///The character set for the content. Because of the constraints of the SMTP protocol, Amazon Pinpoint uses 7-bit ASCII by default. If the text includes characters outside of the ASCII range, you have to specify a character set. For example, you could specify UTF-8
, ISO-8859-1
, or Shift_JIS
.
The content of the message itself.
#[serde(rename = "Data")] pub data: String, } ///A request to add an event destination to a configuration set.
#[derive(Clone, Debug, Default, PartialEq, Serialize)] #[cfg_attr(feature = "deserialize_structs", derive(Deserialize))] pub struct CreateConfigurationSetEventDestinationRequest { ///The name of the configuration set that you want to add an event destination to.
#[serde(rename = "ConfigurationSetName")] pub configuration_set_name: String, ///An object that defines the event destination.
#[serde(rename = "EventDestination")] pub event_destination: EventDestinationDefinition, ///A name that identifies the event destination within the configuration set.
#[serde(rename = "EventDestinationName")] pub event_destination_name: String, } ///An HTTP 200 response if the request succeeds, or an error message if the request fails.
#[derive(Clone, Debug, Default, Deserialize, PartialEq)] #[cfg_attr(any(test, feature = "serialize_structs"), derive(Serialize))] pub struct CreateConfigurationSetEventDestinationResponse {} ///A request to create a configuration set.
#[derive(Clone, Debug, Default, PartialEq, Serialize)] #[cfg_attr(feature = "deserialize_structs", derive(Deserialize))] pub struct CreateConfigurationSetRequest { ///The name of the configuration set.
#[serde(rename = "ConfigurationSetName")] pub configuration_set_name: String, ///An object that defines the dedicated IP pool that is used to send emails that you send using the configuration set.
#[serde(rename = "DeliveryOptions")] #[serde(skip_serializing_if = "Option::is_none")] pub delivery_options: OptionAn object that defines whether or not Amazon Pinpoint collects reputation metrics for the emails that you send that use the configuration set.
#[serde(rename = "ReputationOptions")] #[serde(skip_serializing_if = "Option::is_none")] pub reputation_options: OptionAn object that defines whether or not Amazon Pinpoint can send email that you send using the configuration set.
#[serde(rename = "SendingOptions")] #[serde(skip_serializing_if = "Option::is_none")] pub sending_options: OptionAn array of objects that define the tags (keys and values) that you want to associate with the configuration set.
#[serde(rename = "Tags")] #[serde(skip_serializing_if = "Option::is_none")] pub tags: OptionAn object that defines the open and click tracking options for emails that you send using the configuration set.
#[serde(rename = "TrackingOptions")] #[serde(skip_serializing_if = "Option::is_none")] pub tracking_options: OptionAn HTTP 200 response if the request succeeds, or an error message if the request fails.
#[derive(Clone, Debug, Default, Deserialize, PartialEq)] #[cfg_attr(any(test, feature = "serialize_structs"), derive(Serialize))] pub struct CreateConfigurationSetResponse {} ///A request to create a new dedicated IP pool.
#[derive(Clone, Debug, Default, PartialEq, Serialize)] #[cfg_attr(feature = "deserialize_structs", derive(Deserialize))] pub struct CreateDedicatedIpPoolRequest { ///The name of the dedicated IP pool.
#[serde(rename = "PoolName")] pub pool_name: String, ///An object that defines the tags (keys and values) that you want to associate with the pool.
#[serde(rename = "Tags")] #[serde(skip_serializing_if = "Option::is_none")] pub tags: OptionAn HTTP 200 response if the request succeeds, or an error message if the request fails.
#[derive(Clone, Debug, Default, Deserialize, PartialEq)] #[cfg_attr(any(test, feature = "serialize_structs"), derive(Serialize))] pub struct CreateDedicatedIpPoolResponse {} ///A request to perform a predictive inbox placement test. Predictive inbox placement tests can help you predict how your messages will be handled by various email providers around the world. When you perform a predictive inbox placement test, you provide a sample message that contains the content that you plan to send to your customers. Amazon Pinpoint then sends that message to special email addresses spread across several major email providers. After about 24 hours, the test is complete, and you can use the GetDeliverabilityTestReport
operation to view the results of the test.
The HTML body of the message that you sent when you performed the predictive inbox placement test.
#[serde(rename = "Content")] pub content: EmailContent, ///The email address that the predictive inbox placement test email was sent from.
#[serde(rename = "FromEmailAddress")] pub from_email_address: String, ///A unique name that helps you to identify the predictive inbox placement test when you retrieve the results.
#[serde(rename = "ReportName")] #[serde(skip_serializing_if = "Option::is_none")] pub report_name: OptionAn array of objects that define the tags (keys and values) that you want to associate with the predictive inbox placement test.
#[serde(rename = "Tags")] #[serde(skip_serializing_if = "Option::is_none")] pub tags: OptionInformation about the predictive inbox placement test that you created.
#[derive(Clone, Debug, Default, Deserialize, PartialEq)] #[cfg_attr(any(test, feature = "serialize_structs"), derive(Serialize))] pub struct CreateDeliverabilityTestReportResponse { ///The status of the 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
to view the results of the test.
A unique string that identifies the predictive inbox placement test.
#[serde(rename = "ReportId")] pub report_id: String, } ///A request to begin the verification process for an email identity (an email address or domain).
#[derive(Clone, Debug, Default, PartialEq, Serialize)] #[cfg_attr(feature = "deserialize_structs", derive(Deserialize))] pub struct CreateEmailIdentityRequest { ///The email address or domain that you want to verify.
#[serde(rename = "EmailIdentity")] pub email_identity: String, ///An array of objects that define the tags (keys and values) that you want to associate with the email identity.
#[serde(rename = "Tags")] #[serde(skip_serializing_if = "Option::is_none")] pub tags: OptionIf 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.
If the email identity is an email address, this object is empty.
#[derive(Clone, Debug, Default, Deserialize, PartialEq)] #[cfg_attr(any(test, feature = "serialize_structs"), derive(Serialize))] pub struct CreateEmailIdentityResponse { ///An object that contains information about the DKIM attributes for the identity. This object includes the tokens that you use to create the CNAME records that are required to complete the DKIM verification process.
#[serde(rename = "DkimAttributes")] #[serde(skip_serializing_if = "Option::is_none")] pub dkim_attributes: OptionThe email identity type.
#[serde(rename = "IdentityType")] #[serde(skip_serializing_if = "Option::is_none")] pub identity_type: OptionSpecifies whether or not the identity is verified. In Amazon Pinpoint, you can only send email from verified email addresses or domains. For more information about verifying identities, see the Amazon Pinpoint User Guide.
#[serde(rename = "VerifiedForSendingStatus")] #[serde(skip_serializing_if = "Option::is_none")] pub verified_for_sending_status: OptionAn object that contains information about the volume of email sent on each day of the analysis period.
#[derive(Clone, Debug, Default, Deserialize, PartialEq)] #[cfg_attr(any(test, feature = "serialize_structs"), derive(Serialize))] pub struct DailyVolume { ///An object that contains inbox placement metrics for a specified day in the analysis period, broken out by the recipient's email provider.
#[serde(rename = "DomainIspPlacements")] #[serde(skip_serializing_if = "Option::is_none")] pub domain_isp_placements: OptionThe date that the DailyVolume metrics apply to, in Unix time.
#[serde(rename = "StartDate")] #[serde(skip_serializing_if = "Option::is_none")] pub start_date: OptionAn object that contains inbox placement metrics for a specific day in the analysis period.
#[serde(rename = "VolumeStatistics")] #[serde(skip_serializing_if = "Option::is_none")] pub volume_statistics: OptionContains information about a dedicated IP address that is associated with your Amazon Pinpoint account.
#[derive(Clone, Debug, Default, Deserialize, PartialEq)] #[cfg_attr(any(test, feature = "serialize_structs"), derive(Serialize))] pub struct DedicatedIp { ///An IP address that is reserved for use by your Amazon Pinpoint account.
#[serde(rename = "Ip")] pub ip: String, ///The name of the dedicated IP pool that the IP address is associated with.
#[serde(rename = "PoolName")] #[serde(skip_serializing_if = "Option::is_none")] pub pool_name: OptionIndicates how complete the dedicated IP warm-up process is. When this value equals 1, the address has completed the warm-up process and is ready for use.
#[serde(rename = "WarmupPercentage")] pub warmup_percentage: i64, ///The warm-up status of a dedicated IP address. The status can have one of the following values:
IN_PROGRESS
– The IP address isn't ready to use because the dedicated IP warm-up process is ongoing.
DONE
– The dedicated IP warm-up process is complete, and the IP address is ready to use.
A request to delete an event destination from a configuration set.
#[derive(Clone, Debug, Default, PartialEq, Serialize)] #[cfg_attr(feature = "deserialize_structs", derive(Deserialize))] pub struct DeleteConfigurationSetEventDestinationRequest { ///The name of the configuration set that contains the event destination that you want to delete.
#[serde(rename = "ConfigurationSetName")] pub configuration_set_name: String, ///The name of the event destination that you want to delete.
#[serde(rename = "EventDestinationName")] pub event_destination_name: String, } ///An HTTP 200 response if the request succeeds, or an error message if the request fails.
#[derive(Clone, Debug, Default, Deserialize, PartialEq)] #[cfg_attr(any(test, feature = "serialize_structs"), derive(Serialize))] pub struct DeleteConfigurationSetEventDestinationResponse {} ///A request to delete a configuration set.
#[derive(Clone, Debug, Default, PartialEq, Serialize)] #[cfg_attr(feature = "deserialize_structs", derive(Deserialize))] pub struct DeleteConfigurationSetRequest { ///The name of the configuration set that you want to delete.
#[serde(rename = "ConfigurationSetName")] pub configuration_set_name: String, } ///An HTTP 200 response if the request succeeds, or an error message if the request fails.
#[derive(Clone, Debug, Default, Deserialize, PartialEq)] #[cfg_attr(any(test, feature = "serialize_structs"), derive(Serialize))] pub struct DeleteConfigurationSetResponse {} ///A request to delete a dedicated IP pool.
#[derive(Clone, Debug, Default, PartialEq, Serialize)] #[cfg_attr(feature = "deserialize_structs", derive(Deserialize))] pub struct DeleteDedicatedIpPoolRequest { ///The name of the dedicated IP pool that you want to delete.
#[serde(rename = "PoolName")] pub pool_name: String, } ///An HTTP 200 response if the request succeeds, or an error message if the request fails.
#[derive(Clone, Debug, Default, Deserialize, PartialEq)] #[cfg_attr(any(test, feature = "serialize_structs"), derive(Serialize))] pub struct DeleteDedicatedIpPoolResponse {} ///A request to delete an existing email identity. When you delete an identity, you lose the ability to use Amazon Pinpoint to send email from that identity. You can restore your ability to send email by completing the verification process for the identity again.
#[derive(Clone, Debug, Default, PartialEq, Serialize)] #[cfg_attr(feature = "deserialize_structs", derive(Deserialize))] pub struct DeleteEmailIdentityRequest { ///The identity (that is, the email address or domain) that you want to delete from your Amazon Pinpoint account.
#[serde(rename = "EmailIdentity")] pub email_identity: String, } ///An HTTP 200 response if the request succeeds, or an error message if the request fails.
#[derive(Clone, Debug, Default, Deserialize, PartialEq)] #[cfg_attr(any(test, feature = "serialize_structs"), derive(Serialize))] pub struct DeleteEmailIdentityResponse {} ///An object that contains metadata related to a predictive inbox placement test.
#[derive(Clone, Debug, Default, Deserialize, PartialEq)] #[cfg_attr(any(test, feature = "serialize_structs"), derive(Serialize))] pub struct DeliverabilityTestReport { ///The date and time when the predictive inbox placement test was created, in Unix time format.
#[serde(rename = "CreateDate")] #[serde(skip_serializing_if = "Option::is_none")] pub create_date: OptionThe status of the 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
to view the results of the test.
The sender address that you specified for the predictive inbox placement test.
#[serde(rename = "FromEmailAddress")] #[serde(skip_serializing_if = "Option::is_none")] pub from_email_address: OptionA unique string that identifies the predictive inbox placement test.
#[serde(rename = "ReportId")] #[serde(skip_serializing_if = "Option::is_none")] pub report_id: OptionA name that helps you identify a predictive inbox placement test report.
#[serde(rename = "ReportName")] #[serde(skip_serializing_if = "Option::is_none")] pub report_name: OptionThe subject line for an email that you submitted in a predictive inbox placement test.
#[serde(rename = "Subject")] #[serde(skip_serializing_if = "Option::is_none")] pub subject: OptionUsed to associate a configuration set with a dedicated IP pool.
#[derive(Clone, Debug, Default, Deserialize, PartialEq, Serialize)] pub struct DeliveryOptions { ///The name of the dedicated IP pool that you want to associate with the configuration set.
#[serde(rename = "SendingPoolName")] #[serde(skip_serializing_if = "Option::is_none")] pub sending_pool_name: OptionSpecifies 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.
An object that describes the recipients for an email.
#[derive(Clone, Debug, Default, PartialEq, Serialize)] #[cfg_attr(feature = "deserialize_structs", derive(Deserialize))] pub struct Destination { ///An array that contains the email addresses of the "BCC" (blind carbon copy) recipients for the email.
#[serde(rename = "BccAddresses")] #[serde(skip_serializing_if = "Option::is_none")] pub bcc_addresses: OptionAn array that contains the email addresses of the "CC" (carbon copy) recipients for the email.
#[serde(rename = "CcAddresses")] #[serde(skip_serializing_if = "Option::is_none")] pub cc_addresses: OptionAn array that contains the email addresses of the "To" recipients for the email.
#[serde(rename = "ToAddresses")] #[serde(skip_serializing_if = "Option::is_none")] pub to_addresses: OptionAn object that contains information about the DKIM configuration for an email identity.
#[derive(Clone, Debug, Default, Deserialize, PartialEq)] #[cfg_attr(any(test, feature = "serialize_structs"), derive(Serialize))] pub struct DkimAttributes { ///If the value is true
, then the messages that Amazon Pinpoint sends from the identity are DKIM-signed. If the value is false
, then the messages that Amazon Pinpoint sends from the identity aren't DKIM-signed.
Describes whether or not Amazon Pinpoint has successfully located the DKIM records in the DNS records for the domain. The status can be one of the following:
PENDING
– Amazon Pinpoint hasn't yet located the DKIM records in the DNS configuration for the domain, but will continue to attempt to locate them.
SUCCESS
– Amazon Pinpoint located the DKIM records in the DNS configuration for the domain and determined that they're correct. Amazon Pinpoint can now send DKIM-signed email from the identity.
FAILED
– Amazon Pinpoint was unable to locate the DKIM records in the DNS settings for the domain, and won't continue to search for them.
TEMPORARYFAILURE
– A temporary issue occurred, which prevented Amazon Pinpoint from determining the DKIM status for the domain.
NOTSTARTED
– Amazon Pinpoint hasn't yet started searching for the DKIM records in the DKIM records for the domain.
A set of unique strings that you use to create a set of CNAME records that you add to the DNS configuration for your domain. When Amazon Pinpoint detects these records in the DNS configuration for your domain, the DKIM authentication process is complete. Amazon Pinpoint usually detects these records within about 72 hours of adding them to the DNS configuration for your domain.
#[serde(rename = "Tokens")] #[serde(skip_serializing_if = "Option::is_none")] pub tokens: OptionAn 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).
The unique identifier for the campaign. Amazon Pinpoint automatically generates and assigns this identifier to a campaign. This value is not the same as the campaign identifier that Amazon Pinpoint assigns to campaigns that you create and manage by using the Amazon Pinpoint API or the Amazon Pinpoint console.
#[serde(rename = "CampaignId")] #[serde(skip_serializing_if = "Option::is_none")] pub campaign_id: OptionThe percentage of email messages that were deleted by recipients, without being opened first. Due to technical limitations, this value only includes recipients who opened the message by using an email client that supports images.
#[serde(rename = "DeleteRate")] #[serde(skip_serializing_if = "Option::is_none")] pub delete_rate: OptionThe major email providers who handled the email message.
#[serde(rename = "Esps")] #[serde(skip_serializing_if = "Option::is_none")] pub esps: OptionThe first time, in Unix time format, when the email message was delivered to any recipient's inbox. This value can help you determine how long it took for a campaign to deliver an email message.
#[serde(rename = "FirstSeenDateTime")] #[serde(skip_serializing_if = "Option::is_none")] pub first_seen_date_time: OptionThe verified email address that the email message was sent from.
#[serde(rename = "FromAddress")] #[serde(skip_serializing_if = "Option::is_none")] pub from_address: OptionThe URL of an image that contains a snapshot of the email message that was sent.
#[serde(rename = "ImageUrl")] #[serde(skip_serializing_if = "Option::is_none")] pub image_url: OptionThe number of email messages that were delivered to recipients’ inboxes.
#[serde(rename = "InboxCount")] #[serde(skip_serializing_if = "Option::is_none")] pub inbox_count: OptionThe last time, in Unix time format, when the email message was delivered to any recipient's inbox. This value can help you determine how long it took for a campaign to deliver an email message.
#[serde(rename = "LastSeenDateTime")] #[serde(skip_serializing_if = "Option::is_none")] pub last_seen_date_time: OptionThe projected number of recipients that the email message was sent to.
#[serde(rename = "ProjectedVolume")] #[serde(skip_serializing_if = "Option::is_none")] pub projected_volume: OptionThe percentage of email messages that were opened and then deleted by recipients. Due to technical limitations, this value only includes recipients who opened the message by using an email client that supports images.
#[serde(rename = "ReadDeleteRate")] #[serde(skip_serializing_if = "Option::is_none")] pub read_delete_rate: OptionThe percentage of email messages that were opened by recipients. Due to technical limitations, this value only includes recipients who opened the message by using an email client that supports images.
#[serde(rename = "ReadRate")] #[serde(skip_serializing_if = "Option::is_none")] pub read_rate: OptionThe IP addresses that were used to send the email message.
#[serde(rename = "SendingIps")] #[serde(skip_serializing_if = "Option::is_none")] pub sending_ips: OptionThe number of email messages that were delivered to recipients' spam or junk mail folders.
#[serde(rename = "SpamCount")] #[serde(skip_serializing_if = "Option::is_none")] pub spam_count: OptionThe subject line, or title, of the email message.
#[serde(rename = "Subject")] #[serde(skip_serializing_if = "Option::is_none")] pub subject: OptionAn 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.
#[derive(Clone, Debug, Default, Deserialize, PartialEq, Serialize)] pub struct DomainDeliverabilityTrackingOption { ///A verified domain that’s associated with your AWS account and currently has an active Deliverability dashboard subscription.
#[serde(rename = "Domain")] #[serde(skip_serializing_if = "Option::is_none")] pub domain: OptionAn object that contains information about the inbox placement data settings for the domain.
#[serde(rename = "InboxPlacementTrackingOption")] #[serde(skip_serializing_if = "Option::is_none")] pub inbox_placement_tracking_option: OptionThe date, in Unix time format, when you enabled the Deliverability dashboard for the domain.
#[serde(rename = "SubscriptionStartDate")] #[serde(skip_serializing_if = "Option::is_none")] pub subscription_start_date: OptionAn object that contains inbox placement data for email sent from one of your email domains to a specific email provider.
#[derive(Clone, Debug, Default, Deserialize, PartialEq)] #[cfg_attr(any(test, feature = "serialize_structs"), derive(Serialize))] pub struct DomainIspPlacement { ///The percentage of messages that were sent from the selected domain to the specified email provider that arrived in recipients' inboxes.
#[serde(rename = "InboxPercentage")] #[serde(skip_serializing_if = "Option::is_none")] pub inbox_percentage: OptionThe total number of messages that were sent from the selected domain to the specified email provider that arrived in recipients' inboxes.
#[serde(rename = "InboxRawCount")] #[serde(skip_serializing_if = "Option::is_none")] pub inbox_raw_count: OptionThe name of the email provider that the inbox placement data applies to.
#[serde(rename = "IspName")] #[serde(skip_serializing_if = "Option::is_none")] pub isp_name: OptionThe percentage of messages that were sent from the selected domain to the specified email provider that arrived in recipients' spam or junk mail folders.
#[serde(rename = "SpamPercentage")] #[serde(skip_serializing_if = "Option::is_none")] pub spam_percentage: OptionThe total number of messages that were sent from the selected domain to the specified email provider that arrived in recipients' spam or junk mail folders.
#[serde(rename = "SpamRawCount")] #[serde(skip_serializing_if = "Option::is_none")] pub spam_raw_count: OptionAn 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.
#[derive(Clone, Debug, Default, PartialEq, Serialize)] #[cfg_attr(feature = "deserialize_structs", derive(Deserialize))] pub struct EmailContent { ///The raw email message. The message has to meet the following criteria:
The message has to contain a header and a body, separated by one blank line.
All of the required header fields must be present in the message.
Each part of a multipart MIME message must be formatted properly.
If you include attachments, they must be in a file format that Amazon Pinpoint supports.
The entire message must be Base64 encoded.
If any of the MIME parts in your message contain content that is outside of the 7-bit ASCII character range, you should encode that content to ensure that recipients' email clients render the message properly.
The length of any single line of text in the message can't exceed 1,000 characters. This restriction is defined in RFC 5321.
The simple email message. The message consists of a subject and a message body.
#[serde(rename = "Simple")] #[serde(skip_serializing_if = "Option::is_none")] pub simple: OptionThe template to use for the email message.
#[serde(rename = "Template")] #[serde(skip_serializing_if = "Option::is_none")] pub template: Option, } ///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.
#[derive(Clone, Debug, Default, Deserialize, PartialEq)] #[cfg_attr(any(test, feature = "serialize_structs"), derive(Serialize))] pub struct EventDestination { ///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.
#[serde(rename = "CloudWatchDestination")] #[serde(skip_serializing_if = "Option::is_none")] pub cloud_watch_destination: OptionIf true
, the event destination is enabled. When the event destination is enabled, the specified event types are sent to the destinations in this EventDestinationDefinition
.
If false
, the event destination is disabled. When the event destination is disabled, events aren't sent to the specified destinations.
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.
#[serde(rename = "KinesisFirehoseDestination")] #[serde(skip_serializing_if = "Option::is_none")] pub kinesis_firehose_destination: OptionThe types of events that Amazon Pinpoint sends to the specified event destinations.
#[serde(rename = "MatchingEventTypes")] pub matching_event_types: VecA name that identifies the event destination.
#[serde(rename = "Name")] pub name: String, ///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.
#[serde(rename = "PinpointDestination")] #[serde(skip_serializing_if = "Option::is_none")] pub pinpoint_destination: OptionAn object that defines an Amazon SNS destination for email events. You can use Amazon SNS to send notification when certain email events occur.
#[serde(rename = "SnsDestination")] #[serde(skip_serializing_if = "Option::is_none")] pub sns_destination: OptionAn 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.
#[derive(Clone, Debug, Default, PartialEq, Serialize)] #[cfg_attr(feature = "deserialize_structs", derive(Deserialize))] pub struct EventDestinationDefinition { ///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.
#[serde(rename = "CloudWatchDestination")] #[serde(skip_serializing_if = "Option::is_none")] pub cloud_watch_destination: OptionIf true
, the event destination is enabled. When the event destination is enabled, the specified event types are sent to the destinations in this EventDestinationDefinition
.
If false
, the event destination is disabled. When the event destination is disabled, events aren't sent to the specified destinations.
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.
#[serde(rename = "KinesisFirehoseDestination")] #[serde(skip_serializing_if = "Option::is_none")] pub kinesis_firehose_destination: OptionAn array that specifies which events Amazon Pinpoint should send to the destinations in this EventDestinationDefinition
.
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.
#[serde(rename = "PinpointDestination")] #[serde(skip_serializing_if = "Option::is_none")] pub pinpoint_destination: OptionAn object that defines an Amazon SNS destination for email events. You can use Amazon SNS to send notification when certain email events occur.
#[serde(rename = "SnsDestination")] #[serde(skip_serializing_if = "Option::is_none")] pub sns_destination: OptionA request to obtain information about the email-sending capabilities of your Amazon Pinpoint account.
#[derive(Clone, Debug, Default, PartialEq, Serialize)] #[cfg_attr(feature = "deserialize_structs", derive(Deserialize))] pub struct GetAccountRequest {} ///A list of details about the email-sending capabilities of your Amazon Pinpoint account in the current AWS Region.
#[derive(Clone, Debug, Default, Deserialize, PartialEq)] #[cfg_attr(any(test, feature = "serialize_structs"), derive(Serialize))] pub struct GetAccountResponse { ///Indicates whether or not the automatic warm-up feature is enabled for dedicated IP addresses that are associated with your account.
#[serde(rename = "DedicatedIpAutoWarmupEnabled")] #[serde(skip_serializing_if = "Option::is_none")] pub dedicated_ip_auto_warmup_enabled: OptionThe reputation status of your Amazon Pinpoint account. The status can be one of the following:
HEALTHY
– There are no reputation-related issues that currently impact your account.
PROBATION
– We've identified some issues with your Amazon Pinpoint account. We're placing your account under review while you work on correcting these issues.
SHUTDOWN
– Your account's ability to send email is currently paused because of an issue with the email sent from your account. When you correct the issue, you can contact us and request that your account's ability to send email is resumed.
Indicates whether or not your account has production access in the current AWS Region.
If the value is false
, then your account is in the sandbox. When your account is in the sandbox, you can only send email to verified identities. Additionally, the maximum number of emails you can send in a 24-hour period (your sending quota) is 200, and the maximum number of emails you can send per second (your maximum sending rate) is 1.
If the value is true
, then your account has production access. When your account has production access, you can send email to any address. The sending quota and maximum sending rate for your account vary based on your specific use case.
An object that contains information about the per-day and per-second sending limits for your Amazon Pinpoint account in the current AWS Region.
#[serde(rename = "SendQuota")] #[serde(skip_serializing_if = "Option::is_none")] pub send_quota: OptionIndicates whether or not email sending is enabled for your Amazon Pinpoint account in the current AWS Region.
#[serde(rename = "SendingEnabled")] #[serde(skip_serializing_if = "Option::is_none")] pub sending_enabled: OptionA request to retrieve a list of the blacklists that your dedicated IP addresses appear on.
#[derive(Clone, Debug, Default, PartialEq, Serialize)] #[cfg_attr(feature = "deserialize_structs", derive(Deserialize))] pub struct GetBlacklistReportsRequest { ///A list of IP addresses that you want to retrieve blacklist information about. You can only specify the dedicated IP addresses that you use to send email using Amazon Pinpoint or Amazon SES.
#[serde(rename = "BlacklistItemNames")] pub blacklist_item_names: VecAn object that contains information about blacklist events.
#[derive(Clone, Debug, Default, Deserialize, PartialEq)] #[cfg_attr(any(test, feature = "serialize_structs"), derive(Serialize))] pub struct GetBlacklistReportsResponse { ///An object that contains information about a blacklist that one of your dedicated IP addresses appears on.
#[serde(rename = "BlacklistReport")] pub blacklist_report: ::std::collections::HashMapA request to obtain information about the event destinations for a configuration set.
#[derive(Clone, Debug, Default, PartialEq, Serialize)] #[cfg_attr(feature = "deserialize_structs", derive(Deserialize))] pub struct GetConfigurationSetEventDestinationsRequest { ///The name of the configuration set that contains the event destination.
#[serde(rename = "ConfigurationSetName")] pub configuration_set_name: String, } ///Information about an event destination for a configuration set.
#[derive(Clone, Debug, Default, Deserialize, PartialEq)] #[cfg_attr(any(test, feature = "serialize_structs"), derive(Serialize))] pub struct GetConfigurationSetEventDestinationsResponse { ///An array that includes all of the events destinations that have been configured for the configuration set.
#[serde(rename = "EventDestinations")] #[serde(skip_serializing_if = "Option::is_none")] pub event_destinations: OptionA request to obtain information about a configuration set.
#[derive(Clone, Debug, Default, PartialEq, Serialize)] #[cfg_attr(feature = "deserialize_structs", derive(Deserialize))] pub struct GetConfigurationSetRequest { ///The name of the configuration set that you want to obtain more information about.
#[serde(rename = "ConfigurationSetName")] pub configuration_set_name: String, } ///Information about a configuration set.
#[derive(Clone, Debug, Default, Deserialize, PartialEq)] #[cfg_attr(any(test, feature = "serialize_structs"), derive(Serialize))] pub struct GetConfigurationSetResponse { ///The name of the configuration set.
#[serde(rename = "ConfigurationSetName")] #[serde(skip_serializing_if = "Option::is_none")] pub configuration_set_name: OptionAn object that defines the dedicated IP pool that is used to send emails that you send using the configuration set.
#[serde(rename = "DeliveryOptions")] #[serde(skip_serializing_if = "Option::is_none")] pub delivery_options: OptionAn object that defines whether or not Amazon Pinpoint collects reputation metrics for the emails that you send that use the configuration set.
#[serde(rename = "ReputationOptions")] #[serde(skip_serializing_if = "Option::is_none")] pub reputation_options: OptionAn object that defines whether or not Amazon Pinpoint can send email that you send using the configuration set.
#[serde(rename = "SendingOptions")] #[serde(skip_serializing_if = "Option::is_none")] pub sending_options: OptionAn array of objects that define the tags (keys and values) that are associated with the configuration set.
#[serde(rename = "Tags")] #[serde(skip_serializing_if = "Option::is_none")] pub tags: OptionAn object that defines the open and click tracking options for emails that you send using the configuration set.
#[serde(rename = "TrackingOptions")] #[serde(skip_serializing_if = "Option::is_none")] pub tracking_options: OptionA request to obtain more information about a dedicated IP address.
#[derive(Clone, Debug, Default, PartialEq, Serialize)] #[cfg_attr(feature = "deserialize_structs", derive(Deserialize))] pub struct GetDedicatedIpRequest { ///The IP address that you want to obtain more information about. The value you specify has to be a dedicated IP address that's assocaited with your Amazon Pinpoint account.
#[serde(rename = "Ip")] pub ip: String, } ///Information about a dedicated IP address.
#[derive(Clone, Debug, Default, Deserialize, PartialEq)] #[cfg_attr(any(test, feature = "serialize_structs"), derive(Serialize))] pub struct GetDedicatedIpResponse { ///An object that contains information about a dedicated IP address.
#[serde(rename = "DedicatedIp")] #[serde(skip_serializing_if = "Option::is_none")] pub dedicated_ip: OptionA request to obtain more information about dedicated IP pools.
#[derive(Clone, Debug, Default, PartialEq, Serialize)] #[cfg_attr(feature = "deserialize_structs", derive(Deserialize))] pub struct GetDedicatedIpsRequest { ///A token returned from a previous call to GetDedicatedIps
to indicate the position of the dedicated IP pool in the list of IP pools.
The number of results to show in a single call to GetDedicatedIpsRequest
. If the number of results is larger than the number you specified in this parameter, then the response includes a NextToken
element, which you can use to obtain additional results.
The name of the IP pool that the dedicated IP address is associated with.
#[serde(rename = "PoolName")] #[serde(skip_serializing_if = "Option::is_none")] pub pool_name: OptionInformation about the dedicated IP addresses that are associated with your Amazon Pinpoint account.
#[derive(Clone, Debug, Default, Deserialize, PartialEq)] #[cfg_attr(any(test, feature = "serialize_structs"), derive(Serialize))] pub struct GetDedicatedIpsResponse { ///A list of dedicated IP addresses that are reserved for use by your Amazon Pinpoint account.
#[serde(rename = "DedicatedIps")] #[serde(skip_serializing_if = "Option::is_none")] pub dedicated_ips: OptionA token that indicates that there are additional dedicated IP addresses to list. To view additional addresses, issue another request to GetDedicatedIps
, passing this token in the NextToken
parameter.
Retrieve information about the status of the Deliverability dashboard for your Amazon Pinpoint account. When the Deliverability dashboard is enabled, you gain access to reputation, deliverability, and other metrics for the domains that you use to send email using Amazon Pinpoint. You also gain the ability to perform predictive inbox placement tests.
When you use the Deliverability dashboard, you pay a monthly subscription charge, in addition to any other fees that you accrue by using Amazon Pinpoint. For more information about the features and cost of a Deliverability dashboard subscription, see Amazon Pinpoint Pricing.
#[derive(Clone, Debug, Default, PartialEq, Serialize)] #[cfg_attr(feature = "deserialize_structs", derive(Deserialize))] pub struct GetDeliverabilityDashboardOptionsRequest {} ///An object that shows the status of the Deliverability dashboard for your Amazon Pinpoint account.
#[derive(Clone, Debug, Default, Deserialize, PartialEq)] #[cfg_attr(any(test, feature = "serialize_structs"), derive(Serialize))] pub struct GetDeliverabilityDashboardOptionsResponse { ///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.
An array of objects, one for each verified domain that you use to send email and currently has an active Deliverability dashboard subscription that isn’t scheduled to expire at the end of the current calendar month.
#[serde(rename = "ActiveSubscribedDomains")] #[serde(skip_serializing_if = "Option::is_none")] pub active_subscribed_domains: OptionSpecifies whether the Deliverability dashboard is enabled for your Amazon Pinpoint account. If this value is true
, the dashboard is enabled.
An array of objects, one for each verified domain that you use to send email and currently has an active Deliverability dashboard subscription that's scheduled to expire at the end of the current calendar month.
#[serde(rename = "PendingExpirationSubscribedDomains")] #[serde(skip_serializing_if = "Option::is_none")] pub pending_expiration_subscribed_domains: OptionThe date, in Unix time format, when your current subscription to the Deliverability dashboard is scheduled to expire, if your subscription is scheduled to expire at the end of the current calendar month. This value is null if you have an active subscription that isn’t due to expire at the end of the month.
#[serde(rename = "SubscriptionExpiryDate")] #[serde(skip_serializing_if = "Option::is_none")] pub subscription_expiry_date: OptionA request to retrieve the results of a predictive inbox placement test.
#[derive(Clone, Debug, Default, PartialEq, Serialize)] #[cfg_attr(feature = "deserialize_structs", derive(Deserialize))] pub struct GetDeliverabilityTestReportRequest { ///A unique string that identifies the predictive inbox placement test.
#[serde(rename = "ReportId")] pub report_id: String, } ///The results of the predictive inbox placement test.
#[derive(Clone, Debug, Default, Deserialize, PartialEq)] #[cfg_attr(any(test, feature = "serialize_structs"), derive(Serialize))] pub struct GetDeliverabilityTestReportResponse { ///An object that contains the results of the predictive inbox placement test.
#[serde(rename = "DeliverabilityTestReport")] pub deliverability_test_report: DeliverabilityTestReport, ///An object that describes how the test email was handled by several email providers, including Gmail, Hotmail, Yahoo, AOL, and others.
#[serde(rename = "IspPlacements")] pub isp_placements: VecAn object that contains the message that you sent when you performed this predictive inbox placement test.
#[serde(rename = "Message")] #[serde(skip_serializing_if = "Option::is_none")] pub message: OptionAn object that specifies how many test messages that were sent during the predictive inbox placement test were delivered to recipients' inboxes, how many were sent to recipients' spam folders, and how many weren't delivered.
#[serde(rename = "OverallPlacement")] pub overall_placement: PlacementStatistics, ///An array of objects that define the tags (keys and values) that are associated with the predictive inbox placement test.
#[serde(rename = "Tags")] #[serde(skip_serializing_if = "Option::is_none")] pub tags: OptionRetrieve 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).
The unique identifier for the campaign. Amazon Pinpoint automatically generates and assigns this identifier to a campaign. This value is not the same as the campaign identifier that Amazon Pinpoint assigns to campaigns that you create and manage by using the Amazon Pinpoint API or the Amazon Pinpoint console.
#[serde(rename = "CampaignId")] pub campaign_id: String, } ///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).
An object that contains the deliverability data for the campaign.
#[serde(rename = "DomainDeliverabilityCampaign")] pub domain_deliverability_campaign: DomainDeliverabilityCampaign, } ///A request to obtain deliverability metrics for a domain.
#[derive(Clone, Debug, Default, PartialEq, Serialize)] #[cfg_attr(feature = "deserialize_structs", derive(Deserialize))] pub struct GetDomainStatisticsReportRequest { ///The domain that you want to obtain deliverability metrics for.
#[serde(rename = "Domain")] pub domain: String, ///The last day (in Unix time) that you want to obtain domain deliverability metrics for. The EndDate
that you specify has to be less than or equal to 30 days after the StartDate
.
The first day (in Unix time) that you want to obtain domain deliverability metrics for.
#[serde(rename = "StartDate")] pub start_date: f64, } ///An object that includes statistics that are related to the domain that you specified.
#[derive(Clone, Debug, Default, Deserialize, PartialEq)] #[cfg_attr(any(test, feature = "serialize_structs"), derive(Serialize))] pub struct GetDomainStatisticsReportResponse { ///An object that contains deliverability metrics for the domain that you specified. This object contains data for each day, starting on the StartDate
and ending on the EndDate
.
An object that contains deliverability metrics for the domain that you specified. The data in this object is a summary of all of the data that was collected from the StartDate
to the EndDate
.
A request to return details about an email identity.
#[derive(Clone, Debug, Default, PartialEq, Serialize)] #[cfg_attr(feature = "deserialize_structs", derive(Deserialize))] pub struct GetEmailIdentityRequest { ///The email identity that you want to retrieve details for.
#[serde(rename = "EmailIdentity")] pub email_identity: String, } ///Details about an email identity.
#[derive(Clone, Debug, Default, Deserialize, PartialEq)] #[cfg_attr(any(test, feature = "serialize_structs"), derive(Serialize))] pub struct GetEmailIdentityResponse { ///An object that contains information about the DKIM attributes for the identity. This object includes the tokens that you use to create the CNAME records that are required to complete the DKIM verification process.
#[serde(rename = "DkimAttributes")] #[serde(skip_serializing_if = "Option::is_none")] pub dkim_attributes: OptionThe feedback forwarding configuration for the identity.
If the value is true
, Amazon Pinpoint sends you email notifications when bounce or complaint events occur. Amazon Pinpoint sends this notification to the address that you specified in the Return-Path header of the original email.
When you set this value to false
, Amazon Pinpoint sends notifications through other mechanisms, such as by notifying an Amazon SNS topic or another event destination. You're required to have a method of tracking bounces and complaints. If you haven't set up another mechanism for receiving bounce or complaint notifications, Amazon Pinpoint sends an email notification when these events occur (even if this setting is disabled).
The email identity type.
#[serde(rename = "IdentityType")] #[serde(skip_serializing_if = "Option::is_none")] pub identity_type: OptionAn object that contains information about the Mail-From attributes for the email identity.
#[serde(rename = "MailFromAttributes")] #[serde(skip_serializing_if = "Option::is_none")] pub mail_from_attributes: OptionAn array of objects that define the tags (keys and values) that are associated with the email identity.
#[serde(rename = "Tags")] #[serde(skip_serializing_if = "Option::is_none")] pub tags: OptionSpecifies whether or not the identity is verified. In Amazon Pinpoint, you can only send email from verified email addresses or domains. For more information about verifying identities, see the Amazon Pinpoint User Guide.
#[serde(rename = "VerifiedForSendingStatus")] #[serde(skip_serializing_if = "Option::is_none")] pub verified_for_sending_status: OptionInformation about an email identity.
#[derive(Clone, Debug, Default, Deserialize, PartialEq)] #[cfg_attr(any(test, feature = "serialize_structs"), derive(Serialize))] pub struct IdentityInfo { ///The address or domain of the identity.
#[serde(rename = "IdentityName")] #[serde(skip_serializing_if = "Option::is_none")] pub identity_name: OptionThe email identity type. The identity type can be one of the following:
EMAILADDRESS
– The identity is an email address.
DOMAIN
– The identity is a domain.
MANAGEDDOMAIN
– The identity is a domain that is managed by AWS.
Indicates whether or not you can send email from the identity.
In Amazon Pinpoint, an identity is an email address or domain that you send email from. Before you can send email from an identity, you have to demostrate that you own the identity, and that you authorize Amazon Pinpoint to send email from that identity.
#[serde(rename = "SendingEnabled")] #[serde(skip_serializing_if = "Option::is_none")] pub sending_enabled: OptionAn 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).
Specifies whether inbox placement data is being tracked for the domain.
#[serde(rename = "Global")] #[serde(skip_serializing_if = "Option::is_none")] pub global: OptionAn array of strings, one for each major email provider that the inbox placement data applies to.
#[serde(rename = "TrackedIsps")] #[serde(skip_serializing_if = "Option::is_none")] pub tracked_isps: OptionAn object that describes how email sent during the predictive inbox placement test was handled by a certain email provider.
#[derive(Clone, Debug, Default, Deserialize, PartialEq)] #[cfg_attr(any(test, feature = "serialize_structs"), derive(Serialize))] pub struct IspPlacement { ///The name of the email provider that the inbox placement data applies to.
#[serde(rename = "IspName")] #[serde(skip_serializing_if = "Option::is_none")] pub isp_name: OptionAn object that contains inbox placement metrics for a specific email provider.
#[serde(rename = "PlacementStatistics")] #[serde(skip_serializing_if = "Option::is_none")] pub placement_statistics: OptionAn 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.
#[derive(Clone, Debug, Default, Deserialize, PartialEq, Serialize)] pub struct KinesisFirehoseDestination { ///The Amazon Resource Name (ARN) of the Amazon Kinesis Data Firehose stream that Amazon Pinpoint sends email events to.
#[serde(rename = "DeliveryStreamArn")] pub delivery_stream_arn: String, ///The Amazon Resource Name (ARN) of the IAM role that Amazon Pinpoint uses when sending email events to the Amazon Kinesis Data Firehose stream.
#[serde(rename = "IamRoleArn")] pub iam_role_arn: String, } ///A request to obtain a list of configuration sets for your Amazon Pinpoint account in the current AWS Region.
#[derive(Clone, Debug, Default, PartialEq, Serialize)] #[cfg_attr(feature = "deserialize_structs", derive(Deserialize))] pub struct ListConfigurationSetsRequest { ///A token returned from a previous call to ListConfigurationSets
to indicate the position in the list of configuration sets.
The number of results to show in a single call to ListConfigurationSets
. If the number of results is larger than the number you specified in this parameter, then the response includes a NextToken
element, which you can use to obtain additional results.
A list of configuration sets in your Amazon Pinpoint account in the current AWS Region.
#[derive(Clone, Debug, Default, Deserialize, PartialEq)] #[cfg_attr(any(test, feature = "serialize_structs"), derive(Serialize))] pub struct ListConfigurationSetsResponse { ///An array that contains all of the configuration sets in your Amazon Pinpoint account in the current AWS Region.
#[serde(rename = "ConfigurationSets")] #[serde(skip_serializing_if = "Option::is_none")] pub configuration_sets: OptionA token that indicates that there are additional configuration sets to list. To view additional configuration sets, issue another request to ListConfigurationSets
, and pass this token in the NextToken
parameter.
A request to obtain a list of dedicated IP pools.
#[derive(Clone, Debug, Default, PartialEq, Serialize)] #[cfg_attr(feature = "deserialize_structs", derive(Deserialize))] pub struct ListDedicatedIpPoolsRequest { ///A token returned from a previous call to ListDedicatedIpPools
to indicate the position in the list of dedicated IP pools.
The number of results to show in a single call to ListDedicatedIpPools
. If the number of results is larger than the number you specified in this parameter, then the response includes a NextToken
element, which you can use to obtain additional results.
A list of dedicated IP pools.
#[derive(Clone, Debug, Default, Deserialize, PartialEq)] #[cfg_attr(any(test, feature = "serialize_structs"), derive(Serialize))] pub struct ListDedicatedIpPoolsResponse { ///A list of all of the dedicated IP pools that are associated with your Amazon Pinpoint account.
#[serde(rename = "DedicatedIpPools")] #[serde(skip_serializing_if = "Option::is_none")] pub dedicated_ip_pools: OptionA token that indicates that there are additional IP pools to list. To view additional IP pools, issue another request to ListDedicatedIpPools
, passing this token in the NextToken
parameter.
A request to list all of the predictive inbox placement tests that you've performed.
#[derive(Clone, Debug, Default, PartialEq, Serialize)] #[cfg_attr(feature = "deserialize_structs", derive(Deserialize))] pub struct ListDeliverabilityTestReportsRequest { ///A token returned from a previous call to ListDeliverabilityTestReports
to indicate the position in the list of predictive inbox placement tests.
The number of results to show in a single call to ListDeliverabilityTestReports
. If the number of results is larger than the number you specified in this parameter, then the response includes a NextToken
element, which you can use to obtain additional results.
The value you specify has to be at least 0, and can be no more than 1000.
#[serde(rename = "PageSize")] #[serde(skip_serializing_if = "Option::is_none")] pub page_size: OptionA list of the predictive inbox placement test reports that are available for your account, regardless of whether or not those tests are complete.
#[derive(Clone, Debug, Default, Deserialize, PartialEq)] #[cfg_attr(any(test, feature = "serialize_structs"), derive(Serialize))] pub struct ListDeliverabilityTestReportsResponse { ///An object that contains a lists of predictive inbox placement tests that you've performed.
#[serde(rename = "DeliverabilityTestReports")] pub deliverability_test_reports: VecA token that indicates that there are additional predictive inbox placement tests to list. To view additional predictive inbox placement tests, issue another request to ListDeliverabilityTestReports
, and pass this token in the NextToken
parameter.
Retrieve 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.
The last day, in Unix time format, that you want to obtain deliverability data for. This value has to be less than or equal to 30 days after the value of the StartDate
parameter.
A token that’s returned from a previous call to the ListDomainDeliverabilityCampaigns
operation. This token indicates the position of a campaign in the list of campaigns.
The maximum number of results to include in response to a single call to the ListDomainDeliverabilityCampaigns
operation. If the number of results is larger than the number that you specify in this parameter, the response includes a NextToken
element, which you can use to obtain additional results.
The first day, in Unix time format, that you want to obtain deliverability data for.
#[serde(rename = "StartDate")] pub start_date: f64, ///The domain to obtain deliverability data for.
#[serde(rename = "SubscribedDomain")] pub subscribed_domain: String, } ///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.
An array of responses, one for each campaign that used the domain to send email during the specified time range.
#[serde(rename = "DomainDeliverabilityCampaigns")] pub domain_deliverability_campaigns: VecA token that’s returned from a previous call to the ListDomainDeliverabilityCampaigns
operation. This token indicates the position of the campaign in the list of campaigns.
A request to list all of the email identities associated with your Amazon Pinpoint account. This list includes identities that you've already verified, identities that are unverified, and identities that were verified in the past, but are no longer verified.
#[derive(Clone, Debug, Default, PartialEq, Serialize)] #[cfg_attr(feature = "deserialize_structs", derive(Deserialize))] pub struct ListEmailIdentitiesRequest { ///A token returned from a previous call to ListEmailIdentities
to indicate the position in the list of identities.
The number of results to show in a single call to ListEmailIdentities
. If the number of results is larger than the number you specified in this parameter, then the response includes a NextToken
element, which you can use to obtain additional results.
The value you specify has to be at least 0, and can be no more than 1000.
#[serde(rename = "PageSize")] #[serde(skip_serializing_if = "Option::is_none")] pub page_size: OptionA 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.
#[derive(Clone, Debug, Default, Deserialize, PartialEq)] #[cfg_attr(any(test, feature = "serialize_structs"), derive(Serialize))] pub struct ListEmailIdentitiesResponse { ///An array that includes all of the identities associated with your Amazon Pinpoint account.
#[serde(rename = "EmailIdentities")] #[serde(skip_serializing_if = "Option::is_none")] pub email_identities: OptionA token that indicates that there are additional configuration sets to list. To view additional configuration sets, issue another request to ListEmailIdentities
, and pass this token in the NextToken
parameter.
The Amazon Resource Name (ARN) of the resource that you want to retrieve tag information for.
#[serde(rename = "ResourceArn")] pub resource_arn: String, } #[derive(Clone, Debug, Default, Deserialize, PartialEq)] #[cfg_attr(any(test, feature = "serialize_structs"), derive(Serialize))] pub struct ListTagsForResourceResponse { ///An array that lists all the tags that are associated with the resource. Each tag consists of a required tag key (Key
) and an associated tag value (Value
)
A list of attributes that are associated with a MAIL FROM domain.
#[derive(Clone, Debug, Default, Deserialize, PartialEq)] #[cfg_attr(any(test, feature = "serialize_structs"), derive(Serialize))] pub struct MailFromAttributes { ///The action that Amazon Pinpoint to takes 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.
These behaviors are taken when the custom MAIL FROM domain configuration is in the Pending
, Failed
, and TemporaryFailure
states.
The name of a domain that an email identity uses as a custom MAIL FROM domain.
#[serde(rename = "MailFromDomain")] pub mail_from_domain: String, ///The status of the MAIL FROM domain. This status can have the following values:
PENDING
– Amazon Pinpoint hasn't started searching for the MX record yet.
SUCCESS
– Amazon Pinpoint detected the required MX record for the MAIL FROM domain.
FAILED
– Amazon Pinpoint can't find the required MX record, or the record no longer exists.
TEMPORARY_FAILURE
– A temporary issue occurred, which prevented Amazon Pinpoint from determining the status of the MAIL FROM domain.
Represents the email message that you're sending. The Message
object consists of a subject line and a message body.
The body of the message. You can specify an HTML version of the message, a text-only version of the message, or both.
#[serde(rename = "Body")] pub body: Body, ///The subject line of the email. The subject line can only contain 7-bit ASCII characters. However, you can specify non-ASCII characters in the subject line by using encoded-word syntax, as described in RFC 2047.
#[serde(rename = "Subject")] pub subject: Content, } ///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.
#[derive(Clone, Debug, Default, PartialEq, Serialize)] #[cfg_attr(feature = "deserialize_structs", derive(Deserialize))] pub struct MessageTag { ///The name of the message tag. The message tag name has to meet the following criteria:
It can only contain ASCII letters (a–z, A–Z), numbers (0–9), underscores (_), or dashes (-).
It can contain no more than 256 characters.
The value of the message tag. The message tag value has to meet the following criteria:
It can only contain ASCII letters (a–z, A–Z), numbers (0–9), underscores (_), or dashes (-).
It can contain no more than 256 characters.
An object that contains information about email that was sent from the selected domain.
#[derive(Clone, Debug, Default, Deserialize, PartialEq)] #[cfg_attr(any(test, feature = "serialize_structs"), derive(Serialize))] pub struct OverallVolume { ///An object that contains inbox and junk mail placement metrics for individual email providers.
#[serde(rename = "DomainIspPlacements")] #[serde(skip_serializing_if = "Option::is_none")] pub domain_isp_placements: OptionThe percentage of emails that were sent from the domain that were read by their recipients.
#[serde(rename = "ReadRatePercent")] #[serde(skip_serializing_if = "Option::is_none")] pub read_rate_percent: OptionAn object that contains information about the numbers of messages that arrived in recipients' inboxes and junk mail folders.
#[serde(rename = "VolumeStatistics")] #[serde(skip_serializing_if = "Option::is_none")] pub volume_statistics: OptionAn 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.
#[derive(Clone, Debug, Default, Deserialize, PartialEq, Serialize)] pub struct PinpointDestination { ///The Amazon Resource Name (ARN) of the Amazon Pinpoint project that you want to send email events to.
#[serde(rename = "ApplicationArn")] #[serde(skip_serializing_if = "Option::is_none")] pub application_arn: OptionAn object that contains inbox placement data for an email provider.
#[derive(Clone, Debug, Default, Deserialize, PartialEq)] #[cfg_attr(any(test, feature = "serialize_structs"), derive(Serialize))] pub struct PlacementStatistics { ///The percentage of emails that were authenticated by using DomainKeys Identified Mail (DKIM) during the predictive inbox placement test.
#[serde(rename = "DkimPercentage")] #[serde(skip_serializing_if = "Option::is_none")] pub dkim_percentage: OptionThe percentage of emails that arrived in recipients' inboxes during the predictive inbox placement test.
#[serde(rename = "InboxPercentage")] #[serde(skip_serializing_if = "Option::is_none")] pub inbox_percentage: OptionThe percentage of emails that didn't arrive in recipients' inboxes at all during the predictive inbox placement test.
#[serde(rename = "MissingPercentage")] #[serde(skip_serializing_if = "Option::is_none")] pub missing_percentage: OptionThe percentage of emails that arrived in recipients' spam or junk mail folders during the predictive inbox placement test.
#[serde(rename = "SpamPercentage")] #[serde(skip_serializing_if = "Option::is_none")] pub spam_percentage: OptionThe percentage of emails that were authenticated by using Sender Policy Framework (SPF) during the predictive inbox placement test.
#[serde(rename = "SpfPercentage")] #[serde(skip_serializing_if = "Option::is_none")] pub spf_percentage: OptionA request to enable or disable the automatic IP address warm-up feature.
#[derive(Clone, Debug, Default, PartialEq, Serialize)] #[cfg_attr(feature = "deserialize_structs", derive(Deserialize))] pub struct PutAccountDedicatedIpWarmupAttributesRequest { ///Enables or disables the automatic warm-up feature for dedicated IP addresses that are associated with your Amazon Pinpoint account in the current AWS Region. Set to true
to enable the automatic warm-up feature, or set to false
to disable it.
An HTTP 200 response if the request succeeds, or an error message if the request fails.
#[derive(Clone, Debug, Default, Deserialize, PartialEq)] #[cfg_attr(any(test, feature = "serialize_structs"), derive(Serialize))] pub struct PutAccountDedicatedIpWarmupAttributesResponse {} ///A request to change the ability of your account to send email.
#[derive(Clone, Debug, Default, PartialEq, Serialize)] #[cfg_attr(feature = "deserialize_structs", derive(Deserialize))] pub struct PutAccountSendingAttributesRequest { ///Enables or disables your account's ability to send email. Set to true
to enable email sending, or set to false
to disable email sending.
If AWS paused your account's ability to send email, you can't use this operation to resume your account's ability to send email.
An HTTP 200 response if the request succeeds, or an error message if the request fails.
#[derive(Clone, Debug, Default, Deserialize, PartialEq)] #[cfg_attr(any(test, feature = "serialize_structs"), derive(Serialize))] pub struct PutAccountSendingAttributesResponse {} ///A request to associate a configuration set with a dedicated IP pool.
#[derive(Clone, Debug, Default, PartialEq, Serialize)] #[cfg_attr(feature = "deserialize_structs", derive(Deserialize))] pub struct PutConfigurationSetDeliveryOptionsRequest { ///The name of the configuration set that you want to associate with a dedicated IP pool.
#[serde(rename = "ConfigurationSetName")] pub configuration_set_name: String, ///The name of the dedicated IP pool that you want to associate with the configuration set.
#[serde(rename = "SendingPoolName")] #[serde(skip_serializing_if = "Option::is_none")] pub sending_pool_name: OptionSpecifies 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.
An HTTP 200 response if the request succeeds, or an error message if the request fails.
#[derive(Clone, Debug, Default, Deserialize, PartialEq)] #[cfg_attr(any(test, feature = "serialize_structs"), derive(Serialize))] pub struct PutConfigurationSetDeliveryOptionsResponse {} ///A request to enable or disable tracking of reputation metrics for a configuration set.
#[derive(Clone, Debug, Default, PartialEq, Serialize)] #[cfg_attr(feature = "deserialize_structs", derive(Deserialize))] pub struct PutConfigurationSetReputationOptionsRequest { ///The name of the configuration set that you want to enable or disable reputation metric tracking for.
#[serde(rename = "ConfigurationSetName")] pub configuration_set_name: String, ///If true
, tracking of reputation metrics is enabled for the configuration set. If false
, tracking of reputation metrics is disabled for the configuration set.
An HTTP 200 response if the request succeeds, or an error message if the request fails.
#[derive(Clone, Debug, Default, Deserialize, PartialEq)] #[cfg_attr(any(test, feature = "serialize_structs"), derive(Serialize))] pub struct PutConfigurationSetReputationOptionsResponse {} ///A request to enable or disable the ability of Amazon Pinpoint to send emails that use a specific configuration set.
#[derive(Clone, Debug, Default, PartialEq, Serialize)] #[cfg_attr(feature = "deserialize_structs", derive(Deserialize))] pub struct PutConfigurationSetSendingOptionsRequest { ///The name of the configuration set that you want to enable or disable email sending for.
#[serde(rename = "ConfigurationSetName")] pub configuration_set_name: String, ///If true
, email sending is enabled for the configuration set. If false
, email sending is disabled for the configuration set.
An HTTP 200 response if the request succeeds, or an error message if the request fails.
#[derive(Clone, Debug, Default, Deserialize, PartialEq)] #[cfg_attr(any(test, feature = "serialize_structs"), derive(Serialize))] pub struct PutConfigurationSetSendingOptionsResponse {} ///A request to add a custom domain for tracking open and click events to a configuration set.
#[derive(Clone, Debug, Default, PartialEq, Serialize)] #[cfg_attr(feature = "deserialize_structs", derive(Deserialize))] pub struct PutConfigurationSetTrackingOptionsRequest { ///The name of the configuration set that you want to add a custom tracking domain to.
#[serde(rename = "ConfigurationSetName")] pub configuration_set_name: String, ///The domain that you want to use to track open and click events.
#[serde(rename = "CustomRedirectDomain")] #[serde(skip_serializing_if = "Option::is_none")] pub custom_redirect_domain: OptionAn HTTP 200 response if the request succeeds, or an error message if the request fails.
#[derive(Clone, Debug, Default, Deserialize, PartialEq)] #[cfg_attr(any(test, feature = "serialize_structs"), derive(Serialize))] pub struct PutConfigurationSetTrackingOptionsResponse {} ///A request to move a dedicated IP address to a dedicated IP pool.
#[derive(Clone, Debug, Default, PartialEq, Serialize)] #[cfg_attr(feature = "deserialize_structs", derive(Deserialize))] pub struct PutDedicatedIpInPoolRequest { ///The name of the IP pool that you want to add the dedicated IP address to. You have to specify an IP pool that already exists.
#[serde(rename = "DestinationPoolName")] pub destination_pool_name: String, ///The IP address that you want to move to the dedicated IP pool. The value you specify has to be a dedicated IP address that's associated with your Amazon Pinpoint account.
#[serde(rename = "Ip")] pub ip: String, } ///An HTTP 200 response if the request succeeds, or an error message if the request fails.
#[derive(Clone, Debug, Default, Deserialize, PartialEq)] #[cfg_attr(any(test, feature = "serialize_structs"), derive(Serialize))] pub struct PutDedicatedIpInPoolResponse {} ///A request to change the warm-up attributes for a dedicated IP address. This operation is useful when you want to resume the warm-up process for an existing IP address.
#[derive(Clone, Debug, Default, PartialEq, Serialize)] #[cfg_attr(feature = "deserialize_structs", derive(Deserialize))] pub struct PutDedicatedIpWarmupAttributesRequest { ///The dedicated IP address that you want to update the warm-up attributes for.
#[serde(rename = "Ip")] pub ip: String, ///The warm-up percentage that you want to associate with the dedicated IP address.
#[serde(rename = "WarmupPercentage")] pub warmup_percentage: i64, } ///An HTTP 200 response if the request succeeds, or an error message if the request fails.
#[derive(Clone, Debug, Default, Deserialize, PartialEq)] #[cfg_attr(any(test, feature = "serialize_structs"), derive(Serialize))] pub struct PutDedicatedIpWarmupAttributesResponse {} ///Enable or disable the Deliverability dashboard for your Amazon Pinpoint account. When you enable the Deliverability dashboard, you gain access to reputation, deliverability, and other metrics for the domains that you use to send email using Amazon Pinpoint. You also gain the ability to perform predictive inbox placement tests.
When you use the Deliverability dashboard, you pay a monthly subscription charge, in addition to any other fees that you accrue by using Amazon Pinpoint. For more information about the features and cost of a Deliverability dashboard subscription, see Amazon Pinpoint Pricing.
#[derive(Clone, Debug, Default, PartialEq, Serialize)] #[cfg_attr(feature = "deserialize_structs", derive(Deserialize))] pub struct PutDeliverabilityDashboardOptionRequest { ///Specifies whether to enable the Deliverability dashboard for your Amazon Pinpoint account. To enable the dashboard, set this value to true
.
An array of objects, one for each verified domain that you use to send email and enabled the Deliverability dashboard for.
#[serde(rename = "SubscribedDomains")] #[serde(skip_serializing_if = "Option::is_none")] pub subscribed_domains: OptionA response that indicates whether the Deliverability dashboard is enabled for your Amazon Pinpoint account.
#[derive(Clone, Debug, Default, Deserialize, PartialEq)] #[cfg_attr(any(test, feature = "serialize_structs"), derive(Serialize))] pub struct PutDeliverabilityDashboardOptionResponse {} ///A request to enable or disable DKIM signing of email that you send from an email identity.
#[derive(Clone, Debug, Default, PartialEq, Serialize)] #[cfg_attr(feature = "deserialize_structs", derive(Deserialize))] pub struct PutEmailIdentityDkimAttributesRequest { ///The email identity that you want to change the DKIM settings for.
#[serde(rename = "EmailIdentity")] pub email_identity: String, ///Sets the DKIM signing configuration for the identity.
When you set this value true
, then the messages that Amazon Pinpoint sends from the identity are DKIM-signed. When you set this value to false
, then the messages that Amazon Pinpoint sends from the identity aren't DKIM-signed.
An HTTP 200 response if the request succeeds, or an error message if the request fails.
#[derive(Clone, Debug, Default, Deserialize, PartialEq)] #[cfg_attr(any(test, feature = "serialize_structs"), derive(Serialize))] pub struct PutEmailIdentityDkimAttributesResponse {} ///A request to set the attributes that control how bounce and complaint events are processed.
#[derive(Clone, Debug, Default, PartialEq, Serialize)] #[cfg_attr(feature = "deserialize_structs", derive(Deserialize))] pub struct PutEmailIdentityFeedbackAttributesRequest { ///Sets the feedback forwarding configuration for the identity.
If the value is true
, Amazon Pinpoint sends you email notifications when bounce or complaint events occur. Amazon Pinpoint sends this notification to the address that you specified in the Return-Path header of the original email.
When you set this value to false
, Amazon Pinpoint sends notifications through other mechanisms, such as by notifying an Amazon SNS topic or another event destination. You're required to have a method of tracking bounces and complaints. If you haven't set up another mechanism for receiving bounce or complaint notifications, Amazon Pinpoint sends an email notification when these events occur (even if this setting is disabled).
The email identity that you want to configure bounce and complaint feedback forwarding for.
#[serde(rename = "EmailIdentity")] pub email_identity: String, } ///An HTTP 200 response if the request succeeds, or an error message if the request fails.
#[derive(Clone, Debug, Default, Deserialize, PartialEq)] #[cfg_attr(any(test, feature = "serialize_structs"), derive(Serialize))] pub struct PutEmailIdentityFeedbackAttributesResponse {} ///A request to configure the custom MAIL FROM domain for a verified identity.
#[derive(Clone, Debug, Default, PartialEq, Serialize)] #[cfg_attr(feature = "deserialize_structs", derive(Deserialize))] pub struct PutEmailIdentityMailFromAttributesRequest { ///The action that you want Amazon Pinpoint to take if it can't read the required MX record when you send an email. 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.
These behaviors are taken when the custom MAIL FROM domain configuration is in the Pending
, Failed
, and TemporaryFailure
states.
The verified email identity that you want to set up the custom MAIL FROM domain for.
#[serde(rename = "EmailIdentity")] pub email_identity: String, ///The custom MAIL FROM domain that you want the verified identity to use. The MAIL FROM domain must meet the following criteria:
It has to be a subdomain of the verified identity.
It can't be used to receive email.
It can't be used in a "From" address if the MAIL FROM domain is a destination for feedback forwarding emails.
An HTTP 200 response if the request succeeds, or an error message if the request fails.
#[derive(Clone, Debug, Default, Deserialize, PartialEq)] #[cfg_attr(any(test, feature = "serialize_structs"), derive(Serialize))] pub struct PutEmailIdentityMailFromAttributesResponse {} ///The raw email message.
#[derive(Clone, Debug, Default, PartialEq, Serialize)] #[cfg_attr(feature = "deserialize_structs", derive(Deserialize))] pub struct RawMessage { ///The raw email message. The message has to meet the following criteria:
The message has to contain a header and a body, separated by one blank line.
All of the required header fields must be present in the message.
Each part of a multipart MIME message must be formatted properly.
Attachments must be in a file format that Amazon Pinpoint supports.
The entire message must be Base64 encoded.
If any of the MIME parts in your message contain content that is outside of the 7-bit ASCII character range, you should encode that content to ensure that recipients' email clients render the message properly.
The length of any single line of text in the message can't exceed 1,000 characters. This restriction is defined in RFC 5321.
Enable or disable collection of reputation metrics for emails that you send using this configuration set in the current AWS Region.
#[derive(Clone, Debug, Default, Deserialize, PartialEq, Serialize)] pub struct ReputationOptions { ///The date and time (in Unix time) when the reputation metrics were last given a fresh start. When your account is given a fresh start, your reputation metrics are calculated starting from the date of the fresh start.
#[serde(rename = "LastFreshStart")] #[serde(skip_serializing_if = "Option::is_none")] pub last_fresh_start: OptionIf true
, tracking of reputation metrics is enabled for the configuration set. If false
, tracking of reputation metrics is disabled for the configuration set.
A request to send an email message.
#[derive(Clone, Debug, Default, PartialEq, Serialize)] #[cfg_attr(feature = "deserialize_structs", derive(Deserialize))] pub struct SendEmailRequest { ///The name of the configuration set that you want to use when sending the email.
#[serde(rename = "ConfigurationSetName")] #[serde(skip_serializing_if = "Option::is_none")] pub configuration_set_name: OptionAn object that contains the body of the message. You can send either a Simple message or a Raw message.
#[serde(rename = "Content")] pub content: EmailContent, ///An object that contains the recipients of the email message.
#[serde(rename = "Destination")] pub destination: Destination, ///A list of tags, in the form of name/value pairs, to apply to an email that you send using the SendEmail
operation. Tags correspond to characteristics of the email that you define, so that you can publish email sending events.
The address that Amazon Pinpoint should send bounce and complaint notifications to.
#[serde(rename = "FeedbackForwardingEmailAddress")] #[serde(skip_serializing_if = "Option::is_none")] pub feedback_forwarding_email_address: OptionThe email address that you want to use as the "From" address for the email. The address that you specify has to be verified.
#[serde(rename = "FromEmailAddress")] #[serde(skip_serializing_if = "Option::is_none")] pub from_email_address: OptionThe "Reply-to" email addresses for the message. When the recipient replies to the message, each Reply-to address receives the reply.
#[serde(rename = "ReplyToAddresses")] #[serde(skip_serializing_if = "Option::is_none")] pub reply_to_addresses: OptionA unique message ID that you receive when Amazon Pinpoint accepts an email for sending.
#[derive(Clone, Debug, Default, Deserialize, PartialEq)] #[cfg_attr(any(test, feature = "serialize_structs"), derive(Serialize))] pub struct SendEmailResponse { ///A unique identifier for the message that is generated when Amazon Pinpoint accepts the message.
It is possible for Amazon Pinpoint to accept a message without sending it. This can happen when the message you're trying to send has an attachment doesn't pass a virus check, or when you send a templated email that contains invalid personalization content, for example.
An object that contains information about the per-day and per-second sending limits for your Amazon Pinpoint account in the current AWS Region.
#[derive(Clone, Debug, Default, Deserialize, PartialEq)] #[cfg_attr(any(test, feature = "serialize_structs"), derive(Serialize))] pub struct SendQuota { ///The maximum number of emails that you can send in the current AWS Region over a 24-hour period. This value is also called your sending quota.
#[serde(rename = "Max24HourSend")] #[serde(skip_serializing_if = "Option::is_none")] pub max_24_hour_send: OptionThe maximum number of emails that you can send per second in the current AWS Region. This value is also called your maximum sending rate or your maximum TPS (transactions per second) rate.
#[serde(rename = "MaxSendRate")] #[serde(skip_serializing_if = "Option::is_none")] pub max_send_rate: OptionThe number of emails sent from your Amazon Pinpoint account in the current AWS Region over the past 24 hours.
#[serde(rename = "SentLast24Hours")] #[serde(skip_serializing_if = "Option::is_none")] pub sent_last_24_hours: OptionUsed to enable or disable email sending for messages that use this configuration set in the current AWS Region.
#[derive(Clone, Debug, Default, Deserialize, PartialEq, Serialize)] pub struct SendingOptions { ///If true
, email sending is enabled for the configuration set. If false
, email sending is disabled for the configuration set.
An object that defines an Amazon SNS destination for email events. You can use Amazon SNS to send notification when certain email events occur.
#[derive(Clone, Debug, Default, Deserialize, PartialEq, Serialize)] pub struct SnsDestination { ///The Amazon Resource Name (ARN) of the Amazon SNS topic that you want to publish email events to. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.
#[serde(rename = "TopicArn")] pub topic_arn: String, } ///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.
Each tag consists of a required tag key and an associated tag value, both of which you define. A tag key is a general label that acts as a category for a more specific tag value. A tag value acts as a descriptor within a tag key. A tag key can contain as many as 128 characters. A tag value can contain as many as 256 characters. The characters can be Unicode letters, digits, white space, or one of the following symbols: _ . : / = + -. The following additional restrictions apply to tags:
Tag keys and values are case sensitive.
For each associated resource, each tag key must be unique and it can have only one value.
The aws:
prefix is reserved for use by AWS; you can’t use it in any tag keys or values that you define. In addition, you can't edit or remove tag keys or values that use this prefix. Tags that use this prefix don’t count against the limit of 50 tags per resource.
You can associate tags with public or shared resources, but the tags are available only for your AWS account, not any other accounts that share the resource. In addition, the tags are available only for resources that are located in the specified AWS Region for your AWS account.
One part of a key-value pair that defines a tag. The maximum length of a tag key is 128 characters. The minimum length is 1 character.
#[serde(rename = "Key")] pub key: String, ///The optional part of a key-value pair that defines a tag. The maximum length of a tag value is 256 characters. The minimum length is 0 characters. If you don’t want a resource to have a specific tag value, don’t specify a value for this parameter. Amazon Pinpoint will set the value to an empty string.
#[serde(rename = "Value")] pub value: String, } #[derive(Clone, Debug, Default, PartialEq, Serialize)] #[cfg_attr(feature = "deserialize_structs", derive(Deserialize))] pub struct TagResourceRequest { ///The Amazon Resource Name (ARN) of the resource that you want to add one or more tags to.
#[serde(rename = "ResourceArn")] pub resource_arn: String, ///A list of the tags that you want to add to the resource. A tag consists of a required tag key (Key
) and an associated tag value (Value
). The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.
The Amazon Resource Name (ARN) of the template.
#[serde(rename = "TemplateArn")] #[serde(skip_serializing_if = "Option::is_none")] pub template_arn: OptionAn object that defines the values to use for message variables in the template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the value to use for that variable.
#[serde(rename = "TemplateData")] #[serde(skip_serializing_if = "Option::is_none")] pub template_data: OptionAn 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.
These images and links include references to a domain operated by AWS. You can optionally configure Amazon Pinpoint to use a domain that you operate for these images and links.
#[derive(Clone, Debug, Default, Deserialize, PartialEq, Serialize)] pub struct TrackingOptions { ///The domain that you want to use for tracking open and click events.
#[serde(rename = "CustomRedirectDomain")] pub custom_redirect_domain: String, } #[derive(Clone, Debug, Default, PartialEq, Serialize)] #[cfg_attr(feature = "deserialize_structs", derive(Deserialize))] pub struct UntagResourceRequest { ///The Amazon Resource Name (ARN) of the resource that you want to remove one or more tags from.
#[serde(rename = "ResourceArn")] pub resource_arn: String, ///The tags (tag keys) that you want to remove from the resource. When you specify a tag key, the action removes both that key and its associated tag value.
To remove more than one tag from the resource, append the TagKeys
parameter and argument for each additional tag to remove, separated by an ampersand. For example: /v1/email/tags?ResourceArn=ResourceArn&TagKeys=Key1&TagKeys=Key2
A request to change the settings for an event destination for a configuration set.
#[derive(Clone, Debug, Default, PartialEq, Serialize)] #[cfg_attr(feature = "deserialize_structs", derive(Deserialize))] pub struct UpdateConfigurationSetEventDestinationRequest { ///The name of the configuration set that contains the event destination that you want to modify.
#[serde(rename = "ConfigurationSetName")] pub configuration_set_name: String, ///An object that defines the event destination.
#[serde(rename = "EventDestination")] pub event_destination: EventDestinationDefinition, ///The name of the event destination that you want to modify.
#[serde(rename = "EventDestinationName")] pub event_destination_name: String, } ///An HTTP 200 response if the request succeeds, or an error message if the request fails.
#[derive(Clone, Debug, Default, Deserialize, PartialEq)] #[cfg_attr(any(test, feature = "serialize_structs"), derive(Serialize))] pub struct UpdateConfigurationSetEventDestinationResponse {} ///An object that contains information about the amount of email that was delivered to recipients.
#[derive(Clone, Debug, Default, Deserialize, PartialEq)] #[cfg_attr(any(test, feature = "serialize_structs"), derive(Serialize))] pub struct VolumeStatistics { ///The total number of emails that arrived in recipients' inboxes.
#[serde(rename = "InboxRawCount")] #[serde(skip_serializing_if = "Option::is_none")] pub inbox_raw_count: OptionAn estimate of the percentage of emails sent from the current domain that will arrive in recipients' inboxes.
#[serde(rename = "ProjectedInbox")] #[serde(skip_serializing_if = "Option::is_none")] pub projected_inbox: OptionAn estimate of the percentage of emails sent from the current domain that will arrive in recipients' spam or junk mail folders.
#[serde(rename = "ProjectedSpam")] #[serde(skip_serializing_if = "Option::is_none")] pub projected_spam: OptionThe total number of emails that arrived in recipients' spam or junk mail folders.
#[serde(rename = "SpamRawCount")] #[serde(skip_serializing_if = "Option::is_none")] pub spam_raw_count: OptionThe resource specified in your request already exists.
AlreadyExists(String), ///The input you provided is invalid.
BadRequest(String), ///The resource is being modified by another operation or thread.
ConcurrentModification(String), ///There are too many instances of the specified resource type.
LimitExceeded(String), ///The resource you attempted to access doesn't exist.
NotFound(String), ///Too many requests have been made to the operation.
TooManyRequests(String), } impl CreateConfigurationSetError { pub fn from_response(res: BufferedHttpResponse) -> RusotoErrorThe resource specified in your request already exists.
AlreadyExists(String), ///The input you provided is invalid.
BadRequest(String), ///There are too many instances of the specified resource type.
LimitExceeded(String), ///The resource you attempted to access doesn't exist.
NotFound(String), ///Too many requests have been made to the operation.
TooManyRequests(String), } impl CreateConfigurationSetEventDestinationError { pub fn from_response( res: BufferedHttpResponse, ) -> RusotoErrorThe resource specified in your request already exists.
AlreadyExists(String), ///The input you provided is invalid.
BadRequest(String), ///The resource is being modified by another operation or thread.
ConcurrentModification(String), ///There are too many instances of the specified resource type.
LimitExceeded(String), ///Too many requests have been made to the operation.
TooManyRequests(String), } impl CreateDedicatedIpPoolError { pub fn from_response(res: BufferedHttpResponse) -> RusotoErrorThe message can't be sent because the account's ability to send email has been permanently restricted.
AccountSuspended(String), ///The input you provided is invalid.
BadRequest(String), ///The resource is being modified by another operation or thread.
ConcurrentModification(String), ///There are too many instances of the specified resource type.
LimitExceeded(String), ///The message can't be sent because the sending domain isn't verified.
MailFromDomainNotVerified(String), ///The message can't be sent because it contains invalid content.
MessageRejected(String), ///The resource you attempted to access doesn't exist.
NotFound(String), ///The message can't be sent because the account's ability to send email is currently paused.
SendingPaused(String), ///Too many requests have been made to the operation.
TooManyRequests(String), } impl CreateDeliverabilityTestReportError { pub fn from_response( res: BufferedHttpResponse, ) -> RusotoErrorThe input you provided is invalid.
BadRequest(String), ///The resource is being modified by another operation or thread.
ConcurrentModification(String), ///There are too many instances of the specified resource type.
LimitExceeded(String), ///Too many requests have been made to the operation.
TooManyRequests(String), } impl CreateEmailIdentityError { pub fn from_response(res: BufferedHttpResponse) -> RusotoErrorThe input you provided is invalid.
BadRequest(String), ///The resource is being modified by another operation or thread.
ConcurrentModification(String), ///The resource you attempted to access doesn't exist.
NotFound(String), ///Too many requests have been made to the operation.
TooManyRequests(String), } impl DeleteConfigurationSetError { pub fn from_response(res: BufferedHttpResponse) -> RusotoErrorThe input you provided is invalid.
BadRequest(String), ///The resource you attempted to access doesn't exist.
NotFound(String), ///Too many requests have been made to the operation.
TooManyRequests(String), } impl DeleteConfigurationSetEventDestinationError { pub fn from_response( res: BufferedHttpResponse, ) -> RusotoErrorThe input you provided is invalid.
BadRequest(String), ///The resource is being modified by another operation or thread.
ConcurrentModification(String), ///The resource you attempted to access doesn't exist.
NotFound(String), ///Too many requests have been made to the operation.
TooManyRequests(String), } impl DeleteDedicatedIpPoolError { pub fn from_response(res: BufferedHttpResponse) -> RusotoErrorThe input you provided is invalid.
BadRequest(String), ///The resource is being modified by another operation or thread.
ConcurrentModification(String), ///The resource you attempted to access doesn't exist.
NotFound(String), ///Too many requests have been made to the operation.
TooManyRequests(String), } impl DeleteEmailIdentityError { pub fn from_response(res: BufferedHttpResponse) -> RusotoErrorThe input you provided is invalid.
BadRequest(String), ///Too many requests have been made to the operation.
TooManyRequests(String), } impl GetAccountError { pub fn from_response(res: BufferedHttpResponse) -> RusotoErrorThe input you provided is invalid.
BadRequest(String), ///The resource you attempted to access doesn't exist.
NotFound(String), ///Too many requests have been made to the operation.
TooManyRequests(String), } impl GetBlacklistReportsError { pub fn from_response(res: BufferedHttpResponse) -> RusotoErrorThe input you provided is invalid.
BadRequest(String), ///The resource you attempted to access doesn't exist.
NotFound(String), ///Too many requests have been made to the operation.
TooManyRequests(String), } impl GetConfigurationSetError { pub fn from_response(res: BufferedHttpResponse) -> RusotoErrorThe input you provided is invalid.
BadRequest(String), ///The resource you attempted to access doesn't exist.
NotFound(String), ///Too many requests have been made to the operation.
TooManyRequests(String), } impl GetConfigurationSetEventDestinationsError { pub fn from_response( res: BufferedHttpResponse, ) -> RusotoErrorThe input you provided is invalid.
BadRequest(String), ///The resource you attempted to access doesn't exist.
NotFound(String), ///Too many requests have been made to the operation.
TooManyRequests(String), } impl GetDedicatedIpError { pub fn from_response(res: BufferedHttpResponse) -> RusotoErrorThe input you provided is invalid.
BadRequest(String), ///The resource you attempted to access doesn't exist.
NotFound(String), ///Too many requests have been made to the operation.
TooManyRequests(String), } impl GetDedicatedIpsError { pub fn from_response(res: BufferedHttpResponse) -> RusotoErrorThe input you provided is invalid.
BadRequest(String), ///There are too many instances of the specified resource type.
LimitExceeded(String), ///Too many requests have been made to the operation.
TooManyRequests(String), } impl GetDeliverabilityDashboardOptionsError { pub fn from_response( res: BufferedHttpResponse, ) -> RusotoErrorThe input you provided is invalid.
BadRequest(String), ///The resource you attempted to access doesn't exist.
NotFound(String), ///Too many requests have been made to the operation.
TooManyRequests(String), } impl GetDeliverabilityTestReportError { pub fn from_response( res: BufferedHttpResponse, ) -> RusotoErrorThe input you provided is invalid.
BadRequest(String), ///The resource you attempted to access doesn't exist.
NotFound(String), ///Too many requests have been made to the operation.
TooManyRequests(String), } impl GetDomainDeliverabilityCampaignError { pub fn from_response( res: BufferedHttpResponse, ) -> RusotoErrorThe input you provided is invalid.
BadRequest(String), ///The resource you attempted to access doesn't exist.
NotFound(String), ///Too many requests have been made to the operation.
TooManyRequests(String), } impl GetDomainStatisticsReportError { pub fn from_response(res: BufferedHttpResponse) -> RusotoErrorThe input you provided is invalid.
BadRequest(String), ///The resource you attempted to access doesn't exist.
NotFound(String), ///Too many requests have been made to the operation.
TooManyRequests(String), } impl GetEmailIdentityError { pub fn from_response(res: BufferedHttpResponse) -> RusotoErrorThe input you provided is invalid.
BadRequest(String), ///Too many requests have been made to the operation.
TooManyRequests(String), } impl ListConfigurationSetsError { pub fn from_response(res: BufferedHttpResponse) -> RusotoErrorThe input you provided is invalid.
BadRequest(String), ///Too many requests have been made to the operation.
TooManyRequests(String), } impl ListDedicatedIpPoolsError { pub fn from_response(res: BufferedHttpResponse) -> RusotoErrorThe input you provided is invalid.
BadRequest(String), ///The resource you attempted to access doesn't exist.
NotFound(String), ///Too many requests have been made to the operation.
TooManyRequests(String), } impl ListDeliverabilityTestReportsError { pub fn from_response( res: BufferedHttpResponse, ) -> RusotoErrorThe input you provided is invalid.
BadRequest(String), ///The resource you attempted to access doesn't exist.
NotFound(String), ///Too many requests have been made to the operation.
TooManyRequests(String), } impl ListDomainDeliverabilityCampaignsError { pub fn from_response( res: BufferedHttpResponse, ) -> RusotoErrorThe input you provided is invalid.
BadRequest(String), ///Too many requests have been made to the operation.
TooManyRequests(String), } impl ListEmailIdentitiesError { pub fn from_response(res: BufferedHttpResponse) -> RusotoErrorThe input you provided is invalid.
BadRequest(String), ///The resource you attempted to access doesn't exist.
NotFound(String), ///Too many requests have been made to the operation.
TooManyRequests(String), } impl ListTagsForResourceError { pub fn from_response(res: BufferedHttpResponse) -> RusotoErrorThe input you provided is invalid.
BadRequest(String), ///Too many requests have been made to the operation.
TooManyRequests(String), } impl PutAccountDedicatedIpWarmupAttributesError { pub fn from_response( res: BufferedHttpResponse, ) -> RusotoErrorThe input you provided is invalid.
BadRequest(String), ///Too many requests have been made to the operation.
TooManyRequests(String), } impl PutAccountSendingAttributesError { pub fn from_response( res: BufferedHttpResponse, ) -> RusotoErrorThe input you provided is invalid.
BadRequest(String), ///The resource you attempted to access doesn't exist.
NotFound(String), ///Too many requests have been made to the operation.
TooManyRequests(String), } impl PutConfigurationSetDeliveryOptionsError { pub fn from_response( res: BufferedHttpResponse, ) -> RusotoErrorThe input you provided is invalid.
BadRequest(String), ///The resource you attempted to access doesn't exist.
NotFound(String), ///Too many requests have been made to the operation.
TooManyRequests(String), } impl PutConfigurationSetReputationOptionsError { pub fn from_response( res: BufferedHttpResponse, ) -> RusotoErrorThe input you provided is invalid.
BadRequest(String), ///The resource you attempted to access doesn't exist.
NotFound(String), ///Too many requests have been made to the operation.
TooManyRequests(String), } impl PutConfigurationSetSendingOptionsError { pub fn from_response( res: BufferedHttpResponse, ) -> RusotoErrorThe input you provided is invalid.
BadRequest(String), ///The resource you attempted to access doesn't exist.
NotFound(String), ///Too many requests have been made to the operation.
TooManyRequests(String), } impl PutConfigurationSetTrackingOptionsError { pub fn from_response( res: BufferedHttpResponse, ) -> RusotoErrorThe input you provided is invalid.
BadRequest(String), ///The resource you attempted to access doesn't exist.
NotFound(String), ///Too many requests have been made to the operation.
TooManyRequests(String), } impl PutDedicatedIpInPoolError { pub fn from_response(res: BufferedHttpResponse) -> RusotoErrorThe input you provided is invalid.
BadRequest(String), ///The resource you attempted to access doesn't exist.
NotFound(String), ///Too many requests have been made to the operation.
TooManyRequests(String), } impl PutDedicatedIpWarmupAttributesError { pub fn from_response( res: BufferedHttpResponse, ) -> RusotoErrorThe resource specified in your request already exists.
AlreadyExists(String), ///The input you provided is invalid.
BadRequest(String), ///There are too many instances of the specified resource type.
LimitExceeded(String), ///The resource you attempted to access doesn't exist.
NotFound(String), ///Too many requests have been made to the operation.
TooManyRequests(String), } impl PutDeliverabilityDashboardOptionError { pub fn from_response( res: BufferedHttpResponse, ) -> RusotoErrorThe input you provided is invalid.
BadRequest(String), ///The resource you attempted to access doesn't exist.
NotFound(String), ///Too many requests have been made to the operation.
TooManyRequests(String), } impl PutEmailIdentityDkimAttributesError { pub fn from_response( res: BufferedHttpResponse, ) -> RusotoErrorThe input you provided is invalid.
BadRequest(String), ///The resource you attempted to access doesn't exist.
NotFound(String), ///Too many requests have been made to the operation.
TooManyRequests(String), } impl PutEmailIdentityFeedbackAttributesError { pub fn from_response( res: BufferedHttpResponse, ) -> RusotoErrorThe input you provided is invalid.
BadRequest(String), ///The resource you attempted to access doesn't exist.
NotFound(String), ///Too many requests have been made to the operation.
TooManyRequests(String), } impl PutEmailIdentityMailFromAttributesError { pub fn from_response( res: BufferedHttpResponse, ) -> RusotoErrorThe message can't be sent because the account's ability to send email has been permanently restricted.
AccountSuspended(String), ///The input you provided is invalid.
BadRequest(String), ///There are too many instances of the specified resource type.
LimitExceeded(String), ///The message can't be sent because the sending domain isn't verified.
MailFromDomainNotVerified(String), ///The message can't be sent because it contains invalid content.
MessageRejected(String), ///The resource you attempted to access doesn't exist.
NotFound(String), ///The message can't be sent because the account's ability to send email is currently paused.
SendingPaused(String), ///Too many requests have been made to the operation.
TooManyRequests(String), } impl SendEmailError { pub fn from_response(res: BufferedHttpResponse) -> RusotoErrorThe input you provided is invalid.
BadRequest(String), ///The resource is being modified by another operation or thread.
ConcurrentModification(String), ///The resource you attempted to access doesn't exist.
NotFound(String), ///Too many requests have been made to the operation.
TooManyRequests(String), } impl TagResourceError { pub fn from_response(res: BufferedHttpResponse) -> RusotoErrorThe input you provided is invalid.
BadRequest(String), ///The resource is being modified by another operation or thread.
ConcurrentModification(String), ///The resource you attempted to access doesn't exist.
NotFound(String), ///Too many requests have been made to the operation.
TooManyRequests(String), } impl UntagResourceError { pub fn from_response(res: BufferedHttpResponse) -> RusotoErrorThe input you provided is invalid.
BadRequest(String), ///The resource you attempted to access doesn't exist.
NotFound(String), ///Too many requests have been made to the operation.
TooManyRequests(String), } impl UpdateConfigurationSetEventDestinationError { pub fn from_response( res: BufferedHttpResponse, ) -> RusotoErrorCreate a configuration set. Configuration sets are groups of rules that you can apply to the emails you send using Amazon Pinpoint. You apply a configuration set to an email by including a reference to the configuration set in the headers of the email. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email.
async fn create_configuration_set( &self, input: CreateConfigurationSetRequest, ) -> ResultCreate an event destination. 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.
A single configuration set can include more than one event destination.
async fn create_configuration_set_event_destination( &self, input: CreateConfigurationSetEventDestinationRequest, ) -> Result< CreateConfigurationSetEventDestinationResponse, RusotoErrorCreate a new pool of dedicated IP addresses. A pool can include one or more dedicated IP addresses that are associated with your Amazon Pinpoint account. You can associate a pool with a configuration set. When you send an email that uses that configuration set, Amazon Pinpoint sends it using only the IP addresses in the associated pool.
async fn create_dedicated_ip_pool( &self, input: CreateDedicatedIpPoolRequest, ) -> ResultCreate a new predictive inbox placement test. Predictive inbox placement tests can help you predict how your messages will be handled by various email providers around the world. When you perform a predictive inbox placement test, you provide a sample message that contains the content that you plan to send to your customers. Amazon Pinpoint then sends that message to special email addresses spread across several major email providers. After about 24 hours, the test is complete, and you can use the GetDeliverabilityTestReport
operation to view the results of the test.
Verifies an email identity for use with Amazon Pinpoint. In Amazon Pinpoint, an identity is an email address or domain that you use when you send email. Before you can use an identity to send email with Amazon Pinpoint, you first have to verify it. By verifying an address, you demonstrate that you're the owner of the address, and that you've given Amazon Pinpoint permission to send email from the address.
When you verify an email address, Amazon Pinpoint sends an email to the address. Your email address is verified as soon as you follow the link in the verification email.
When you verify a domain, this operation provides a set of DKIM tokens, which you can convert into CNAME tokens. You add these CNAME tokens to the DNS configuration for your domain. Your domain is verified when Amazon Pinpoint detects these records in the DNS configuration for your domain. It usually takes around 72 hours to complete the domain verification process.
async fn create_email_identity( &self, input: CreateEmailIdentityRequest, ) -> ResultDelete an existing configuration set.
In Amazon Pinpoint, configuration sets are groups of rules that you can apply to the emails you send. You apply a configuration set to an email by including a reference to the configuration set in the headers of the email. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email.
async fn delete_configuration_set( &self, input: DeleteConfigurationSetRequest, ) -> ResultDelete an event destination.
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.
async fn delete_configuration_set_event_destination( &self, input: DeleteConfigurationSetEventDestinationRequest, ) -> Result< DeleteConfigurationSetEventDestinationResponse, RusotoErrorDelete a dedicated IP pool.
async fn delete_dedicated_ip_pool( &self, input: DeleteDedicatedIpPoolRequest, ) -> ResultDeletes an email identity that you previously verified for use with Amazon Pinpoint. An identity can be either an email address or a domain name.
async fn delete_email_identity( &self, input: DeleteEmailIdentityRequest, ) -> ResultObtain information about the email-sending status and capabilities of your Amazon Pinpoint account in the current AWS Region.
async fn get_account(&self) -> ResultRetrieve a list of the blacklists that your dedicated IP addresses appear on.
async fn get_blacklist_reports( &self, input: GetBlacklistReportsRequest, ) -> ResultGet information about an existing configuration set, including the dedicated IP pool that it's associated with, whether or not it's enabled for sending email, and more.
In Amazon Pinpoint, configuration sets are groups of rules that you can apply to the emails you send. You apply a configuration set to an email by including a reference to the configuration set in the headers of the email. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email.
async fn get_configuration_set( &self, input: GetConfigurationSetRequest, ) -> ResultRetrieve a list of event destinations that are associated with a configuration set.
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.
async fn get_configuration_set_event_destinations( &self, input: GetConfigurationSetEventDestinationsRequest, ) -> Result< GetConfigurationSetEventDestinationsResponse, RusotoErrorGet information about a dedicated IP address, including the name of the dedicated IP pool that it's associated with, as well information about the automatic warm-up process for the address.
async fn get_dedicated_ip( &self, input: GetDedicatedIpRequest, ) -> ResultList the dedicated IP addresses that are associated with your Amazon Pinpoint account.
async fn get_dedicated_ips( &self, input: GetDedicatedIpsRequest, ) -> ResultRetrieve information about the status of the Deliverability dashboard for your Amazon Pinpoint account. When the Deliverability dashboard is enabled, you gain access to reputation, deliverability, and other metrics for the domains that you use to send email using Amazon Pinpoint. You also gain the ability to perform predictive inbox placement tests.
When you use the Deliverability dashboard, you pay a monthly subscription charge, in addition to any other fees that you accrue by using Amazon Pinpoint. For more information about the features and cost of a Deliverability dashboard subscription, see Amazon Pinpoint Pricing.
async fn get_deliverability_dashboard_options( &self, ) -> Result< GetDeliverabilityDashboardOptionsResponse, RusotoErrorRetrieve the results of a predictive inbox placement test.
async fn get_deliverability_test_report( &self, input: GetDeliverabilityTestReportRequest, ) -> ResultRetrieve 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).
Retrieve inbox placement and engagement rates for the domains that you use to send email.
async fn get_domain_statistics_report( &self, input: GetDomainStatisticsReportRequest, ) -> ResultProvides information about a specific identity associated with your Amazon Pinpoint account, including the identity's verification status, its DKIM authentication status, and its custom Mail-From settings.
async fn get_email_identity( &self, input: GetEmailIdentityRequest, ) -> ResultList all of the configuration sets associated with your Amazon Pinpoint account in the current region.
In Amazon Pinpoint, configuration sets are groups of rules that you can apply to the emails you send. You apply a configuration set to an email by including a reference to the configuration set in the headers of the email. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email.
async fn list_configuration_sets( &self, input: ListConfigurationSetsRequest, ) -> ResultList all of the dedicated IP pools that exist in your Amazon Pinpoint account in the current AWS Region.
async fn list_dedicated_ip_pools( &self, input: ListDedicatedIpPoolsRequest, ) -> ResultShow a list of the predictive inbox placement tests that you've performed, regardless of their statuses. For predictive inbox placement tests that are complete, you can use the GetDeliverabilityTestReport
operation to view the results.
Retrieve 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.
Returns a list of all of the email identities that are associated with your Amazon Pinpoint account. An identity can be either an email address or a domain. This operation returns identities that are verified as well as those that aren't.
async fn list_email_identities( &self, input: ListEmailIdentitiesRequest, ) -> ResultRetrieve a list of the tags (keys and values) that are associated with a specified resource. A tag is a label that you optionally define and associate with a resource in Amazon Pinpoint. Each tag consists of a required tag key and an optional associated tag value. A tag key is a general label that acts as a category for more specific tag values. A tag value acts as a descriptor within a tag key.
async fn list_tags_for_resource( &self, input: ListTagsForResourceRequest, ) -> ResultEnable or disable the automatic warm-up feature for dedicated IP addresses.
async fn put_account_dedicated_ip_warmup_attributes( &self, input: PutAccountDedicatedIpWarmupAttributesRequest, ) -> Result< PutAccountDedicatedIpWarmupAttributesResponse, RusotoErrorEnable or disable the ability of your account to send email.
async fn put_account_sending_attributes( &self, input: PutAccountSendingAttributesRequest, ) -> ResultAssociate a configuration set with a dedicated IP pool. You can use dedicated IP pools to create groups of dedicated IP addresses for sending specific types of email.
async fn put_configuration_set_delivery_options( &self, input: PutConfigurationSetDeliveryOptionsRequest, ) -> Result< PutConfigurationSetDeliveryOptionsResponse, RusotoErrorEnable or disable collection of reputation metrics for emails that you send using a particular configuration set in a specific AWS Region.
async fn put_configuration_set_reputation_options( &self, input: PutConfigurationSetReputationOptionsRequest, ) -> Result< PutConfigurationSetReputationOptionsResponse, RusotoErrorEnable or disable email sending for messages that use a particular configuration set in a specific AWS Region.
async fn put_configuration_set_sending_options( &self, input: PutConfigurationSetSendingOptionsRequest, ) -> Result< PutConfigurationSetSendingOptionsResponse, RusotoErrorSpecify a custom domain to use for open and click tracking elements in email that you send using Amazon Pinpoint.
async fn put_configuration_set_tracking_options( &self, input: PutConfigurationSetTrackingOptionsRequest, ) -> Result< PutConfigurationSetTrackingOptionsResponse, RusotoErrorMove a dedicated IP address to an existing dedicated IP pool.
The dedicated IP address that you specify must already exist, and must be associated with your Amazon Pinpoint account.
The dedicated IP pool you specify must already exist. You can create a new pool by using the CreateDedicatedIpPool
operation.
Enable or disable the Deliverability dashboard for your Amazon Pinpoint account. When you enable the Deliverability dashboard, you gain access to reputation, deliverability, and other metrics for the domains that you use to send email using Amazon Pinpoint. You also gain the ability to perform predictive inbox placement tests.
When you use the Deliverability dashboard, you pay a monthly subscription charge, in addition to any other fees that you accrue by using Amazon Pinpoint. For more information about the features and cost of a Deliverability dashboard subscription, see Amazon Pinpoint Pricing.
async fn put_deliverability_dashboard_option( &self, input: PutDeliverabilityDashboardOptionRequest, ) -> Result< PutDeliverabilityDashboardOptionResponse, RusotoErrorUsed to enable or disable DKIM authentication for an email identity.
async fn put_email_identity_dkim_attributes( &self, input: PutEmailIdentityDkimAttributesRequest, ) -> Result< PutEmailIdentityDkimAttributesResponse, RusotoError