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

package/dist-types/PinpointEmail.d.ts

@@ -43,6 +43,7 @@ import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./command
 import { UpdateConfigurationSetEventDestinationCommandInput, UpdateConfigurationSetEventDestinationCommandOutput } from "./commands/UpdateConfigurationSetEventDestinationCommand";
 import { PinpointEmailClient } from "./PinpointEmailClient";
 /**
+ * @public
  * <fullname>Amazon Pinpoint Email Service</fullname>
  *         <p>Welcome to the <i>Amazon Pinpoint Email API Reference</i>. This guide provides
  *             information about the Amazon Pinpoint Email API (version 1.0), including supported
@@ -75,6 +76,7 @@ import { PinpointEmailClient } from "./PinpointEmailClient";
  */
 export declare class PinpointEmail extends PinpointEmailClient {
     /**
+     * @public
      * <p>Create a configuration set. <i>Configuration sets</i> are groups of
      *             rules that you can apply to the emails you send using Amazon Pinpoint. You apply a configuration
      *             set to an email by including a reference to the configuration set in the headers of the
@@ -85,6 +87,7 @@ export declare class PinpointEmail extends PinpointEmailClient {
     createConfigurationSet(args: CreateConfigurationSetCommandInput, cb: (err: any, data?: CreateConfigurationSetCommandOutput) => void): void;
     createConfigurationSet(args: CreateConfigurationSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateConfigurationSetCommandOutput) => void): void;
     /**
+     * @public
      * <p>Create an event destination. 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
@@ -97,6 +100,7 @@ export declare class PinpointEmail extends PinpointEmailClient {
     createConfigurationSetEventDestination(args: CreateConfigurationSetEventDestinationCommandInput, cb: (err: any, data?: CreateConfigurationSetEventDestinationCommandOutput) => void): void;
     createConfigurationSetEventDestination(args: CreateConfigurationSetEventDestinationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateConfigurationSetEventDestinationCommandOutput) => void): void;
     /**
+     * @public
      * <p>Create a new pool of dedicated IP addresses. A pool can include one or more dedicated
      *             IP addresses that are associated with your Amazon Pinpoint account. You can associate a pool with
      *             a configuration set. When you send an email that uses that configuration set, Amazon Pinpoint
@@ -106,6 +110,7 @@ export declare class PinpointEmail extends PinpointEmailClient {
     createDedicatedIpPool(args: CreateDedicatedIpPoolCommandInput, cb: (err: any, data?: CreateDedicatedIpPoolCommandOutput) => void): void;
     createDedicatedIpPool(args: CreateDedicatedIpPoolCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDedicatedIpPoolCommandOutput) => void): void;
     /**
+     * @public
      * <p>Create a new predictive inbox placement test. Predictive inbox placement tests can help you predict how your messages will be handled
      *             by various email providers around the world. When you perform a predictive inbox placement test, you provide a
      *             sample message that contains the content that you plan to send to your customers. Amazon Pinpoint
@@ -118,6 +123,7 @@ export declare class PinpointEmail extends PinpointEmailClient {
     createDeliverabilityTestReport(args: CreateDeliverabilityTestReportCommandInput, cb: (err: any, data?: CreateDeliverabilityTestReportCommandOutput) => void): void;
     createDeliverabilityTestReport(args: CreateDeliverabilityTestReportCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDeliverabilityTestReportCommandOutput) => void): void;
     /**
+     * @public
      * <p>Verifies an email identity for use with Amazon Pinpoint. In Amazon Pinpoint, an identity is an email
      *             address or domain that you use when you send email. Before you can use an identity to
      *             send email with Amazon Pinpoint, you first have to verify it. By verifying an address, you
@@ -137,6 +143,7 @@ export declare class PinpointEmail extends PinpointEmailClient {
     createEmailIdentity(args: CreateEmailIdentityCommandInput, cb: (err: any, data?: CreateEmailIdentityCommandOutput) => void): void;
     createEmailIdentity(args: CreateEmailIdentityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateEmailIdentityCommandOutput) => void): void;
     /**
+     * @public
      * <p>Delete an existing configuration set.</p>
      *         <p>In Amazon Pinpoint, <i>configuration sets</i> are groups of rules that you can
      *             apply to the emails you send. You apply a configuration set to an email by including a
@@ -148,6 +155,7 @@ export declare class PinpointEmail extends PinpointEmailClient {
     deleteConfigurationSet(args: DeleteConfigurationSetCommandInput, cb: (err: any, data?: DeleteConfigurationSetCommandOutput) => void): void;
     deleteConfigurationSet(args: DeleteConfigurationSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteConfigurationSetCommandOutput) => void): void;
     /**
+     * @public
      * <p>Delete an event destination.</p>
      *         <p>In Amazon Pinpoint, <i>events</i> include message sends, deliveries, opens,
      *             clicks, bounces, and complaints. <i>Event destinations</i> are places that
@@ -159,12 +167,14 @@ export declare class PinpointEmail extends PinpointEmailClient {
     deleteConfigurationSetEventDestination(args: DeleteConfigurationSetEventDestinationCommandInput, cb: (err: any, data?: DeleteConfigurationSetEventDestinationCommandOutput) => void): void;
     deleteConfigurationSetEventDestination(args: DeleteConfigurationSetEventDestinationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteConfigurationSetEventDestinationCommandOutput) => void): void;
     /**
+     * @public
      * <p>Delete a dedicated IP pool.</p>
      */
     deleteDedicatedIpPool(args: DeleteDedicatedIpPoolCommandInput, options?: __HttpHandlerOptions): Promise<DeleteDedicatedIpPoolCommandOutput>;
     deleteDedicatedIpPool(args: DeleteDedicatedIpPoolCommandInput, cb: (err: any, data?: DeleteDedicatedIpPoolCommandOutput) => void): void;
     deleteDedicatedIpPool(args: DeleteDedicatedIpPoolCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDedicatedIpPoolCommandOutput) => void): void;
     /**
+     * @public
      * <p>Deletes an email identity that you previously verified for use with Amazon Pinpoint. An identity
      *             can be either an email address or a domain name.</p>
      */
@@ -172,6 +182,7 @@ export declare class PinpointEmail extends PinpointEmailClient {
     deleteEmailIdentity(args: DeleteEmailIdentityCommandInput, cb: (err: any, data?: DeleteEmailIdentityCommandOutput) => void): void;
     deleteEmailIdentity(args: DeleteEmailIdentityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteEmailIdentityCommandOutput) => void): void;
     /**
+     * @public
      * <p>Obtain information about the email-sending status and capabilities of your Amazon Pinpoint
      *             account in the current AWS Region.</p>
      */
@@ -179,12 +190,14 @@ export declare class PinpointEmail extends PinpointEmailClient {
     getAccount(args: GetAccountCommandInput, cb: (err: any, data?: GetAccountCommandOutput) => void): void;
     getAccount(args: GetAccountCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAccountCommandOutput) => void): void;
     /**
+     * @public
      * <p>Retrieve a list of the blacklists that your dedicated IP addresses appear on.</p>
      */
     getBlacklistReports(args: GetBlacklistReportsCommandInput, options?: __HttpHandlerOptions): Promise<GetBlacklistReportsCommandOutput>;
     getBlacklistReports(args: GetBlacklistReportsCommandInput, cb: (err: any, data?: GetBlacklistReportsCommandOutput) => void): void;
     getBlacklistReports(args: GetBlacklistReportsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetBlacklistReportsCommandOutput) => void): void;
     /**
+     * @public
      * <p>Get information about an existing configuration set, including the dedicated IP pool
      *             that it's associated with, whether or not it's enabled for sending email, and
      *             more.</p>
@@ -198,6 +211,7 @@ export declare class PinpointEmail extends PinpointEmailClient {
     getConfigurationSet(args: GetConfigurationSetCommandInput, cb: (err: any, data?: GetConfigurationSetCommandOutput) => void): void;
     getConfigurationSet(args: GetConfigurationSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetConfigurationSetCommandOutput) => void): void;
     /**
+     * @public
      * <p>Retrieve a list of event destinations that are associated with a configuration
      *             set.</p>
      *         <p>In Amazon Pinpoint, <i>events</i> include message sends, deliveries, opens,
@@ -210,6 +224,7 @@ export declare class PinpointEmail extends PinpointEmailClient {
     getConfigurationSetEventDestinations(args: GetConfigurationSetEventDestinationsCommandInput, cb: (err: any, data?: GetConfigurationSetEventDestinationsCommandOutput) => void): void;
     getConfigurationSetEventDestinations(args: GetConfigurationSetEventDestinationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetConfigurationSetEventDestinationsCommandOutput) => void): void;
     /**
+     * @public
      * <p>Get information about a dedicated IP address, including the name of the dedicated IP
      *             pool that it's associated with, as well information about the automatic warm-up process
      *             for the address.</p>
@@ -218,6 +233,7 @@ export declare class PinpointEmail extends PinpointEmailClient {
     getDedicatedIp(args: GetDedicatedIpCommandInput, cb: (err: any, data?: GetDedicatedIpCommandOutput) => void): void;
     getDedicatedIp(args: GetDedicatedIpCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDedicatedIpCommandOutput) => void): void;
     /**
+     * @public
      * <p>List the dedicated IP addresses that are associated with your Amazon Pinpoint
      *             account.</p>
      */
@@ -225,6 +241,7 @@ export declare class PinpointEmail extends PinpointEmailClient {
     getDedicatedIps(args: GetDedicatedIpsCommandInput, cb: (err: any, data?: GetDedicatedIpsCommandOutput) => void): void;
     getDedicatedIps(args: GetDedicatedIpsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDedicatedIpsCommandOutput) => void): void;
     /**
+     * @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
@@ -237,12 +254,14 @@ export declare class PinpointEmail extends PinpointEmailClient {
     getDeliverabilityDashboardOptions(args: GetDeliverabilityDashboardOptionsCommandInput, cb: (err: any, data?: GetDeliverabilityDashboardOptionsCommandOutput) => void): void;
     getDeliverabilityDashboardOptions(args: GetDeliverabilityDashboardOptionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDeliverabilityDashboardOptionsCommandOutput) => void): void;
     /**
+     * @public
      * <p>Retrieve the results of a predictive inbox placement test.</p>
      */
     getDeliverabilityTestReport(args: GetDeliverabilityTestReportCommandInput, options?: __HttpHandlerOptions): Promise<GetDeliverabilityTestReportCommandOutput>;
     getDeliverabilityTestReport(args: GetDeliverabilityTestReportCommandInput, cb: (err: any, data?: GetDeliverabilityTestReportCommandOutput) => void): void;
     getDeliverabilityTestReport(args: GetDeliverabilityTestReportCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDeliverabilityTestReportCommandOutput) => void): void;
     /**
+     * @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>
@@ -252,6 +271,7 @@ export declare class PinpointEmail extends PinpointEmailClient {
     getDomainDeliverabilityCampaign(args: GetDomainDeliverabilityCampaignCommandInput, cb: (err: any, data?: GetDomainDeliverabilityCampaignCommandOutput) => void): void;
     getDomainDeliverabilityCampaign(args: GetDomainDeliverabilityCampaignCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDomainDeliverabilityCampaignCommandOutput) => void): void;
     /**
+     * @public
      * <p>Retrieve inbox placement and engagement rates for the domains that you use to send
      *             email.</p>
      */
@@ -259,6 +279,7 @@ export declare class PinpointEmail extends PinpointEmailClient {
     getDomainStatisticsReport(args: GetDomainStatisticsReportCommandInput, cb: (err: any, data?: GetDomainStatisticsReportCommandOutput) => void): void;
     getDomainStatisticsReport(args: GetDomainStatisticsReportCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDomainStatisticsReportCommandOutput) => void): void;
     /**
+     * @public
      * <p>Provides information about a specific identity associated with your Amazon Pinpoint account,
      *             including the identity's verification status, its DKIM authentication status, and its
      *             custom Mail-From settings.</p>
@@ -267,6 +288,7 @@ export declare class PinpointEmail extends PinpointEmailClient {
     getEmailIdentity(args: GetEmailIdentityCommandInput, cb: (err: any, data?: GetEmailIdentityCommandOutput) => void): void;
     getEmailIdentity(args: GetEmailIdentityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetEmailIdentityCommandOutput) => void): void;
     /**
+     * @public
      * <p>List all of the configuration sets associated with your Amazon Pinpoint account in the current
      *             region.</p>
      *         <p>In Amazon Pinpoint, <i>configuration sets</i> are groups of rules that you can
@@ -279,6 +301,7 @@ export declare class PinpointEmail extends PinpointEmailClient {
     listConfigurationSets(args: ListConfigurationSetsCommandInput, cb: (err: any, data?: ListConfigurationSetsCommandOutput) => void): void;
     listConfigurationSets(args: ListConfigurationSetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListConfigurationSetsCommandOutput) => void): void;
     /**
+     * @public
      * <p>List all of the dedicated IP pools that exist in your Amazon Pinpoint account in the current
      *             AWS Region.</p>
      */
@@ -286,6 +309,7 @@ export declare class PinpointEmail extends PinpointEmailClient {
     listDedicatedIpPools(args: ListDedicatedIpPoolsCommandInput, cb: (err: any, data?: ListDedicatedIpPoolsCommandOutput) => void): void;
     listDedicatedIpPools(args: ListDedicatedIpPoolsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDedicatedIpPoolsCommandOutput) => void): void;
     /**
+     * @public
      * <p>Show a list of the predictive inbox placement tests that you've performed, regardless of their statuses. For
      *             predictive inbox placement tests that are complete, you can use the <code>GetDeliverabilityTestReport</code>
      *             operation to view the results.</p>
@@ -294,6 +318,7 @@ export declare class PinpointEmail extends PinpointEmailClient {
     listDeliverabilityTestReports(args: ListDeliverabilityTestReportsCommandInput, cb: (err: any, data?: ListDeliverabilityTestReportsCommandOutput) => void): void;
     listDeliverabilityTestReports(args: ListDeliverabilityTestReportsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDeliverabilityTestReportsCommandOutput) => void): void;
     /**
+     * @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)
@@ -303,6 +328,7 @@ export declare class PinpointEmail extends PinpointEmailClient {
     listDomainDeliverabilityCampaigns(args: ListDomainDeliverabilityCampaignsCommandInput, cb: (err: any, data?: ListDomainDeliverabilityCampaignsCommandOutput) => void): void;
     listDomainDeliverabilityCampaigns(args: ListDomainDeliverabilityCampaignsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDomainDeliverabilityCampaignsCommandOutput) => void): void;
     /**
+     * @public
      * <p>Returns a list of all of the email identities that are associated with your Amazon Pinpoint
      *             account. An identity can be either an email address or a domain. This operation returns
      *             identities that are verified as well as those that aren't.</p>
@@ -311,6 +337,7 @@ export declare class PinpointEmail extends PinpointEmailClient {
     listEmailIdentities(args: ListEmailIdentitiesCommandInput, cb: (err: any, data?: ListEmailIdentitiesCommandOutput) => void): void;
     listEmailIdentities(args: ListEmailIdentitiesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListEmailIdentitiesCommandOutput) => void): void;
     /**
+     * @public
      * <p>Retrieve a list of the tags (keys and values) that are associated with a specified
      *             resource. A <i>tag</i> is a label that you optionally define and associate
      *             with a resource in Amazon Pinpoint. Each tag consists of a required <i>tag
@@ -322,18 +349,21 @@ export declare class PinpointEmail extends PinpointEmailClient {
     listTagsForResource(args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
     listTagsForResource(args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
     /**
+     * @public
      * <p>Enable or disable the automatic warm-up feature for dedicated IP addresses.</p>
      */
     putAccountDedicatedIpWarmupAttributes(args: PutAccountDedicatedIpWarmupAttributesCommandInput, options?: __HttpHandlerOptions): Promise<PutAccountDedicatedIpWarmupAttributesCommandOutput>;
     putAccountDedicatedIpWarmupAttributes(args: PutAccountDedicatedIpWarmupAttributesCommandInput, cb: (err: any, data?: PutAccountDedicatedIpWarmupAttributesCommandOutput) => void): void;
     putAccountDedicatedIpWarmupAttributes(args: PutAccountDedicatedIpWarmupAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutAccountDedicatedIpWarmupAttributesCommandOutput) => void): void;
     /**
+     * @public
      * <p>Enable or disable the ability of your account to send email.</p>
      */
     putAccountSendingAttributes(args: PutAccountSendingAttributesCommandInput, options?: __HttpHandlerOptions): Promise<PutAccountSendingAttributesCommandOutput>;
     putAccountSendingAttributes(args: PutAccountSendingAttributesCommandInput, cb: (err: any, data?: PutAccountSendingAttributesCommandOutput) => void): void;
     putAccountSendingAttributes(args: PutAccountSendingAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutAccountSendingAttributesCommandOutput) => void): void;
     /**
+     * @public
      * <p>Associate a configuration set with a dedicated IP pool. You can use dedicated IP pools
      *             to create groups of dedicated IP addresses for sending specific types of email.</p>
      */
@@ -341,6 +371,7 @@ export declare class PinpointEmail extends PinpointEmailClient {
     putConfigurationSetDeliveryOptions(args: PutConfigurationSetDeliveryOptionsCommandInput, cb: (err: any, data?: PutConfigurationSetDeliveryOptionsCommandOutput) => void): void;
     putConfigurationSetDeliveryOptions(args: PutConfigurationSetDeliveryOptionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutConfigurationSetDeliveryOptionsCommandOutput) => void): void;
     /**
+     * @public
      * <p>Enable or disable collection of reputation metrics for emails that you send using a
      *             particular configuration set in a specific AWS Region.</p>
      */
@@ -348,6 +379,7 @@ export declare class PinpointEmail extends PinpointEmailClient {
     putConfigurationSetReputationOptions(args: PutConfigurationSetReputationOptionsCommandInput, cb: (err: any, data?: PutConfigurationSetReputationOptionsCommandOutput) => void): void;
     putConfigurationSetReputationOptions(args: PutConfigurationSetReputationOptionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutConfigurationSetReputationOptionsCommandOutput) => void): void;
     /**
+     * @public
      * <p>Enable or disable email sending for messages that use a particular configuration set
      *             in a specific AWS Region.</p>
      */
@@ -355,6 +387,7 @@ export declare class PinpointEmail extends PinpointEmailClient {
     putConfigurationSetSendingOptions(args: PutConfigurationSetSendingOptionsCommandInput, cb: (err: any, data?: PutConfigurationSetSendingOptionsCommandOutput) => void): void;
     putConfigurationSetSendingOptions(args: PutConfigurationSetSendingOptionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutConfigurationSetSendingOptionsCommandOutput) => void): void;
     /**
+     * @public
      * <p>Specify a custom domain to use for open and click tracking elements in email that you
      *             send using Amazon Pinpoint.</p>
      */
@@ -362,6 +395,7 @@ export declare class PinpointEmail extends PinpointEmailClient {
     putConfigurationSetTrackingOptions(args: PutConfigurationSetTrackingOptionsCommandInput, cb: (err: any, data?: PutConfigurationSetTrackingOptionsCommandOutput) => void): void;
     putConfigurationSetTrackingOptions(args: PutConfigurationSetTrackingOptionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutConfigurationSetTrackingOptionsCommandOutput) => void): void;
     /**
+     * @public
      * <p>Move a dedicated IP address to an existing dedicated IP pool.</p>
      *         <note>
      *             <p>The dedicated IP address that you specify must already exist, and must be
@@ -377,12 +411,14 @@ export declare class PinpointEmail extends PinpointEmailClient {
     putDedicatedIpInPool(args: PutDedicatedIpInPoolCommandInput, cb: (err: any, data?: PutDedicatedIpInPoolCommandOutput) => void): void;
     putDedicatedIpInPool(args: PutDedicatedIpInPoolCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutDedicatedIpInPoolCommandOutput) => void): void;
     /**
+     * @public
      * <p></p>
      */
     putDedicatedIpWarmupAttributes(args: PutDedicatedIpWarmupAttributesCommandInput, options?: __HttpHandlerOptions): Promise<PutDedicatedIpWarmupAttributesCommandOutput>;
     putDedicatedIpWarmupAttributes(args: PutDedicatedIpWarmupAttributesCommandInput, cb: (err: any, data?: PutDedicatedIpWarmupAttributesCommandOutput) => void): void;
     putDedicatedIpWarmupAttributes(args: PutDedicatedIpWarmupAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutDedicatedIpWarmupAttributesCommandOutput) => void): void;
     /**
+     * @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
@@ -395,12 +431,14 @@ export declare class PinpointEmail extends PinpointEmailClient {
     putDeliverabilityDashboardOption(args: PutDeliverabilityDashboardOptionCommandInput, cb: (err: any, data?: PutDeliverabilityDashboardOptionCommandOutput) => void): void;
     putDeliverabilityDashboardOption(args: PutDeliverabilityDashboardOptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutDeliverabilityDashboardOptionCommandOutput) => void): void;
     /**
+     * @public
      * <p>Used to enable or disable DKIM authentication for an email identity.</p>
      */
     putEmailIdentityDkimAttributes(args: PutEmailIdentityDkimAttributesCommandInput, options?: __HttpHandlerOptions): Promise<PutEmailIdentityDkimAttributesCommandOutput>;
     putEmailIdentityDkimAttributes(args: PutEmailIdentityDkimAttributesCommandInput, cb: (err: any, data?: PutEmailIdentityDkimAttributesCommandOutput) => void): void;
     putEmailIdentityDkimAttributes(args: PutEmailIdentityDkimAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutEmailIdentityDkimAttributesCommandOutput) => void): void;
     /**
+     * @public
      * <p>Used to enable or disable feedback forwarding for an identity. This setting determines
      *             what happens when an identity is used to send an email that results in a bounce or
      *             complaint event.</p>
@@ -417,6 +455,7 @@ export declare class PinpointEmail extends PinpointEmailClient {
     putEmailIdentityFeedbackAttributes(args: PutEmailIdentityFeedbackAttributesCommandInput, cb: (err: any, data?: PutEmailIdentityFeedbackAttributesCommandOutput) => void): void;
     putEmailIdentityFeedbackAttributes(args: PutEmailIdentityFeedbackAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutEmailIdentityFeedbackAttributesCommandOutput) => void): void;
     /**
+     * @public
      * <p>Used to enable or disable the custom Mail-From domain configuration for an email
      *             identity.</p>
      */
@@ -424,6 +463,7 @@ export declare class PinpointEmail extends PinpointEmailClient {
     putEmailIdentityMailFromAttributes(args: PutEmailIdentityMailFromAttributesCommandInput, cb: (err: any, data?: PutEmailIdentityMailFromAttributesCommandOutput) => void): void;
     putEmailIdentityMailFromAttributes(args: PutEmailIdentityMailFromAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutEmailIdentityMailFromAttributesCommandOutput) => void): void;
     /**
+     * @public
      * <p>Sends an email message. You can use the Amazon Pinpoint Email API to send two types of
      *             messages:</p>
      *         <ul>
@@ -447,6 +487,7 @@ export declare class PinpointEmail extends PinpointEmailClient {
     sendEmail(args: SendEmailCommandInput, cb: (err: any, data?: SendEmailCommandOutput) => void): void;
     sendEmail(args: SendEmailCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SendEmailCommandOutput) => void): void;
     /**
+     * @public
      * <p>Add one or more tags (keys and values) to a specified 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 ways,
@@ -461,12 +502,14 @@ export declare class PinpointEmail extends PinpointEmailClient {
     tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
     tagResource(args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
     /**
+     * @public
      * <p>Remove one or more tags (keys and values) from a specified resource.</p>
      */
     untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise<UntagResourceCommandOutput>;
     untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
     untagResource(args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
     /**
+     * @public
      * <p>Update the configuration of an event destination for a configuration set.</p>
      *         <p>In Amazon Pinpoint, <i>events</i> include message sends, deliveries, opens,
      *             clicks, bounces, and complaints. <i>Event destinations</i> are places that

package/dist-types/PinpointEmailClient.d.ts

@@ -50,15 +50,24 @@ import { TagResourceCommandInput, TagResourceCommandOutput } from "./commands/Ta
 import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./commands/UntagResourceCommand";
 import { UpdateConfigurationSetEventDestinationCommandInput, UpdateConfigurationSetEventDestinationCommandOutput } from "./commands/UpdateConfigurationSetEventDestinationCommand";
 import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
+/**
+ * @public
+ */
 export type ServiceInputTypes = CreateConfigurationSetCommandInput | CreateConfigurationSetEventDestinationCommandInput | CreateDedicatedIpPoolCommandInput | CreateDeliverabilityTestReportCommandInput | CreateEmailIdentityCommandInput | DeleteConfigurationSetCommandInput | DeleteConfigurationSetEventDestinationCommandInput | DeleteDedicatedIpPoolCommandInput | DeleteEmailIdentityCommandInput | GetAccountCommandInput | GetBlacklistReportsCommandInput | GetConfigurationSetCommandInput | GetConfigurationSetEventDestinationsCommandInput | GetDedicatedIpCommandInput | GetDedicatedIpsCommandInput | GetDeliverabilityDashboardOptionsCommandInput | GetDeliverabilityTestReportCommandInput | GetDomainDeliverabilityCampaignCommandInput | GetDomainStatisticsReportCommandInput | GetEmailIdentityCommandInput | ListConfigurationSetsCommandInput | ListDedicatedIpPoolsCommandInput | ListDeliverabilityTestReportsCommandInput | ListDomainDeliverabilityCampaignsCommandInput | ListEmailIdentitiesCommandInput | ListTagsForResourceCommandInput | PutAccountDedicatedIpWarmupAttributesCommandInput | PutAccountSendingAttributesCommandInput | PutConfigurationSetDeliveryOptionsCommandInput | PutConfigurationSetReputationOptionsCommandInput | PutConfigurationSetSendingOptionsCommandInput | PutConfigurationSetTrackingOptionsCommandInput | PutDedicatedIpInPoolCommandInput | PutDedicatedIpWarmupAttributesCommandInput | PutDeliverabilityDashboardOptionCommandInput | PutEmailIdentityDkimAttributesCommandInput | PutEmailIdentityFeedbackAttributesCommandInput | PutEmailIdentityMailFromAttributesCommandInput | SendEmailCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateConfigurationSetEventDestinationCommandInput;
+/**
+ * @public
+ */
 export type ServiceOutputTypes = CreateConfigurationSetCommandOutput | CreateConfigurationSetEventDestinationCommandOutput | CreateDedicatedIpPoolCommandOutput | CreateDeliverabilityTestReportCommandOutput | CreateEmailIdentityCommandOutput | DeleteConfigurationSetCommandOutput | DeleteConfigurationSetEventDestinationCommandOutput | DeleteDedicatedIpPoolCommandOutput | DeleteEmailIdentityCommandOutput | GetAccountCommandOutput | GetBlacklistReportsCommandOutput | GetConfigurationSetCommandOutput | GetConfigurationSetEventDestinationsCommandOutput | GetDedicatedIpCommandOutput | GetDedicatedIpsCommandOutput | GetDeliverabilityDashboardOptionsCommandOutput | GetDeliverabilityTestReportCommandOutput | GetDomainDeliverabilityCampaignCommandOutput | GetDomainStatisticsReportCommandOutput | GetEmailIdentityCommandOutput | ListConfigurationSetsCommandOutput | ListDedicatedIpPoolsCommandOutput | ListDeliverabilityTestReportsCommandOutput | ListDomainDeliverabilityCampaignsCommandOutput | ListEmailIdentitiesCommandOutput | ListTagsForResourceCommandOutput | PutAccountDedicatedIpWarmupAttributesCommandOutput | PutAccountSendingAttributesCommandOutput | PutConfigurationSetDeliveryOptionsCommandOutput | PutConfigurationSetReputationOptionsCommandOutput | PutConfigurationSetSendingOptionsCommandOutput | PutConfigurationSetTrackingOptionsCommandOutput | PutDedicatedIpInPoolCommandOutput | PutDedicatedIpWarmupAttributesCommandOutput | PutDeliverabilityDashboardOptionCommandOutput | PutEmailIdentityDkimAttributesCommandOutput | PutEmailIdentityFeedbackAttributesCommandOutput | PutEmailIdentityMailFromAttributesCommandOutput | SendEmailCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateConfigurationSetEventDestinationCommandOutput;
+/**
+ * @public
+ */
 export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
     /**
      * The HTTP handler to use. Fetch in browser and Https in Nodejs.
      */
     requestHandler?: __HttpHandler;
     /**
-     * A constructor for a class implementing the {@link __Checksum} interface
+     * A constructor for a class implementing the {@link @aws-sdk/types#ChecksumConstructor} interface
      * that computes the SHA-256 HMAC or checksum of a string or binary buffer.
      * @internal
      */
@@ -148,23 +157,34 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
      */
     logger?: __Logger;
     /**
-     * The {@link __DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
+     * The {@link @aws-sdk/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
      */
     defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
 }
+/**
+ * @public
+ */
 type PinpointEmailClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & ClientInputEndpointParameters;
 /**
- * The configuration interface of PinpointEmailClient class constructor that set the region, credentials and other options.
+ * @public
+ *
+ *  The configuration interface of PinpointEmailClient class constructor that set the region, credentials and other options.
  */
 export interface PinpointEmailClientConfig extends PinpointEmailClientConfigType {
 }
+/**
+ * @public
+ */
 type PinpointEmailClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
 /**
- * The resolved configuration interface of PinpointEmailClient class. This is resolved and normalized from the {@link PinpointEmailClientConfig | constructor configuration interface}.
+ * @public
+ *
+ *  The resolved configuration interface of PinpointEmailClient class. This is resolved and normalized from the {@link PinpointEmailClientConfig | constructor configuration interface}.
  */
 export interface PinpointEmailClientResolvedConfig extends PinpointEmailClientResolvedConfigType {
 }
 /**
+ * @public
  * <fullname>Amazon Pinpoint Email Service</fullname>
  *         <p>Welcome to the <i>Amazon Pinpoint Email API Reference</i>. This guide provides
  *             information about the Amazon Pinpoint Email API (version 1.0), including supported

package/dist-types/commands/CreateConfigurationSetCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { CreateConfigurationSetRequest, CreateConfigurationSetResponse } from "../models/models_0";
 import { PinpointEmailClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PinpointEmailClient";
 /**
+ * @public
+ *
  * The input for {@link CreateConfigurationSetCommand}.
  */
 export interface CreateConfigurationSetCommandInput extends CreateConfigurationSetRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link CreateConfigurationSetCommand}.
  */
 export interface CreateConfigurationSetCommandOutput extends CreateConfigurationSetResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Create a configuration set. <i>Configuration sets</i> are groups of
  *             rules that you can apply to the emails you send using Amazon Pinpoint. You apply a configuration
  *             set to an email by including a reference to the configuration set in the headers of the
@@ -29,6 +34,8 @@ export interface CreateConfigurationSetCommandOutput extends CreateConfiguration
  * const response = await client.send(command);
  * ```
  *
+ * @param CreateConfigurationSetCommandInput - {@link CreateConfigurationSetCommandInput}
+ * @returns {@link CreateConfigurationSetCommandOutput}
  * @see {@link CreateConfigurationSetCommandInput} for command's `input` shape.
  * @see {@link CreateConfigurationSetCommandOutput} for command's `response` shape.
  * @see {@link PinpointEmailClientResolvedConfig | config} for PinpointEmailClient's `config` shape.
@@ -56,11 +63,20 @@ export interface CreateConfigurationSetCommandOutput extends CreateConfiguration
 export declare class CreateConfigurationSetCommand extends $Command<CreateConfigurationSetCommandInput, CreateConfigurationSetCommandOutput, PinpointEmailClientResolvedConfig> {
     readonly input: CreateConfigurationSetCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: CreateConfigurationSetCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PinpointEmailClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateConfigurationSetCommandInput, CreateConfigurationSetCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/CreateConfigurationSetEventDestinationCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { CreateConfigurationSetEventDestinationRequest, CreateConfigurationSetEventDestinationResponse } from "../models/models_0";
 import { PinpointEmailClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PinpointEmailClient";
 /**
+ * @public
+ *
  * The input for {@link CreateConfigurationSetEventDestinationCommand}.
  */
 export interface CreateConfigurationSetEventDestinationCommandInput extends CreateConfigurationSetEventDestinationRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link CreateConfigurationSetEventDestinationCommand}.
  */
 export interface CreateConfigurationSetEventDestinationCommandOutput extends CreateConfigurationSetEventDestinationResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Create an event destination. 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
@@ -31,6 +36,8 @@ export interface CreateConfigurationSetEventDestinationCommandOutput extends Cre
  * const response = await client.send(command);
  * ```
  *
+ * @param CreateConfigurationSetEventDestinationCommandInput - {@link CreateConfigurationSetEventDestinationCommandInput}
+ * @returns {@link CreateConfigurationSetEventDestinationCommandOutput}
  * @see {@link CreateConfigurationSetEventDestinationCommandInput} for command's `input` shape.
  * @see {@link CreateConfigurationSetEventDestinationCommandOutput} for command's `response` shape.
  * @see {@link PinpointEmailClientResolvedConfig | config} for PinpointEmailClient's `config` shape.
@@ -55,11 +62,20 @@ export interface CreateConfigurationSetEventDestinationCommandOutput extends Cre
 export declare class CreateConfigurationSetEventDestinationCommand extends $Command<CreateConfigurationSetEventDestinationCommandInput, CreateConfigurationSetEventDestinationCommandOutput, PinpointEmailClientResolvedConfig> {
     readonly input: CreateConfigurationSetEventDestinationCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: CreateConfigurationSetEventDestinationCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PinpointEmailClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateConfigurationSetEventDestinationCommandInput, CreateConfigurationSetEventDestinationCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/CreateDedicatedIpPoolCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { CreateDedicatedIpPoolRequest, CreateDedicatedIpPoolResponse } from "../models/models_0";
 import { PinpointEmailClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PinpointEmailClient";
 /**
+ * @public
+ *
  * The input for {@link CreateDedicatedIpPoolCommand}.
  */
 export interface CreateDedicatedIpPoolCommandInput extends CreateDedicatedIpPoolRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link CreateDedicatedIpPoolCommand}.
  */
 export interface CreateDedicatedIpPoolCommandOutput extends CreateDedicatedIpPoolResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Create a new pool of dedicated IP addresses. A pool can include one or more dedicated
  *             IP addresses that are associated with your Amazon Pinpoint account. You can associate a pool with
  *             a configuration set. When you send an email that uses that configuration set, Amazon Pinpoint
@@ -28,6 +33,8 @@ export interface CreateDedicatedIpPoolCommandOutput extends CreateDedicatedIpPoo
  * const response = await client.send(command);
  * ```
  *
+ * @param CreateDedicatedIpPoolCommandInput - {@link CreateDedicatedIpPoolCommandInput}
+ * @returns {@link CreateDedicatedIpPoolCommandOutput}
  * @see {@link CreateDedicatedIpPoolCommandInput} for command's `input` shape.
  * @see {@link CreateDedicatedIpPoolCommandOutput} for command's `response` shape.
  * @see {@link PinpointEmailClientResolvedConfig | config} for PinpointEmailClient's `config` shape.
@@ -52,11 +59,20 @@ export interface CreateDedicatedIpPoolCommandOutput extends CreateDedicatedIpPoo
 export declare class CreateDedicatedIpPoolCommand extends $Command<CreateDedicatedIpPoolCommandInput, CreateDedicatedIpPoolCommandOutput, PinpointEmailClientResolvedConfig> {
     readonly input: CreateDedicatedIpPoolCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: CreateDedicatedIpPoolCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PinpointEmailClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateDedicatedIpPoolCommandInput, CreateDedicatedIpPoolCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/CreateDeliverabilityTestReportCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { CreateDeliverabilityTestReportRequest, CreateDeliverabilityTestReportResponse } from "../models/models_0";
 import { PinpointEmailClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PinpointEmailClient";
 /**
+ * @public
+ *
  * The input for {@link CreateDeliverabilityTestReportCommand}.
  */
 export interface CreateDeliverabilityTestReportCommandInput extends CreateDeliverabilityTestReportRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link CreateDeliverabilityTestReportCommand}.
  */
 export interface CreateDeliverabilityTestReportCommandOutput extends CreateDeliverabilityTestReportResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Create a new predictive inbox placement test. Predictive inbox placement tests can help you predict how your messages will be handled
  *             by various email providers around the world. When you perform a predictive inbox placement test, you provide a
  *             sample message that contains the content that you plan to send to your customers. Amazon Pinpoint
@@ -31,6 +36,8 @@ export interface CreateDeliverabilityTestReportCommandOutput extends CreateDeliv
  * const response = await client.send(command);
  * ```
  *
+ * @param CreateDeliverabilityTestReportCommandInput - {@link CreateDeliverabilityTestReportCommandInput}
+ * @returns {@link CreateDeliverabilityTestReportCommandOutput}
  * @see {@link CreateDeliverabilityTestReportCommandInput} for command's `input` shape.
  * @see {@link CreateDeliverabilityTestReportCommandOutput} for command's `response` shape.
  * @see {@link PinpointEmailClientResolvedConfig | config} for PinpointEmailClient's `config` shape.
@@ -69,11 +76,20 @@ export interface CreateDeliverabilityTestReportCommandOutput extends CreateDeliv
 export declare class CreateDeliverabilityTestReportCommand extends $Command<CreateDeliverabilityTestReportCommandInput, CreateDeliverabilityTestReportCommandOutput, PinpointEmailClientResolvedConfig> {
     readonly input: CreateDeliverabilityTestReportCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: CreateDeliverabilityTestReportCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PinpointEmailClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateDeliverabilityTestReportCommandInput, CreateDeliverabilityTestReportCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }