Welcome to the Amazon Pinpoint Email API Reference. This guide provides + * information about the Amazon Pinpoint Email API (version 1.0), including supported + * operations, data types, parameters, and schemas.
+ *+ * Amazon Pinpoint is an AWS service that you + * can use to engage with your customers across multiple messaging channels. You can use + * Amazon Pinpoint to send email, SMS text messages, voice messages, and push notifications. The + * Amazon Pinpoint Email API provides programmatic access to options that are unique to the + * email channel and supplement the options provided by the Amazon Pinpoint API.
+ *If you're new to Amazon Pinpoint, you might find it helpful to also review the Amazon + * Pinpoint Developer Guide. The Amazon Pinpoint Developer + * Guide provides tutorials, code samples, and procedures that demonstrate + * how to use Amazon Pinpoint features programmatically and how to integrate Amazon Pinpoint functionality into + * mobile apps and other types of applications. The guide also provides information about + * key topics such as Amazon Pinpoint integration with other AWS services and the limits that apply + * to using the service.
+ *The Amazon Pinpoint Email API is available in several AWS Regions and it provides an endpoint + * for each of these Regions. For a list of all the Regions and endpoints where the API is + * currently available, see AWS Service Endpoints in + * the Amazon Web Services General Reference. To learn more about AWS Regions, see + * Managing AWS + * Regions in the Amazon Web Services General Reference.
+ *In each Region, AWS maintains multiple Availability Zones. These Availability Zones + * are physically isolated from each other, but are united by private, low-latency, + * high-throughput, and highly redundant network connections. These Availability Zones + * enable us to provide very high levels of availability and redundancy, while also + * minimizing latency. To learn more about the number of Availability Zones that are + * available in each Region, see AWS Global Infrastructure.
+ * + */ +export class PinpointEmail extends PinpointEmailClient { + /** + * + *Create an event destination. In Amazon Pinpoint, events include message + * sends, deliveries, opens, clicks, bounces, and complaints. Event + * destinations are places that you can send information about these events + * to. For example, you can send event data to Amazon SNS to receive notifications when you + * receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term + * storage.
+ *A single configuration set can include more than one event destination.
+ * + */ + public createConfigurationSetEventDestination( + args: CreateConfigurationSetEventDestinationCommandInput, + options?: __HttpHandlerOptions + ): PromiseEnable or disable the ability of your account to send email.
+ * + */ + public putAccountSendingAttributes( + args: PutAccountSendingAttributesCommandInput, + options?: __HttpHandlerOptions + ): PromiseDeletes an email identity that you previously verified for use with Amazon Pinpoint. An identity + * can be either an email address or a domain name.
+ * + */ + public deleteEmailIdentity( + args: DeleteEmailIdentityCommandInput, + options?: __HttpHandlerOptions + ): PromiseAssociate 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.
+ * + */ + public putConfigurationSetDeliveryOptions( + args: PutConfigurationSetDeliveryOptionsCommandInput, + options?: __HttpHandlerOptions + ): PromiseDelete 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.
+ * + */ + public deleteConfigurationSetEventDestination( + args: DeleteConfigurationSetEventDestinationCommandInput, + options?: __HttpHandlerOptions + ): PromiseCreate a new predictive inbox placement test. Predictive inbox placement tests can help you predict how your messages will be handled
+ * by various email providers around the world. When you perform a predictive inbox placement test, you provide a
+ * sample message that contains the content that you plan to send to your customers. Amazon Pinpoint
+ * then sends that message to special email addresses spread across several major email
+ * providers. After about 24 hours, the test is complete, and you can use the
+ * GetDeliverabilityTestReport operation to view the results of the
+ * test.
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 GetDeliverabilityTestReport
+ * operation to view the results.
Verifies an email identity for use with Amazon Pinpoint. In Amazon Pinpoint, an identity is an email + * address or domain that you use when you send email. Before you can use an identity to + * send email with Amazon Pinpoint, you first have to verify it. By verifying an address, you + * demonstrate that you're the owner of the address, and that you've given Amazon Pinpoint permission + * to send email from the address.
+ *When you verify an email address, Amazon Pinpoint sends an email to the address. Your email + * address is verified as soon as you follow the link in the verification email. + * + *
+ *When you verify a domain, this operation provides a set of DKIM tokens, which you can + * convert into CNAME tokens. You add these CNAME tokens to the DNS configuration for your + * domain. Your domain is verified when Amazon Pinpoint detects these records in the DNS + * configuration for your domain. It usually takes around 72 hours to complete the domain + * verification process.
+ * + */ + public createEmailIdentity( + args: CreateEmailIdentityCommandInput, + options?: __HttpHandlerOptions + ): PromiseMove a dedicated IP address to an existing dedicated IP pool.
+ *The dedicated IP address that you specify must already exist, and must be + * associated with your Amazon Pinpoint account. + * + *
+ *The dedicated IP pool you specify must already exist. You can create a new pool by
+ * using the CreateDedicatedIpPool operation.
Create a configuration set. Configuration sets are groups of + * rules that you can apply to the emails you send using Amazon Pinpoint. You apply a configuration + * set to an email by including a reference to the configuration set in the headers of the + * email. When you apply a configuration set to an email, all of the rules in that + * configuration set are applied to the email.
+ * + */ + public createConfigurationSet( + args: CreateConfigurationSetCommandInput, + options?: __HttpHandlerOptions + ): PromiseAdd 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.
+ * + */ + public tagResource( + args: TagResourceCommandInput, + options?: __HttpHandlerOptions + ): PromiseRetrieve 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.
+ * + */ + public getDeliverabilityDashboardOptions( + args: GetDeliverabilityDashboardOptionsCommandInput, + options?: __HttpHandlerOptions + ): PromiseUsed to enable or disable DKIM authentication for an email identity.
+ * + */ + public putEmailIdentityDkimAttributes( + args: PutEmailIdentityDkimAttributesCommandInput, + options?: __HttpHandlerOptions + ): PromiseList all of the configuration sets associated with your Amazon Pinpoint account in the current + * region.
+ *In Amazon Pinpoint, configuration sets are groups of rules that you can + * apply to the emails you send. You apply a configuration set to an email by including a + * reference to the configuration set in the headers of the email. When you apply a + * configuration set to an email, all of the rules in that configuration set are applied to + * the email.
+ * + */ + public listConfigurationSets( + args: ListConfigurationSetsCommandInput, + options?: __HttpHandlerOptions + ): PromiseProvides 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.
+ * + */ + public getEmailIdentity( + args: GetEmailIdentityCommandInput, + options?: __HttpHandlerOptions + ): PromiseList all of the dedicated IP pools that exist in your Amazon Pinpoint account in the current + * AWS Region.
+ * + */ + public listDedicatedIpPools( + args: ListDedicatedIpPoolsCommandInput, + options?: __HttpHandlerOptions + ): PromiseEnable or disable email sending for messages that use a particular configuration set + * in a specific AWS Region.
+ * + */ + public putConfigurationSetSendingOptions( + args: PutConfigurationSetSendingOptionsCommandInput, + options?: __HttpHandlerOptions + ): PromiseObtain information about the email-sending status and capabilities of your Amazon Pinpoint + * account in the current AWS Region.
+ * + */ + public getAccount( + args: GetAccountCommandInput, + options?: __HttpHandlerOptions + ): PromiseEnable or disable the automatic warm-up feature for dedicated IP addresses.
+ * + */ + public putAccountDedicatedIpWarmupAttributes( + args: PutAccountDedicatedIpWarmupAttributesCommandInput, + options?: __HttpHandlerOptions + ): PromiseEnable 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.
+ * + */ + public putDeliverabilityDashboardOption( + args: PutDeliverabilityDashboardOptionCommandInput, + options?: __HttpHandlerOptions + ): PromiseRetrieve 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).
Delete an existing configuration set.
+ *In Amazon Pinpoint, configuration sets are groups of rules that you can + * apply to the emails you send. You apply a configuration set to an email by including a + * reference to the configuration set in the headers of the email. When you apply a + * configuration set to an email, all of the rules in that configuration set are applied to + * the email.
+ * + */ + public deleteConfigurationSet( + args: DeleteConfigurationSetCommandInput, + options?: __HttpHandlerOptions + ): PromiseSends an email message. You can use the Amazon Pinpoint Email API to send two types of + * messages:
+ *+ * Simple – A standard email message. When + * you create this type of message, you specify the sender, the recipient, and the + * message body, and Amazon Pinpoint assembles the message for you.
+ *+ * Raw – A raw, MIME-formatted email + * message. When you send this type of email, you have to specify all of the + * message headers, as well as the message body. You can use this message type to + * send messages that contain attachments. The message that you specify has to be a + * valid MIME message.
+ *Specify a custom domain to use for open and click tracking elements in email that you + * send using Amazon Pinpoint.
+ * + * + */ + public putConfigurationSetTrackingOptions( + args: PutConfigurationSetTrackingOptionsCommandInput, + options?: __HttpHandlerOptions + ): PromiseDelete a dedicated IP pool.
+ * + */ + public deleteDedicatedIpPool( + args: DeleteDedicatedIpPoolCommandInput, + options?: __HttpHandlerOptions + ): PromiseUsed to enable or disable the custom Mail-From domain configuration for an email + * identity.
+ * + */ + public putEmailIdentityMailFromAttributes( + args: PutEmailIdentityMailFromAttributesCommandInput, + options?: __HttpHandlerOptions + ): PromiseRetrieve the results of a predictive inbox placement test.
+ * + */ + public getDeliverabilityTestReport( + args: GetDeliverabilityTestReportCommandInput, + options?: __HttpHandlerOptions + ): PromiseList the dedicated IP addresses that are associated with your Amazon Pinpoint + * account.
+ * + */ + public getDedicatedIps( + args: GetDedicatedIpsCommandInput, + options?: __HttpHandlerOptions + ): PromiseRemove one or more tags (keys and values) from a specified resource.
+ * + */ + public untagResource( + args: UntagResourceCommandInput, + options?: __HttpHandlerOptions + ): PromiseRetrieve 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.
+ * + */ + public listTagsForResource( + args: ListTagsForResourceCommandInput, + options?: __HttpHandlerOptions + ): PromiseEnable or disable collection of reputation metrics for emails that you send using a + * particular configuration set in a specific AWS Region.
+ * + */ + public putConfigurationSetReputationOptions( + args: PutConfigurationSetReputationOptionsCommandInput, + options?: __HttpHandlerOptions + ): PromiseGet information about an existing configuration set, including the dedicated IP pool + * that it's associated with, whether or not it's enabled for sending email, and + * more.
+ *In Amazon Pinpoint, configuration sets are groups of rules that you can + * apply to the emails you send. You apply a configuration set to an email by including a + * reference to the configuration set in the headers of the email. When you apply a + * configuration set to an email, all of the rules in that configuration set are applied to + * the email.
+ * + */ + public getConfigurationSet( + args: GetConfigurationSetCommandInput, + options?: __HttpHandlerOptions + ): PromiseReturns 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.
+ * + */ + public listEmailIdentities( + args: ListEmailIdentitiesCommandInput, + options?: __HttpHandlerOptions + ): PromiseCreate a new pool of dedicated IP addresses. A pool can include one or more dedicated + * IP addresses that are associated with your Amazon Pinpoint account. You can associate a pool with + * a configuration set. When you send an email that uses that configuration set, Amazon Pinpoint + * sends it using only the IP addresses in the associated pool.
+ * + */ + public createDedicatedIpPool( + args: CreateDedicatedIpPoolCommandInput, + options?: __HttpHandlerOptions + ): PromiseRetrieve inbox placement and engagement rates for the domains that you use to send + * email.
+ * + */ + public getDomainStatisticsReport( + args: GetDomainStatisticsReportCommandInput, + options?: __HttpHandlerOptions + ): PromiseUpdate the configuration of an event destination for a configuration set.
+ *In Amazon Pinpoint, events include message sends, deliveries, opens, + * clicks, bounces, and complaints. Event destinations are places that + * you can send information about these events to. For example, you can send event data to + * Amazon SNS to receive notifications when you receive bounces or complaints, or you can use + * Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage.
+ * + */ + public updateConfigurationSetEventDestination( + args: UpdateConfigurationSetEventDestinationCommandInput, + options?: __HttpHandlerOptions + ): PromiseUsed 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.
+ *When you enable feedback forwarding, Amazon Pinpoint sends you email notifications when bounce + * or complaint events occur. Amazon Pinpoint sends this notification to the address that you + * specified in the Return-Path header of the original email.
+ *When you disable feedback forwarding, Amazon Pinpoint sends notifications through other + * mechanisms, such as by notifying an Amazon SNS topic. You're required to have a method of + * tracking bounces and complaints. If you haven't set up another mechanism for receiving + * bounce or complaint notifications, Amazon Pinpoint sends an email notification when these events + * occur (even if this setting is disabled).
+ * + */ + public putEmailIdentityFeedbackAttributes( + args: PutEmailIdentityFeedbackAttributesCommandInput, + options?: __HttpHandlerOptions + ): PromiseRetrieve a list of event destinations that are associated with a configuration + * set.
+ *In Amazon Pinpoint, events include message sends, deliveries, opens, + * clicks, bounces, and complaints. Event destinations are places that + * you can send information about these events to. For example, you can send event data to + * Amazon SNS to receive notifications when you receive bounces or complaints, or you can use + * Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage.
+ * + */ + public getConfigurationSetEventDestinations( + args: GetConfigurationSetEventDestinationsCommandInput, + options?: __HttpHandlerOptions + ): PromiseGet 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.
+ * + */ + public getDedicatedIp( + args: GetDedicatedIpCommandInput, + options?: __HttpHandlerOptions + ): PromiseRetrieve 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 a list of the blacklists that your dedicated IP addresses appear on.
+ * + */ + public getBlacklistReports( + args: GetBlacklistReportsCommandInput, + options?: __HttpHandlerOptions + ): PromiseWelcome to the Amazon Pinpoint Email API Reference. This guide provides + * information about the Amazon Pinpoint Email API (version 1.0), including supported + * operations, data types, parameters, and schemas.
+ *+ * Amazon Pinpoint is an AWS service that you + * can use to engage with your customers across multiple messaging channels. You can use + * Amazon Pinpoint to send email, SMS text messages, voice messages, and push notifications. The + * Amazon Pinpoint Email API provides programmatic access to options that are unique to the + * email channel and supplement the options provided by the Amazon Pinpoint API.
+ *If you're new to Amazon Pinpoint, you might find it helpful to also review the Amazon + * Pinpoint Developer Guide. The Amazon Pinpoint Developer + * Guide provides tutorials, code samples, and procedures that demonstrate + * how to use Amazon Pinpoint features programmatically and how to integrate Amazon Pinpoint functionality into + * mobile apps and other types of applications. The guide also provides information about + * key topics such as Amazon Pinpoint integration with other AWS services and the limits that apply + * to using the service.
+ *The Amazon Pinpoint Email API is available in several AWS Regions and it provides an endpoint + * for each of these Regions. For a list of all the Regions and endpoints where the API is + * currently available, see AWS Service Endpoints in + * the Amazon Web Services General Reference. To learn more about AWS Regions, see + * Managing AWS + * Regions in the Amazon Web Services General Reference.
+ *In each Region, AWS maintains multiple Availability Zones. These Availability Zones + * are physically isolated from each other, but are united by private, low-latency, + * high-throughput, and highly redundant network connections. These Availability Zones + * enable us to provide very high levels of availability and redundancy, while also + * minimizing latency. To learn more about the number of Availability Zones that are + * available in each Region, see AWS Global Infrastructure.
+ * + */ +export class PinpointEmailClient extends __Client< + __HttpHandlerOptions, + ServiceInputTypes, + ServiceOutputTypes, + PinpointEmailClientResolvedConfig +> { + readonly config: PinpointEmailClientResolvedConfig; + + constructor(configuration: PinpointEmailClientConfig) { + let _config_0 = { + ...__ClientDefaultValues, + ...configuration + }; + let _config_1 = resolveRegionConfig(_config_0); + let _config_2 = resolveEndpointsConfig(_config_1); + let _config_3 = resolveAwsAuthConfig(_config_2); + let _config_4 = resolveRetryConfig(_config_3); + let _config_5 = resolveUserAgentConfig(_config_4); + let _config_6 = resolveHostHeaderConfig(_config_5); + super(_config_6); + this.config = _config_6; + this.middlewareStack.use(getAwsAuthPlugin(this.config)); + this.middlewareStack.use(getRetryPlugin(this.config)); + this.middlewareStack.use(getUserAgentPlugin(this.config)); + this.middlewareStack.use(getContentLengthPlugin(this.config)); + this.middlewareStack.use(getHostHeaderPlugin(this.config)); + } + + destroy(): void {} +} diff --git a/clients/client-pinpoint-email/README.md b/clients/client-pinpoint-email/README.md new file mode 100644 index 000000000000..84760f537533 --- /dev/null +++ b/clients/client-pinpoint-email/README.md @@ -0,0 +1,6 @@ +@aws-sdk/client-pinpoint-email + +[](https://www.npmjs.com/package/@aws-sdk/client-pinpoint-email) +[](https://www.npmjs.com/package/@aws-sdk/client-pinpoint-email) + +For SDK usage, please step to [SDK reademe](https://github.com/aws/aws-sdk-js-v3). diff --git a/clients/client-pinpoint-email/commands/CreateConfigurationSetCommand.ts b/clients/client-pinpoint-email/commands/CreateConfigurationSetCommand.ts new file mode 100644 index 000000000000..8b260a1aeb43 --- /dev/null +++ b/clients/client-pinpoint-email/commands/CreateConfigurationSetCommand.ts @@ -0,0 +1,93 @@ +import { + PinpointEmailClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes +} from "../PinpointEmailClient"; +import { + CreateConfigurationSetRequest, + CreateConfigurationSetResponse +} from "../models/index"; +import { + deserializeAws_restJson1_1CreateConfigurationSetCommand, + serializeAws_restJson1_1CreateConfigurationSetCommand +} from "../protocols/Aws_restJson1_1"; +import { getSerdePlugin } from "@aws-sdk/middleware-serde"; +import { + HttpRequest as __HttpRequest, + HttpResponse as __HttpResponse +} from "@aws-sdk/protocol-http"; +import { Command as $Command } from "@aws-sdk/smithy-client"; +import { + FinalizeHandlerArguments, + Handler, + HandlerExecutionContext, + MiddlewareStack, + SerdeContext, + HttpHandlerOptions as __HttpHandlerOptions +} from "@aws-sdk/types"; + +export type CreateConfigurationSetCommandInput = CreateConfigurationSetRequest; +export type CreateConfigurationSetCommandOutput = CreateConfigurationSetResponse; + +export class CreateConfigurationSetCommand extends $Command< + CreateConfigurationSetCommandInput, + CreateConfigurationSetCommandOutput, + PinpointEmailClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + constructor(readonly input: CreateConfigurationSetCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + resolveMiddleware( + clientStack: MiddlewareStackAn object that defines the tags that are associated with a resource. + * A tag is a label that you optionally define and associate with + * a resource in Amazon Pinpoint. Tags can help you categorize and manage resources in different + * ways, such as by purpose, owner, environment, or other criteria. A resource can have as + * many as 50 tags.
+ *Each tag consists of a required tag key and an + * associated tag value, both of which you define. A tag key is a + * general label that acts as a category for a more specific tag value. A tag value acts as + * a descriptor within a tag key. A tag key can contain as many as 128 characters. A tag + * value can contain as many as 256 characters. The characters can be Unicode letters, + * digits, white space, or one of the following symbols: _ . : / = + -. The following + * additional restrictions apply to tags:
+ *Tag keys and values are case sensitive.
+ *For each associated resource, each tag key must be unique and it can have only + * one value.
+ *The aws: prefix is reserved for use by AWS; you can’t use it in
+ * any tag keys or values that you define. In addition, you can't edit or remove
+ * tag keys or values that use this prefix. Tags that use this prefix don’t count
+ * against the limit of 50 tags per resource.
You can associate tags with public or shared resources, but the tags are + * available only for your AWS account, not any other accounts that share the + * resource. In addition, the tags are available only for resources that are + * located in the specified AWS Region for your AWS account.
+ *One part of a key-value pair that defines a tag. The maximum length of a tag key is + * 128 characters. The minimum length is 1 character.
+ * + */ + Key: string | undefined; + + /** + * + *The optional part of a key-value pair that defines a tag. The maximum length of a tag + * value is 256 characters. The minimum length is 0 characters. If you don’t want a + * resource to have a specific tag value, don’t specify a value for this parameter. Amazon Pinpoint + * will set the value to an empty string.
+ * + */ + Value: string | undefined; +} + +export namespace Tag { + export function isa(o: any): o is Tag { + return _smithy.isa(o, "Tag"); + } +} + +/** + * + *The message can't be sent because the account's ability to send email has been + * permanently restricted.
+ * + */ +export interface AccountSuspendedException + extends _smithy.SmithyException, + $MetadataBearer { + __type: "AccountSuspendedException"; + $fault: "client"; + message?: string; +} + +export namespace AccountSuspendedException { + export function isa(o: any): o is AccountSuspendedException { + return _smithy.isa(o, "AccountSuspendedException"); + } +} + +/** + * + *The resource specified in your request already exists.
+ * + */ +export interface AlreadyExistsException + extends _smithy.SmithyException, + $MetadataBearer { + __type: "AlreadyExistsException"; + $fault: "client"; + message?: string; +} + +export namespace AlreadyExistsException { + export function isa(o: any): o is AlreadyExistsException { + return _smithy.isa(o, "AlreadyExistsException"); + } +} + +/** + * + *The input you provided is invalid.
+ * + */ +export interface BadRequestException + extends _smithy.SmithyException, + $MetadataBearer { + __type: "BadRequestException"; + $fault: "client"; + message?: string; +} + +export namespace BadRequestException { + export function isa(o: any): o is BadRequestException { + return _smithy.isa(o, "BadRequestException"); + } +} + +export enum BehaviorOnMxFailure { + REJECT_MESSAGE = "REJECT_MESSAGE", + USE_DEFAULT_VALUE = "USE_DEFAULT_VALUE" +} + +/** + * + *An object that contains information about a blacklisting event that impacts one of the + * dedicated IP addresses that is associated with your account.
+ * + */ +export interface BlacklistEntry { + __type?: "BlacklistEntry"; + /** + * + *Additional information about the blacklisting event, as provided by the blacklist + * maintainer.
+ * + */ + Description?: string; + + /** + * + *The time when the blacklisting event occurred, shown in Unix time format.
+ * + */ + ListingTime?: Date; + + /** + * + *The name of the blacklist that the IP address appears on.
+ * + */ + RblName?: string; +} + +export namespace BlacklistEntry { + export function isa(o: any): o is BlacklistEntry { + return _smithy.isa(o, "BlacklistEntry"); + } +} + +/** + * + *Represents the body of the email message.
+ * + */ +export interface Body { + __type?: "Body"; + /** + * + *An object that represents the version of the message that is displayed in email + * clients that support HTML. HTML messages can include formatted text, hyperlinks, images, + * and more.
+ * + */ + Html?: Content; + + /** + * + *An object that represents the version of the message that is displayed in email + * clients that don't support HTML, or clients where the recipient has disabled HTML + * rendering.
+ * + */ + Text?: Content; +} + +export namespace Body { + export function isa(o: any): o is Body { + return _smithy.isa(o, "Body"); + } +} + +/** + * + *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.
+ * + */ +export interface CloudWatchDestination { + __type?: "CloudWatchDestination"; + /** + * + *An array of objects that define the dimensions to use when you send email events to + * Amazon CloudWatch.
+ * + */ + DimensionConfigurations: ArrayAn object that defines the dimension configuration to use when you send Amazon Pinpoint email + * events to Amazon CloudWatch.
+ * + */ +export interface CloudWatchDimensionConfiguration { + __type?: "CloudWatchDimensionConfiguration"; + /** + * + *The default value of the dimension that is published to Amazon CloudWatch if you don't provide the + * value of the dimension when you send an email. This value has to meet the following + * criteria:
+ *It can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), + * or dashes (-).
+ *It can contain no more than 256 characters.
+ *The name of an Amazon CloudWatch dimension associated with an email sending metric. The name has to + * meet the following criteria:
+ *It can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), + * or dashes (-).
+ *It can contain no more than 256 characters.
+ *The location where Amazon Pinpoint finds the value of a dimension to publish to Amazon CloudWatch. If you
+ * want Amazon Pinpoint to use the message tags that you specify using an X-SES-MESSAGE-TAGS header
+ * or a parameter to the SendEmail/SendRawEmail API, choose messageTag. If you
+ * want Amazon Pinpoint to use your own email headers, choose emailHeader. If you want
+ * Amazon Pinpoint to use link tags, choose linkTags.
The resource is being modified by another operation or thread.
+ * + */ +export interface ConcurrentModificationException + extends _smithy.SmithyException, + $MetadataBearer { + __type: "ConcurrentModificationException"; + $fault: "server"; + message?: string; +} + +export namespace ConcurrentModificationException { + export function isa(o: any): o is ConcurrentModificationException { + return _smithy.isa(o, "ConcurrentModificationException"); + } +} + +/** + * + *An object that represents the content of the email, and optionally a character set + * specification.
+ * + */ +export interface Content { + __type?: "Content"; + /** + * + *The character set for the content. Because of the constraints of the SMTP protocol,
+ * Amazon Pinpoint uses 7-bit ASCII by default. If the text includes characters outside of the ASCII
+ * range, you have to specify a character set. For example, you could specify
+ * UTF-8, ISO-8859-1, or Shift_JIS.
The content of the message itself.
+ * + */ + Data: string | undefined; +} + +export namespace Content { + export function isa(o: any): o is Content { + return _smithy.isa(o, "Content"); + } +} + +/** + * + *A request to add an event destination to a configuration set.
+ * + */ +export interface CreateConfigurationSetEventDestinationRequest { + __type?: "CreateConfigurationSetEventDestinationRequest"; + /** + * + *The name of the configuration set that you want to add an event destination to.
+ * + */ + ConfigurationSetName: string | undefined; + + /** + * + *An object that defines the event destination.
+ * + */ + EventDestination: EventDestinationDefinition | undefined; + + /** + * + *A name that identifies the event destination within the configuration set.
+ * + */ + EventDestinationName: string | undefined; +} + +export namespace CreateConfigurationSetEventDestinationRequest { + export function isa( + o: any + ): o is CreateConfigurationSetEventDestinationRequest { + return _smithy.isa(o, "CreateConfigurationSetEventDestinationRequest"); + } +} + +/** + * + *An HTTP 200 response if the request succeeds, or an error message if the request + * fails.
+ * + */ +export interface CreateConfigurationSetEventDestinationResponse + extends $MetadataBearer { + __type?: "CreateConfigurationSetEventDestinationResponse"; +} + +export namespace CreateConfigurationSetEventDestinationResponse { + export function isa( + o: any + ): o is CreateConfigurationSetEventDestinationResponse { + return _smithy.isa(o, "CreateConfigurationSetEventDestinationResponse"); + } +} + +/** + * + *A request to create a configuration set.
+ * + */ +export interface CreateConfigurationSetRequest { + __type?: "CreateConfigurationSetRequest"; + /** + * + *The name of the configuration set.
+ * + */ + ConfigurationSetName: string | undefined; + + /** + * + *An object that defines the dedicated IP pool that is used to send emails that you send + * using the configuration set.
+ * + */ + DeliveryOptions?: DeliveryOptions; + + /** + * + *An object that defines whether or not Amazon Pinpoint collects reputation metrics for the emails + * that you send that use the configuration set.
+ * + */ + ReputationOptions?: ReputationOptions; + + /** + * + *An object that defines whether or not Amazon Pinpoint can send email that you send using the + * configuration set.
+ * + */ + SendingOptions?: SendingOptions; + + /** + * + *An array of objects that define the tags (keys and values) that you want to associate + * with the configuration set.
+ * + */ + Tags?: ArrayAn object that defines the open and click tracking options for emails that you send + * using the configuration set.
+ * + */ + TrackingOptions?: TrackingOptions; +} + +export namespace CreateConfigurationSetRequest { + export function isa(o: any): o is CreateConfigurationSetRequest { + return _smithy.isa(o, "CreateConfigurationSetRequest"); + } +} + +/** + * + *An HTTP 200 response if the request succeeds, or an error message if the request + * fails.
+ * + */ +export interface CreateConfigurationSetResponse extends $MetadataBearer { + __type?: "CreateConfigurationSetResponse"; +} + +export namespace CreateConfigurationSetResponse { + export function isa(o: any): o is CreateConfigurationSetResponse { + return _smithy.isa(o, "CreateConfigurationSetResponse"); + } +} + +/** + * + *A request to create a new dedicated IP pool.
+ * + */ +export interface CreateDedicatedIpPoolRequest { + __type?: "CreateDedicatedIpPoolRequest"; + /** + * + *The name of the dedicated IP pool.
+ * + */ + PoolName: string | undefined; + + /** + * + *An object that defines the tags (keys and values) that you want to associate with the + * pool.
+ * + */ + Tags?: ArrayAn HTTP 200 response if the request succeeds, or an error message if the request + * fails.
+ * + */ +export interface CreateDedicatedIpPoolResponse extends $MetadataBearer { + __type?: "CreateDedicatedIpPoolResponse"; +} + +export namespace CreateDedicatedIpPoolResponse { + export function isa(o: any): o is CreateDedicatedIpPoolResponse { + return _smithy.isa(o, "CreateDedicatedIpPoolResponse"); + } +} + +/** + * + *A request to perform a predictive inbox placement test. Predictive inbox placement tests can help you predict how your messages will
+ * be handled by various email providers around the world. When you perform a predictive inbox placement test, you
+ * provide a sample message that contains the content that you plan to send to your
+ * customers. Amazon Pinpoint then sends that message to special email addresses spread across
+ * several major email providers. After about 24 hours, the test is complete, and you can
+ * use the GetDeliverabilityTestReport operation to view the results of the
+ * test.
The HTML body of the message that you sent when you performed the predictive inbox placement test.
+ * + */ + Content: EmailContent | undefined; + + /** + * + *The email address that the predictive inbox placement test email was sent from.
+ * + */ + FromEmailAddress: string | undefined; + + /** + * + *A unique name that helps you to identify the predictive inbox placement test when you retrieve the + * results.
+ * + */ + ReportName?: string; + + /** + * + *An array of objects that define the tags (keys and values) that you want to associate + * with the predictive inbox placement test.
+ * + */ + Tags?: ArrayInformation about the predictive inbox placement test that you created.
+ * + */ +export interface CreateDeliverabilityTestReportResponse + extends $MetadataBearer { + __type?: "CreateDeliverabilityTestReportResponse"; + /** + * + *The status of the predictive inbox placement test. If the status is IN_PROGRESS, then the predictive inbox placement test
+ * is currently running. Predictive inbox placement tests are usually complete within 24 hours of creating the
+ * test. If the status is COMPLETE, then the test is finished, and you can use
+ * the GetDeliverabilityTestReport to view the results of the test.
A unique string that identifies the predictive inbox placement test.
+ * + */ + ReportId: string | undefined; +} + +export namespace CreateDeliverabilityTestReportResponse { + export function isa(o: any): o is CreateDeliverabilityTestReportResponse { + return _smithy.isa(o, "CreateDeliverabilityTestReportResponse"); + } +} + +/** + * + *A request to begin the verification process for an email identity (an email address or + * domain).
+ * + */ +export interface CreateEmailIdentityRequest { + __type?: "CreateEmailIdentityRequest"; + /** + * + *The email address or domain that you want to verify.
+ * + */ + EmailIdentity: string | undefined; + + /** + * + *An array of objects that define the tags (keys and values) that you want to associate + * with the email identity.
+ * + */ + Tags?: ArrayIf 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.
+ * + */ +export interface CreateEmailIdentityResponse extends $MetadataBearer { + __type?: "CreateEmailIdentityResponse"; + /** + * + *An object that contains information about the DKIM attributes for the identity. This + * object includes the tokens that you use to create the CNAME records that are required to + * complete the DKIM verification process.
+ * + */ + DkimAttributes?: DkimAttributes; + + /** + * + *The email identity type.
+ * + */ + IdentityType?: IdentityType | string; + + /** + * + *Specifies whether or not the identity is verified. In Amazon Pinpoint, you can only send email + * from verified email addresses or domains. For more information about verifying + * identities, see the Amazon Pinpoint User Guide.
+ * + */ + VerifiedForSendingStatus?: boolean; +} + +export namespace CreateEmailIdentityResponse { + export function isa(o: any): o is CreateEmailIdentityResponse { + return _smithy.isa(o, "CreateEmailIdentityResponse"); + } +} + +/** + * + *An object that contains information about the volume of email sent on each day of the + * analysis period.
+ * + */ +export interface DailyVolume { + __type?: "DailyVolume"; + /** + * + *An object that contains inbox placement metrics for a specified day in the analysis + * period, broken out by the recipient's email provider.
+ * + */ + DomainIspPlacements?: ArrayThe date that the DailyVolume metrics apply to, in Unix time.
+ * + */ + StartDate?: Date; + + /** + * + *An object that contains inbox placement metrics for a specific day in the analysis + * period.
+ * + */ + VolumeStatistics?: VolumeStatistics; +} + +export namespace DailyVolume { + export function isa(o: any): o is DailyVolume { + return _smithy.isa(o, "DailyVolume"); + } +} + +/** + * + *Contains information about a dedicated IP address that is associated with your Amazon Pinpoint + * account.
+ * + * + */ +export interface DedicatedIp { + __type?: "DedicatedIp"; + /** + * + *An IP address that is reserved for use by your Amazon Pinpoint account.
+ * + */ + Ip: string | undefined; + + /** + * + *The name of the dedicated IP pool that the IP address is associated with.
+ * + */ + PoolName?: string; + + /** + * + *Indicates how complete the dedicated IP warm-up process is. When this value equals 1, + * the address has completed the warm-up process and is ready for use.
+ * + */ + WarmupPercentage: number | undefined; + + /** + * + *The warm-up status of a dedicated IP address. The status can have one of the following + * values:
+ *
+ * IN_PROGRESS – The IP address isn't ready to use because the
+ * dedicated IP warm-up process is ongoing.
+ * DONE – The dedicated IP warm-up process is complete, and
+ * the IP address is ready to use.
A request to delete an event destination from a configuration set.
+ * + */ +export interface DeleteConfigurationSetEventDestinationRequest { + __type?: "DeleteConfigurationSetEventDestinationRequest"; + /** + * + *The name of the configuration set that contains the event destination that you want to + * delete.
+ * + */ + ConfigurationSetName: string | undefined; + + /** + * + *The name of the event destination that you want to delete.
+ * + */ + EventDestinationName: string | undefined; +} + +export namespace DeleteConfigurationSetEventDestinationRequest { + export function isa( + o: any + ): o is DeleteConfigurationSetEventDestinationRequest { + return _smithy.isa(o, "DeleteConfigurationSetEventDestinationRequest"); + } +} + +/** + * + *An HTTP 200 response if the request succeeds, or an error message if the request + * fails.
+ * + */ +export interface DeleteConfigurationSetEventDestinationResponse + extends $MetadataBearer { + __type?: "DeleteConfigurationSetEventDestinationResponse"; +} + +export namespace DeleteConfigurationSetEventDestinationResponse { + export function isa( + o: any + ): o is DeleteConfigurationSetEventDestinationResponse { + return _smithy.isa(o, "DeleteConfigurationSetEventDestinationResponse"); + } +} + +/** + * + *A request to delete a configuration set.
+ * + */ +export interface DeleteConfigurationSetRequest { + __type?: "DeleteConfigurationSetRequest"; + /** + * + *The name of the configuration set that you want to delete.
+ * + */ + ConfigurationSetName: string | undefined; +} + +export namespace DeleteConfigurationSetRequest { + export function isa(o: any): o is DeleteConfigurationSetRequest { + return _smithy.isa(o, "DeleteConfigurationSetRequest"); + } +} + +/** + * + *An HTTP 200 response if the request succeeds, or an error message if the request + * fails.
+ * + */ +export interface DeleteConfigurationSetResponse extends $MetadataBearer { + __type?: "DeleteConfigurationSetResponse"; +} + +export namespace DeleteConfigurationSetResponse { + export function isa(o: any): o is DeleteConfigurationSetResponse { + return _smithy.isa(o, "DeleteConfigurationSetResponse"); + } +} + +/** + * + *A request to delete a dedicated IP pool.
+ * + */ +export interface DeleteDedicatedIpPoolRequest { + __type?: "DeleteDedicatedIpPoolRequest"; + /** + * + *The name of the dedicated IP pool that you want to delete.
+ * + */ + PoolName: string | undefined; +} + +export namespace DeleteDedicatedIpPoolRequest { + export function isa(o: any): o is DeleteDedicatedIpPoolRequest { + return _smithy.isa(o, "DeleteDedicatedIpPoolRequest"); + } +} + +/** + * + *An HTTP 200 response if the request succeeds, or an error message if the request + * fails.
+ * + */ +export interface DeleteDedicatedIpPoolResponse extends $MetadataBearer { + __type?: "DeleteDedicatedIpPoolResponse"; +} + +export namespace DeleteDedicatedIpPoolResponse { + export function isa(o: any): o is DeleteDedicatedIpPoolResponse { + return _smithy.isa(o, "DeleteDedicatedIpPoolResponse"); + } +} + +/** + * + *A request to delete an existing email identity. When you delete an identity, you lose + * the ability to use Amazon Pinpoint to send email from that identity. You can restore your ability + * to send email by completing the verification process for the identity again.
+ * + */ +export interface DeleteEmailIdentityRequest { + __type?: "DeleteEmailIdentityRequest"; + /** + * + *The identity (that is, the email address or domain) that you want to delete from your + * Amazon Pinpoint account.
+ * + */ + EmailIdentity: string | undefined; +} + +export namespace DeleteEmailIdentityRequest { + export function isa(o: any): o is DeleteEmailIdentityRequest { + return _smithy.isa(o, "DeleteEmailIdentityRequest"); + } +} + +/** + * + *An HTTP 200 response if the request succeeds, or an error message if the request + * fails.
+ * + */ +export interface DeleteEmailIdentityResponse extends $MetadataBearer { + __type?: "DeleteEmailIdentityResponse"; +} + +export namespace DeleteEmailIdentityResponse { + export function isa(o: any): o is DeleteEmailIdentityResponse { + return _smithy.isa(o, "DeleteEmailIdentityResponse"); + } +} + +export enum DeliverabilityDashboardAccountStatus { + ACTIVE = "ACTIVE", + DISABLED = "DISABLED", + PENDING_EXPIRATION = "PENDING_EXPIRATION" +} + +/** + * + *An object that contains metadata related to a predictive inbox placement test.
+ * + */ +export interface DeliverabilityTestReport { + __type?: "DeliverabilityTestReport"; + /** + * + *The date and time when the predictive inbox placement test was created, in Unix time format.
+ * + */ + CreateDate?: Date; + + /** + * + *The status of the predictive inbox placement test. If the status is IN_PROGRESS, then the predictive inbox placement test
+ * is currently running. Predictive inbox placement tests are usually complete within 24 hours of creating the
+ * test. If the status is COMPLETE, then the test is finished, and you can use
+ * the GetDeliverabilityTestReport to view the results of the test.
The sender address that you specified for the predictive inbox placement test.
+ * + */ + FromEmailAddress?: string; + + /** + * + *A unique string that identifies the predictive inbox placement test.
+ * + */ + ReportId?: string; + + /** + * + *A name that helps you identify a predictive inbox placement test report.
+ * + */ + ReportName?: string; + + /** + * + *The subject line for an email that you submitted in a predictive inbox placement test.
+ * + */ + Subject?: string; +} + +export namespace DeliverabilityTestReport { + export function isa(o: any): o is DeliverabilityTestReport { + return _smithy.isa(o, "DeliverabilityTestReport"); + } +} + +export enum DeliverabilityTestStatus { + COMPLETED = "COMPLETED", + IN_PROGRESS = "IN_PROGRESS" +} + +/** + * + *Used to associate a configuration set with a dedicated IP pool.
+ * + */ +export interface DeliveryOptions { + __type?: "DeliveryOptions"; + /** + * + *The name of the dedicated IP pool that you want to associate with the configuration + * set.
+ * + */ + SendingPoolName?: string; + + /** + * + *Specifies whether messages that use the configuration set are required to use
+ * Transport Layer Security (TLS). If the value is Require, messages are only
+ * delivered if a TLS connection can be established. If the value is Optional,
+ * messages can be delivered in plain text if a TLS connection can't be established.
An object that describes the recipients for an email.
+ * + */ +export interface Destination { + __type?: "Destination"; + /** + * + *An array that contains the email addresses of the "BCC" (blind carbon copy) recipients + * for the email.
+ * + */ + BccAddresses?: ArrayAn array that contains the email addresses of the "CC" (carbon copy) recipients for + * the email.
+ * + */ + CcAddresses?: ArrayAn array that contains the email addresses of the "To" recipients for the + * email.
+ * + */ + ToAddresses?: ArrayAn object that contains information about the DKIM configuration for an email + * identity.
+ * + */ +export interface DkimAttributes { + __type?: "DkimAttributes"; + /** + * + *If the value is true, then the messages that Amazon Pinpoint sends from the
+ * identity are DKIM-signed. If the value is false, then the messages that
+ * Amazon Pinpoint sends from the identity aren't DKIM-signed.
Describes whether or not Amazon Pinpoint has successfully located the DKIM records in the DNS + * records for the domain. The status can be one of the following:
+ *
+ * PENDING – Amazon Pinpoint hasn't yet located the DKIM records in the
+ * DNS configuration for the domain, but will continue to attempt to locate
+ * them.
+ * SUCCESS – Amazon Pinpoint located the DKIM records in the DNS
+ * configuration for the domain and determined that they're correct. Amazon Pinpoint can now
+ * send DKIM-signed email from the identity.
+ * FAILED – Amazon Pinpoint was unable to locate the DKIM records in the
+ * DNS settings for the domain, and won't continue to search for them.
+ * TEMPORARY_FAILURE – A temporary issue occurred, which
+ * prevented Amazon Pinpoint from determining the DKIM status for the domain.
+ * NOT_STARTED – Amazon Pinpoint hasn't yet started searching for the
+ * DKIM records in the DKIM records for the domain.
A set of unique strings that you use to create a set of CNAME records that you add to + * the DNS configuration for your domain. When Amazon Pinpoint detects these records in the DNS + * configuration for your domain, the DKIM authentication process is complete. Amazon Pinpoint + * usually detects these records within about 72 hours of adding them to the DNS + * configuration for your domain.
+ * + */ + Tokens?: ArrayAn object that contains the deliverability data for a specific campaign. This data is
+ * available for a campaign only if the campaign sent email by using a domain that the
+ * Deliverability dashboard is enabled for (PutDeliverabilityDashboardOption
+ * operation).
The unique identifier for the campaign. Amazon Pinpoint automatically generates and assigns this + * identifier to a campaign. This value is not the same as the campaign identifier that + * Amazon Pinpoint assigns to campaigns that you create and manage by using the Amazon Pinpoint API or the + * Amazon Pinpoint console.
+ * + */ + CampaignId?: string; + + /** + * + *The percentage of email messages that were deleted by recipients, without being opened + * first. Due to technical limitations, this value only includes recipients who opened the + * message by using an email client that supports images.
+ * + */ + DeleteRate?: number; + + /** + * + *The major email providers who handled the email message.
+ * + */ + Esps?: ArrayThe first time, in Unix time format, when the email message was delivered to any + * recipient's inbox. This value can help you determine how long it took for a campaign to + * deliver an email message.
+ * + */ + FirstSeenDateTime?: Date; + + /** + * + *The verified email address that the email message was sent from.
+ * + */ + FromAddress?: string; + + /** + * + *The URL of an image that contains a snapshot of the email message that was + * sent.
+ * + */ + ImageUrl?: string; + + /** + * + *The number of email messages that were delivered to recipients’ inboxes.
+ * + */ + InboxCount?: number; + + /** + * + *The last time, in Unix time format, when the email message was delivered to any + * recipient's inbox. This value can help you determine how long it took for a campaign to + * deliver an email message.
+ * + */ + LastSeenDateTime?: Date; + + /** + * + *The projected number of recipients that the email message was sent to.
+ * + */ + ProjectedVolume?: number; + + /** + * + *The percentage of email messages that were opened and then deleted by recipients. Due + * to technical limitations, this value only includes recipients who opened the message by + * using an email client that supports images.
+ * + */ + ReadDeleteRate?: number; + + /** + * + *The percentage of email messages that were opened by recipients. Due to technical + * limitations, this value only includes recipients who opened the message by using an + * email client that supports images.
+ * + */ + ReadRate?: number; + + /** + * + *The IP addresses that were used to send the email message.
+ * + */ + SendingIps?: ArrayThe number of email messages that were delivered to recipients' spam or junk mail + * folders.
+ * + */ + SpamCount?: number; + + /** + * + *The subject line, or title, of the email message.
+ * + */ + Subject?: string; +} + +export namespace DomainDeliverabilityCampaign { + export function isa(o: any): o is DomainDeliverabilityCampaign { + return _smithy.isa(o, "DomainDeliverabilityCampaign"); + } +} + +/** + * + *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.
+ * + */ +export interface DomainDeliverabilityTrackingOption { + __type?: "DomainDeliverabilityTrackingOption"; + /** + * + *A verified domain that’s associated with your AWS account and currently has an + * active Deliverability dashboard subscription.
+ * + */ + Domain?: string; + + /** + * + *An object that contains information about the inbox placement data settings for the + * domain.
+ * + */ + InboxPlacementTrackingOption?: InboxPlacementTrackingOption; + + /** + * + *The date, in Unix time format, when you enabled the Deliverability dashboard for the + * domain.
+ * + */ + SubscriptionStartDate?: Date; +} + +export namespace DomainDeliverabilityTrackingOption { + export function isa(o: any): o is DomainDeliverabilityTrackingOption { + return _smithy.isa(o, "DomainDeliverabilityTrackingOption"); + } +} + +/** + * + *An object that contains inbox placement data for email sent from one of your email + * domains to a specific email provider.
+ * + */ +export interface DomainIspPlacement { + __type?: "DomainIspPlacement"; + /** + * + *The percentage of messages that were sent from the selected domain to the specified + * email provider that arrived in recipients' inboxes.
+ * + */ + InboxPercentage?: number; + + /** + * + *The total number of messages that were sent from the selected domain to the specified + * email provider that arrived in recipients' inboxes.
+ * + */ + InboxRawCount?: number; + + /** + * + *The name of the email provider that the inbox placement data applies to.
+ * + */ + IspName?: string; + + /** + * + *The percentage of messages that were sent from the selected domain to the specified + * email provider that arrived in recipients' spam or junk mail folders.
+ * + */ + SpamPercentage?: number; + + /** + * + *The total number of messages that were sent from the selected domain to the specified + * email provider that arrived in recipients' spam or junk mail folders.
+ * + */ + SpamRawCount?: number; +} + +export namespace DomainIspPlacement { + export function isa(o: any): o is DomainIspPlacement { + return _smithy.isa(o, "DomainIspPlacement"); + } +} + +/** + * + *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.
+ * + */ +export interface EmailContent { + __type?: "EmailContent"; + /** + * + *The raw email message. The message has to meet the following criteria:
+ *The message has to contain a header and a body, separated by one blank + * line.
+ *All of the required header fields must be present in the message.
+ *Each part of a multipart MIME message must be formatted properly.
+ *If you include attachments, they must be in a file format that Amazon Pinpoint supports. + *
+ *The entire message must be Base64 encoded.
+ *If any of the MIME parts in your message contain content that is outside of + * the 7-bit ASCII character range, you should encode that content to ensure that + * recipients' email clients render the message properly.
+ *The length of any single line of text in the message can't exceed 1,000 + * characters. This restriction is defined in RFC 5321.
+ *The simple email message. The message consists of a subject and a message body.
+ * + */ + Simple?: Message; + + /** + * + *The template to use for the email message.
+ * + */ + Template?: Template; +} + +export namespace EmailContent { + export function isa(o: any): o is EmailContent { + return _smithy.isa(o, "EmailContent"); + } +} + +/** + * + *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.
+ * + */ +export interface EventDestination { + __type?: "EventDestination"; + /** + * + *An object that defines an Amazon CloudWatch destination for email events. You can use Amazon CloudWatch to + * monitor and gain insights on your email sending metrics.
+ * + */ + CloudWatchDestination?: CloudWatchDestination; + + /** + * + *If true, the event destination is enabled. When the event destination is
+ * enabled, the specified event types are sent to the destinations in this
+ * EventDestinationDefinition.
If false, the event destination is disabled. When the event destination
+ * is disabled, events aren't sent to the specified destinations.
An object that defines an Amazon Kinesis Data Firehose destination for email events. You can use Amazon Kinesis Data Firehose to + * stream data to other services, such as Amazon S3 and Amazon Redshift.
+ * + */ + KinesisFirehoseDestination?: KinesisFirehoseDestination; + + /** + * + *The types of events that Amazon Pinpoint sends to the specified event destinations.
+ * + */ + MatchingEventTypes: ArrayA name that identifies the event destination.
+ * + */ + Name: string | undefined; + + /** + * + *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.
+ * + */ + PinpointDestination?: PinpointDestination; + + /** + * + *An object that defines an Amazon SNS destination for email events. You can use Amazon SNS to + * send notification when certain email events occur.
+ * + */ + SnsDestination?: SnsDestination; +} + +export namespace EventDestination { + export function isa(o: any): o is EventDestination { + return _smithy.isa(o, "EventDestination"); + } +} + +/** + * + *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.
+ * + */ +export interface EventDestinationDefinition { + __type?: "EventDestinationDefinition"; + /** + * + *An object that defines an Amazon CloudWatch destination for email events. You can use Amazon CloudWatch to + * monitor and gain insights on your email sending metrics.
+ * + */ + CloudWatchDestination?: CloudWatchDestination; + + /** + * + *If true, the event destination is enabled. When the event destination is
+ * enabled, the specified event types are sent to the destinations in this
+ * EventDestinationDefinition.
If false, the event destination is disabled. When the event destination
+ * is disabled, events aren't sent to the specified destinations.
An object that defines an Amazon Kinesis Data Firehose destination for email events. You can use Amazon Kinesis Data Firehose to + * stream data to other services, such as Amazon S3 and Amazon Redshift.
+ * + */ + KinesisFirehoseDestination?: KinesisFirehoseDestination; + + /** + * + *An array that specifies which events Amazon Pinpoint should send to the destinations in this
+ * EventDestinationDefinition.
An object that defines a Amazon Pinpoint destination for email events. You can use Amazon Pinpoint events + * to create attributes in Amazon Pinpoint projects. You can use these attributes to create segments + * for your campaigns.
+ * + */ + PinpointDestination?: PinpointDestination; + + /** + * + *An object that defines an Amazon SNS destination for email events. You can use Amazon SNS to + * send notification when certain email events occur.
+ * + */ + SnsDestination?: SnsDestination; +} + +export namespace EventDestinationDefinition { + export function isa(o: any): o is EventDestinationDefinition { + return _smithy.isa(o, "EventDestinationDefinition"); + } +} + +export enum EventType { + BOUNCE = "BOUNCE", + CLICK = "CLICK", + COMPLAINT = "COMPLAINT", + DELIVERY = "DELIVERY", + OPEN = "OPEN", + REJECT = "REJECT", + RENDERING_FAILURE = "RENDERING_FAILURE", + SEND = "SEND" +} + +/** + * + *A request to obtain information about the email-sending capabilities of your Amazon Pinpoint + * account.
+ * + */ +export interface GetAccountRequest { + __type?: "GetAccountRequest"; +} + +export namespace GetAccountRequest { + export function isa(o: any): o is GetAccountRequest { + return _smithy.isa(o, "GetAccountRequest"); + } +} + +/** + * + *A list of details about the email-sending capabilities of your Amazon Pinpoint account in the + * current AWS Region.
+ * + */ +export interface GetAccountResponse extends $MetadataBearer { + __type?: "GetAccountResponse"; + /** + * + *Indicates whether or not the automatic warm-up feature is enabled for dedicated IP + * addresses that are associated with your account.
+ * + */ + DedicatedIpAutoWarmupEnabled?: boolean; + + /** + * + *The reputation status of your Amazon Pinpoint account. The status can be one of the + * following:
+ *
+ * HEALTHY – There are no reputation-related issues that
+ * currently impact your account.
+ * PROBATION – We've identified some issues with your Amazon Pinpoint
+ * account. We're placing your account under review while you work on correcting
+ * these issues.
+ * SHUTDOWN – Your account's ability to send email is
+ * currently paused because of an issue with the email sent from your account. When
+ * you correct the issue, you can contact us and request that your account's
+ * ability to send email is resumed.
Indicates whether or not your account has production access in the current AWS + * Region.
+ *If the value is false, then your account is in the
+ * sandbox. When your account is in the sandbox, you can only send
+ * email to verified identities. Additionally, the maximum number of emails you can send in
+ * a 24-hour period (your sending quota) is 200, and the maximum number of emails you can
+ * send per second (your maximum sending rate) is 1.
If the value is true, then your account has production access. When your
+ * account has production access, you can send email to any address. The sending quota and
+ * maximum sending rate for your account vary based on your specific use case.
An object that contains information about the per-day and per-second sending limits + * for your Amazon Pinpoint account in the current AWS Region.
+ * + */ + SendQuota?: SendQuota; + + /** + * + *Indicates whether or not email sending is enabled for your Amazon Pinpoint account in the + * current AWS Region.
+ * + */ + SendingEnabled?: boolean; +} + +export namespace GetAccountResponse { + export function isa(o: any): o is GetAccountResponse { + return _smithy.isa(o, "GetAccountResponse"); + } +} + +/** + * + *A request to retrieve a list of the blacklists that your dedicated IP addresses appear + * on.
+ * + */ +export interface GetBlacklistReportsRequest { + __type?: "GetBlacklistReportsRequest"; + /** + * + *A list of IP addresses that you want to retrieve blacklist information about. You can + * only specify the dedicated IP addresses that you use to send email using Amazon Pinpoint or + * Amazon SES.
+ * + */ + BlacklistItemNames: ArrayAn object that contains information about blacklist events.
+ * + */ +export interface GetBlacklistReportsResponse extends $MetadataBearer { + __type?: "GetBlacklistReportsResponse"; + /** + * + *An object that contains information about a blacklist that one of your dedicated IP + * addresses appears on.
+ * + */ + BlacklistReport: { [key: string]: ArrayA request to obtain information about the event destinations for a configuration + * set.
+ * + */ +export interface GetConfigurationSetEventDestinationsRequest { + __type?: "GetConfigurationSetEventDestinationsRequest"; + /** + * + *The name of the configuration set that contains the event destination.
+ * + */ + ConfigurationSetName: string | undefined; +} + +export namespace GetConfigurationSetEventDestinationsRequest { + export function isa( + o: any + ): o is GetConfigurationSetEventDestinationsRequest { + return _smithy.isa(o, "GetConfigurationSetEventDestinationsRequest"); + } +} + +/** + * + *Information about an event destination for a configuration set.
+ * + */ +export interface GetConfigurationSetEventDestinationsResponse + extends $MetadataBearer { + __type?: "GetConfigurationSetEventDestinationsResponse"; + /** + * + *An array that includes all of the events destinations that have been configured for + * the configuration set.
+ * + */ + EventDestinations?: ArrayA request to obtain information about a configuration set.
+ * + */ +export interface GetConfigurationSetRequest { + __type?: "GetConfigurationSetRequest"; + /** + * + *The name of the configuration set that you want to obtain more information + * about.
+ * + */ + ConfigurationSetName: string | undefined; +} + +export namespace GetConfigurationSetRequest { + export function isa(o: any): o is GetConfigurationSetRequest { + return _smithy.isa(o, "GetConfigurationSetRequest"); + } +} + +/** + * + *Information about a configuration set.
+ * + */ +export interface GetConfigurationSetResponse extends $MetadataBearer { + __type?: "GetConfigurationSetResponse"; + /** + * + *The name of the configuration set.
+ * + */ + ConfigurationSetName?: string; + + /** + * + *An object that defines the dedicated IP pool that is used to send emails that you send + * using the configuration set.
+ * + */ + DeliveryOptions?: DeliveryOptions; + + /** + * + *An object that defines whether or not Amazon Pinpoint collects reputation metrics for the emails + * that you send that use the configuration set.
+ * + */ + ReputationOptions?: ReputationOptions; + + /** + * + *An object that defines whether or not Amazon Pinpoint can send email that you send using the + * configuration set.
+ * + */ + SendingOptions?: SendingOptions; + + /** + * + *An array of objects that define the tags (keys and values) that are associated with + * the configuration set.
+ * + */ + Tags?: ArrayAn object that defines the open and click tracking options for emails that you send + * using the configuration set.
+ * + */ + TrackingOptions?: TrackingOptions; +} + +export namespace GetConfigurationSetResponse { + export function isa(o: any): o is GetConfigurationSetResponse { + return _smithy.isa(o, "GetConfigurationSetResponse"); + } +} + +/** + * + *A request to obtain more information about a dedicated IP address.
+ * + */ +export interface GetDedicatedIpRequest { + __type?: "GetDedicatedIpRequest"; + /** + * + *The IP address that you want to obtain more information about. The value you specify + * has to be a dedicated IP address that's assocaited with your Amazon Pinpoint account.
+ * + */ + Ip: string | undefined; +} + +export namespace GetDedicatedIpRequest { + export function isa(o: any): o is GetDedicatedIpRequest { + return _smithy.isa(o, "GetDedicatedIpRequest"); + } +} + +/** + * + *Information about a dedicated IP address.
+ * + */ +export interface GetDedicatedIpResponse extends $MetadataBearer { + __type?: "GetDedicatedIpResponse"; + /** + * + *An object that contains information about a dedicated IP address.
+ * + */ + DedicatedIp?: DedicatedIp; +} + +export namespace GetDedicatedIpResponse { + export function isa(o: any): o is GetDedicatedIpResponse { + return _smithy.isa(o, "GetDedicatedIpResponse"); + } +} + +/** + * + *A request to obtain more information about dedicated IP pools.
+ * + */ +export interface GetDedicatedIpsRequest { + __type?: "GetDedicatedIpsRequest"; + /** + * + *A token returned from a previous call to GetDedicatedIps to indicate the
+ * position of the dedicated IP pool in the list of IP pools.
The number of results to show in a single call to GetDedicatedIpsRequest.
+ * If the number of results is larger than the number you specified in this parameter, then
+ * the response includes a NextToken element, which you can use to obtain
+ * additional results.
The name of the IP pool that the dedicated IP address is associated with.
+ * + */ + PoolName?: string; +} + +export namespace GetDedicatedIpsRequest { + export function isa(o: any): o is GetDedicatedIpsRequest { + return _smithy.isa(o, "GetDedicatedIpsRequest"); + } +} + +/** + * + *Information about the dedicated IP addresses that are associated with your Amazon Pinpoint + * account.
+ * + */ +export interface GetDedicatedIpsResponse extends $MetadataBearer { + __type?: "GetDedicatedIpsResponse"; + /** + * + *A list of dedicated IP addresses that are reserved for use by your Amazon Pinpoint + * account.
+ * + */ + DedicatedIps?: ArrayA token that indicates that there are additional dedicated IP addresses to list. To
+ * view additional addresses, issue another request to GetDedicatedIps,
+ * passing this token in the NextToken parameter.
Retrieve information about the status of the Deliverability dashboard for your Amazon Pinpoint account. + * When the Deliverability dashboard is enabled, you gain access to reputation, deliverability, and + * other metrics for the domains that you use to send email using Amazon Pinpoint. You also gain the + * ability to perform predictive inbox placement tests.
+ *When you use the Deliverability dashboard, you pay a monthly subscription charge, in addition + * to any other fees that you accrue by using Amazon Pinpoint. For more information about the + * features and cost of a Deliverability dashboard subscription, see Amazon Pinpoint Pricing.
+ * + */ +export interface GetDeliverabilityDashboardOptionsRequest { + __type?: "GetDeliverabilityDashboardOptionsRequest"; +} + +export namespace GetDeliverabilityDashboardOptionsRequest { + export function isa(o: any): o is GetDeliverabilityDashboardOptionsRequest { + return _smithy.isa(o, "GetDeliverabilityDashboardOptionsRequest"); + } +} + +/** + * + *An object that shows the status of the Deliverability dashboard for your Amazon Pinpoint account.
+ * + */ +export interface GetDeliverabilityDashboardOptionsResponse + extends $MetadataBearer { + __type?: "GetDeliverabilityDashboardOptionsResponse"; + /** + * + *The current status of your Deliverability dashboard subscription. If this value is
+ * PENDING_EXPIRATION, your subscription is scheduled to expire at the end
+ * of the current calendar month.
An array of objects, one for each verified domain that you use to send email and + * currently has an active Deliverability dashboard subscription that isn’t scheduled to expire at + * the end of the current calendar month.
+ * + */ + ActiveSubscribedDomains?: ArraySpecifies whether the Deliverability dashboard is enabled for your Amazon Pinpoint account. If this value
+ * is true, the dashboard is enabled.
An array of objects, one for each verified domain that you use to send email and + * currently has an active Deliverability dashboard subscription that's scheduled to expire at the + * end of the current calendar month.
+ * + */ + PendingExpirationSubscribedDomains?: Array< + DomainDeliverabilityTrackingOption + >; + + /** + * + *The date, in Unix time format, when your current subscription to the Deliverability dashboard + * is scheduled to expire, if your subscription is scheduled to expire at the end of the + * current calendar month. This value is null if you have an active subscription that isn’t + * due to expire at the end of the month.
+ * + */ + SubscriptionExpiryDate?: Date; +} + +export namespace GetDeliverabilityDashboardOptionsResponse { + export function isa(o: any): o is GetDeliverabilityDashboardOptionsResponse { + return _smithy.isa(o, "GetDeliverabilityDashboardOptionsResponse"); + } +} + +/** + * + *A request to retrieve the results of a predictive inbox placement test.
+ * + */ +export interface GetDeliverabilityTestReportRequest { + __type?: "GetDeliverabilityTestReportRequest"; + /** + * + *A unique string that identifies the predictive inbox placement test.
+ * + */ + ReportId: string | undefined; +} + +export namespace GetDeliverabilityTestReportRequest { + export function isa(o: any): o is GetDeliverabilityTestReportRequest { + return _smithy.isa(o, "GetDeliverabilityTestReportRequest"); + } +} + +/** + * + *The results of the predictive inbox placement test.
+ * + */ +export interface GetDeliverabilityTestReportResponse extends $MetadataBearer { + __type?: "GetDeliverabilityTestReportResponse"; + /** + * + *An object that contains the results of the predictive inbox placement test.
+ * + */ + DeliverabilityTestReport: DeliverabilityTestReport | undefined; + + /** + * + *An object that describes how the test email was handled by several email providers, + * including Gmail, Hotmail, Yahoo, AOL, and others.
+ * + */ + IspPlacements: ArrayAn object that contains the message that you sent when you performed this + * predictive inbox placement test.
+ * + */ + Message?: string; + + /** + * + *An object that specifies how many test messages that were sent during the predictive inbox placement test were + * delivered to recipients' inboxes, how many were sent to recipients' spam folders, and + * how many weren't delivered.
+ * + */ + OverallPlacement: PlacementStatistics | undefined; + + /** + * + *An array of objects that define the tags (keys and values) that are associated with + * the predictive inbox placement test.
+ * + */ + Tags?: ArrayRetrieve all the deliverability data for a specific campaign. This data is available
+ * for a campaign only if the campaign sent email by using a domain that the
+ * Deliverability dashboard is enabled for (PutDeliverabilityDashboardOption
+ * operation).
The unique identifier for the campaign. Amazon Pinpoint automatically generates and assigns this + * identifier to a campaign. This value is not the same as the campaign identifier that + * Amazon Pinpoint assigns to campaigns that you create and manage by using the Amazon Pinpoint API or the + * Amazon Pinpoint console.
+ * + */ + CampaignId: string | undefined; +} + +export namespace GetDomainDeliverabilityCampaignRequest { + export function isa(o: any): o is GetDomainDeliverabilityCampaignRequest { + return _smithy.isa(o, "GetDomainDeliverabilityCampaignRequest"); + } +} + +/** + * + *An object that contains all the deliverability data for a specific campaign. This data
+ * is available for a campaign only if the campaign sent email by using a domain that the
+ * Deliverability dashboard is enabled for (PutDeliverabilityDashboardOption
+ * operation).
An object that contains the deliverability data for the campaign.
+ * + */ + DomainDeliverabilityCampaign: DomainDeliverabilityCampaign | undefined; +} + +export namespace GetDomainDeliverabilityCampaignResponse { + export function isa(o: any): o is GetDomainDeliverabilityCampaignResponse { + return _smithy.isa(o, "GetDomainDeliverabilityCampaignResponse"); + } +} + +/** + * + *A request to obtain deliverability metrics for a domain.
+ * + */ +export interface GetDomainStatisticsReportRequest { + __type?: "GetDomainStatisticsReportRequest"; + /** + * + *The domain that you want to obtain deliverability metrics for.
+ * + */ + Domain: string | undefined; + + /** + * + *The last day (in Unix time) that you want to obtain domain deliverability metrics for.
+ * The EndDate that you specify has to be less than or equal to 30 days after
+ * the StartDate.
The first day (in Unix time) that you want to obtain domain deliverability metrics + * for.
+ * + */ + StartDate: Date | undefined; +} + +export namespace GetDomainStatisticsReportRequest { + export function isa(o: any): o is GetDomainStatisticsReportRequest { + return _smithy.isa(o, "GetDomainStatisticsReportRequest"); + } +} + +/** + * + *An object that includes statistics that are related to the domain that you + * specified.
+ * + */ +export interface GetDomainStatisticsReportResponse extends $MetadataBearer { + __type?: "GetDomainStatisticsReportResponse"; + /** + * + *An object that contains deliverability metrics for the domain that you specified. This
+ * object contains data for each day, starting on the StartDate and ending on
+ * the EndDate.
An object that contains deliverability metrics for the domain that you specified. The
+ * data in this object is a summary of all of the data that was collected from the
+ * StartDate to the EndDate.
A request to return details about an email identity.
+ * + */ +export interface GetEmailIdentityRequest { + __type?: "GetEmailIdentityRequest"; + /** + * + *The email identity that you want to retrieve details for.
+ * + */ + EmailIdentity: string | undefined; +} + +export namespace GetEmailIdentityRequest { + export function isa(o: any): o is GetEmailIdentityRequest { + return _smithy.isa(o, "GetEmailIdentityRequest"); + } +} + +/** + * + *Details about an email identity.
+ * + */ +export interface GetEmailIdentityResponse extends $MetadataBearer { + __type?: "GetEmailIdentityResponse"; + /** + * + *An object that contains information about the DKIM attributes for the identity. This + * object includes the tokens that you use to create the CNAME records that are required to + * complete the DKIM verification process.
+ * + */ + DkimAttributes?: DkimAttributes; + + /** + * + *The feedback forwarding configuration for the identity.
+ *If the value is true, Amazon Pinpoint sends you email notifications when bounce or
+ * complaint events occur. Amazon Pinpoint sends this notification to the address that you specified
+ * in the Return-Path header of the original email.
When you set this value to false, Amazon Pinpoint sends notifications through other
+ * mechanisms, such as by notifying an Amazon SNS topic or another event destination. You're
+ * required to have a method of tracking bounces and complaints. If you haven't set up
+ * another mechanism for receiving bounce or complaint notifications, Amazon Pinpoint sends an email
+ * notification when these events occur (even if this setting is disabled).
The email identity type.
+ * + */ + IdentityType?: IdentityType | string; + + /** + * + *An object that contains information about the Mail-From attributes for the email + * identity.
+ * + */ + MailFromAttributes?: MailFromAttributes; + + /** + * + *An array of objects that define the tags (keys and values) that are associated with + * the email identity.
+ * + */ + Tags?: ArraySpecifies whether or not the identity is verified. In Amazon Pinpoint, you can only send email + * from verified email addresses or domains. For more information about verifying + * identities, see the Amazon Pinpoint User Guide.
+ * + */ + VerifiedForSendingStatus?: boolean; +} + +export namespace GetEmailIdentityResponse { + export function isa(o: any): o is GetEmailIdentityResponse { + return _smithy.isa(o, "GetEmailIdentityResponse"); + } +} + +/** + * + *Information about an email identity.
+ * + */ +export interface IdentityInfo { + __type?: "IdentityInfo"; + /** + * + *The address or domain of the identity.
+ * + */ + IdentityName?: string; + + /** + * + *The email identity type. The identity type can be one of the following:
+ *
+ * EMAIL_ADDRESS – The identity is an email address.
+ * DOMAIN – The identity is a domain.
+ * MANAGED_DOMAIN – The identity is a domain that is managed
+ * by AWS.
Indicates whether or not you can send email from the identity.
+ *In Amazon Pinpoint, an identity is an email address or domain that you send email from. Before + * you can send email from an identity, you have to demostrate that you own the identity, + * and that you authorize Amazon Pinpoint to send email from that identity.
+ * + */ + SendingEnabled?: boolean; +} + +export namespace IdentityInfo { + export function isa(o: any): o is IdentityInfo { + return _smithy.isa(o, "IdentityInfo"); + } +} + +export enum IdentityType { + DOMAIN = "DOMAIN", + EMAIL_ADDRESS = "EMAIL_ADDRESS", + MANAGED_DOMAIN = "MANAGED_DOMAIN" +} + +/** + * + *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).
Specifies whether inbox placement data is being tracked for the domain.
+ * + */ + Global?: boolean; + + /** + * + *An array of strings, one for each major email provider that the inbox placement data + * applies to.
+ * + */ + TrackedIsps?: ArrayAn object that describes how email sent during the predictive inbox placement test was handled by a certain + * email provider.
+ * + */ +export interface IspPlacement { + __type?: "IspPlacement"; + /** + * + *The name of the email provider that the inbox placement data applies to.
+ * + */ + IspName?: string; + + /** + * + *An object that contains inbox placement metrics for a specific email provider.
+ * + */ + PlacementStatistics?: PlacementStatistics; +} + +export namespace IspPlacement { + export function isa(o: any): o is IspPlacement { + return _smithy.isa(o, "IspPlacement"); + } +} + +/** + * + *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.
+ * + */ +export interface KinesisFirehoseDestination { + __type?: "KinesisFirehoseDestination"; + /** + * + *The Amazon Resource Name (ARN) of the Amazon Kinesis Data Firehose stream that Amazon Pinpoint sends email events + * to.
+ * + */ + DeliveryStreamArn: string | undefined; + + /** + * + *The Amazon Resource Name (ARN) of the IAM role that Amazon Pinpoint uses when sending email + * events to the Amazon Kinesis Data Firehose stream.
+ * + */ + IamRoleArn: string | undefined; +} + +export namespace KinesisFirehoseDestination { + export function isa(o: any): o is KinesisFirehoseDestination { + return _smithy.isa(o, "KinesisFirehoseDestination"); + } +} + +/** + * + *There are too many instances of the specified resource type.
+ * + */ +export interface LimitExceededException + extends _smithy.SmithyException, + $MetadataBearer { + __type: "LimitExceededException"; + $fault: "client"; + message?: string; +} + +export namespace LimitExceededException { + export function isa(o: any): o is LimitExceededException { + return _smithy.isa(o, "LimitExceededException"); + } +} + +/** + * + *A request to obtain a list of configuration sets for your Amazon Pinpoint account in the current + * AWS Region.
+ * + */ +export interface ListConfigurationSetsRequest { + __type?: "ListConfigurationSetsRequest"; + /** + * + *A token returned from a previous call to ListConfigurationSets to
+ * indicate the position in the list of configuration sets.
The number of results to show in a single call to ListConfigurationSets.
+ * If the number of results is larger than the number you specified in this parameter, then
+ * the response includes a NextToken element, which you can use to obtain
+ * additional results.
A list of configuration sets in your Amazon Pinpoint account in the current AWS Region.
+ * + */ +export interface ListConfigurationSetsResponse extends $MetadataBearer { + __type?: "ListConfigurationSetsResponse"; + /** + * + *An array that contains all of the configuration sets in your Amazon Pinpoint account in the + * current AWS Region.
+ * + */ + ConfigurationSets?: ArrayA token that indicates that there are additional configuration sets to list. To view
+ * additional configuration sets, issue another request to
+ * ListConfigurationSets, and pass this token in the
+ * NextToken parameter.
A request to obtain a list of dedicated IP pools.
+ * + */ +export interface ListDedicatedIpPoolsRequest { + __type?: "ListDedicatedIpPoolsRequest"; + /** + * + *A token returned from a previous call to ListDedicatedIpPools to indicate
+ * the position in the list of dedicated IP pools.
The number of results to show in a single call to ListDedicatedIpPools.
+ * If the number of results is larger than the number you specified in this parameter, then
+ * the response includes a NextToken element, which you can use to obtain
+ * additional results.
A list of dedicated IP pools.
+ * + */ +export interface ListDedicatedIpPoolsResponse extends $MetadataBearer { + __type?: "ListDedicatedIpPoolsResponse"; + /** + * + *A list of all of the dedicated IP pools that are associated with your Amazon Pinpoint + * account.
+ * + */ + DedicatedIpPools?: ArrayA token that indicates that there are additional IP pools to list. To view additional
+ * IP pools, issue another request to ListDedicatedIpPools, passing this token
+ * in the NextToken parameter.
A request to list all of the predictive inbox placement tests that you've performed.
+ * + */ +export interface ListDeliverabilityTestReportsRequest { + __type?: "ListDeliverabilityTestReportsRequest"; + /** + * + *A token returned from a previous call to ListDeliverabilityTestReports to
+ * indicate the position in the list of predictive inbox placement tests.
The number of results to show in a single call to
+ * ListDeliverabilityTestReports. If the number of results is larger than
+ * the number you specified in this parameter, then the response includes a
+ * NextToken element, which you can use to obtain additional
+ * results.
The value you specify has to be at least 0, and can be no more than 1000.
+ * + */ + PageSize?: number; +} + +export namespace ListDeliverabilityTestReportsRequest { + export function isa(o: any): o is ListDeliverabilityTestReportsRequest { + return _smithy.isa(o, "ListDeliverabilityTestReportsRequest"); + } +} + +/** + * + *A list of the predictive inbox placement test reports that are available for your account, regardless of + * whether or not those tests are complete.
+ * + */ +export interface ListDeliverabilityTestReportsResponse extends $MetadataBearer { + __type?: "ListDeliverabilityTestReportsResponse"; + /** + * + *An object that contains a lists of predictive inbox placement tests that you've performed.
+ * + */ + DeliverabilityTestReports: ArrayA token that indicates that there are additional predictive inbox placement tests to list. To view additional
+ * predictive inbox placement tests, issue another request to ListDeliverabilityTestReports, and pass
+ * this token in the NextToken parameter.
Retrieve deliverability data for all the campaigns that used a specific domain to send
+ * email during a specified time range. This data is available for a domain only if you
+ * enabled the Deliverability dashboard (PutDeliverabilityDashboardOption operation)
+ * for the domain.
The last day, in Unix time format, that you want to obtain deliverability data for.
+ * This value has to be less than or equal to 30 days after the value of the
+ * StartDate parameter.
A token that’s returned from a previous call to the
+ * ListDomainDeliverabilityCampaigns operation. This token indicates the
+ * position of a campaign in the list of campaigns.
The maximum number of results to include in response to a single call to the
+ * ListDomainDeliverabilityCampaigns operation. If the number of results
+ * is larger than the number that you specify in this parameter, the response includes a
+ * NextToken element, which you can use to obtain additional
+ * results.
The first day, in Unix time format, that you want to obtain deliverability data + * for.
+ * + */ + StartDate: Date | undefined; + + /** + * + *The domain to obtain deliverability data for.
+ * + */ + SubscribedDomain: string | undefined; +} + +export namespace ListDomainDeliverabilityCampaignsRequest { + export function isa(o: any): o is ListDomainDeliverabilityCampaignsRequest { + return _smithy.isa(o, "ListDomainDeliverabilityCampaignsRequest"); + } +} + +/** + * + *An array of objects that provide deliverability data for all the campaigns that used a
+ * specific domain to send email during a specified time range. This data is available for
+ * a domain only if you enabled the Deliverability dashboard
+ * (PutDeliverabilityDashboardOption operation) for the domain.
An array of responses, one for each campaign that used the domain to send email during + * the specified time range.
+ * + */ + DomainDeliverabilityCampaigns: + | ArrayA token that’s returned from a previous call to the
+ * ListDomainDeliverabilityCampaigns operation. This token indicates the
+ * position of the campaign in the list of campaigns.
A request to list all of the email identities associated with your Amazon Pinpoint account. This + * list includes identities that you've already verified, identities that are unverified, + * and identities that were verified in the past, but are no longer verified.
+ * + */ +export interface ListEmailIdentitiesRequest { + __type?: "ListEmailIdentitiesRequest"; + /** + * + *A token returned from a previous call to ListEmailIdentities to indicate
+ * the position in the list of identities.
The number of results to show in a single call to ListEmailIdentities. If
+ * the number of results is larger than the number you specified in this parameter, then
+ * the response includes a NextToken element, which you can use to obtain
+ * additional results.
The value you specify has to be at least 0, and can be no more than 1000.
+ * + */ + PageSize?: number; +} + +export namespace ListEmailIdentitiesRequest { + export function isa(o: any): o is ListEmailIdentitiesRequest { + return _smithy.isa(o, "ListEmailIdentitiesRequest"); + } +} + +/** + * + *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.
+ * + */ +export interface ListEmailIdentitiesResponse extends $MetadataBearer { + __type?: "ListEmailIdentitiesResponse"; + /** + * + *An array that includes all of the identities associated with your Amazon Pinpoint + * account.
+ * + */ + EmailIdentities?: ArrayA token that indicates that there are additional configuration sets to list. To view
+ * additional configuration sets, issue another request to
+ * ListEmailIdentities, and pass this token in the NextToken
+ * parameter.
The Amazon Resource Name (ARN) of the resource that you want to retrieve tag + * information for.
+ * + */ + ResourceArn: string | undefined; +} + +export namespace ListTagsForResourceRequest { + export function isa(o: any): o is ListTagsForResourceRequest { + return _smithy.isa(o, "ListTagsForResourceRequest"); + } +} + +export interface ListTagsForResourceResponse extends $MetadataBearer { + __type?: "ListTagsForResourceResponse"; + /** + * + *An array that lists all the tags that are associated with the resource. Each tag
+ * consists of a required tag key (Key) and an associated tag value
+ * (Value)
A list of attributes that are associated with a MAIL FROM domain.
+ * + */ +export interface MailFromAttributes { + __type?: "MailFromAttributes"; + /** + * + *The action that Amazon Pinpoint to takes if it can't read the required MX record for a custom
+ * MAIL FROM domain. When you set this value to UseDefaultValue, Amazon Pinpoint uses
+ * amazonses.com as the MAIL FROM domain. When you set this value
+ * to RejectMessage, Amazon Pinpoint returns a MailFromDomainNotVerified
+ * error, and doesn't attempt to deliver the email.
These behaviors are taken when the custom MAIL FROM domain configuration is in the
+ * Pending, Failed, and TemporaryFailure
+ * states.
The name of a domain that an email identity uses as a custom MAIL FROM domain.
+ * + */ + MailFromDomain: string | undefined; + + /** + * + *The status of the MAIL FROM domain. This status can have the following values:
+ *
+ * PENDING – Amazon Pinpoint hasn't started searching for the MX record
+ * yet.
+ * SUCCESS – Amazon Pinpoint detected the required MX record for the
+ * MAIL FROM domain.
+ * FAILED – Amazon Pinpoint can't find the required MX record, or the
+ * record no longer exists.
+ * TEMPORARY_FAILURE – A temporary issue occurred, which
+ * prevented Amazon Pinpoint from determining the status of the MAIL FROM domain.
The message can't be sent because the sending domain isn't verified.
+ * + */ +export interface MailFromDomainNotVerifiedException + extends _smithy.SmithyException, + $MetadataBearer { + __type: "MailFromDomainNotVerifiedException"; + $fault: "client"; + message?: string; +} + +export namespace MailFromDomainNotVerifiedException { + export function isa(o: any): o is MailFromDomainNotVerifiedException { + return _smithy.isa(o, "MailFromDomainNotVerifiedException"); + } +} + +export enum MailFromDomainStatus { + FAILED = "FAILED", + PENDING = "PENDING", + SUCCESS = "SUCCESS", + TEMPORARY_FAILURE = "TEMPORARY_FAILURE" +} + +/** + * + *Represents the email message that you're sending. The Message object
+ * consists of a subject line and a message body.
The body of the message. You can specify an HTML version of the message, a text-only + * version of the message, or both.
+ * + */ + Body: Body | undefined; + + /** + * + *The subject line of the email. The subject line can only contain 7-bit ASCII + * characters. However, you can specify non-ASCII characters in the subject line by using + * encoded-word syntax, as described in RFC 2047.
+ * + */ + Subject: Content | undefined; +} + +export namespace Message { + export function isa(o: any): o is Message { + return _smithy.isa(o, "Message"); + } +} + +/** + * + *The message can't be sent because it contains invalid content.
+ * + */ +export interface MessageRejected + extends _smithy.SmithyException, + $MetadataBearer { + __type: "MessageRejected"; + $fault: "client"; + message?: string; +} + +export namespace MessageRejected { + export function isa(o: any): o is MessageRejected { + return _smithy.isa(o, "MessageRejected"); + } +} + +/** + * + *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. + *
+ * + */ +export interface MessageTag { + __type?: "MessageTag"; + /** + * + *The name of the message tag. The message tag name has to meet the following + * criteria:
+ *It can only contain ASCII letters (a–z, A–Z), numbers (0–9), + * underscores (_), or dashes (-).
+ *It can contain no more than 256 characters.
+ *The value of the message tag. The message tag value has to meet the following + * criteria:
+ *It can only contain ASCII letters (a–z, A–Z), numbers (0–9), + * underscores (_), or dashes (-).
+ *It can contain no more than 256 characters.
+ *The resource you attempted to access doesn't exist.
+ * + */ +export interface NotFoundException + extends _smithy.SmithyException, + $MetadataBearer { + __type: "NotFoundException"; + $fault: "client"; + message?: string; +} + +export namespace NotFoundException { + export function isa(o: any): o is NotFoundException { + return _smithy.isa(o, "NotFoundException"); + } +} + +/** + * + *An object that contains information about email that was sent from the selected + * domain.
+ * + */ +export interface OverallVolume { + __type?: "OverallVolume"; + /** + * + *An object that contains inbox and junk mail placement metrics for individual email + * providers.
+ * + */ + DomainIspPlacements?: ArrayThe percentage of emails that were sent from the domain that were read by their + * recipients.
+ * + */ + ReadRatePercent?: number; + + /** + * + *An object that contains information about the numbers of messages that arrived in + * recipients' inboxes and junk mail folders.
+ * + */ + VolumeStatistics?: VolumeStatistics; +} + +export namespace OverallVolume { + export function isa(o: any): o is OverallVolume { + return _smithy.isa(o, "OverallVolume"); + } +} + +/** + * + *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.
+ * + */ +export interface PinpointDestination { + __type?: "PinpointDestination"; + /** + * + *The Amazon Resource Name (ARN) of the Amazon Pinpoint project that you want to send email + * events to.
+ * + */ + ApplicationArn?: string; +} + +export namespace PinpointDestination { + export function isa(o: any): o is PinpointDestination { + return _smithy.isa(o, "PinpointDestination"); + } +} + +/** + * + *An object that contains inbox placement data for an email provider.
+ * + */ +export interface PlacementStatistics { + __type?: "PlacementStatistics"; + /** + * + *The percentage of emails that were authenticated by using DomainKeys Identified Mail + * (DKIM) during the predictive inbox placement test.
+ * + */ + DkimPercentage?: number; + + /** + * + *The percentage of emails that arrived in recipients' inboxes during the predictive inbox placement test.
+ * + */ + InboxPercentage?: number; + + /** + * + *The percentage of emails that didn't arrive in recipients' inboxes at all during the + * predictive inbox placement test.
+ * + */ + MissingPercentage?: number; + + /** + * + *The percentage of emails that arrived in recipients' spam or junk mail folders during + * the predictive inbox placement test.
+ * + */ + SpamPercentage?: number; + + /** + * + *The percentage of emails that were authenticated by using Sender Policy Framework + * (SPF) during the predictive inbox placement test.
+ * + */ + SpfPercentage?: number; +} + +export namespace PlacementStatistics { + export function isa(o: any): o is PlacementStatistics { + return _smithy.isa(o, "PlacementStatistics"); + } +} + +/** + * + *A request to enable or disable the automatic IP address warm-up feature.
+ * + */ +export interface PutAccountDedicatedIpWarmupAttributesRequest { + __type?: "PutAccountDedicatedIpWarmupAttributesRequest"; + /** + * + *Enables or disables the automatic warm-up feature for dedicated IP addresses that are
+ * associated with your Amazon Pinpoint account in the current AWS Region. Set to true
+ * to enable the automatic warm-up feature, or set to false to disable
+ * it.
An HTTP 200 response if the request succeeds, or an error message if the request + * fails.
+ * + */ +export interface PutAccountDedicatedIpWarmupAttributesResponse + extends $MetadataBearer { + __type?: "PutAccountDedicatedIpWarmupAttributesResponse"; +} + +export namespace PutAccountDedicatedIpWarmupAttributesResponse { + export function isa( + o: any + ): o is PutAccountDedicatedIpWarmupAttributesResponse { + return _smithy.isa(o, "PutAccountDedicatedIpWarmupAttributesResponse"); + } +} + +/** + * + *A request to change the ability of your account to send email.
+ * + */ +export interface PutAccountSendingAttributesRequest { + __type?: "PutAccountSendingAttributesRequest"; + /** + * + *Enables or disables your account's ability to send email. Set to true to
+ * enable email sending, or set to false to disable email sending.
If AWS paused your account's ability to send email, you can't use this operation + * to resume your account's ability to send email.
+ *An HTTP 200 response if the request succeeds, or an error message if the request + * fails.
+ * + */ +export interface PutAccountSendingAttributesResponse extends $MetadataBearer { + __type?: "PutAccountSendingAttributesResponse"; +} + +export namespace PutAccountSendingAttributesResponse { + export function isa(o: any): o is PutAccountSendingAttributesResponse { + return _smithy.isa(o, "PutAccountSendingAttributesResponse"); + } +} + +/** + * + *A request to associate a configuration set with a dedicated IP pool.
+ * + */ +export interface PutConfigurationSetDeliveryOptionsRequest { + __type?: "PutConfigurationSetDeliveryOptionsRequest"; + /** + * + *The name of the configuration set that you want to associate with a dedicated IP + * pool.
+ * + */ + ConfigurationSetName: string | undefined; + + /** + * + *The name of the dedicated IP pool that you want to associate with the configuration + * set.
+ * + */ + SendingPoolName?: string; + + /** + * + *Specifies whether messages that use the configuration set are required to use
+ * Transport Layer Security (TLS). If the value is Require, messages are only
+ * delivered if a TLS connection can be established. If the value is Optional,
+ * messages can be delivered in plain text if a TLS connection can't be established.
An HTTP 200 response if the request succeeds, or an error message if the request + * fails.
+ * + */ +export interface PutConfigurationSetDeliveryOptionsResponse + extends $MetadataBearer { + __type?: "PutConfigurationSetDeliveryOptionsResponse"; +} + +export namespace PutConfigurationSetDeliveryOptionsResponse { + export function isa(o: any): o is PutConfigurationSetDeliveryOptionsResponse { + return _smithy.isa(o, "PutConfigurationSetDeliveryOptionsResponse"); + } +} + +/** + * + *A request to enable or disable tracking of reputation metrics for a configuration + * set.
+ * + */ +export interface PutConfigurationSetReputationOptionsRequest { + __type?: "PutConfigurationSetReputationOptionsRequest"; + /** + * + *The name of the configuration set that you want to enable or disable reputation metric + * tracking for.
+ * + */ + ConfigurationSetName: string | undefined; + + /** + * + *If true, tracking of reputation metrics is enabled for the configuration
+ * set. If false, tracking of reputation metrics is disabled for the
+ * configuration set.
An HTTP 200 response if the request succeeds, or an error message if the request + * fails.
+ * + */ +export interface PutConfigurationSetReputationOptionsResponse + extends $MetadataBearer { + __type?: "PutConfigurationSetReputationOptionsResponse"; +} + +export namespace PutConfigurationSetReputationOptionsResponse { + export function isa( + o: any + ): o is PutConfigurationSetReputationOptionsResponse { + return _smithy.isa(o, "PutConfigurationSetReputationOptionsResponse"); + } +} + +/** + * + *A request to enable or disable the ability of Amazon Pinpoint to send emails that use a specific + * configuration set.
+ * + */ +export interface PutConfigurationSetSendingOptionsRequest { + __type?: "PutConfigurationSetSendingOptionsRequest"; + /** + * + *The name of the configuration set that you want to enable or disable email sending + * for.
+ * + */ + ConfigurationSetName: string | undefined; + + /** + * + *If true, email sending is enabled for the configuration set. If
+ * false, email sending is disabled for the configuration set.
An HTTP 200 response if the request succeeds, or an error message if the request + * fails.
+ * + */ +export interface PutConfigurationSetSendingOptionsResponse + extends $MetadataBearer { + __type?: "PutConfigurationSetSendingOptionsResponse"; +} + +export namespace PutConfigurationSetSendingOptionsResponse { + export function isa(o: any): o is PutConfigurationSetSendingOptionsResponse { + return _smithy.isa(o, "PutConfigurationSetSendingOptionsResponse"); + } +} + +/** + * + *A request to add a custom domain for tracking open and click events to a configuration + * set.
+ * + */ +export interface PutConfigurationSetTrackingOptionsRequest { + __type?: "PutConfigurationSetTrackingOptionsRequest"; + /** + * + *The name of the configuration set that you want to add a custom tracking domain + * to.
+ * + */ + ConfigurationSetName: string | undefined; + + /** + * + *The domain that you want to use to track open and click events.
+ * + */ + CustomRedirectDomain?: string; +} + +export namespace PutConfigurationSetTrackingOptionsRequest { + export function isa(o: any): o is PutConfigurationSetTrackingOptionsRequest { + return _smithy.isa(o, "PutConfigurationSetTrackingOptionsRequest"); + } +} + +/** + * + *An HTTP 200 response if the request succeeds, or an error message if the request + * fails.
+ * + */ +export interface PutConfigurationSetTrackingOptionsResponse + extends $MetadataBearer { + __type?: "PutConfigurationSetTrackingOptionsResponse"; +} + +export namespace PutConfigurationSetTrackingOptionsResponse { + export function isa(o: any): o is PutConfigurationSetTrackingOptionsResponse { + return _smithy.isa(o, "PutConfigurationSetTrackingOptionsResponse"); + } +} + +/** + * + *A request to move a dedicated IP address to a dedicated IP pool.
+ * + */ +export interface PutDedicatedIpInPoolRequest { + __type?: "PutDedicatedIpInPoolRequest"; + /** + * + *The name of the IP pool that you want to add the dedicated IP address to. You have to + * specify an IP pool that already exists.
+ * + */ + DestinationPoolName: string | undefined; + + /** + * + *The IP address that you want to move to the dedicated IP pool. The value you specify + * has to be a dedicated IP address that's associated with your Amazon Pinpoint account.
+ * + */ + Ip: string | undefined; +} + +export namespace PutDedicatedIpInPoolRequest { + export function isa(o: any): o is PutDedicatedIpInPoolRequest { + return _smithy.isa(o, "PutDedicatedIpInPoolRequest"); + } +} + +/** + * + *An HTTP 200 response if the request succeeds, or an error message if the request + * fails.
+ * + */ +export interface PutDedicatedIpInPoolResponse extends $MetadataBearer { + __type?: "PutDedicatedIpInPoolResponse"; +} + +export namespace PutDedicatedIpInPoolResponse { + export function isa(o: any): o is PutDedicatedIpInPoolResponse { + return _smithy.isa(o, "PutDedicatedIpInPoolResponse"); + } +} + +/** + * + *A request to change the warm-up attributes for a dedicated IP address. This operation + * is useful when you want to resume the warm-up process for an existing IP address.
+ * + */ +export interface PutDedicatedIpWarmupAttributesRequest { + __type?: "PutDedicatedIpWarmupAttributesRequest"; + /** + * + *The dedicated IP address that you want to update the warm-up attributes for.
+ * + */ + Ip: string | undefined; + + /** + * + *The warm-up percentage that you want to associate with the dedicated IP + * address.
+ * + */ + WarmupPercentage: number | undefined; +} + +export namespace PutDedicatedIpWarmupAttributesRequest { + export function isa(o: any): o is PutDedicatedIpWarmupAttributesRequest { + return _smithy.isa(o, "PutDedicatedIpWarmupAttributesRequest"); + } +} + +/** + * + *An HTTP 200 response if the request succeeds, or an error message if the request + * fails.
+ * + */ +export interface PutDedicatedIpWarmupAttributesResponse + extends $MetadataBearer { + __type?: "PutDedicatedIpWarmupAttributesResponse"; +} + +export namespace PutDedicatedIpWarmupAttributesResponse { + export function isa(o: any): o is PutDedicatedIpWarmupAttributesResponse { + return _smithy.isa(o, "PutDedicatedIpWarmupAttributesResponse"); + } +} + +/** + * + *Enable or disable the Deliverability dashboard for your Amazon Pinpoint account. When you enable the + * Deliverability dashboard, you gain access to reputation, deliverability, and other metrics for + * the domains that you use to send email using Amazon Pinpoint. You also gain the ability to perform + * predictive inbox placement tests.
+ *When you use the Deliverability dashboard, you pay a monthly subscription charge, in addition + * to any other fees that you accrue by using Amazon Pinpoint. For more information about the + * features and cost of a Deliverability dashboard subscription, see Amazon Pinpoint Pricing.
+ * + */ +export interface PutDeliverabilityDashboardOptionRequest { + __type?: "PutDeliverabilityDashboardOptionRequest"; + /** + * + *Specifies whether to enable the Deliverability dashboard for your Amazon Pinpoint account. To enable the
+ * dashboard, set this value to true.
An array of objects, one for each verified domain that you use to send email and + * enabled the Deliverability dashboard for.
+ * + */ + SubscribedDomains?: ArrayA response that indicates whether the Deliverability dashboard is enabled for your Amazon Pinpoint + * account.
+ * + */ +export interface PutDeliverabilityDashboardOptionResponse + extends $MetadataBearer { + __type?: "PutDeliverabilityDashboardOptionResponse"; +} + +export namespace PutDeliverabilityDashboardOptionResponse { + export function isa(o: any): o is PutDeliverabilityDashboardOptionResponse { + return _smithy.isa(o, "PutDeliverabilityDashboardOptionResponse"); + } +} + +/** + * + *A request to enable or disable DKIM signing of email that you send from an email + * identity.
+ * + */ +export interface PutEmailIdentityDkimAttributesRequest { + __type?: "PutEmailIdentityDkimAttributesRequest"; + /** + * + *The email identity that you want to change the DKIM settings for.
+ * + */ + EmailIdentity: string | undefined; + + /** + * + *Sets the DKIM signing configuration for the identity.
+ *When you set this value true, then the messages that Amazon Pinpoint sends from the
+ * identity are DKIM-signed. When you set this value to false, then the
+ * messages that Amazon Pinpoint sends from the identity aren't DKIM-signed.
An HTTP 200 response if the request succeeds, or an error message if the request + * fails.
+ * + */ +export interface PutEmailIdentityDkimAttributesResponse + extends $MetadataBearer { + __type?: "PutEmailIdentityDkimAttributesResponse"; +} + +export namespace PutEmailIdentityDkimAttributesResponse { + export function isa(o: any): o is PutEmailIdentityDkimAttributesResponse { + return _smithy.isa(o, "PutEmailIdentityDkimAttributesResponse"); + } +} + +/** + * + *A request to set the attributes that control how bounce and complaint events are + * processed.
+ * + */ +export interface PutEmailIdentityFeedbackAttributesRequest { + __type?: "PutEmailIdentityFeedbackAttributesRequest"; + /** + * + *Sets the feedback forwarding configuration for the identity.
+ *If the value is true, Amazon Pinpoint sends you email notifications when bounce or
+ * complaint events occur. Amazon Pinpoint sends this notification to the address that you specified
+ * in the Return-Path header of the original email.
When you set this value to false, Amazon Pinpoint sends notifications through other
+ * mechanisms, such as by notifying an Amazon SNS topic or another event destination. You're
+ * required to have a method of tracking bounces and complaints. If you haven't set up
+ * another mechanism for receiving bounce or complaint notifications, Amazon Pinpoint sends an email
+ * notification when these events occur (even if this setting is disabled).
The email identity that you want to configure bounce and complaint feedback forwarding + * for.
+ * + */ + EmailIdentity: string | undefined; +} + +export namespace PutEmailIdentityFeedbackAttributesRequest { + export function isa(o: any): o is PutEmailIdentityFeedbackAttributesRequest { + return _smithy.isa(o, "PutEmailIdentityFeedbackAttributesRequest"); + } +} + +/** + * + *An HTTP 200 response if the request succeeds, or an error message if the request + * fails.
+ * + */ +export interface PutEmailIdentityFeedbackAttributesResponse + extends $MetadataBearer { + __type?: "PutEmailIdentityFeedbackAttributesResponse"; +} + +export namespace PutEmailIdentityFeedbackAttributesResponse { + export function isa(o: any): o is PutEmailIdentityFeedbackAttributesResponse { + return _smithy.isa(o, "PutEmailIdentityFeedbackAttributesResponse"); + } +} + +/** + * + *A request to configure the custom MAIL FROM domain for a verified identity.
+ * + */ +export interface PutEmailIdentityMailFromAttributesRequest { + __type?: "PutEmailIdentityMailFromAttributesRequest"; + /** + * + *The action that you want Amazon Pinpoint to take if it can't read the required MX record when
+ * you send an email. When you set this value to UseDefaultValue, Amazon Pinpoint uses
+ * amazonses.com as the MAIL FROM domain. When you set this value
+ * to RejectMessage, Amazon Pinpoint returns a MailFromDomainNotVerified
+ * error, and doesn't attempt to deliver the email.
These behaviors are taken when the custom MAIL FROM domain configuration is in the
+ * Pending, Failed, and TemporaryFailure
+ * states.
The verified email identity that you want to set up the custom MAIL FROM domain + * for.
+ * + */ + EmailIdentity: string | undefined; + + /** + * + *The custom MAIL FROM domain that you want the verified identity to use. The MAIL FROM + * domain must meet the following criteria:
+ *