/* * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). * You may not use this file except in compliance with the License. * A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either * express or implied. See the License for the specific language governing * permissions and limitations under the License. */ /* * Do not modify this file. This file is generated from the pinpoint-email-2018-07-26.normal.json service model. */ using System; using System.Threading; using System.Threading.Tasks; using System.Collections.Generic; using Amazon.Runtime; using Amazon.PinpointEmail.Model; namespace Amazon.PinpointEmail { /// /// Interface for accessing PinpointEmail /// /// Amazon Pinpoint Email Service /// /// 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. /// /// public partial interface IAmazonPinpointEmail : IAmazonService, IDisposable { #if AWS_ASYNC_ENUMERABLES_API /// /// Paginators for the service /// IPinpointEmailPaginatorFactory Paginators { get; } #endif #region CreateConfigurationSet /// /// 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. /// /// Container for the necessary parameters to execute the CreateConfigurationSet service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the CreateConfigurationSet service method, as returned by PinpointEmail. /// /// The resource specified in your request already exists. /// /// /// The input you provided is invalid. /// /// /// The resource is being modified by another operation or thread. /// /// /// There are too many instances of the specified resource type. /// /// /// The resource you attempted to access doesn't exist. /// /// /// Too many requests have been made to the operation. /// /// REST API Reference for CreateConfigurationSet Operation Task CreateConfigurationSetAsync(CreateConfigurationSetRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region CreateConfigurationSetEventDestination /// /// 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. /// /// /// Container for the necessary parameters to execute the CreateConfigurationSetEventDestination service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the CreateConfigurationSetEventDestination service method, as returned by PinpointEmail. /// /// The resource specified in your request already exists. /// /// /// The input you provided is invalid. /// /// /// There are too many instances of the specified resource type. /// /// /// The resource you attempted to access doesn't exist. /// /// /// Too many requests have been made to the operation. /// /// REST API Reference for CreateConfigurationSetEventDestination Operation Task CreateConfigurationSetEventDestinationAsync(CreateConfigurationSetEventDestinationRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region CreateDedicatedIpPool /// /// Create a new pool of dedicated IP addresses. A pool can include one or more dedicated /// IP addresses that are associated with your Amazon Pinpoint account. You can associate /// a pool with a configuration set. When you send an email that uses that configuration /// set, Amazon Pinpoint sends it using only the IP addresses in the associated pool. /// /// Container for the necessary parameters to execute the CreateDedicatedIpPool service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the CreateDedicatedIpPool service method, as returned by PinpointEmail. /// /// The resource specified in your request already exists. /// /// /// The input you provided is invalid. /// /// /// The resource is being modified by another operation or thread. /// /// /// There are too many instances of the specified resource type. /// /// /// Too many requests have been made to the operation. /// /// REST API Reference for CreateDedicatedIpPool Operation Task CreateDedicatedIpPoolAsync(CreateDedicatedIpPoolRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region CreateDeliverabilityTestReport /// /// Create a new predictive inbox placement test. Predictive inbox placement tests can /// help you predict how your messages will be handled by various email providers around /// the world. When you perform a predictive inbox placement test, you provide a sample /// message that contains the content that you plan to send to your customers. Amazon /// Pinpoint 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. /// /// Container for the necessary parameters to execute the CreateDeliverabilityTestReport service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the CreateDeliverabilityTestReport service method, as returned by PinpointEmail. /// /// The message can't be sent because the account's ability to send email has been permanently /// restricted. /// /// /// The input you provided is invalid. /// /// /// The resource is being modified by another operation or thread. /// /// /// There are too many instances of the specified resource type. /// /// /// The message can't be sent because the sending domain isn't verified. /// /// /// The message can't be sent because it contains invalid content. /// /// /// The resource you attempted to access doesn't exist. /// /// /// The message can't be sent because the account's ability to send email is currently /// paused. /// /// /// Too many requests have been made to the operation. /// /// REST API Reference for CreateDeliverabilityTestReport Operation Task CreateDeliverabilityTestReportAsync(CreateDeliverabilityTestReportRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region CreateEmailIdentity /// /// 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. /// /// /// Container for the necessary parameters to execute the CreateEmailIdentity service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the CreateEmailIdentity service method, as returned by PinpointEmail. /// /// The input you provided is invalid. /// /// /// The resource is being modified by another operation or thread. /// /// /// There are too many instances of the specified resource type. /// /// /// Too many requests have been made to the operation. /// /// REST API Reference for CreateEmailIdentity Operation Task CreateEmailIdentityAsync(CreateEmailIdentityRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DeleteConfigurationSet /// /// 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. /// /// /// Container for the necessary parameters to execute the DeleteConfigurationSet service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DeleteConfigurationSet service method, as returned by PinpointEmail. /// /// The input you provided is invalid. /// /// /// The resource is being modified by another operation or thread. /// /// /// The resource you attempted to access doesn't exist. /// /// /// Too many requests have been made to the operation. /// /// REST API Reference for DeleteConfigurationSet Operation Task DeleteConfigurationSetAsync(DeleteConfigurationSetRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DeleteConfigurationSetEventDestination /// /// Delete 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. /// /// /// Container for the necessary parameters to execute the DeleteConfigurationSetEventDestination service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DeleteConfigurationSetEventDestination service method, as returned by PinpointEmail. /// /// The input you provided is invalid. /// /// /// The resource you attempted to access doesn't exist. /// /// /// Too many requests have been made to the operation. /// /// REST API Reference for DeleteConfigurationSetEventDestination Operation Task DeleteConfigurationSetEventDestinationAsync(DeleteConfigurationSetEventDestinationRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DeleteDedicatedIpPool /// /// Delete a dedicated IP pool. /// /// Container for the necessary parameters to execute the DeleteDedicatedIpPool service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DeleteDedicatedIpPool service method, as returned by PinpointEmail. /// /// The input you provided is invalid. /// /// /// The resource is being modified by another operation or thread. /// /// /// The resource you attempted to access doesn't exist. /// /// /// Too many requests have been made to the operation. /// /// REST API Reference for DeleteDedicatedIpPool Operation Task DeleteDedicatedIpPoolAsync(DeleteDedicatedIpPoolRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DeleteEmailIdentity /// /// Deletes an email identity that you previously verified for use with Amazon Pinpoint. /// An identity can be either an email address or a domain name. /// /// Container for the necessary parameters to execute the DeleteEmailIdentity service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DeleteEmailIdentity service method, as returned by PinpointEmail. /// /// The input you provided is invalid. /// /// /// The resource is being modified by another operation or thread. /// /// /// The resource you attempted to access doesn't exist. /// /// /// Too many requests have been made to the operation. /// /// REST API Reference for DeleteEmailIdentity Operation Task DeleteEmailIdentityAsync(DeleteEmailIdentityRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region GetAccount /// /// Obtain information about the email-sending status and capabilities of your Amazon /// Pinpoint account in the current AWS Region. /// /// Container for the necessary parameters to execute the GetAccount service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the GetAccount service method, as returned by PinpointEmail. /// /// The input you provided is invalid. /// /// /// Too many requests have been made to the operation. /// /// REST API Reference for GetAccount Operation Task GetAccountAsync(GetAccountRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region GetBlacklistReports /// /// Retrieve a list of the blacklists that your dedicated IP addresses appear on. /// /// Container for the necessary parameters to execute the GetBlacklistReports service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the GetBlacklistReports service method, as returned by PinpointEmail. /// /// The input you provided is invalid. /// /// /// The resource you attempted to access doesn't exist. /// /// /// Too many requests have been made to the operation. /// /// REST API Reference for GetBlacklistReports Operation Task GetBlacklistReportsAsync(GetBlacklistReportsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region GetConfigurationSet /// /// Get information about an existing configuration set, including the dedicated IP pool /// that it's associated with, whether or not it's enabled for sending email, and more. /// /// /// /// 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. /// /// /// Container for the necessary parameters to execute the GetConfigurationSet service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the GetConfigurationSet service method, as returned by PinpointEmail. /// /// The input you provided is invalid. /// /// /// The resource you attempted to access doesn't exist. /// /// /// Too many requests have been made to the operation. /// /// REST API Reference for GetConfigurationSet Operation Task GetConfigurationSetAsync(GetConfigurationSetRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region GetConfigurationSetEventDestinations /// /// Retrieve 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. /// /// /// Container for the necessary parameters to execute the GetConfigurationSetEventDestinations service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the GetConfigurationSetEventDestinations service method, as returned by PinpointEmail. /// /// The input you provided is invalid. /// /// /// The resource you attempted to access doesn't exist. /// /// /// Too many requests have been made to the operation. /// /// REST API Reference for GetConfigurationSetEventDestinations Operation Task GetConfigurationSetEventDestinationsAsync(GetConfigurationSetEventDestinationsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region GetDedicatedIp /// /// Get information about a dedicated IP address, including the name of the dedicated /// IP pool that it's associated with, as well information about the automatic warm-up /// process for the address. /// /// Container for the necessary parameters to execute the GetDedicatedIp service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the GetDedicatedIp service method, as returned by PinpointEmail. /// /// The input you provided is invalid. /// /// /// The resource you attempted to access doesn't exist. /// /// /// Too many requests have been made to the operation. /// /// REST API Reference for GetDedicatedIp Operation Task GetDedicatedIpAsync(GetDedicatedIpRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region GetDedicatedIps /// /// List the dedicated IP addresses that are associated with your Amazon Pinpoint account. /// /// Container for the necessary parameters to execute the GetDedicatedIps service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the GetDedicatedIps service method, as returned by PinpointEmail. /// /// The input you provided is invalid. /// /// /// The resource you attempted to access doesn't exist. /// /// /// Too many requests have been made to the operation. /// /// REST API Reference for GetDedicatedIps Operation Task GetDedicatedIpsAsync(GetDedicatedIpsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region GetDeliverabilityDashboardOptions /// /// 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. /// /// /// Container for the necessary parameters to execute the GetDeliverabilityDashboardOptions service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the GetDeliverabilityDashboardOptions service method, as returned by PinpointEmail. /// /// The input you provided is invalid. /// /// /// There are too many instances of the specified resource type. /// /// /// Too many requests have been made to the operation. /// /// REST API Reference for GetDeliverabilityDashboardOptions Operation Task GetDeliverabilityDashboardOptionsAsync(GetDeliverabilityDashboardOptionsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region GetDeliverabilityTestReport /// /// Retrieve the results of a predictive inbox placement test. /// /// Container for the necessary parameters to execute the GetDeliverabilityTestReport service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the GetDeliverabilityTestReport service method, as returned by PinpointEmail. /// /// The input you provided is invalid. /// /// /// The resource you attempted to access doesn't exist. /// /// /// Too many requests have been made to the operation. /// /// REST API Reference for GetDeliverabilityTestReport Operation Task GetDeliverabilityTestReportAsync(GetDeliverabilityTestReportRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region GetDomainDeliverabilityCampaign /// /// Retrieve all the deliverability data for a specific campaign. This data is available /// for a campaign only if the campaign sent email by using a domain that the Deliverability /// dashboard is enabled for (PutDeliverabilityDashboardOption operation). /// /// Container for the necessary parameters to execute the GetDomainDeliverabilityCampaign service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the GetDomainDeliverabilityCampaign service method, as returned by PinpointEmail. /// /// The input you provided is invalid. /// /// /// The resource you attempted to access doesn't exist. /// /// /// Too many requests have been made to the operation. /// /// REST API Reference for GetDomainDeliverabilityCampaign Operation Task GetDomainDeliverabilityCampaignAsync(GetDomainDeliverabilityCampaignRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region GetDomainStatisticsReport /// /// Retrieve inbox placement and engagement rates for the domains that you use to send /// email. /// /// Container for the necessary parameters to execute the GetDomainStatisticsReport service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the GetDomainStatisticsReport service method, as returned by PinpointEmail. /// /// The input you provided is invalid. /// /// /// The resource you attempted to access doesn't exist. /// /// /// Too many requests have been made to the operation. /// /// REST API Reference for GetDomainStatisticsReport Operation Task GetDomainStatisticsReportAsync(GetDomainStatisticsReportRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region GetEmailIdentity /// /// Provides information about a specific identity associated with your Amazon Pinpoint /// account, including the identity's verification status, its DKIM authentication status, /// and its custom Mail-From settings. /// /// Container for the necessary parameters to execute the GetEmailIdentity service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the GetEmailIdentity service method, as returned by PinpointEmail. /// /// The input you provided is invalid. /// /// /// The resource you attempted to access doesn't exist. /// /// /// Too many requests have been made to the operation. /// /// REST API Reference for GetEmailIdentity Operation Task GetEmailIdentityAsync(GetEmailIdentityRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region ListConfigurationSets /// /// List 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. /// /// /// Container for the necessary parameters to execute the ListConfigurationSets service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the ListConfigurationSets service method, as returned by PinpointEmail. /// /// The input you provided is invalid. /// /// /// Too many requests have been made to the operation. /// /// REST API Reference for ListConfigurationSets Operation Task ListConfigurationSetsAsync(ListConfigurationSetsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region ListDedicatedIpPools /// /// List all of the dedicated IP pools that exist in your Amazon Pinpoint account in the /// current AWS Region. /// /// Container for the necessary parameters to execute the ListDedicatedIpPools service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the ListDedicatedIpPools service method, as returned by PinpointEmail. /// /// The input you provided is invalid. /// /// /// Too many requests have been made to the operation. /// /// REST API Reference for ListDedicatedIpPools Operation Task ListDedicatedIpPoolsAsync(ListDedicatedIpPoolsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region ListDeliverabilityTestReports /// /// 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. /// /// Container for the necessary parameters to execute the ListDeliverabilityTestReports service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the ListDeliverabilityTestReports service method, as returned by PinpointEmail. /// /// The input you provided is invalid. /// /// /// The resource you attempted to access doesn't exist. /// /// /// Too many requests have been made to the operation. /// /// REST API Reference for ListDeliverabilityTestReports Operation Task ListDeliverabilityTestReportsAsync(ListDeliverabilityTestReportsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region ListDomainDeliverabilityCampaigns /// /// 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. /// /// Container for the necessary parameters to execute the ListDomainDeliverabilityCampaigns service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the ListDomainDeliverabilityCampaigns service method, as returned by PinpointEmail. /// /// The input you provided is invalid. /// /// /// The resource you attempted to access doesn't exist. /// /// /// Too many requests have been made to the operation. /// /// REST API Reference for ListDomainDeliverabilityCampaigns Operation Task ListDomainDeliverabilityCampaignsAsync(ListDomainDeliverabilityCampaignsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region ListEmailIdentities /// /// Returns a list of all of the email identities that are associated with your Amazon /// Pinpoint account. An identity can be either an email address or a domain. This operation /// returns identities that are verified as well as those that aren't. /// /// Container for the necessary parameters to execute the ListEmailIdentities service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the ListEmailIdentities service method, as returned by PinpointEmail. /// /// The input you provided is invalid. /// /// /// Too many requests have been made to the operation. /// /// REST API Reference for ListEmailIdentities Operation Task ListEmailIdentitiesAsync(ListEmailIdentitiesRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region ListTagsForResource /// /// Retrieve a list of the tags (keys and values) that are associated with a specified /// resource. A tag is a label that you optionally define and associate with a /// resource in Amazon Pinpoint. Each tag consists of a required tag key and an /// optional associated tag value. A tag key is a general label that acts as a /// category for more specific tag values. A tag value acts as a descriptor within a tag /// key. /// /// Container for the necessary parameters to execute the ListTagsForResource service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the ListTagsForResource service method, as returned by PinpointEmail. /// /// The input you provided is invalid. /// /// /// The resource you attempted to access doesn't exist. /// /// /// Too many requests have been made to the operation. /// /// REST API Reference for ListTagsForResource Operation Task ListTagsForResourceAsync(ListTagsForResourceRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region PutAccountDedicatedIpWarmupAttributes /// /// Enable or disable the automatic warm-up feature for dedicated IP addresses. /// /// Container for the necessary parameters to execute the PutAccountDedicatedIpWarmupAttributes service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the PutAccountDedicatedIpWarmupAttributes service method, as returned by PinpointEmail. /// /// The input you provided is invalid. /// /// /// Too many requests have been made to the operation. /// /// REST API Reference for PutAccountDedicatedIpWarmupAttributes Operation Task PutAccountDedicatedIpWarmupAttributesAsync(PutAccountDedicatedIpWarmupAttributesRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region PutAccountSendingAttributes /// /// Enable or disable the ability of your account to send email. /// /// Container for the necessary parameters to execute the PutAccountSendingAttributes service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the PutAccountSendingAttributes service method, as returned by PinpointEmail. /// /// The input you provided is invalid. /// /// /// Too many requests have been made to the operation. /// /// REST API Reference for PutAccountSendingAttributes Operation Task PutAccountSendingAttributesAsync(PutAccountSendingAttributesRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region PutConfigurationSetDeliveryOptions /// /// Associate a configuration set with a dedicated IP pool. You can use dedicated IP pools /// to create groups of dedicated IP addresses for sending specific types of email. /// /// Container for the necessary parameters to execute the PutConfigurationSetDeliveryOptions service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the PutConfigurationSetDeliveryOptions service method, as returned by PinpointEmail. /// /// The input you provided is invalid. /// /// /// The resource you attempted to access doesn't exist. /// /// /// Too many requests have been made to the operation. /// /// REST API Reference for PutConfigurationSetDeliveryOptions Operation Task PutConfigurationSetDeliveryOptionsAsync(PutConfigurationSetDeliveryOptionsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region PutConfigurationSetReputationOptions /// /// Enable or disable collection of reputation metrics for emails that you send using /// a particular configuration set in a specific AWS Region. /// /// Container for the necessary parameters to execute the PutConfigurationSetReputationOptions service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the PutConfigurationSetReputationOptions service method, as returned by PinpointEmail. /// /// The input you provided is invalid. /// /// /// The resource you attempted to access doesn't exist. /// /// /// Too many requests have been made to the operation. /// /// REST API Reference for PutConfigurationSetReputationOptions Operation Task PutConfigurationSetReputationOptionsAsync(PutConfigurationSetReputationOptionsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region PutConfigurationSetSendingOptions /// /// Enable or disable email sending for messages that use a particular configuration set /// in a specific AWS Region. /// /// Container for the necessary parameters to execute the PutConfigurationSetSendingOptions service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the PutConfigurationSetSendingOptions service method, as returned by PinpointEmail. /// /// The input you provided is invalid. /// /// /// The resource you attempted to access doesn't exist. /// /// /// Too many requests have been made to the operation. /// /// REST API Reference for PutConfigurationSetSendingOptions Operation Task PutConfigurationSetSendingOptionsAsync(PutConfigurationSetSendingOptionsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region PutConfigurationSetTrackingOptions /// /// Specify a custom domain to use for open and click tracking elements in email that /// you send using Amazon Pinpoint. /// /// Container for the necessary parameters to execute the PutConfigurationSetTrackingOptions service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the PutConfigurationSetTrackingOptions service method, as returned by PinpointEmail. /// /// The input you provided is invalid. /// /// /// The resource you attempted to access doesn't exist. /// /// /// Too many requests have been made to the operation. /// /// REST API Reference for PutConfigurationSetTrackingOptions Operation Task PutConfigurationSetTrackingOptionsAsync(PutConfigurationSetTrackingOptionsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region PutDedicatedIpInPool /// /// Move 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. /// /// /// /// Container for the necessary parameters to execute the PutDedicatedIpInPool service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the PutDedicatedIpInPool service method, as returned by PinpointEmail. /// /// The input you provided is invalid. /// /// /// The resource you attempted to access doesn't exist. /// /// /// Too many requests have been made to the operation. /// /// REST API Reference for PutDedicatedIpInPool Operation Task PutDedicatedIpInPoolAsync(PutDedicatedIpInPoolRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region PutDedicatedIpWarmupAttributes /// /// /// /// Container for the necessary parameters to execute the PutDedicatedIpWarmupAttributes service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the PutDedicatedIpWarmupAttributes service method, as returned by PinpointEmail. /// /// The input you provided is invalid. /// /// /// The resource you attempted to access doesn't exist. /// /// /// Too many requests have been made to the operation. /// /// REST API Reference for PutDedicatedIpWarmupAttributes Operation Task PutDedicatedIpWarmupAttributesAsync(PutDedicatedIpWarmupAttributesRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region PutDeliverabilityDashboardOption /// /// 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. /// /// /// Container for the necessary parameters to execute the PutDeliverabilityDashboardOption service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the PutDeliverabilityDashboardOption service method, as returned by PinpointEmail. /// /// The resource specified in your request already exists. /// /// /// The input you provided is invalid. /// /// /// There are too many instances of the specified resource type. /// /// /// The resource you attempted to access doesn't exist. /// /// /// Too many requests have been made to the operation. /// /// REST API Reference for PutDeliverabilityDashboardOption Operation Task PutDeliverabilityDashboardOptionAsync(PutDeliverabilityDashboardOptionRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region PutEmailIdentityDkimAttributes /// /// Used to enable or disable DKIM authentication for an email identity. /// /// Container for the necessary parameters to execute the PutEmailIdentityDkimAttributes service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the PutEmailIdentityDkimAttributes service method, as returned by PinpointEmail. /// /// The input you provided is invalid. /// /// /// The resource you attempted to access doesn't exist. /// /// /// Too many requests have been made to the operation. /// /// REST API Reference for PutEmailIdentityDkimAttributes Operation Task PutEmailIdentityDkimAttributesAsync(PutEmailIdentityDkimAttributesRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region PutEmailIdentityFeedbackAttributes /// /// Used to enable or disable feedback forwarding for an identity. This setting determines /// what happens when an identity is used to send an email that results in a bounce or /// complaint event. /// /// /// /// 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). /// /// /// Container for the necessary parameters to execute the PutEmailIdentityFeedbackAttributes service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the PutEmailIdentityFeedbackAttributes service method, as returned by PinpointEmail. /// /// The input you provided is invalid. /// /// /// The resource you attempted to access doesn't exist. /// /// /// Too many requests have been made to the operation. /// /// REST API Reference for PutEmailIdentityFeedbackAttributes Operation Task PutEmailIdentityFeedbackAttributesAsync(PutEmailIdentityFeedbackAttributesRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region PutEmailIdentityMailFromAttributes /// /// Used to enable or disable the custom Mail-From domain configuration for an email identity. /// /// Container for the necessary parameters to execute the PutEmailIdentityMailFromAttributes service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the PutEmailIdentityMailFromAttributes service method, as returned by PinpointEmail. /// /// The input you provided is invalid. /// /// /// The resource you attempted to access doesn't exist. /// /// /// Too many requests have been made to the operation. /// /// REST API Reference for PutEmailIdentityMailFromAttributes Operation Task PutEmailIdentityMailFromAttributesAsync(PutEmailIdentityMailFromAttributesRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region SendEmail /// /// Sends 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. /// ///
/// /// Container for the necessary parameters to execute the SendEmail service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the SendEmail service method, as returned by PinpointEmail. /// /// The message can't be sent because the account's ability to send email has been permanently /// restricted. /// /// /// The input you provided is invalid. /// /// /// There are too many instances of the specified resource type. /// /// /// The message can't be sent because the sending domain isn't verified. /// /// /// The message can't be sent because it contains invalid content. /// /// /// The resource you attempted to access doesn't exist. /// /// /// The message can't be sent because the account's ability to send email is currently /// paused. /// /// /// Too many requests have been made to the operation. /// /// REST API Reference for SendEmail Operation Task SendEmailAsync(SendEmailRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region TagResource /// /// Add one or more tags (keys and values) to a specified resource. A tag is a /// label that you optionally define and associate with a resource in Amazon Pinpoint. /// Tags can help you categorize and manage resources in different ways, such as by purpose, /// owner, environment, or other criteria. A resource can have as many as 50 tags. /// /// /// /// Each tag consists of a required tag key and an associated tag value, /// both of which you define. A tag key is a general label that acts as a category for /// more specific tag values. A tag value acts as a descriptor within a tag key. /// /// /// Container for the necessary parameters to execute the TagResource service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the TagResource service method, as returned by PinpointEmail. /// /// The input you provided is invalid. /// /// /// The resource is being modified by another operation or thread. /// /// /// The resource you attempted to access doesn't exist. /// /// /// Too many requests have been made to the operation. /// /// REST API Reference for TagResource Operation Task TagResourceAsync(TagResourceRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region UntagResource /// /// Remove one or more tags (keys and values) from a specified resource. /// /// Container for the necessary parameters to execute the UntagResource service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the UntagResource service method, as returned by PinpointEmail. /// /// The input you provided is invalid. /// /// /// The resource is being modified by another operation or thread. /// /// /// The resource you attempted to access doesn't exist. /// /// /// Too many requests have been made to the operation. /// /// REST API Reference for UntagResource Operation Task UntagResourceAsync(UntagResourceRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region UpdateConfigurationSetEventDestination /// /// Update 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. /// /// /// Container for the necessary parameters to execute the UpdateConfigurationSetEventDestination service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the UpdateConfigurationSetEventDestination service method, as returned by PinpointEmail. /// /// The input you provided is invalid. /// /// /// The resource you attempted to access doesn't exist. /// /// /// Too many requests have been made to the operation. /// /// REST API Reference for UpdateConfigurationSetEventDestination Operation Task UpdateConfigurationSetEventDestinationAsync(UpdateConfigurationSetEventDestinationRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion } }