Awso_pinpoint_email_asyncSourceval create_configuration_set :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_pinpoint_email.Values.CreateConfigurationSetRequest.t ->
(Awso_pinpoint_email.Values.CreateConfigurationSetResponse.t,
Awso_pinpoint_email.Values.CreateConfigurationSetResponse.error)
Result.t
Async.Deferred.tval create_configuration_set_event_destination :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_pinpoint_email.Values.CreateConfigurationSetEventDestinationRequest.t ->
(Awso_pinpoint_email.Values.CreateConfigurationSetEventDestinationResponse.t,
Awso_pinpoint_email.Values.CreateConfigurationSetEventDestinationResponse.error)
Result.t
Async.Deferred.tval create_dedicated_ip_pool :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_pinpoint_email.Values.CreateDedicatedIpPoolRequest.t ->
(Awso_pinpoint_email.Values.CreateDedicatedIpPoolResponse.t,
Awso_pinpoint_email.Values.CreateDedicatedIpPoolResponse.error)
Result.t
Async.Deferred.tval create_deliverability_test_report :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_pinpoint_email.Values.CreateDeliverabilityTestReportRequest.t ->
(Awso_pinpoint_email.Values.CreateDeliverabilityTestReportResponse.t,
Awso_pinpoint_email.Values.CreateDeliverabilityTestReportResponse.error)
Result.t
Async.Deferred.tval create_email_identity :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_pinpoint_email.Values.CreateEmailIdentityRequest.t ->
(Awso_pinpoint_email.Values.CreateEmailIdentityResponse.t,
Awso_pinpoint_email.Values.CreateEmailIdentityResponse.error)
Result.t
Async.Deferred.tval delete_configuration_set :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_pinpoint_email.Values.DeleteConfigurationSetRequest.t ->
(Awso_pinpoint_email.Values.DeleteConfigurationSetResponse.t,
Awso_pinpoint_email.Values.DeleteConfigurationSetResponse.error)
Result.t
Async.Deferred.tval delete_configuration_set_event_destination :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_pinpoint_email.Values.DeleteConfigurationSetEventDestinationRequest.t ->
(Awso_pinpoint_email.Values.DeleteConfigurationSetEventDestinationResponse.t,
Awso_pinpoint_email.Values.DeleteConfigurationSetEventDestinationResponse.error)
Result.t
Async.Deferred.tval delete_dedicated_ip_pool :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_pinpoint_email.Values.DeleteDedicatedIpPoolRequest.t ->
(Awso_pinpoint_email.Values.DeleteDedicatedIpPoolResponse.t,
Awso_pinpoint_email.Values.DeleteDedicatedIpPoolResponse.error)
Result.t
Async.Deferred.tval delete_email_identity :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_pinpoint_email.Values.DeleteEmailIdentityRequest.t ->
(Awso_pinpoint_email.Values.DeleteEmailIdentityResponse.t,
Awso_pinpoint_email.Values.DeleteEmailIdentityResponse.error)
Result.t
Async.Deferred.tval get_account :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_pinpoint_email.Values.GetAccountRequest.t ->
(Awso_pinpoint_email.Values.GetAccountResponse.t,
Awso_pinpoint_email.Values.GetAccountResponse.error)
Result.t
Async.Deferred.tval get_blacklist_reports :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_pinpoint_email.Values.GetBlacklistReportsRequest.t ->
(Awso_pinpoint_email.Values.GetBlacklistReportsResponse.t,
Awso_pinpoint_email.Values.GetBlacklistReportsResponse.error)
Result.t
Async.Deferred.tval get_configuration_set :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_pinpoint_email.Values.GetConfigurationSetRequest.t ->
(Awso_pinpoint_email.Values.GetConfigurationSetResponse.t,
Awso_pinpoint_email.Values.GetConfigurationSetResponse.error)
Result.t
Async.Deferred.tval get_configuration_set_event_destinations :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_pinpoint_email.Values.GetConfigurationSetEventDestinationsRequest.t ->
(Awso_pinpoint_email.Values.GetConfigurationSetEventDestinationsResponse.t,
Awso_pinpoint_email.Values.GetConfigurationSetEventDestinationsResponse.error)
Result.t
Async.Deferred.tval get_dedicated_ip :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_pinpoint_email.Values.GetDedicatedIpRequest.t ->
(Awso_pinpoint_email.Values.GetDedicatedIpResponse.t,
Awso_pinpoint_email.Values.GetDedicatedIpResponse.error)
Result.t
Async.Deferred.tval get_dedicated_ips :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_pinpoint_email.Values.GetDedicatedIpsRequest.t ->
(Awso_pinpoint_email.Values.GetDedicatedIpsResponse.t,
Awso_pinpoint_email.Values.GetDedicatedIpsResponse.error)
Result.t
Async.Deferred.tval get_deliverability_dashboard_options :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_pinpoint_email.Values.GetDeliverabilityDashboardOptionsRequest.t ->
(Awso_pinpoint_email.Values.GetDeliverabilityDashboardOptionsResponse.t,
Awso_pinpoint_email.Values.GetDeliverabilityDashboardOptionsResponse.error)
Result.t
Async.Deferred.tval get_deliverability_test_report :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_pinpoint_email.Values.GetDeliverabilityTestReportRequest.t ->
(Awso_pinpoint_email.Values.GetDeliverabilityTestReportResponse.t,
Awso_pinpoint_email.Values.GetDeliverabilityTestReportResponse.error)
Result.t
Async.Deferred.tval get_domain_deliverability_campaign :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_pinpoint_email.Values.GetDomainDeliverabilityCampaignRequest.t ->
(Awso_pinpoint_email.Values.GetDomainDeliverabilityCampaignResponse.t,
Awso_pinpoint_email.Values.GetDomainDeliverabilityCampaignResponse.error)
Result.t
Async.Deferred.tval get_domain_statistics_report :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_pinpoint_email.Values.GetDomainStatisticsReportRequest.t ->
(Awso_pinpoint_email.Values.GetDomainStatisticsReportResponse.t,
Awso_pinpoint_email.Values.GetDomainStatisticsReportResponse.error)
Result.t
Async.Deferred.tval get_email_identity :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_pinpoint_email.Values.GetEmailIdentityRequest.t ->
(Awso_pinpoint_email.Values.GetEmailIdentityResponse.t,
Awso_pinpoint_email.Values.GetEmailIdentityResponse.error)
Result.t
Async.Deferred.tval list_configuration_sets :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_pinpoint_email.Values.ListConfigurationSetsRequest.t ->
(Awso_pinpoint_email.Values.ListConfigurationSetsResponse.t,
Awso_pinpoint_email.Values.ListConfigurationSetsResponse.error)
Result.t
Async.Deferred.tval list_dedicated_ip_pools :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_pinpoint_email.Values.ListDedicatedIpPoolsRequest.t ->
(Awso_pinpoint_email.Values.ListDedicatedIpPoolsResponse.t,
Awso_pinpoint_email.Values.ListDedicatedIpPoolsResponse.error)
Result.t
Async.Deferred.tval list_deliverability_test_reports :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_pinpoint_email.Values.ListDeliverabilityTestReportsRequest.t ->
(Awso_pinpoint_email.Values.ListDeliverabilityTestReportsResponse.t,
Awso_pinpoint_email.Values.ListDeliverabilityTestReportsResponse.error)
Result.t
Async.Deferred.tval list_domain_deliverability_campaigns :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_pinpoint_email.Values.ListDomainDeliverabilityCampaignsRequest.t ->
(Awso_pinpoint_email.Values.ListDomainDeliverabilityCampaignsResponse.t,
Awso_pinpoint_email.Values.ListDomainDeliverabilityCampaignsResponse.error)
Result.t
Async.Deferred.tval list_email_identities :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_pinpoint_email.Values.ListEmailIdentitiesRequest.t ->
(Awso_pinpoint_email.Values.ListEmailIdentitiesResponse.t,
Awso_pinpoint_email.Values.ListEmailIdentitiesResponse.error)
Result.t
Async.Deferred.tval list_tags_for_resource :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_pinpoint_email.Values.ListTagsForResourceRequest.t ->
(Awso_pinpoint_email.Values.ListTagsForResourceResponse.t,
Awso_pinpoint_email.Values.ListTagsForResourceResponse.error)
Result.t
Async.Deferred.tval put_account_dedicated_ip_warmup_attributes :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_pinpoint_email.Values.PutAccountDedicatedIpWarmupAttributesRequest.t ->
(Awso_pinpoint_email.Values.PutAccountDedicatedIpWarmupAttributesResponse.t,
Awso_pinpoint_email.Values.PutAccountDedicatedIpWarmupAttributesResponse.error)
Result.t
Async.Deferred.tval put_account_sending_attributes :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_pinpoint_email.Values.PutAccountSendingAttributesRequest.t ->
(Awso_pinpoint_email.Values.PutAccountSendingAttributesResponse.t,
Awso_pinpoint_email.Values.PutAccountSendingAttributesResponse.error)
Result.t
Async.Deferred.tval put_configuration_set_delivery_options :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_pinpoint_email.Values.PutConfigurationSetDeliveryOptionsRequest.t ->
(Awso_pinpoint_email.Values.PutConfigurationSetDeliveryOptionsResponse.t,
Awso_pinpoint_email.Values.PutConfigurationSetDeliveryOptionsResponse.error)
Result.t
Async.Deferred.tval put_configuration_set_reputation_options :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_pinpoint_email.Values.PutConfigurationSetReputationOptionsRequest.t ->
(Awso_pinpoint_email.Values.PutConfigurationSetReputationOptionsResponse.t,
Awso_pinpoint_email.Values.PutConfigurationSetReputationOptionsResponse.error)
Result.t
Async.Deferred.tval put_configuration_set_sending_options :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_pinpoint_email.Values.PutConfigurationSetSendingOptionsRequest.t ->
(Awso_pinpoint_email.Values.PutConfigurationSetSendingOptionsResponse.t,
Awso_pinpoint_email.Values.PutConfigurationSetSendingOptionsResponse.error)
Result.t
Async.Deferred.tval put_configuration_set_tracking_options :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_pinpoint_email.Values.PutConfigurationSetTrackingOptionsRequest.t ->
(Awso_pinpoint_email.Values.PutConfigurationSetTrackingOptionsResponse.t,
Awso_pinpoint_email.Values.PutConfigurationSetTrackingOptionsResponse.error)
Result.t
Async.Deferred.tval put_dedicated_ip_in_pool :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_pinpoint_email.Values.PutDedicatedIpInPoolRequest.t ->
(Awso_pinpoint_email.Values.PutDedicatedIpInPoolResponse.t,
Awso_pinpoint_email.Values.PutDedicatedIpInPoolResponse.error)
Result.t
Async.Deferred.tval put_dedicated_ip_warmup_attributes :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_pinpoint_email.Values.PutDedicatedIpWarmupAttributesRequest.t ->
(Awso_pinpoint_email.Values.PutDedicatedIpWarmupAttributesResponse.t,
Awso_pinpoint_email.Values.PutDedicatedIpWarmupAttributesResponse.error)
Result.t
Async.Deferred.tval put_deliverability_dashboard_option :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_pinpoint_email.Values.PutDeliverabilityDashboardOptionRequest.t ->
(Awso_pinpoint_email.Values.PutDeliverabilityDashboardOptionResponse.t,
Awso_pinpoint_email.Values.PutDeliverabilityDashboardOptionResponse.error)
Result.t
Async.Deferred.tval put_email_identity_dkim_attributes :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_pinpoint_email.Values.PutEmailIdentityDkimAttributesRequest.t ->
(Awso_pinpoint_email.Values.PutEmailIdentityDkimAttributesResponse.t,
Awso_pinpoint_email.Values.PutEmailIdentityDkimAttributesResponse.error)
Result.t
Async.Deferred.tval put_email_identity_feedback_attributes :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_pinpoint_email.Values.PutEmailIdentityFeedbackAttributesRequest.t ->
(Awso_pinpoint_email.Values.PutEmailIdentityFeedbackAttributesResponse.t,
Awso_pinpoint_email.Values.PutEmailIdentityFeedbackAttributesResponse.error)
Result.t
Async.Deferred.tval put_email_identity_mail_from_attributes :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_pinpoint_email.Values.PutEmailIdentityMailFromAttributesRequest.t ->
(Awso_pinpoint_email.Values.PutEmailIdentityMailFromAttributesResponse.t,
Awso_pinpoint_email.Values.PutEmailIdentityMailFromAttributesResponse.error)
Result.t
Async.Deferred.tval send_email :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_pinpoint_email.Values.SendEmailRequest.t ->
(Awso_pinpoint_email.Values.SendEmailResponse.t,
Awso_pinpoint_email.Values.SendEmailResponse.error)
Result.t
Async.Deferred.tval tag_resource :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_pinpoint_email.Values.TagResourceRequest.t ->
(Awso_pinpoint_email.Values.TagResourceResponse.t,
Awso_pinpoint_email.Values.TagResourceResponse.error)
Result.t
Async.Deferred.tval untag_resource :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_pinpoint_email.Values.UntagResourceRequest.t ->
(Awso_pinpoint_email.Values.UntagResourceResponse.t,
Awso_pinpoint_email.Values.UntagResourceResponse.error)
Result.t
Async.Deferred.tval update_configuration_set_event_destination :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_pinpoint_email.Values.UpdateConfigurationSetEventDestinationRequest.t ->
(Awso_pinpoint_email.Values.UpdateConfigurationSetEventDestinationResponse.t,
Awso_pinpoint_email.Values.UpdateConfigurationSetEventDestinationResponse.error)
Result.t
Async.Deferred.tinclude module type of struct include Awso_pinpoint_email.Values endval structure_to_value_aux :
('a * 'b option) list ->
f:(('a * 'b) list -> 'c) ->
[> `Structure of 'c ]val structure_to_wrapped_value :
wrapper:'a ->
response:'a ->
('b * 'c option) list ->
[> `Structure of ('a * [> `Structure of ('b * 'c) list ]) list ]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 name of an email provider.
An object that contains information about inbox placement percentages.
An object that contains information about inbox placement volume.
module CloudWatchDimensionConfiguration =
Awso_pinpoint_email.Values.CloudWatchDimensionConfigurationAn object that defines the dimension configuration to use when you send Amazon Pinpoint email events to Amazon CloudWatch.
An object that represents the content of the email, and optionally a character set specification.
A dedicated IP address that is associated with your Amazon Pinpoint account.
An object that contains inbox placement data for email sent from one of your email domains to a specific email provider.
module CloudWatchDimensionConfigurations =
Awso_pinpoint_email.Values.CloudWatchDimensionConfigurationsA description of the blacklisting event.
The name of a blacklist that an IP address was found on.
Represents the body of the email message.
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.
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 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).
The subject line for an email that you submitted in a predictive inbox placement test.
A unique string that identifies a Deliverability dashboard report.
A name that helps you identify a report generated by the Deliverability dashboard.
An object that contains information about the amount of email that was delivered to recipients.
An object that contains inbox placement data for an email provider.
The name of a dedicated IP pool.
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.
The name of 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.
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.
An object that defines a Amazon Pinpoint destination for email events. You can use Amazon Pinpoint events to create attributes in Amazon Pinpoint projects. You can use these attributes to create segments for your campaigns.
An object that defines an Amazon SNS destination for email events. You can use Amazon SNS to send notification when certain email events occur.
An object that contains information about a blacklisting event that impacts one of the dedicated IP addresses that is associated with your account.
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.
Represents the email message that you're sending. The Message object consists of a subject line and a message body.
The raw email message.
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.
module DomainDeliverabilityTrackingOption =
Awso_pinpoint_email.Values.DomainDeliverabilityTrackingOptionAn 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.
Information about an email identity.
An object that contains the deliverability data for a specific campaign. This data is available for a campaign only if the campaign sent email by using a domain that the Deliverability dashboard is enabled for (PutDeliverabilityDashboardOption operation).
An object that contains metadata related to a predictive inbox placement test.
The name of a 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.
The domain that you want to use as a MAIL FROM domain.
An object that contains information about the volume of email sent on each day of the analysis period.
An object that describes how email sent during the predictive inbox placement test was handled by a certain email provider.
Contains information about a dedicated IP address that is associated with your Amazon Pinpoint account.
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.
The domain that you want to use for tracking open and click events.
In Amazon Pinpoint, events include message sends, deliveries, opens, clicks, bounces, and complaints. Event destinations are places that you can send information about these events to. For example, you can send event data to Amazon SNS to receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage.
An IP address that you want to obtain blacklist information for.
The input you provided is invalid.
The resource you attempted to access doesn't exist.
Too many requests have been made to the operation.
An object that defines the event destination. Specifically, it defines which services receive events from emails sent using the configuration set that the event destination is associated with. Also defines the types of events that are sent to the event destination.
module ConcurrentModificationException =
Awso_pinpoint_email.Values.ConcurrentModificationExceptionThe resource is being modified by another operation or thread.
The message can't be sent because the account's ability to send email has been permanently restricted.
There are too many instances of the specified resource type.
module MailFromDomainNotVerifiedException =
Awso_pinpoint_email.Values.MailFromDomainNotVerifiedExceptionThe message can't be sent because the sending domain isn't verified.
The message can't be sent because it contains invalid content.
The message can't be sent because the account's ability to send email is currently paused.
An object that describes the recipients for an email.
An object that defines the entire content of the email, including the message headers and the body content. You can create a simple email message, in which you specify the subject and the text and HTML versions of the message body. You can also create raw messages, in which you specify a complete MIME-formatted message. Raw messages can include attachments and custom headers.
The resource specified in your request already exists.
module DomainDeliverabilityTrackingOptions =
Awso_pinpoint_email.Values.DomainDeliverabilityTrackingOptionsThe name of the dedicated IP pool that you want to associate with the configuration set.
module DomainDeliverabilityCampaignList =
Awso_pinpoint_email.Values.DomainDeliverabilityCampaignListAn object that contains information about the DKIM configuration for an email identity.
A list of attributes that are associated with a MAIL FROM domain.
An object that contains information about email that was sent from the selected domain.
The body of an email message.
module DeliverabilityDashboardAccountStatus =
Awso_pinpoint_email.Values.DeliverabilityDashboardAccountStatusUsed to associate a configuration set with a dedicated IP pool.
Enable or disable collection of reputation metrics for emails that you send using this configuration set in the current AWS Region.
Used to enable or disable email sending for messages that use this configuration set in the current AWS Region.
An object that defines 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.
An object that contains information about the per-day and per-second sending limits for your Amazon Pinpoint account in the current AWS Region.
module UpdateConfigurationSetEventDestinationResponse =
Awso_pinpoint_email.Values.UpdateConfigurationSetEventDestinationResponseAn HTTP 200 response if the request succeeds, or an error message if the request fails.
module UpdateConfigurationSetEventDestinationRequest =
Awso_pinpoint_email.Values.UpdateConfigurationSetEventDestinationRequestA request to change the settings for an event destination for a configuration set.
Remove one or more tags (keys and values) from a specified resource.
Remove one or more tags (keys and values) from a specified resource.
Add one or more tags (keys and values) to a specified 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 more specific tag values. A tag value acts as a descriptor within a tag key.
Add one or more tags (keys and values) to a specified 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 more specific tag values. A tag value acts as a descriptor within a tag key.
A unique message ID that you receive when Amazon Pinpoint accepts an email for sending.
A request to send an email message.
module PutEmailIdentityMailFromAttributesResponse =
Awso_pinpoint_email.Values.PutEmailIdentityMailFromAttributesResponseAn HTTP 200 response if the request succeeds, or an error message if the request fails.
module PutEmailIdentityMailFromAttributesRequest =
Awso_pinpoint_email.Values.PutEmailIdentityMailFromAttributesRequestA request to configure the custom MAIL FROM domain for a verified identity.
module PutEmailIdentityFeedbackAttributesResponse =
Awso_pinpoint_email.Values.PutEmailIdentityFeedbackAttributesResponseAn HTTP 200 response if the request succeeds, or an error message if the request fails.
module PutEmailIdentityFeedbackAttributesRequest =
Awso_pinpoint_email.Values.PutEmailIdentityFeedbackAttributesRequestA request to set the attributes that control how bounce and complaint events are processed.
module PutEmailIdentityDkimAttributesResponse =
Awso_pinpoint_email.Values.PutEmailIdentityDkimAttributesResponseAn HTTP 200 response if the request succeeds, or an error message if the request fails.
module PutEmailIdentityDkimAttributesRequest =
Awso_pinpoint_email.Values.PutEmailIdentityDkimAttributesRequestA request to enable or disable DKIM signing of email that you send from an email identity.
module PutDeliverabilityDashboardOptionResponse =
Awso_pinpoint_email.Values.PutDeliverabilityDashboardOptionResponseA response that indicates whether the Deliverability dashboard is enabled for your Amazon Pinpoint account.
module PutDeliverabilityDashboardOptionRequest =
Awso_pinpoint_email.Values.PutDeliverabilityDashboardOptionRequestEnable 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.
module PutDedicatedIpWarmupAttributesResponse =
Awso_pinpoint_email.Values.PutDedicatedIpWarmupAttributesResponseAn HTTP 200 response if the request succeeds, or an error message if the request fails.
module PutDedicatedIpWarmupAttributesRequest =
Awso_pinpoint_email.Values.PutDedicatedIpWarmupAttributesRequestA 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.
An HTTP 200 response if the request succeeds, or an error message if the request fails.
A request to move a dedicated IP address to a dedicated IP pool.
module PutConfigurationSetTrackingOptionsResponse =
Awso_pinpoint_email.Values.PutConfigurationSetTrackingOptionsResponseAn HTTP 200 response if the request succeeds, or an error message if the request fails.
module PutConfigurationSetTrackingOptionsRequest =
Awso_pinpoint_email.Values.PutConfigurationSetTrackingOptionsRequestA request to add a custom domain for tracking open and click events to a configuration set.
module PutConfigurationSetSendingOptionsResponse =
Awso_pinpoint_email.Values.PutConfigurationSetSendingOptionsResponseAn HTTP 200 response if the request succeeds, or an error message if the request fails.
module PutConfigurationSetSendingOptionsRequest =
Awso_pinpoint_email.Values.PutConfigurationSetSendingOptionsRequestA request to enable or disable the ability of Amazon Pinpoint to send emails that use a specific configuration set.
module PutConfigurationSetReputationOptionsResponse =
Awso_pinpoint_email.Values.PutConfigurationSetReputationOptionsResponseAn HTTP 200 response if the request succeeds, or an error message if the request fails.
module PutConfigurationSetReputationOptionsRequest =
Awso_pinpoint_email.Values.PutConfigurationSetReputationOptionsRequestA request to enable or disable tracking of reputation metrics for a configuration set.
module PutConfigurationSetDeliveryOptionsResponse =
Awso_pinpoint_email.Values.PutConfigurationSetDeliveryOptionsResponseAn HTTP 200 response if the request succeeds, or an error message if the request fails.
module PutConfigurationSetDeliveryOptionsRequest =
Awso_pinpoint_email.Values.PutConfigurationSetDeliveryOptionsRequestA request to associate a configuration set with a dedicated IP pool.
module PutAccountSendingAttributesResponse =
Awso_pinpoint_email.Values.PutAccountSendingAttributesResponseAn HTTP 200 response if the request succeeds, or an error message if the request fails.
module PutAccountSendingAttributesRequest =
Awso_pinpoint_email.Values.PutAccountSendingAttributesRequestA request to change the ability of your account to send email.
module PutAccountDedicatedIpWarmupAttributesResponse =
Awso_pinpoint_email.Values.PutAccountDedicatedIpWarmupAttributesResponseAn HTTP 200 response if the request succeeds, or an error message if the request fails.
module PutAccountDedicatedIpWarmupAttributesRequest =
Awso_pinpoint_email.Values.PutAccountDedicatedIpWarmupAttributesRequestA request to enable or disable the automatic IP address warm-up feature.
Retrieve 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.
Retrieve 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.
A list of all of the identities that you've attempted to verify for use with Amazon Pinpoint, regardless of whether or not those identities were successfully verified.
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.
module ListDomainDeliverabilityCampaignsResponse =
Awso_pinpoint_email.Values.ListDomainDeliverabilityCampaignsResponseAn 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.
module ListDomainDeliverabilityCampaignsRequest =
Awso_pinpoint_email.Values.ListDomainDeliverabilityCampaignsRequestRetrieve 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.
module ListDeliverabilityTestReportsResponse =
Awso_pinpoint_email.Values.ListDeliverabilityTestReportsResponseA list of the predictive inbox placement test reports that are available for your account, regardless of whether or not those tests are complete.
module ListDeliverabilityTestReportsRequest =
Awso_pinpoint_email.Values.ListDeliverabilityTestReportsRequestA request to list all of the predictive inbox placement tests that you've performed.
A list of dedicated IP pools.
A request to obtain a list of dedicated IP pools.
module ListConfigurationSetsResponse =
Awso_pinpoint_email.Values.ListConfigurationSetsResponseA list of configuration sets in your Amazon Pinpoint account in the current AWS Region.
A request to obtain a list of configuration sets for your Amazon Pinpoint account in the current AWS Region.
Details about an email identity.
A request to return details about an email identity.
module GetDomainStatisticsReportResponse =
Awso_pinpoint_email.Values.GetDomainStatisticsReportResponseAn object that includes statistics that are related to the domain that you specified.
module GetDomainStatisticsReportRequest =
Awso_pinpoint_email.Values.GetDomainStatisticsReportRequestA request to obtain deliverability metrics for a domain.
module GetDomainDeliverabilityCampaignResponse =
Awso_pinpoint_email.Values.GetDomainDeliverabilityCampaignResponseAn 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).
module GetDomainDeliverabilityCampaignRequest =
Awso_pinpoint_email.Values.GetDomainDeliverabilityCampaignRequestRetrieve 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).
module GetDeliverabilityTestReportResponse =
Awso_pinpoint_email.Values.GetDeliverabilityTestReportResponseThe results of the predictive inbox placement test.
module GetDeliverabilityTestReportRequest =
Awso_pinpoint_email.Values.GetDeliverabilityTestReportRequestA request to retrieve the results of a predictive inbox placement test.
module GetDeliverabilityDashboardOptionsResponse =
Awso_pinpoint_email.Values.GetDeliverabilityDashboardOptionsResponseAn object that shows the status of the Deliverability dashboard for your Amazon Pinpoint account.
module GetDeliverabilityDashboardOptionsRequest =
Awso_pinpoint_email.Values.GetDeliverabilityDashboardOptionsRequestRetrieve 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.
Information about the dedicated IP addresses that are associated with your Amazon Pinpoint account.
A request to obtain more information about dedicated IP pools.
Information about a dedicated IP address.
A request to obtain more information about a dedicated IP address.
Information about a configuration set.
A request to obtain information about a configuration set.
module GetConfigurationSetEventDestinationsResponse =
Awso_pinpoint_email.Values.GetConfigurationSetEventDestinationsResponseInformation about an event destination for a configuration set.
module GetConfigurationSetEventDestinationsRequest =
Awso_pinpoint_email.Values.GetConfigurationSetEventDestinationsRequestA request to obtain information about the event destinations for a configuration set.
An object that contains information about blacklist events.
A request to retrieve a list of the blacklists that your dedicated IP addresses appear on.
A list of details about the email-sending capabilities of your Amazon Pinpoint account in the current AWS Region.
A request to obtain information about the email-sending capabilities of your Amazon Pinpoint account.
An HTTP 200 response if the request succeeds, or an error message if the request fails.
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.
module DeleteDedicatedIpPoolResponse =
Awso_pinpoint_email.Values.DeleteDedicatedIpPoolResponseAn HTTP 200 response if the request succeeds, or an error message if the request fails.
A request to delete a dedicated IP pool.
module DeleteConfigurationSetResponse =
Awso_pinpoint_email.Values.DeleteConfigurationSetResponseAn HTTP 200 response if the request succeeds, or an error message if the request fails.
module DeleteConfigurationSetRequest =
Awso_pinpoint_email.Values.DeleteConfigurationSetRequestA request to delete a configuration set.
module DeleteConfigurationSetEventDestinationResponse =
Awso_pinpoint_email.Values.DeleteConfigurationSetEventDestinationResponseAn HTTP 200 response if the request succeeds, or an error message if the request fails.
module DeleteConfigurationSetEventDestinationRequest =
Awso_pinpoint_email.Values.DeleteConfigurationSetEventDestinationRequestA request to delete an event destination from a configuration set.
If the email identity is a domain, this object contains tokens that you can use to create a set of CNAME records. To sucessfully verify your domain, you have to add these records to the DNS configuration for your domain. If the email identity is an email address, this object is empty.
A request to begin the verification process for an email identity (an email address or domain).
module CreateDeliverabilityTestReportResponse =
Awso_pinpoint_email.Values.CreateDeliverabilityTestReportResponseInformation about the predictive inbox placement test that you created.
module CreateDeliverabilityTestReportRequest =
Awso_pinpoint_email.Values.CreateDeliverabilityTestReportRequestA 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.
module CreateDedicatedIpPoolResponse =
Awso_pinpoint_email.Values.CreateDedicatedIpPoolResponseAn HTTP 200 response if the request succeeds, or an error message if the request fails.
A request to create a new dedicated IP pool.
module CreateConfigurationSetResponse =
Awso_pinpoint_email.Values.CreateConfigurationSetResponseAn HTTP 200 response if the request succeeds, or an error message if the request fails.
module CreateConfigurationSetRequest =
Awso_pinpoint_email.Values.CreateConfigurationSetRequestA request to create a configuration set.
module CreateConfigurationSetEventDestinationResponse =
Awso_pinpoint_email.Values.CreateConfigurationSetEventDestinationResponseAn HTTP 200 response if the request succeeds, or an error message if the request fails.
module CreateConfigurationSetEventDestinationRequest =
Awso_pinpoint_email.Values.CreateConfigurationSetEventDestinationRequestA request to add an event destination to a configuration set.