@aws-sdk/client-pinpoint-email 3.296.0 → 3.297.0

package/dist-types/models/models_0.d.ts

@@ -1,6 +1,7 @@
 import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
 import { PinpointEmailServiceException as __BaseException } from "./PinpointEmailServiceException";
 /**
+ * @public
  * <p>The message can't be sent because the account's ability to send email has been
  *             permanently restricted.</p>
  */
@@ -13,6 +14,7 @@ export declare class AccountSuspendedException extends __BaseException {
     constructor(opts: __ExceptionOptionType<AccountSuspendedException, __BaseException>);
 }
 /**
+ * @public
  * <p>The resource specified in your request already exists.</p>
  */
 export declare class AlreadyExistsException extends __BaseException {
@@ -24,6 +26,7 @@ export declare class AlreadyExistsException extends __BaseException {
     constructor(opts: __ExceptionOptionType<AlreadyExistsException, __BaseException>);
 }
 /**
+ * @public
  * <p>The input you provided is invalid.</p>
  */
 export declare class BadRequestException extends __BaseException {
@@ -35,6 +38,7 @@ export declare class BadRequestException extends __BaseException {
     constructor(opts: __ExceptionOptionType<BadRequestException, __BaseException>);
 }
 /**
+ * @public
  * <p>The resource is being modified by another operation or thread.</p>
  */
 export declare class ConcurrentModificationException extends __BaseException {
@@ -45,11 +49,15 @@ export declare class ConcurrentModificationException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<ConcurrentModificationException, __BaseException>);
 }
+/**
+ * @public
+ */
 export declare enum TlsPolicy {
     OPTIONAL = "OPTIONAL",
     REQUIRE = "REQUIRE"
 }
 /**
+ * @public
  * <p>Used to associate a configuration set with a dedicated IP pool.</p>
  */
 export interface DeliveryOptions {
@@ -67,6 +75,7 @@ export interface DeliveryOptions {
     SendingPoolName?: string;
 }
 /**
+ * @public
  * <p>Enable or disable collection of reputation metrics for emails that you send using this
  *             configuration set in the current AWS Region. </p>
  */
@@ -85,6 +94,7 @@ export interface ReputationOptions {
     LastFreshStart?: Date;
 }
 /**
+ * @public
  * <p>Used to enable or disable email sending for messages that use this configuration set
  *             in the current AWS Region.</p>
  */
@@ -96,6 +106,7 @@ export interface SendingOptions {
     SendingEnabled?: boolean;
 }
 /**
+ * @public
  * <p>An object that defines the tags that are associated with a resource.
  *                 A <i>tag</i> 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
@@ -145,6 +156,7 @@ export interface Tag {
     Value: string | undefined;
 }
 /**
+ * @public
  * <p>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
@@ -160,6 +172,7 @@ export interface TrackingOptions {
     CustomRedirectDomain: string | undefined;
 }
 /**
+ * @public
  * <p>A request to create a configuration set.</p>
  */
 export interface CreateConfigurationSetRequest {
@@ -194,12 +207,14 @@ export interface CreateConfigurationSetRequest {
     Tags?: Tag[];
 }
 /**
+ * @public
  * <p>An HTTP 200 response if the request succeeds, or an error message if the request
  *             fails.</p>
  */
 export interface CreateConfigurationSetResponse {
 }
 /**
+ * @public
  * <p>There are too many instances of the specified resource type.</p>
  */
 export declare class LimitExceededException extends __BaseException {
@@ -211,6 +226,7 @@ export declare class LimitExceededException extends __BaseException {
     constructor(opts: __ExceptionOptionType<LimitExceededException, __BaseException>);
 }
 /**
+ * @public
  * <p>The resource you attempted to access doesn't exist.</p>
  */
 export declare class NotFoundException extends __BaseException {
@@ -222,6 +238,7 @@ export declare class NotFoundException extends __BaseException {
     constructor(opts: __ExceptionOptionType<NotFoundException, __BaseException>);
 }
 /**
+ * @public
  * <p>Too many requests have been made to the operation.</p>
  */
 export declare class TooManyRequestsException extends __BaseException {
@@ -232,12 +249,16 @@ export declare class TooManyRequestsException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<TooManyRequestsException, __BaseException>);
 }
+/**
+ * @public
+ */
 export declare enum DimensionValueSource {
     EMAIL_HEADER = "EMAIL_HEADER",
     LINK_TAG = "LINK_TAG",
     MESSAGE_TAG = "MESSAGE_TAG"
 }
 /**
+ * @public
  * <p>An object that defines the dimension configuration to use when you send Amazon Pinpoint email
  *             events to Amazon CloudWatch.</p>
  */
@@ -281,6 +302,7 @@ export interface CloudWatchDimensionConfiguration {
     DefaultDimensionValue: string | undefined;
 }
 /**
+ * @public
  * <p>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.</p>
  */
@@ -292,6 +314,7 @@ export interface CloudWatchDestination {
     DimensionConfigurations: CloudWatchDimensionConfiguration[] | undefined;
 }
 /**
+ * @public
  * <p>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.</p>
  */
@@ -307,6 +330,9 @@ export interface KinesisFirehoseDestination {
      */
     DeliveryStreamArn: string | undefined;
 }
+/**
+ * @public
+ */
 export declare enum EventType {
     BOUNCE = "BOUNCE",
     CLICK = "CLICK",
@@ -318,6 +344,7 @@ export declare enum EventType {
     SEND = "SEND"
 }
 /**
+ * @public
  * <p>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.</p>
@@ -330,6 +357,7 @@ export interface PinpointDestination {
     ApplicationArn?: string;
 }
 /**
+ * @public
  * <p>An object that defines an Amazon SNS destination for email events. You can use Amazon SNS to
  *             send notification when certain email events occur.</p>
  */
@@ -342,6 +370,7 @@ export interface SnsDestination {
     TopicArn: string | undefined;
 }
 /**
+ * @public
  * <p>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
@@ -384,6 +413,7 @@ export interface EventDestinationDefinition {
     PinpointDestination?: PinpointDestination;
 }
 /**
+ * @public
  * <p>A request to add an event destination to a configuration set.</p>
  */
 export interface CreateConfigurationSetEventDestinationRequest {
@@ -401,12 +431,14 @@ export interface CreateConfigurationSetEventDestinationRequest {
     EventDestination: EventDestinationDefinition | undefined;
 }
 /**
+ * @public
  * <p>An HTTP 200 response if the request succeeds, or an error message if the request
  *             fails.</p>
  */
 export interface CreateConfigurationSetEventDestinationResponse {
 }
 /**
+ * @public
  * <p>A request to create a new dedicated IP pool.</p>
  */
 export interface CreateDedicatedIpPoolRequest {
@@ -421,12 +453,14 @@ export interface CreateDedicatedIpPoolRequest {
     Tags?: Tag[];
 }
 /**
+ * @public
  * <p>An HTTP 200 response if the request succeeds, or an error message if the request
  *             fails.</p>
  */
 export interface CreateDedicatedIpPoolResponse {
 }
 /**
+ * @public
  * <p>The raw email message.</p>
  */
 export interface RawMessage {
@@ -464,6 +498,7 @@ export interface RawMessage {
     Data: Uint8Array | undefined;
 }
 /**
+ * @public
  * <p>An object that represents the content of the email, and optionally a character set
  *             specification.</p>
  */
@@ -481,6 +516,7 @@ export interface Content {
     Charset?: string;
 }
 /**
+ * @public
  * <p>Represents the body of the email message.</p>
  */
 export interface Body {
@@ -498,6 +534,7 @@ export interface Body {
     Html?: Content;
 }
 /**
+ * @public
  * <p>Represents the email message that you're sending. The <code>Message</code> object
  *             consists of a subject line and a message body.</p>
  */
@@ -514,6 +551,9 @@ export interface Message {
      */
     Body: Body | undefined;
 }
+/**
+ * @public
+ */
 export interface Template {
     /**
      * <p>The Amazon Resource Name (ARN) of the template.</p>
@@ -525,6 +565,7 @@ export interface Template {
     TemplateData?: string;
 }
 /**
+ * @public
  * <p>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
@@ -574,6 +615,7 @@ export interface EmailContent {
     Template?: Template;
 }
 /**
+ * @public
  * <p>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
@@ -602,11 +644,15 @@ export interface CreateDeliverabilityTestReportRequest {
      */
     Tags?: Tag[];
 }
+/**
+ * @public
+ */
 export declare enum DeliverabilityTestStatus {
     COMPLETED = "COMPLETED",
     IN_PROGRESS = "IN_PROGRESS"
 }
 /**
+ * @public
  * <p>Information about the predictive inbox placement test that you created.</p>
  */
 export interface CreateDeliverabilityTestReportResponse {
@@ -623,6 +669,7 @@ export interface CreateDeliverabilityTestReportResponse {
     DeliverabilityTestStatus: DeliverabilityTestStatus | string | undefined;
 }
 /**
+ * @public
  * <p>The message can't be sent because the sending domain isn't verified.</p>
  */
 export declare class MailFromDomainNotVerifiedException extends __BaseException {
@@ -634,6 +681,7 @@ export declare class MailFromDomainNotVerifiedException extends __BaseException
     constructor(opts: __ExceptionOptionType<MailFromDomainNotVerifiedException, __BaseException>);
 }
 /**
+ * @public
  * <p>The message can't be sent because it contains invalid content.</p>
  */
 export declare class MessageRejected extends __BaseException {
@@ -645,6 +693,7 @@ export declare class MessageRejected extends __BaseException {
     constructor(opts: __ExceptionOptionType<MessageRejected, __BaseException>);
 }
 /**
+ * @public
  * <p>The message can't be sent because the account's ability to send email is currently
  *             paused.</p>
  */
@@ -657,6 +706,7 @@ export declare class SendingPausedException extends __BaseException {
     constructor(opts: __ExceptionOptionType<SendingPausedException, __BaseException>);
 }
 /**
+ * @public
  * <p>A request to begin the verification process for an email identity (an email address or
  *             domain).</p>
  */
@@ -671,6 +721,9 @@ export interface CreateEmailIdentityRequest {
      */
     Tags?: Tag[];
 }
+/**
+ * @public
+ */
 export declare enum DkimStatus {
     FAILED = "FAILED",
     NOT_STARTED = "NOT_STARTED",
@@ -679,6 +732,7 @@ export declare enum DkimStatus {
     TEMPORARY_FAILURE = "TEMPORARY_FAILURE"
 }
 /**
+ * @public
  * <p>An object that contains information about the DKIM configuration for an email
  *             identity.</p>
  */
@@ -732,12 +786,16 @@ export interface DkimAttributes {
      */
     Tokens?: string[];
 }
+/**
+ * @public
+ */
 export declare enum IdentityType {
     DOMAIN = "DOMAIN",
     EMAIL_ADDRESS = "EMAIL_ADDRESS",
     MANAGED_DOMAIN = "MANAGED_DOMAIN"
 }
 /**
+ * @public
  * <p>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.</p>
@@ -762,6 +820,7 @@ export interface CreateEmailIdentityResponse {
     DkimAttributes?: DkimAttributes;
 }
 /**
+ * @public
  * <p>A request to delete a configuration set.</p>
  */
 export interface DeleteConfigurationSetRequest {
@@ -771,12 +830,14 @@ export interface DeleteConfigurationSetRequest {
     ConfigurationSetName: string | undefined;
 }
 /**
+ * @public
  * <p>An HTTP 200 response if the request succeeds, or an error message if the request
  *             fails.</p>
  */
 export interface DeleteConfigurationSetResponse {
 }
 /**
+ * @public
  * <p>A request to delete an event destination from a configuration set.</p>
  */
 export interface DeleteConfigurationSetEventDestinationRequest {
@@ -791,12 +852,14 @@ export interface DeleteConfigurationSetEventDestinationRequest {
     EventDestinationName: string | undefined;
 }
 /**
+ * @public
  * <p>An HTTP 200 response if the request succeeds, or an error message if the request
  *             fails.</p>
  */
 export interface DeleteConfigurationSetEventDestinationResponse {
 }
 /**
+ * @public
  * <p>A request to delete a dedicated IP pool.</p>
  */
 export interface DeleteDedicatedIpPoolRequest {
@@ -806,12 +869,14 @@ export interface DeleteDedicatedIpPoolRequest {
     PoolName: string | undefined;
 }
 /**
+ * @public
  * <p>An HTTP 200 response if the request succeeds, or an error message if the request
  *             fails.</p>
  */
 export interface DeleteDedicatedIpPoolResponse {
 }
 /**
+ * @public
  * <p>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.</p>
@@ -824,18 +889,21 @@ export interface DeleteEmailIdentityRequest {
     EmailIdentity: string | undefined;
 }
 /**
+ * @public
  * <p>An HTTP 200 response if the request succeeds, or an error message if the request
  *             fails.</p>
  */
 export interface DeleteEmailIdentityResponse {
 }
 /**
+ * @public
  * <p>A request to obtain information about the email-sending capabilities of your Amazon Pinpoint
  *             account.</p>
  */
 export interface GetAccountRequest {
 }
 /**
+ * @public
  * <p>An object that contains information about the per-day and per-second sending limits
  *             for your Amazon Pinpoint account in the current AWS Region.</p>
  */
@@ -859,6 +927,7 @@ export interface SendQuota {
     SentLast24Hours?: number;
 }
 /**
+ * @public
  * <p>A list of details about the email-sending capabilities of your Amazon Pinpoint account in the
  *             current AWS Region.</p>
  */
@@ -918,6 +987,7 @@ export interface GetAccountResponse {
     ProductionAccessEnabled?: boolean;
 }
 /**
+ * @public
  * <p>A request to retrieve a list of the blacklists that your dedicated IP addresses appear
  *             on.</p>
  */
@@ -930,6 +1000,7 @@ export interface GetBlacklistReportsRequest {
     BlacklistItemNames: string[] | undefined;
 }
 /**
+ * @public
  * <p>An object that contains information about a blacklisting event that impacts one of the
  *             dedicated IP addresses that is associated with your account.</p>
  */
@@ -949,6 +1020,7 @@ export interface BlacklistEntry {
     Description?: string;
 }
 /**
+ * @public
  * <p>An object that contains information about blacklist events.</p>
  */
 export interface GetBlacklistReportsResponse {
@@ -959,6 +1031,7 @@ export interface GetBlacklistReportsResponse {
     BlacklistReport: Record<string, BlacklistEntry[]> | undefined;
 }
 /**
+ * @public
  * <p>A request to obtain information about a configuration set.</p>
  */
 export interface GetConfigurationSetRequest {
@@ -969,6 +1042,7 @@ export interface GetConfigurationSetRequest {
     ConfigurationSetName: string | undefined;
 }
 /**
+ * @public
  * <p>Information about a configuration set.</p>
  */
 export interface GetConfigurationSetResponse {
@@ -1003,6 +1077,7 @@ export interface GetConfigurationSetResponse {
     Tags?: Tag[];
 }
 /**
+ * @public
  * <p>A request to obtain information about the event destinations for a configuration
  *             set.</p>
  */
@@ -1013,6 +1088,7 @@ export interface GetConfigurationSetEventDestinationsRequest {
     ConfigurationSetName: string | undefined;
 }
 /**
+ * @public
  * <p>In Amazon Pinpoint, <i>events</i> include message sends, deliveries, opens,
  *             clicks, bounces, and complaints. <i>Event destinations</i> are places that
  *             you can send information about these events to. For example, you can send event data to
@@ -1059,6 +1135,7 @@ export interface EventDestination {
     PinpointDestination?: PinpointDestination;
 }
 /**
+ * @public
  * <p>Information about an event destination for a configuration set.</p>
  */
 export interface GetConfigurationSetEventDestinationsResponse {
@@ -1069,6 +1146,7 @@ export interface GetConfigurationSetEventDestinationsResponse {
     EventDestinations?: EventDestination[];
 }
 /**
+ * @public
  * <p>A request to obtain more information about a dedicated IP address.</p>
  */
 export interface GetDedicatedIpRequest {
@@ -1078,11 +1156,15 @@ export interface GetDedicatedIpRequest {
      */
     Ip: string | undefined;
 }
+/**
+ * @public
+ */
 export declare enum WarmupStatus {
     DONE = "DONE",
     IN_PROGRESS = "IN_PROGRESS"
 }
 /**
+ * @public
  * <p>Contains information about a dedicated IP address that is associated with your Amazon Pinpoint
  *             account.</p>
  *         <p></p>
@@ -1120,6 +1202,7 @@ export interface DedicatedIp {
     PoolName?: string;
 }
 /**
+ * @public
  * <p>Information about a dedicated IP address.</p>
  */
 export interface GetDedicatedIpResponse {
@@ -1129,6 +1212,7 @@ export interface GetDedicatedIpResponse {
     DedicatedIp?: DedicatedIp;
 }
 /**
+ * @public
  * <p>A request to obtain more information about dedicated IP pools.</p>
  */
 export interface GetDedicatedIpsRequest {
@@ -1150,6 +1234,7 @@ export interface GetDedicatedIpsRequest {
     PageSize?: number;
 }
 /**
+ * @public
  * <p>Information about the dedicated IP addresses that are associated with your Amazon Pinpoint
  *             account.</p>
  */
@@ -1167,6 +1252,7 @@ export interface GetDedicatedIpsResponse {
     NextToken?: string;
 }
 /**
+ * @public
  * <p>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
@@ -1177,12 +1263,16 @@ export interface GetDedicatedIpsResponse {
  */
 export interface GetDeliverabilityDashboardOptionsRequest {
 }
+/**
+ * @public
+ */
 export declare enum DeliverabilityDashboardAccountStatus {
     ACTIVE = "ACTIVE",
     DISABLED = "DISABLED",
     PENDING_EXPIRATION = "PENDING_EXPIRATION"
 }
 /**
+ * @public
  * <p>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
@@ -1200,6 +1290,7 @@ export interface InboxPlacementTrackingOption {
     TrackedIsps?: string[];
 }
 /**
+ * @public
  * <p>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
@@ -1223,6 +1314,7 @@ export interface DomainDeliverabilityTrackingOption {
     InboxPlacementTrackingOption?: InboxPlacementTrackingOption;
 }
 /**
+ * @public
  * <p>An object that shows the status of the Deliverability dashboard for your Amazon Pinpoint account.</p>
  */
 export interface GetDeliverabilityDashboardOptionsResponse {
@@ -1258,6 +1350,7 @@ export interface GetDeliverabilityDashboardOptionsResponse {
     PendingExpirationSubscribedDomains?: DomainDeliverabilityTrackingOption[];
 }
 /**
+ * @public
  * <p>A request to retrieve the results of a predictive inbox placement test.</p>
  */
 export interface GetDeliverabilityTestReportRequest {
@@ -1267,6 +1360,7 @@ export interface GetDeliverabilityTestReportRequest {
     ReportId: string | undefined;
 }
 /**
+ * @public
  * <p>An object that contains metadata related to a predictive inbox placement test.</p>
  */
 export interface DeliverabilityTestReport {
@@ -1299,6 +1393,7 @@ export interface DeliverabilityTestReport {
     DeliverabilityTestStatus?: DeliverabilityTestStatus | string;
 }
 /**
+ * @public
  * <p>An object that contains inbox placement data for an email provider.</p>
  */
 export interface PlacementStatistics {
@@ -1328,6 +1423,7 @@ export interface PlacementStatistics {
     DkimPercentage?: number;
 }
 /**
+ * @public
  * <p>An object that describes how email sent during the predictive inbox placement test was handled by a certain
  *             email provider.</p>
  */
@@ -1342,6 +1438,7 @@ export interface IspPlacement {
     PlacementStatistics?: PlacementStatistics;
 }
 /**
+ * @public
  * <p>The results of the predictive inbox placement test.</p>
  */
 export interface GetDeliverabilityTestReportResponse {
@@ -1372,6 +1469,7 @@ export interface GetDeliverabilityTestReportResponse {
     Tags?: Tag[];
 }
 /**
+ * @public
  * <p>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 (<code>PutDeliverabilityDashboardOption</code>
@@ -1387,6 +1485,7 @@ export interface GetDomainDeliverabilityCampaignRequest {
     CampaignId: string | undefined;
 }
 /**
+ * @public
  * <p>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 (<code>PutDeliverabilityDashboardOption</code>
@@ -1466,6 +1565,7 @@ export interface DomainDeliverabilityCampaign {
     Esps?: string[];
 }
 /**
+ * @public
  * <p>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 (<code>PutDeliverabilityDashboardOption</code>
@@ -1478,6 +1578,7 @@ export interface GetDomainDeliverabilityCampaignResponse {
     DomainDeliverabilityCampaign: DomainDeliverabilityCampaign | undefined;
 }
 /**
+ * @public
  * <p>A request to obtain deliverability metrics for a domain.</p>
  */
 export interface GetDomainStatisticsReportRequest {
@@ -1498,6 +1599,7 @@ export interface GetDomainStatisticsReportRequest {
     EndDate: Date | undefined;
 }
 /**
+ * @public
  * <p>An object that contains inbox placement data for email sent from one of your email
  *             domains to a specific email provider.</p>
  */
@@ -1528,6 +1630,7 @@ export interface DomainIspPlacement {
     SpamPercentage?: number;
 }
 /**
+ * @public
  * <p>An object that contains information about the amount of email that was delivered to
  *             recipients.</p>
  */
@@ -1553,6 +1656,7 @@ export interface VolumeStatistics {
     ProjectedSpam?: number;
 }
 /**
+ * @public
  * <p>An object that contains information about the volume of email sent on each day of the
  *             analysis period.</p>
  */
@@ -1573,6 +1677,7 @@ export interface DailyVolume {
     DomainIspPlacements?: DomainIspPlacement[];
 }
 /**
+ * @public
  * <p>An object that contains information about email that was sent from the selected
  *             domain.</p>
  */
@@ -1594,6 +1699,7 @@ export interface OverallVolume {
     DomainIspPlacements?: DomainIspPlacement[];
 }
 /**
+ * @public
  * <p>An object that includes statistics that are related to the domain that you
  *             specified.</p>
  */
@@ -1612,6 +1718,7 @@ export interface GetDomainStatisticsReportResponse {
     DailyVolumes: DailyVolume[] | undefined;
 }
 /**
+ * @public
  * <p>A request to return details about an email identity.</p>
  */
 export interface GetEmailIdentityRequest {
@@ -1620,10 +1727,16 @@ export interface GetEmailIdentityRequest {
      */
     EmailIdentity: string | undefined;
 }
+/**
+ * @public
+ */
 export declare enum BehaviorOnMxFailure {
     REJECT_MESSAGE = "REJECT_MESSAGE",
     USE_DEFAULT_VALUE = "USE_DEFAULT_VALUE"
 }
+/**
+ * @public
+ */
 export declare enum MailFromDomainStatus {
     FAILED = "FAILED",
     PENDING = "PENDING",
@@ -1631,6 +1744,7 @@ export declare enum MailFromDomainStatus {
     TEMPORARY_FAILURE = "TEMPORARY_FAILURE"
 }
 /**
+ * @public
  * <p>A list of attributes that are associated with a MAIL FROM domain.</p>
  */
 export interface MailFromAttributes {
@@ -1677,6 +1791,7 @@ export interface MailFromAttributes {
     BehaviorOnMxFailure: BehaviorOnMxFailure | string | undefined;
 }
 /**
+ * @public
  * <p>Details about an email identity.</p>
  */
 export interface GetEmailIdentityResponse {
@@ -1720,6 +1835,7 @@ export interface GetEmailIdentityResponse {
     Tags?: Tag[];
 }
 /**
+ * @public
  * <p>A request to obtain a list of configuration sets for your Amazon Pinpoint account in the current
  *             AWS Region.</p>
  */
@@ -1738,6 +1854,7 @@ export interface ListConfigurationSetsRequest {
     PageSize?: number;
 }
 /**
+ * @public
  * <p>A list of configuration sets in your Amazon Pinpoint account in the current AWS Region.</p>
  */
 export interface ListConfigurationSetsResponse {
@@ -1755,6 +1872,7 @@ export interface ListConfigurationSetsResponse {
     NextToken?: string;
 }
 /**
+ * @public
  * <p>A request to obtain a list of dedicated IP pools.</p>
  */
 export interface ListDedicatedIpPoolsRequest {
@@ -1772,6 +1890,7 @@ export interface ListDedicatedIpPoolsRequest {
     PageSize?: number;
 }
 /**
+ * @public
  * <p>A list of dedicated IP pools.</p>
  */
 export interface ListDedicatedIpPoolsResponse {
@@ -1788,6 +1907,7 @@ export interface ListDedicatedIpPoolsResponse {
     NextToken?: string;
 }
 /**
+ * @public
  * <p>A request to list all of the predictive inbox placement tests that you've performed.</p>
  */
 export interface ListDeliverabilityTestReportsRequest {
@@ -1807,6 +1927,7 @@ export interface ListDeliverabilityTestReportsRequest {
     PageSize?: number;
 }
 /**
+ * @public
  * <p>A list of the predictive inbox placement test reports that are available for your account, regardless of
  *             whether or not those tests are complete.</p>
  */
@@ -1823,6 +1944,7 @@ export interface ListDeliverabilityTestReportsResponse {
     NextToken?: string;
 }
 /**
+ * @public
  * <p>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 (<code>PutDeliverabilityDashboardOption</code> operation)
@@ -1860,6 +1982,7 @@ export interface ListDomainDeliverabilityCampaignsRequest {
     PageSize?: number;
 }
 /**
+ * @public
  * <p>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
@@ -1879,6 +2002,7 @@ export interface ListDomainDeliverabilityCampaignsResponse {
     NextToken?: string;
 }
 /**
+ * @public
  * <p>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.</p>
@@ -1899,6 +2023,7 @@ export interface ListEmailIdentitiesRequest {
     PageSize?: number;
 }
 /**
+ * @public
  * <p>Information about an email identity.</p>
  */
 export interface IdentityInfo {
@@ -1934,6 +2059,7 @@ export interface IdentityInfo {
     SendingEnabled?: boolean;
 }
 /**
+ * @public
  * <p>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.</p>
  */
@@ -1951,6 +2077,9 @@ export interface ListEmailIdentitiesResponse {
      */
     NextToken?: string;
 }
+/**
+ * @public
+ */
 export interface ListTagsForResourceRequest {
     /**
      * <p>The Amazon Resource Name (ARN) of the resource that you want to retrieve tag
@@ -1958,6 +2087,9 @@ export interface ListTagsForResourceRequest {
      */
     ResourceArn: string | undefined;
 }
+/**
+ * @public
+ */
 export interface ListTagsForResourceResponse {
     /**
      * <p>An array that lists all the tags that are associated with the resource. Each tag
@@ -1967,6 +2099,7 @@ export interface ListTagsForResourceResponse {
     Tags: Tag[] | undefined;
 }
 /**
+ * @public
  * <p>A request to enable or disable the automatic IP address warm-up feature.</p>
  */
 export interface PutAccountDedicatedIpWarmupAttributesRequest {
@@ -1979,12 +2112,14 @@ export interface PutAccountDedicatedIpWarmupAttributesRequest {
     AutoWarmupEnabled?: boolean;
 }
 /**
+ * @public
  * <p>An HTTP 200 response if the request succeeds, or an error message if the request
  *             fails.</p>
  */
 export interface PutAccountDedicatedIpWarmupAttributesResponse {
 }
 /**
+ * @public
  * <p>A request to change the ability of your account to send email.</p>
  */
 export interface PutAccountSendingAttributesRequest {
@@ -1999,12 +2134,14 @@ export interface PutAccountSendingAttributesRequest {
     SendingEnabled?: boolean;
 }
 /**
+ * @public
  * <p>An HTTP 200 response if the request succeeds, or an error message if the request
  *             fails.</p>
  */
 export interface PutAccountSendingAttributesResponse {
 }
 /**
+ * @public
  * <p>A request to associate a configuration set with a dedicated IP pool.</p>
  */
 export interface PutConfigurationSetDeliveryOptionsRequest {
@@ -2027,12 +2164,14 @@ export interface PutConfigurationSetDeliveryOptionsRequest {
     SendingPoolName?: string;
 }
 /**
+ * @public
  * <p>An HTTP 200 response if the request succeeds, or an error message if the request
  *             fails.</p>
  */
 export interface PutConfigurationSetDeliveryOptionsResponse {
 }
 /**
+ * @public
  * <p>A request to enable or disable tracking of reputation metrics for a configuration
  *             set.</p>
  */
@@ -2050,12 +2189,14 @@ export interface PutConfigurationSetReputationOptionsRequest {
     ReputationMetricsEnabled?: boolean;
 }
 /**
+ * @public
  * <p>An HTTP 200 response if the request succeeds, or an error message if the request
  *             fails.</p>
  */
 export interface PutConfigurationSetReputationOptionsResponse {
 }
 /**
+ * @public
  * <p>A request to enable or disable the ability of Amazon Pinpoint to send emails that use a specific
  *             configuration set.</p>
  */
@@ -2072,12 +2213,14 @@ export interface PutConfigurationSetSendingOptionsRequest {
     SendingEnabled?: boolean;
 }
 /**
+ * @public
  * <p>An HTTP 200 response if the request succeeds, or an error message if the request
  *             fails.</p>
  */
 export interface PutConfigurationSetSendingOptionsResponse {
 }
 /**
+ * @public
  * <p>A request to add a custom domain for tracking open and click events to a configuration
  *             set.</p>
  */
@@ -2093,12 +2236,14 @@ export interface PutConfigurationSetTrackingOptionsRequest {
     CustomRedirectDomain?: string;
 }
 /**
+ * @public
  * <p>An HTTP 200 response if the request succeeds, or an error message if the request
  *             fails.</p>
  */
 export interface PutConfigurationSetTrackingOptionsResponse {
 }
 /**
+ * @public
  * <p>A request to move a dedicated IP address to a dedicated IP pool.</p>
  */
 export interface PutDedicatedIpInPoolRequest {
@@ -2114,12 +2259,14 @@ export interface PutDedicatedIpInPoolRequest {
     DestinationPoolName: string | undefined;
 }
 /**
+ * @public
  * <p>An HTTP 200 response if the request succeeds, or an error message if the request
  *             fails.</p>
  */
 export interface PutDedicatedIpInPoolResponse {
 }
 /**
+ * @public
  * <p>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.</p>
  */
@@ -2135,12 +2282,14 @@ export interface PutDedicatedIpWarmupAttributesRequest {
     WarmupPercentage: number | undefined;
 }
 /**
+ * @public
  * <p>An HTTP 200 response if the request succeeds, or an error message if the request
  *             fails.</p>
  */
 export interface PutDedicatedIpWarmupAttributesResponse {
 }
 /**
+ * @public
  * <p>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
@@ -2162,12 +2311,14 @@ export interface PutDeliverabilityDashboardOptionRequest {
     SubscribedDomains?: DomainDeliverabilityTrackingOption[];
 }
 /**
+ * @public
  * <p>A response that indicates whether the Deliverability dashboard is enabled for your Amazon Pinpoint
  *             account.</p>
  */
 export interface PutDeliverabilityDashboardOptionResponse {
 }
 /**
+ * @public
  * <p>A request to enable or disable DKIM signing of email that you send from an email
  *             identity.</p>
  */
@@ -2185,12 +2336,14 @@ export interface PutEmailIdentityDkimAttributesRequest {
     SigningEnabled?: boolean;
 }
 /**
+ * @public
  * <p>An HTTP 200 response if the request succeeds, or an error message if the request
  *             fails.</p>
  */
 export interface PutEmailIdentityDkimAttributesResponse {
 }
 /**
+ * @public
  * <p>A request to set the attributes that control how bounce and complaint events are
  *             processed.</p>
  */
@@ -2214,12 +2367,14 @@ export interface PutEmailIdentityFeedbackAttributesRequest {
     EmailForwardingEnabled?: boolean;
 }
 /**
+ * @public
  * <p>An HTTP 200 response if the request succeeds, or an error message if the request
  *             fails.</p>
  */
 export interface PutEmailIdentityFeedbackAttributesResponse {
 }
 /**
+ * @public
  * <p>A request to configure the custom MAIL FROM domain for a verified identity.</p>
  */
 export interface PutEmailIdentityMailFromAttributesRequest {
@@ -2258,12 +2413,14 @@ export interface PutEmailIdentityMailFromAttributesRequest {
     BehaviorOnMxFailure?: BehaviorOnMxFailure | string;
 }
 /**
+ * @public
  * <p>An HTTP 200 response if the request succeeds, or an error message if the request
  *             fails.</p>
  */
 export interface PutEmailIdentityMailFromAttributesResponse {
 }
 /**
+ * @public
  * <p>An object that describes the recipients for an email.</p>
  */
 export interface Destination {
@@ -2284,6 +2441,7 @@ export interface Destination {
     BccAddresses?: string[];
 }
 /**
+ * @public
  * <p>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.
  *             </p>
@@ -2319,6 +2477,7 @@ export interface MessageTag {
     Value: string | undefined;
 }
 /**
+ * @public
  * <p>A request to send an email message.</p>
  */
 export interface SendEmailRequest {
@@ -2358,6 +2517,7 @@ export interface SendEmailRequest {
     ConfigurationSetName?: string;
 }
 /**
+ * @public
  * <p>A unique message ID that you receive when Amazon Pinpoint accepts an email for sending.</p>
  */
 export interface SendEmailResponse {
@@ -2373,6 +2533,9 @@ export interface SendEmailResponse {
      */
     MessageId?: string;
 }
+/**
+ * @public
+ */
 export interface TagResourceRequest {
     /**
      * <p>The Amazon Resource Name (ARN) of the resource that you want to add one or more tags
@@ -2387,8 +2550,14 @@ export interface TagResourceRequest {
      */
     Tags: Tag[] | undefined;
 }
+/**
+ * @public
+ */
 export interface TagResourceResponse {
 }
+/**
+ * @public
+ */
 export interface UntagResourceRequest {
     /**
      * <p>The Amazon Resource Name (ARN) of the resource that you want to remove one or more
@@ -2406,9 +2575,13 @@ export interface UntagResourceRequest {
      */
     TagKeys: string[] | undefined;
 }
+/**
+ * @public
+ */
 export interface UntagResourceResponse {
 }
 /**
+ * @public
  * <p>A request to change the settings for an event destination for a configuration
  *             set.</p>
  */
@@ -2428,6 +2601,7 @@ export interface UpdateConfigurationSetEventDestinationRequest {
     EventDestination: EventDestinationDefinition | undefined;
 }
 /**
+ * @public
  * <p>An HTTP 200 response if the request succeeds, or an error message if the request
  *             fails.</p>
  */