Module Awso_pinpoint_email.ValuesSource

Sourceval service : Awso.Service.t
Sourceval apiVersion : string
Sourceval endpointPrefix : string
Sourceval serviceFullName : string
Sourceval signatureVersion : string
Sourceval protocol : string
Sourceval globalEndpoint : string
Sourceval serviceAbbreviation : string
Sourceval simple_to_json : ('a -> Awso__Botodata.value) -> 'a -> Yojson.Safe.t
Sourceval composed_to_json : ('a -> Awso__Botodata.value) -> 'a -> Yojson.Safe.t
Sourceval to_query : ('a -> Awso.Client.Query.value) -> 'a -> Awso.Client.Query.t
Sourceval structure_to_value_aux : ('a * 'b option) list -> f:(('a * 'b) list -> 'c) -> [> `Structure of 'c ]
Sourceval structure_to_value : ('a * 'b option) list -> [> `Structure of ('a * 'b) list ]
Sourceval structure_to_wrapped_value : wrapper:'a -> response:'a -> ('b * 'c option) list -> [> `Structure of ('a * [> `Structure of ('b * 'c) list ]) list ]
Sourcemodule DefaultDimensionValue : sig ... end

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.

Sourcemodule DimensionName : sig ... end

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.

Sourcemodule DimensionValueSource : sig ... end
Sourcemodule Charset : sig ... end
Sourcemodule MessageData : sig ... end
Sourcemodule IspName : sig ... end

The name of an email provider.

Sourcemodule Percentage : sig ... end

An object that contains information about inbox placement percentages.

Sourcemodule Volume : sig ... end

An object that contains information about inbox placement volume.

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

Sourcemodule Content : sig ... end

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

Sourcemodule Enabled : sig ... end
Sourcemodule IspNameList : sig ... end
Sourcemodule Esp : sig ... end
Sourcemodule Ip : sig ... end

A dedicated IP address that is associated with your Amazon Pinpoint account.

Sourcemodule DomainIspPlacement : sig ... end

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

Sourcemodule EventType : sig ... end
Sourcemodule AmazonResourceName : sig ... end
Sourcemodule BlacklistingDescription : sig ... end

A description of the blacklisting event.

Sourcemodule RblName : sig ... end

The name of a blacklist that an IP address was found on.

Sourcemodule Timestamp : sig ... end
Sourcemodule TagKey : sig ... end
Sourcemodule TagValue : sig ... end
Sourcemodule EmailAddress : sig ... end
Sourcemodule Body : sig ... end

Represents the body of the email message.

Sourcemodule RawMessageData : sig ... end

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.

Sourcemodule TemplateArn : sig ... end
Sourcemodule TemplateData : sig ... end
Sourcemodule MessageTagName : sig ... end

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.

Sourcemodule MessageTagValue : sig ... end

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.

Sourcemodule Domain : sig ... end

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

Sourcemodule Identity : sig ... end
Sourcemodule IdentityType : sig ... end
Sourcemodule CampaignId : sig ... end
Sourcemodule Esps : sig ... end
Sourcemodule ImageUrl : sig ... end
Sourcemodule IpList : sig ... end
Sourcemodule Subject : sig ... end
Sourcemodule DeliverabilityTestStatus : sig ... end
Sourcemodule DeliverabilityTestSubject : sig ... end

The subject line for an email that you submitted in a predictive inbox placement test.

Sourcemodule ReportId : sig ... end

A unique string that identifies a Deliverability dashboard report.

Sourcemodule ReportName : sig ... end

A name that helps you identify a report generated by the Deliverability dashboard.

Sourcemodule DnsToken : sig ... end
Sourcemodule DomainIspPlacements : sig ... end
Sourcemodule VolumeStatistics : sig ... end

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

Sourcemodule PlacementStatistics : sig ... end

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

Sourcemodule Percentage100Wrapper : sig ... end
Sourcemodule PoolName : sig ... end

The name of a dedicated IP pool.

Sourcemodule WarmupStatus : sig ... end
Sourcemodule CloudWatchDestination : sig ... end

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.

Sourcemodule EventDestinationName : sig ... end

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.

Sourcemodule EventTypes : sig ... end

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.

Sourcemodule PinpointDestination : sig ... end

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.

Sourcemodule SnsDestination : sig ... end

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

Sourcemodule BlacklistEntry : sig ... end

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

Sourcemodule Tag : sig ... end

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.

Sourcemodule EmailAddressList : sig ... end
Sourcemodule Message : sig ... end

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

Sourcemodule RawMessage : sig ... end

The raw email message.

Sourcemodule Template : sig ... end
Sourcemodule MessageTag : sig ... end

Contains the name and value of a tag that you apply to an email. You can use message tags when you publish email sending events.

An object that contains information about 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.

Sourcemodule IdentityInfo : sig ... end

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

Sourcemodule DeliverabilityTestReport : sig ... end

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

Sourcemodule ConfigurationSetName : sig ... end

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.

Sourcemodule DkimStatus : sig ... end
Sourcemodule DnsTokenList : sig ... end
Sourcemodule BehaviorOnMxFailure : sig ... end
Sourcemodule MailFromDomainName : sig ... end

The domain that you want to use as a MAIL FROM domain.

Sourcemodule MailFromDomainStatus : sig ... end
Sourcemodule DailyVolume : sig ... end

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

Sourcemodule IspPlacement : sig ... end

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

Sourcemodule DedicatedIp : sig ... end

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

Sourcemodule TlsPolicy : sig ... end
Sourcemodule LastFreshStart : sig ... end

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.

Sourcemodule CustomRedirectDomain : sig ... end

The domain that you want to use for tracking open and click events.

Sourcemodule EventDestination : sig ... end

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.

Sourcemodule BlacklistEntries : sig ... end
Sourcemodule BlacklistItemName : sig ... end

An IP address that you want to obtain blacklist information for.

Sourcemodule Max24HourSend : sig ... end
Sourcemodule MaxSendRate : sig ... end
Sourcemodule SentLast24Hours : sig ... end
Sourcemodule BadRequestException : sig ... end

The input you provided is invalid.

Sourcemodule NotFoundException : sig ... end

The resource you attempted to access doesn't exist.

Sourcemodule TooManyRequestsException : sig ... end

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.

The resource is being modified by another operation or thread.

Sourcemodule TagKeyList : sig ... end
Sourcemodule TagList : sig ... end
Sourcemodule AccountSuspendedException : sig ... end

The message can't be sent because the account's ability to send email has been permanently restricted.

Sourcemodule LimitExceededException : sig ... end

There are too many instances of the specified resource type.

The message can't be sent because the sending domain isn't verified.

Sourcemodule MessageRejected : sig ... end

The message can't be sent because it contains invalid content.

Sourcemodule OutboundMessageId : sig ... end
Sourcemodule SendingPausedException : sig ... end

The message can't be sent because the account's ability to send email is currently paused.

Sourcemodule Destination : sig ... end

An object that describes the recipients for an email.

Sourcemodule EmailContent : sig ... end

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.

Sourcemodule MessageTagList : sig ... end
Sourcemodule AlreadyExistsException : sig ... end

The resource specified in your request already exists.

Sourcemodule SendingPoolName : sig ... end

The name of the dedicated IP pool that you want to associate with the configuration set.

Sourcemodule IdentityInfoList : sig ... end
Sourcemodule NextToken : sig ... end
Sourcemodule MaxItems : sig ... end
Sourcemodule DeliverabilityTestReports : sig ... end
Sourcemodule ListOfDedicatedIpPools : sig ... end
Sourcemodule ConfigurationSetNameList : sig ... end
Sourcemodule DkimAttributes : sig ... end

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

Sourcemodule MailFromAttributes : sig ... end

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

Sourcemodule DailyVolumes : sig ... end
Sourcemodule OverallVolume : sig ... end

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

Sourcemodule IspPlacements : sig ... end
Sourcemodule MessageContent : sig ... end

The body of an email message.

Sourcemodule DedicatedIpList : sig ... end
Sourcemodule DeliveryOptions : sig ... end

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

Sourcemodule ReputationOptions : sig ... end

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

Sourcemodule SendingOptions : sig ... end

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

Sourcemodule TrackingOptions : sig ... end

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.

Sourcemodule EventDestinations : sig ... end
Sourcemodule BlacklistReport : sig ... end
Sourcemodule BlacklistItemNames : sig ... end
Sourcemodule GeneralEnforcementStatus : sig ... end
Sourcemodule SendQuota : sig ... end

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

An HTTP 200 response if the request succeeds, or an error message if the request fails.

A request to change the settings for an event destination for a configuration set.

Sourcemodule UntagResourceResponse : sig ... end

Remove one or more tags (keys and values) from a specified resource.

Sourcemodule UntagResourceRequest : sig ... end

Remove one or more tags (keys and values) from a specified resource.

Sourcemodule TagResourceResponse : sig ... end

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.

Sourcemodule TagResourceRequest : sig ... end

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.

Sourcemodule SendEmailResponse : sig ... end

A unique message ID that you receive when Amazon Pinpoint accepts an email for sending.

Sourcemodule SendEmailRequest : sig ... end

A request to send an email message.

An HTTP 200 response if the request succeeds, or an error message if the request fails.

A request to configure the custom MAIL FROM domain for a verified identity.

An HTTP 200 response if the request succeeds, or an error message if the request fails.

A request to set the attributes that control how bounce and complaint events are processed.

An HTTP 200 response if the request succeeds, or an error message if the request fails.

A request to enable or disable DKIM signing of email that you send from an email identity.

A response that indicates whether the Deliverability dashboard is enabled for your Amazon Pinpoint account.

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.

An HTTP 200 response if the request succeeds, or an error message if the request fails.

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.

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.

An HTTP 200 response if the request succeeds, or an error message if the request fails.

A request to add a custom domain for tracking open and click events to a configuration set.

An HTTP 200 response if the request succeeds, or an error message if the request fails.

A request to enable or disable the ability of Amazon Pinpoint to send emails that use a specific configuration set.

An HTTP 200 response if the request succeeds, or an error message if the request fails.

A request to enable or disable tracking of reputation metrics for a configuration set.

An HTTP 200 response if the request succeeds, or an error message if the request fails.

A request to associate a configuration set with a dedicated IP pool.

An HTTP 200 response if the request succeeds, or an error message if the request fails.

A request to change the ability of your account to send email.

An HTTP 200 response if the request succeeds, or an error message if the request fails.

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

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.

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.

A list of the predictive inbox placement test reports that are available for your account, regardless of whether or not those tests are complete.

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

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

Sourcemodule GetEmailIdentityResponse : sig ... end

Details about an email identity.

Sourcemodule GetEmailIdentityRequest : sig ... end

A request to return details about an email identity.

An object that includes statistics that are related to the domain that you specified.

A request to obtain deliverability metrics for a domain.

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

Retrieve 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 results of the predictive inbox placement test.

A request to retrieve the results of a predictive inbox placement test.

An object that shows the status of the Deliverability dashboard for your Amazon Pinpoint account.

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.

Sourcemodule GetDedicatedIpsResponse : sig ... end

Information about the dedicated IP addresses that are associated with your Amazon Pinpoint account.

Sourcemodule GetDedicatedIpsRequest : sig ... end

A request to obtain more information about dedicated IP pools.

Sourcemodule GetDedicatedIpResponse : sig ... end

Information about a dedicated IP address.

Sourcemodule GetDedicatedIpRequest : sig ... end

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.

Information about an event destination for a configuration set.

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

Sourcemodule GetAccountResponse : sig ... end

A list of details about the email-sending capabilities of your Amazon Pinpoint account in the current AWS Region.

Sourcemodule GetAccountRequest : sig ... end

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.

An HTTP 200 response if the request succeeds, or an error message if the request fails.

A request to delete a dedicated IP pool.

An HTTP 200 response if the request succeeds, or an error message if the request fails.

A request to delete a configuration set.

An HTTP 200 response if the request succeeds, or an error message if the request fails.

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

Information about the predictive inbox placement test that you created.

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.

An HTTP 200 response if the request succeeds, or an error message if the request fails.

A request to create a new dedicated IP pool.

An HTTP 200 response if the request succeeds, or an error message if the request fails.

A request to create a configuration set.

An HTTP 200 response if the request succeeds, or an error message if the request fails.

A request to add an event destination to a configuration set.