pinpointemail

package module
v0.26.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 30, 2020 License: Apache-2.0 Imports: 26 Imported by: 0

Documentation

Index

Constants

View Source
const ServiceAPIVersion = "2018-07-26"
View Source
const ServiceID = "Pinpoint Email"

Variables

This section is empty.

Functions

func AddResolveEndpointMiddleware

func AddResolveEndpointMiddleware(stack *middleware.Stack, options ResolveEndpointMiddlewareOptions)

func NewDefaultEndpointResolver

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

func RemoveResolveEndpointMiddleware

func RemoveResolveEndpointMiddleware(stack *middleware.Stack) error

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

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 (https://aws.amazon.com/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 (https://docs.aws.amazon.com/pinpoint/latest/developerguide/welcome.html). 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 (https://docs.aws.amazon.com/general/latest/gr/rande.html#pinpoint_region) in the Amazon Web Services General Reference. To learn more about AWS Regions, see Managing AWS Regions (https://docs.aws.amazon.com/general/latest/gr/rande-manage.html) 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 (http://aws.amazon.com/about-aws/global-infrastructure/).

func New

func New(options Options, optFns ...func(*Options)) *Client

New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.

func NewFromConfig

func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client

NewFromConfig returns a new client from the provided config.

func (*Client) CreateConfigurationSet

func (c *Client) CreateConfigurationSet(ctx context.Context, params *CreateConfigurationSetInput, optFns ...func(*Options)) (*CreateConfigurationSetOutput, error)

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.

func (*Client) CreateConfigurationSetEventDestination

func (c *Client) CreateConfigurationSetEventDestination(ctx context.Context, params *CreateConfigurationSetEventDestinationInput, optFns ...func(*Options)) (*CreateConfigurationSetEventDestinationOutput, error)

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.

func (*Client) CreateDedicatedIpPool

func (c *Client) CreateDedicatedIpPool(ctx context.Context, params *CreateDedicatedIpPoolInput, optFns ...func(*Options)) (*CreateDedicatedIpPoolOutput, error)

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.

func (*Client) CreateDeliverabilityTestReport

func (c *Client) CreateDeliverabilityTestReport(ctx context.Context, params *CreateDeliverabilityTestReportInput, optFns ...func(*Options)) (*CreateDeliverabilityTestReportOutput, error)

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.

func (*Client) CreateEmailIdentity

func (c *Client) CreateEmailIdentity(ctx context.Context, params *CreateEmailIdentityInput, optFns ...func(*Options)) (*CreateEmailIdentityOutput, error)

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. </p> <p>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.</p>

func (*Client) DeleteConfigurationSet

func (c *Client) DeleteConfigurationSet(ctx context.Context, params *DeleteConfigurationSetInput, optFns ...func(*Options)) (*DeleteConfigurationSetOutput, error)

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.

func (*Client) DeleteConfigurationSetEventDestination

func (c *Client) DeleteConfigurationSetEventDestination(ctx context.Context, params *DeleteConfigurationSetEventDestinationInput, optFns ...func(*Options)) (*DeleteConfigurationSetEventDestinationOutput, error)

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.

func (*Client) DeleteDedicatedIpPool

func (c *Client) DeleteDedicatedIpPool(ctx context.Context, params *DeleteDedicatedIpPoolInput, optFns ...func(*Options)) (*DeleteDedicatedIpPoolOutput, error)

Delete a dedicated IP pool.

func (*Client) DeleteEmailIdentity

func (c *Client) DeleteEmailIdentity(ctx context.Context, params *DeleteEmailIdentityInput, optFns ...func(*Options)) (*DeleteEmailIdentityOutput, error)

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.

func (*Client) GetAccount

func (c *Client) GetAccount(ctx context.Context, params *GetAccountInput, optFns ...func(*Options)) (*GetAccountOutput, error)

Obtain information about the email-sending status and capabilities of your Amazon Pinpoint account in the current AWS Region.

func (*Client) GetBlacklistReports

func (c *Client) GetBlacklistReports(ctx context.Context, params *GetBlacklistReportsInput, optFns ...func(*Options)) (*GetBlacklistReportsOutput, error)

Retrieve a list of the blacklists that your dedicated IP addresses appear on.

func (*Client) GetConfigurationSet

func (c *Client) GetConfigurationSet(ctx context.Context, params *GetConfigurationSetInput, optFns ...func(*Options)) (*GetConfigurationSetOutput, error)

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.

func (*Client) GetConfigurationSetEventDestinations

func (c *Client) GetConfigurationSetEventDestinations(ctx context.Context, params *GetConfigurationSetEventDestinationsInput, optFns ...func(*Options)) (*GetConfigurationSetEventDestinationsOutput, error)

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.

func (*Client) GetDedicatedIp

func (c *Client) GetDedicatedIp(ctx context.Context, params *GetDedicatedIpInput, optFns ...func(*Options)) (*GetDedicatedIpOutput, error)

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.

func (*Client) GetDedicatedIps

func (c *Client) GetDedicatedIps(ctx context.Context, params *GetDedicatedIpsInput, optFns ...func(*Options)) (*GetDedicatedIpsOutput, error)

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

func (*Client) GetDeliverabilityDashboardOptions

func (c *Client) GetDeliverabilityDashboardOptions(ctx context.Context, params *GetDeliverabilityDashboardOptionsInput, optFns ...func(*Options)) (*GetDeliverabilityDashboardOptionsOutput, error)

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 (http://aws.amazon.com/pinpoint/pricing/).

func (*Client) GetDeliverabilityTestReport

func (c *Client) GetDeliverabilityTestReport(ctx context.Context, params *GetDeliverabilityTestReportInput, optFns ...func(*Options)) (*GetDeliverabilityTestReportOutput, error)

Retrieve the results of a predictive inbox placement test.

func (*Client) GetDomainDeliverabilityCampaign

func (c *Client) GetDomainDeliverabilityCampaign(ctx context.Context, params *GetDomainDeliverabilityCampaignInput, optFns ...func(*Options)) (*GetDomainDeliverabilityCampaignOutput, error)

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

func (*Client) GetDomainStatisticsReport

func (c *Client) GetDomainStatisticsReport(ctx context.Context, params *GetDomainStatisticsReportInput, optFns ...func(*Options)) (*GetDomainStatisticsReportOutput, error)

Retrieve inbox placement and engagement rates for the domains that you use to send email.

func (*Client) GetEmailIdentity

func (c *Client) GetEmailIdentity(ctx context.Context, params *GetEmailIdentityInput, optFns ...func(*Options)) (*GetEmailIdentityOutput, error)

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.

func (*Client) ListConfigurationSets

func (c *Client) ListConfigurationSets(ctx context.Context, params *ListConfigurationSetsInput, optFns ...func(*Options)) (*ListConfigurationSetsOutput, error)

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.

func (*Client) ListDedicatedIpPools

func (c *Client) ListDedicatedIpPools(ctx context.Context, params *ListDedicatedIpPoolsInput, optFns ...func(*Options)) (*ListDedicatedIpPoolsOutput, error)

List all of the dedicated IP pools that exist in your Amazon Pinpoint account in the current AWS Region.

func (*Client) ListDeliverabilityTestReports

func (c *Client) ListDeliverabilityTestReports(ctx context.Context, params *ListDeliverabilityTestReportsInput, optFns ...func(*Options)) (*ListDeliverabilityTestReportsOutput, error)

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.

func (*Client) ListDomainDeliverabilityCampaigns

func (c *Client) ListDomainDeliverabilityCampaigns(ctx context.Context, params *ListDomainDeliverabilityCampaignsInput, optFns ...func(*Options)) (*ListDomainDeliverabilityCampaignsOutput, error)

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.

func (*Client) ListEmailIdentities

func (c *Client) ListEmailIdentities(ctx context.Context, params *ListEmailIdentitiesInput, optFns ...func(*Options)) (*ListEmailIdentitiesOutput, error)

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.

func (*Client) ListTagsForResource

func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)

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.

func (*Client) PutAccountDedicatedIpWarmupAttributes

func (c *Client) PutAccountDedicatedIpWarmupAttributes(ctx context.Context, params *PutAccountDedicatedIpWarmupAttributesInput, optFns ...func(*Options)) (*PutAccountDedicatedIpWarmupAttributesOutput, error)

Enable or disable the automatic warm-up feature for dedicated IP addresses.

func (*Client) PutAccountSendingAttributes

func (c *Client) PutAccountSendingAttributes(ctx context.Context, params *PutAccountSendingAttributesInput, optFns ...func(*Options)) (*PutAccountSendingAttributesOutput, error)

Enable or disable the ability of your account to send email.

func (*Client) PutConfigurationSetDeliveryOptions

func (c *Client) PutConfigurationSetDeliveryOptions(ctx context.Context, params *PutConfigurationSetDeliveryOptionsInput, optFns ...func(*Options)) (*PutConfigurationSetDeliveryOptionsOutput, error)

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.

func (*Client) PutConfigurationSetReputationOptions

func (c *Client) PutConfigurationSetReputationOptions(ctx context.Context, params *PutConfigurationSetReputationOptionsInput, optFns ...func(*Options)) (*PutConfigurationSetReputationOptionsOutput, error)

Enable or disable collection of reputation metrics for emails that you send using a particular configuration set in a specific AWS Region.

func (*Client) PutConfigurationSetSendingOptions

func (c *Client) PutConfigurationSetSendingOptions(ctx context.Context, params *PutConfigurationSetSendingOptionsInput, optFns ...func(*Options)) (*PutConfigurationSetSendingOptionsOutput, error)

Enable or disable email sending for messages that use a particular configuration set in a specific AWS Region.

func (*Client) PutConfigurationSetTrackingOptions

func (c *Client) PutConfigurationSetTrackingOptions(ctx context.Context, params *PutConfigurationSetTrackingOptionsInput, optFns ...func(*Options)) (*PutConfigurationSetTrackingOptionsOutput, error)

Specify a custom domain to use for open and click tracking elements in email that you send using Amazon Pinpoint.

func (*Client) PutDedicatedIpInPool

func (c *Client) PutDedicatedIpInPool(ctx context.Context, params *PutDedicatedIpInPoolInput, optFns ...func(*Options)) (*PutDedicatedIpInPoolOutput, error)

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. </p> <p>The dedicated IP pool you specify must already exist. You can create a new pool by using the <code>CreateDedicatedIpPool</code> operation.</p> </note>

func (*Client) PutDedicatedIpWarmupAttributes

func (c *Client) PutDedicatedIpWarmupAttributes(ctx context.Context, params *PutDedicatedIpWarmupAttributesInput, optFns ...func(*Options)) (*PutDedicatedIpWarmupAttributesOutput, error)

func (*Client) PutDeliverabilityDashboardOption

func (c *Client) PutDeliverabilityDashboardOption(ctx context.Context, params *PutDeliverabilityDashboardOptionInput, optFns ...func(*Options)) (*PutDeliverabilityDashboardOptionOutput, error)

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 (http://aws.amazon.com/pinpoint/pricing/).

func (*Client) PutEmailIdentityDkimAttributes

func (c *Client) PutEmailIdentityDkimAttributes(ctx context.Context, params *PutEmailIdentityDkimAttributesInput, optFns ...func(*Options)) (*PutEmailIdentityDkimAttributesOutput, error)

Used to enable or disable DKIM authentication for an email identity.

func (*Client) PutEmailIdentityFeedbackAttributes

func (c *Client) PutEmailIdentityFeedbackAttributes(ctx context.Context, params *PutEmailIdentityFeedbackAttributesInput, optFns ...func(*Options)) (*PutEmailIdentityFeedbackAttributesOutput, error)

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

func (*Client) PutEmailIdentityMailFromAttributes

func (c *Client) PutEmailIdentityMailFromAttributes(ctx context.Context, params *PutEmailIdentityMailFromAttributesInput, optFns ...func(*Options)) (*PutEmailIdentityMailFromAttributesOutput, error)

Used to enable or disable the custom Mail-From domain configuration for an email identity.

func (*Client) SendEmail

func (c *Client) SendEmail(ctx context.Context, params *SendEmailInput, optFns ...func(*Options)) (*SendEmailOutput, error)

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.

func (*Client) TagResource

func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)

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.

func (*Client) UntagResource

func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)

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

func (*Client) UpdateConfigurationSetEventDestination

func (c *Client) UpdateConfigurationSetEventDestination(ctx context.Context, params *UpdateConfigurationSetEventDestinationInput, optFns ...func(*Options)) (*UpdateConfigurationSetEventDestinationOutput, error)

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.

type CreateConfigurationSetEventDestinationInput

type CreateConfigurationSetEventDestinationInput struct {
	// The name of the configuration set that you want to add an event destination to.
	ConfigurationSetName *string
	// An object that defines the event destination.
	EventDestination *types.EventDestinationDefinition
	// A name that identifies the event destination within the configuration set.
	EventDestinationName *string
}

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

type CreateConfigurationSetEventDestinationOutput

type CreateConfigurationSetEventDestinationOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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

type CreateConfigurationSetInput

type CreateConfigurationSetInput struct {
	// An object that defines whether or not Amazon Pinpoint can send email that you
	// send using the configuration set.
	SendingOptions *types.SendingOptions
	// An object that defines the dedicated IP pool that is used to send emails that
	// you send using the configuration set.
	DeliveryOptions *types.DeliveryOptions
	// An array of objects that define the tags (keys and values) that you want to
	// associate with the configuration set.
	Tags []*types.Tag
	// An object that defines whether or not Amazon Pinpoint collects reputation
	// metrics for the emails that you send that use the configuration set.
	ReputationOptions *types.ReputationOptions
	// The name of the configuration set.
	ConfigurationSetName *string
	// An object that defines the open and click tracking options for emails that you
	// send using the configuration set.
	TrackingOptions *types.TrackingOptions
}

A request to create a configuration set.

type CreateConfigurationSetOutput

type CreateConfigurationSetOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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

type CreateDedicatedIpPoolInput

type CreateDedicatedIpPoolInput struct {
	// The name of the dedicated IP pool.
	PoolName *string
	// An object that defines the tags (keys and values) that you want to associate
	// with the pool.
	Tags []*types.Tag
}

A request to create a new dedicated IP pool.

type CreateDedicatedIpPoolOutput

type CreateDedicatedIpPoolOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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

type CreateDeliverabilityTestReportInput

type CreateDeliverabilityTestReportInput struct {
	// The HTML body of the message that you sent when you performed the predictive
	// inbox placement test.
	Content *types.EmailContent
	// 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 []*types.Tag
	// The email address that the predictive inbox placement test email was sent from.
	FromEmailAddress *string
}

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.

type CreateDeliverabilityTestReportOutput

type CreateDeliverabilityTestReportOutput struct {
	// 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.
	DeliverabilityTestStatus types.DeliverabilityTestStatus
	// A unique string that identifies the predictive inbox placement test.
	ReportId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Information about the predictive inbox placement test that you created.

type CreateEmailIdentityInput

type CreateEmailIdentityInput struct {
	// The email address or domain that you want to verify.
	EmailIdentity *string
	// An array of objects that define the tags (keys and values) that you want to
	// associate with the email identity.
	Tags []*types.Tag
}

A request to begin the verification process for an email identity (an email address or domain).

type CreateEmailIdentityOutput

type CreateEmailIdentityOutput struct {
	// 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
	// (https://docs.aws.amazon.com/pinpoint/latest/userguide/channels-email-manage-verify.html).
	VerifiedForSendingStatus *bool
	// 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 *types.DkimAttributes
	// The email identity type.
	IdentityType types.IdentityType

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

If the email identity is a domain, this object contains tokens that you can use to create a set of CNAME records. To sucessfully verify your domain, you have to add these records to the DNS configuration for your domain. If the email identity is an email address, this object is empty.

type DeleteConfigurationSetEventDestinationInput

type DeleteConfigurationSetEventDestinationInput struct {
	// The name of the configuration set that contains the event destination that you
	// want to delete.
	ConfigurationSetName *string
	// The name of the event destination that you want to delete.
	EventDestinationName *string
}

A request to delete an event destination from a configuration set.

type DeleteConfigurationSetEventDestinationOutput

type DeleteConfigurationSetEventDestinationOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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

type DeleteConfigurationSetInput

type DeleteConfigurationSetInput struct {
	// The name of the configuration set that you want to delete.
	ConfigurationSetName *string
}

A request to delete a configuration set.

type DeleteConfigurationSetOutput

type DeleteConfigurationSetOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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

type DeleteDedicatedIpPoolInput

type DeleteDedicatedIpPoolInput struct {
	// The name of the dedicated IP pool that you want to delete.
	PoolName *string
}

A request to delete a dedicated IP pool.

type DeleteDedicatedIpPoolOutput

type DeleteDedicatedIpPoolOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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

type DeleteEmailIdentityInput

type DeleteEmailIdentityInput struct {
	// The identity (that is, the email address or domain) that you want to delete from
	// your Amazon Pinpoint account.
	EmailIdentity *string
}

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.

type DeleteEmailIdentityOutput

type DeleteEmailIdentityOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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

type EndpointResolver

type EndpointResolver interface {
	ResolveEndpoint(region string, options ResolverOptions) (aws.Endpoint, error)
}

EndpointResolver interface for resolving service endpoints.

func WithEndpointResolver

func WithEndpointResolver(awsResolver aws.EndpointResolver, fallbackResolver EndpointResolver) EndpointResolver

WithEndpointResolver returns an EndpointResolver that first delegates endpoint resolution to the awsResolver. If awsResolver returns aws.EndpointNotFoundError error, the resolver will use the the provided fallbackResolver for resolution. awsResolver and fallbackResolver must not be nil

type EndpointResolverFunc

type EndpointResolverFunc func(region string, options ResolverOptions) (aws.Endpoint, error)

EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.

func (EndpointResolverFunc) ResolveEndpoint

func (fn EndpointResolverFunc) ResolveEndpoint(region string, options ResolverOptions) (endpoint aws.Endpoint, err error)

type GetAccountInput

type GetAccountInput struct {
}

A request to obtain information about the email-sending capabilities of your Amazon Pinpoint account.

type GetAccountOutput

type GetAccountOutput struct {
	// 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 *types.SendQuota
	// Indicates whether or not email sending is enabled for your Amazon Pinpoint
	// account in the current AWS Region.
	SendingEnabled *bool
	// 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.
	ProductionAccessEnabled *bool
	// 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.
	EnforcementStatus *string
	// Indicates whether or not the automatic warm-up feature is enabled for dedicated
	// IP addresses that are associated with your account.
	DedicatedIpAutoWarmupEnabled *bool

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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

type GetBlacklistReportsInput

type GetBlacklistReportsInput struct {
	// 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 []*string
}

A request to retrieve a list of the blacklists that your dedicated IP addresses appear on.

type GetBlacklistReportsOutput

type GetBlacklistReportsOutput struct {
	// An object that contains information about a blacklist that one of your dedicated
	// IP addresses appears on.
	BlacklistReport map[string][]*types.BlacklistEntry

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

An object that contains information about blacklist events.

type GetConfigurationSetEventDestinationsInput

type GetConfigurationSetEventDestinationsInput struct {
	// The name of the configuration set that contains the event destination.
	ConfigurationSetName *string
}

A request to obtain information about the event destinations for a configuration set.

type GetConfigurationSetEventDestinationsOutput

type GetConfigurationSetEventDestinationsOutput struct {
	// An array that includes all of the events destinations that have been configured
	// for the configuration set.
	EventDestinations []*types.EventDestination

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Information about an event destination for a configuration set.

type GetConfigurationSetInput

type GetConfigurationSetInput struct {
	// The name of the configuration set that you want to obtain more information
	// about.
	ConfigurationSetName *string
}

A request to obtain information about a configuration set.

type GetConfigurationSetOutput

type GetConfigurationSetOutput struct {
	// An object that defines whether or not Amazon Pinpoint can send email that you
	// send using the configuration set.
	SendingOptions *types.SendingOptions
	// An object that defines the dedicated IP pool that is used to send emails that
	// you send using the configuration set.
	DeliveryOptions *types.DeliveryOptions
	// An object that defines the open and click tracking options for emails that you
	// send using the configuration set.
	TrackingOptions *types.TrackingOptions
	// An array of objects that define the tags (keys and values) that are associated
	// with the configuration set.
	Tags []*types.Tag
	// The name of the configuration set.
	ConfigurationSetName *string
	// An object that defines whether or not Amazon Pinpoint collects reputation
	// metrics for the emails that you send that use the configuration set.
	ReputationOptions *types.ReputationOptions

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Information about a configuration set.

type GetDedicatedIpInput

type GetDedicatedIpInput struct {
	// 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
}

A request to obtain more information about a dedicated IP address.

type GetDedicatedIpOutput

type GetDedicatedIpOutput struct {
	// An object that contains information about a dedicated IP address.
	DedicatedIp *types.DedicatedIp

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Information about a dedicated IP address.

type GetDedicatedIpsInput

type GetDedicatedIpsInput struct {
	// 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.
	PageSize *int32
	// A token returned from a previous call to GetDedicatedIps to indicate the
	// position of the dedicated IP pool in the list of IP pools.
	NextToken *string
	// The name of the IP pool that the dedicated IP address is associated with.
	PoolName *string
}

A request to obtain more information about dedicated IP pools.

type GetDedicatedIpsOutput

type GetDedicatedIpsOutput struct {
	// A 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.
	NextToken *string
	// A list of dedicated IP addresses that are reserved for use by your Amazon
	// Pinpoint account.
	DedicatedIps []*types.DedicatedIp

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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

type GetDeliverabilityDashboardOptionsInput

type GetDeliverabilityDashboardOptionsInput struct {
}

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 (http://aws.amazon.com/pinpoint/pricing/).

type GetDeliverabilityDashboardOptionsOutput

type GetDeliverabilityDashboardOptionsOutput struct {
	// 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 *time.Time
	// 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 []*types.DomainDeliverabilityTrackingOption
	// Specifies whether the Deliverability dashboard is enabled for your Amazon
	// Pinpoint account. If this value is true, the dashboard is enabled.
	DashboardEnabled *bool
	// 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 []*types.DomainDeliverabilityTrackingOption
	// 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.
	AccountStatus types.DeliverabilityDashboardAccountStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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

type GetDeliverabilityTestReportInput

type GetDeliverabilityTestReportInput struct {
	// A unique string that identifies the predictive inbox placement test.
	ReportId *string
}

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

type GetDeliverabilityTestReportOutput

type GetDeliverabilityTestReportOutput struct {
	// An object that describes how the test email was handled by several email
	// providers, including Gmail, Hotmail, Yahoo, AOL, and others.
	IspPlacements []*types.IspPlacement
	// An array of objects that define the tags (keys and values) that are associated
	// with the predictive inbox placement test.
	Tags []*types.Tag
	// 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 *types.PlacementStatistics
	// An object that contains the message that you sent when you performed this
	// predictive inbox placement test.
	Message *string
	// An object that contains the results of the predictive inbox placement test.
	DeliverabilityTestReport *types.DeliverabilityTestReport

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The results of the predictive inbox placement test.

type GetDomainDeliverabilityCampaignInput

type GetDomainDeliverabilityCampaignInput struct {
	// 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
}

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

type GetDomainDeliverabilityCampaignOutput

type GetDomainDeliverabilityCampaignOutput struct {
	// An object that contains the deliverability data for the campaign.
	DomainDeliverabilityCampaign *types.DomainDeliverabilityCampaign

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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

type GetDomainStatisticsReportInput

type GetDomainStatisticsReportInput struct {
	// The domain that you want to obtain deliverability metrics for.
	Domain *string
	// 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.
	EndDate *time.Time
	// The first day (in Unix time) that you want to obtain domain deliverability
	// metrics for.
	StartDate *time.Time
}

A request to obtain deliverability metrics for a domain.

type GetDomainStatisticsReportOutput

type GetDomainStatisticsReportOutput struct {
	// 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.
	DailyVolumes []*types.DailyVolume
	// 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.
	OverallVolume *types.OverallVolume

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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

type GetEmailIdentityInput

type GetEmailIdentityInput struct {
	// The email identity that you want to retrieve details for.
	EmailIdentity *string
}

A request to return details about an email identity.

type GetEmailIdentityOutput

type GetEmailIdentityOutput struct {
	// The email identity type.
	IdentityType types.IdentityType
	// An object that contains information about the Mail-From attributes for the email
	// identity.
	MailFromAttributes *types.MailFromAttributes
	// 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).
	FeedbackForwardingStatus *bool
	// An array of objects that define the tags (keys and values) that are associated
	// with the email identity.
	Tags []*types.Tag
	// 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 *types.DkimAttributes
	// 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
	// (https://docs.aws.amazon.com/pinpoint/latest/userguide/channels-email-manage-verify.html).
	VerifiedForSendingStatus *bool

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Details about an email identity.

type HTTPClient

type HTTPClient interface {
	Do(*http.Request) (*http.Response, error)
}

type HTTPSignerV4

type HTTPSignerV4 interface {
	SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time) error
}

type ListConfigurationSetsInput

type ListConfigurationSetsInput struct {
	// 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.
	PageSize *int32
	// A token returned from a previous call to ListConfigurationSets to indicate the
	// position in the list of configuration sets.
	NextToken *string
}

A request to obtain a list of configuration sets for your Amazon Pinpoint account in the current AWS Region.

type ListConfigurationSetsOutput

type ListConfigurationSetsOutput struct {
	// An array that contains all of the configuration sets in your Amazon Pinpoint
	// account in the current AWS Region.
	ConfigurationSets []*string
	// A 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.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

A list of configuration sets in your Amazon Pinpoint account in the current AWS Region.

type ListDedicatedIpPoolsInput

type ListDedicatedIpPoolsInput struct {
	// A token returned from a previous call to ListDedicatedIpPools to indicate the
	// position in the list of dedicated IP pools.
	NextToken *string
	// 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.
	PageSize *int32
}

A request to obtain a list of dedicated IP pools.

type ListDedicatedIpPoolsOutput

type ListDedicatedIpPoolsOutput struct {
	// A 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.
	NextToken *string
	// A list of all of the dedicated IP pools that are associated with your Amazon
	// Pinpoint account.
	DedicatedIpPools []*string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

A list of dedicated IP pools.

type ListDeliverabilityTestReportsInput

type ListDeliverabilityTestReportsInput struct {
	// A token returned from a previous call to ListDeliverabilityTestReports to
	// indicate the position in the list of predictive inbox placement tests.
	NextToken *string
	// 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 *int32
}

A request to list all of the predictive inbox placement tests that you've performed.

type ListDeliverabilityTestReportsOutput

type ListDeliverabilityTestReportsOutput struct {
	// An object that contains a lists of predictive inbox placement tests that you've
	// performed.
	DeliverabilityTestReports []*types.DeliverabilityTestReport
	// A 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.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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

type ListDomainDeliverabilityCampaignsInput

type ListDomainDeliverabilityCampaignsInput struct {
	// 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.
	PageSize *int32
	// 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.
	EndDate *time.Time
	// The domain to obtain deliverability data for.
	SubscribedDomain *string
	// The first day, in Unix time format, that you want to obtain deliverability data
	// for.
	StartDate *time.Time
	// 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.
	NextToken *string
}

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.

type ListDomainDeliverabilityCampaignsOutput

type ListDomainDeliverabilityCampaignsOutput struct {
	// An array of responses, one for each campaign that used the domain to send email
	// during the specified time range.
	DomainDeliverabilityCampaigns []*types.DomainDeliverabilityCampaign
	// A 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.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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.

type ListEmailIdentitiesInput

type ListEmailIdentitiesInput struct {
	// A token returned from a previous call to ListEmailIdentities to indicate the
	// position in the list of identities.
	NextToken *string
	// 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 *int32
}

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.

type ListEmailIdentitiesOutput

type ListEmailIdentitiesOutput struct {
	// An array that includes all of the identities associated with your Amazon
	// Pinpoint account.
	EmailIdentities []*types.IdentityInfo
	// A 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.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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.

type ListTagsForResourceInput

type ListTagsForResourceInput struct {
	// The Amazon Resource Name (ARN) of the resource that you want to retrieve tag
	// information for.
	ResourceArn *string
}

type ListTagsForResourceOutput

type ListTagsForResourceOutput struct {
	// 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)
	Tags []*types.Tag

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type Options

type Options struct {
	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	APIOptions []func(*middleware.Stack) error

	// The credentials object to use when signing requests.
	Credentials aws.CredentialsProvider

	// The endpoint options to be used when attempting to resolve an endpoint.
	EndpointOptions ResolverOptions

	// The service endpoint resolver.
	EndpointResolver EndpointResolver

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

	// The region to send requests to. (Required)
	Region string

	// Retryer guides how HTTP requests should be retried in case of recoverable
	// failures. When nil the API client will use a default retryer.
	Retryer retry.Retryer

	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
	// implementation if nil.
	HTTPClient HTTPClient
}

func (Options) Copy

func (o Options) Copy() Options

Copy creates a clone where the APIOptions list is deep copied.

func (Options) GetCredentials

func (o Options) GetCredentials() aws.CredentialsProvider

func (Options) GetEndpointOptions

func (o Options) GetEndpointOptions() ResolverOptions

func (Options) GetEndpointResolver

func (o Options) GetEndpointResolver() EndpointResolver

func (Options) GetHTTPSignerV4

func (o Options) GetHTTPSignerV4() HTTPSignerV4

func (Options) GetRegion

func (o Options) GetRegion() string

func (Options) GetRetryer

func (o Options) GetRetryer() retry.Retryer

type PutAccountDedicatedIpWarmupAttributesInput

type PutAccountDedicatedIpWarmupAttributesInput struct {
	// 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.
	AutoWarmupEnabled *bool
}

A request to enable or disable the automatic IP address warm-up feature.

type PutAccountDedicatedIpWarmupAttributesOutput

type PutAccountDedicatedIpWarmupAttributesOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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

type PutAccountSendingAttributesInput

type PutAccountSendingAttributesInput struct {
	// 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.
	SendingEnabled *bool
}

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

type PutAccountSendingAttributesOutput

type PutAccountSendingAttributesOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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

type PutConfigurationSetDeliveryOptionsInput

type PutConfigurationSetDeliveryOptionsInput struct {
	// 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.
	TlsPolicy types.TlsPolicy
	// The name of the configuration set that you want to associate with a dedicated IP
	// pool.
	ConfigurationSetName *string
}

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

type PutConfigurationSetDeliveryOptionsOutput

type PutConfigurationSetDeliveryOptionsOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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

type PutConfigurationSetReputationOptionsInput

type PutConfigurationSetReputationOptionsInput struct {
	// The name of the configuration set that you want to enable or disable reputation
	// metric tracking for.
	ConfigurationSetName *string
	// If true, tracking of reputation metrics is enabled for the configuration set. If
	// false, tracking of reputation metrics is disabled for the configuration set.
	ReputationMetricsEnabled *bool
}

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

type PutConfigurationSetReputationOptionsOutput

type PutConfigurationSetReputationOptionsOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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

type PutConfigurationSetSendingOptionsInput

type PutConfigurationSetSendingOptionsInput struct {
	// The name of the configuration set that you want to enable or disable email
	// sending for.
	ConfigurationSetName *string
	// If true, email sending is enabled for the configuration set. If false, email
	// sending is disabled for the configuration set.
	SendingEnabled *bool
}

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

type PutConfigurationSetSendingOptionsOutput

type PutConfigurationSetSendingOptionsOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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

type PutConfigurationSetTrackingOptionsInput

type PutConfigurationSetTrackingOptionsInput struct {
	// The domain that you want to use to track open and click events.
	CustomRedirectDomain *string
	// The name of the configuration set that you want to add a custom tracking domain
	// to.
	ConfigurationSetName *string
}

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

type PutConfigurationSetTrackingOptionsOutput

type PutConfigurationSetTrackingOptionsOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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

type PutDedicatedIpInPoolInput

type PutDedicatedIpInPoolInput struct {
	// 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
	// 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
}

A request to move a dedicated IP address to a dedicated IP pool.

type PutDedicatedIpInPoolOutput

type PutDedicatedIpInPoolOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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

type PutDedicatedIpWarmupAttributesInput

type PutDedicatedIpWarmupAttributesInput struct {
	// The dedicated IP address that you want to update the warm-up attributes for.
	Ip *string
	// The warm-up percentage that you want to associate with the dedicated IP address.
	WarmupPercentage *int32
}

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.

type PutDedicatedIpWarmupAttributesOutput

type PutDedicatedIpWarmupAttributesOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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

type PutDeliverabilityDashboardOptionInput

type PutDeliverabilityDashboardOptionInput struct {
	// An array of objects, one for each verified domain that you use to send email and
	// enabled the Deliverability dashboard for.
	SubscribedDomains []*types.DomainDeliverabilityTrackingOption
	// Specifies whether to enable the Deliverability dashboard for your Amazon
	// Pinpoint account. To enable the dashboard, set this value to true.
	DashboardEnabled *bool
}

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 (http://aws.amazon.com/pinpoint/pricing/).

type PutDeliverabilityDashboardOptionOutput

type PutDeliverabilityDashboardOptionOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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

type PutEmailIdentityDkimAttributesInput

type PutEmailIdentityDkimAttributesInput struct {
	// The email identity that you want to change the DKIM settings for.
	EmailIdentity *string
	// 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.
	SigningEnabled *bool
}

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

type PutEmailIdentityDkimAttributesOutput

type PutEmailIdentityDkimAttributesOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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

type PutEmailIdentityFeedbackAttributesInput

type PutEmailIdentityFeedbackAttributesInput struct {
	// 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).
	EmailForwardingEnabled *bool
	// The email identity that you want to configure bounce and complaint feedback
	// forwarding for.
	EmailIdentity *string
}

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

type PutEmailIdentityFeedbackAttributesOutput

type PutEmailIdentityFeedbackAttributesOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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

type PutEmailIdentityMailFromAttributesInput

type PutEmailIdentityMailFromAttributesInput struct {
	// The verified email identity that you want to set up the custom MAIL FROM domain
	// for.
	EmailIdentity *string
	// 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.
	BehaviorOnMxFailure types.BehaviorOnMxFailure
	// The custom MAIL FROM domain that you want the verified identity to use. The MAIL
	// FROM domain must meet the following criteria:
	//
	//     * It has to be a subdomain of
	// the verified identity.
	//
	//     * It can't be used to receive email.
	//
	//     * It can't
	// be used in a "From" address if the MAIL FROM domain is a destination for
	// feedback forwarding emails.
	MailFromDomain *string
}

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

type PutEmailIdentityMailFromAttributesOutput

type PutEmailIdentityMailFromAttributesOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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

type ResolveEndpoint

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  ResolverOptions
}

func (*ResolveEndpoint) HandleSerialize

func (*ResolveEndpoint) ID

func (*ResolveEndpoint) ID() string

type ResolveEndpointMiddlewareOptions

type ResolveEndpointMiddlewareOptions interface {
	GetEndpointResolver() EndpointResolver
	GetEndpointOptions() ResolverOptions
}

type ResolverOptions

type ResolverOptions = internalendpoints.Options

ResolverOptions is the service endpoint resolver options

type SendEmailInput

type SendEmailInput struct {
	// The "Reply-to" email addresses for the message. When the recipient replies to
	// the message, each Reply-to address receives the reply.
	ReplyToAddresses []*string
	// The name of the configuration set that you want to use when sending the email.
	ConfigurationSetName *string
	// The address that Amazon Pinpoint should send bounce and complaint notifications
	// to.
	FeedbackForwardingEmailAddress *string
	// The email address that you want to use as the "From" address for the email. The
	// address that you specify has to be verified.
	FromEmailAddress *string
	// An object that contains the recipients of the email message.
	Destination *types.Destination
	// An object that contains the body of the message. You can send either a Simple
	// message or a Raw message.
	Content *types.EmailContent
	// A list of tags, in the form of name/value pairs, to apply to an email that you
	// send using the SendEmail operation. Tags correspond to characteristics of the
	// email that you define, so that you can publish email sending events.
	EmailTags []*types.MessageTag
}

A request to send an email message.

type SendEmailOutput

type SendEmailOutput struct {
	// A unique identifier for the message that is generated when Amazon Pinpoint
	// accepts the message. It is possible for Amazon Pinpoint to accept a message
	// without sending it. This can happen when the message you're trying to send has
	// an attachment doesn't pass a virus check, or when you send a templated email
	// that contains invalid personalization content, for example.
	MessageId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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

type TagResourceInput

type TagResourceInput struct {
	// A list of the tags that you want to add to the resource. A tag consists of a
	// required tag key (Key) and an associated tag value (Value). The maximum length
	// of a tag key is 128 characters. The maximum length of a tag value is 256
	// characters.
	Tags []*types.Tag
	// The Amazon Resource Name (ARN) of the resource that you want to add one or more
	// tags to.
	ResourceArn *string
}

type TagResourceOutput

type TagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UntagResourceInput

type UntagResourceInput struct {
	// The Amazon Resource Name (ARN) of the resource that you want to remove one or
	// more tags from.
	ResourceArn *string
	// The tags (tag keys) that you want to remove from the resource. When you specify
	// a tag key, the action removes both that key and its associated tag value. To
	// remove more than one tag from the resource, append the TagKeys parameter and
	// argument for each additional tag to remove, separated by an ampersand. For
	// example: /v1/email/tags?ResourceArn=ResourceArn&TagKeys=Key1&TagKeys=Key2
	TagKeys []*string
}

type UntagResourceOutput

type UntagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UpdateConfigurationSetEventDestinationInput

type UpdateConfigurationSetEventDestinationInput struct {
	// The name of the configuration set that contains the event destination that you
	// want to modify.
	ConfigurationSetName *string
	// An object that defines the event destination.
	EventDestination *types.EventDestinationDefinition
	// The name of the event destination that you want to modify.
	EventDestinationName *string
}

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

type UpdateConfigurationSetEventDestinationOutput

type UpdateConfigurationSetEventDestinationOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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

Source Files

Directories

Path Synopsis
internal

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL