pinpointemail

package
v0.21.0 Latest Latest
Warning

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

 Go to latest Published: Apr 22, 2020 License: Apache-2.0 Imports: 9 Imported by: 9

Documentation

Overview

Package pinpointemail provides the client and types for making API requests to Pinpoint Email.

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

See https://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26 for more information on this service.

See pinpointemail package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/pinpointemail/

Using the Client

To use Pinpoint Email with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the Pinpoint Email client for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/pinpointemail/#New

Index

Constants

View Source 
const (
	ServiceName = "Pinpoint Email" // Service's name
	ServiceID   = "PinpointEmail"  // Service's identifier
	EndpointsID = "email"          // Service's Endpoint identifier
)
View Source 
const (

	// ErrCodeAccountSuspendedException for service response error code
	// "AccountSuspendedException".
	//
	// The message can't be sent because the account's ability to send email has
	// been permanently restricted.
	ErrCodeAccountSuspendedException = "AccountSuspendedException"

	// ErrCodeAlreadyExistsException for service response error code
	// "AlreadyExistsException".
	//
	// The resource specified in your request already exists.
	ErrCodeAlreadyExistsException = "AlreadyExistsException"

	// ErrCodeBadRequestException for service response error code
	// "BadRequestException".
	//
	// The input you provided is invalid.
	ErrCodeBadRequestException = "BadRequestException"

	// ErrCodeConcurrentModificationException for service response error code
	// "ConcurrentModificationException".
	//
	// The resource is being modified by another operation or thread.
	ErrCodeConcurrentModificationException = "ConcurrentModificationException"

	// ErrCodeLimitExceededException for service response error code
	// "LimitExceededException".
	//
	// There are too many instances of the specified resource type.
	ErrCodeLimitExceededException = "LimitExceededException"

	// ErrCodeMailFromDomainNotVerifiedException for service response error code
	// "MailFromDomainNotVerifiedException".
	//
	// The message can't be sent because the sending domain isn't verified.
	ErrCodeMailFromDomainNotVerifiedException = "MailFromDomainNotVerifiedException"

	// ErrCodeMessageRejected for service response error code
	// "MessageRejected".
	//
	// The message can't be sent because it contains invalid content.
	ErrCodeMessageRejected = "MessageRejected"

	// ErrCodeNotFoundException for service response error code
	// "NotFoundException".
	//
	// The resource you attempted to access doesn't exist.
	ErrCodeNotFoundException = "NotFoundException"

	// ErrCodeSendingPausedException for service response error code
	// "SendingPausedException".
	//
	// The message can't be sent because the account's ability to send email is
	// currently paused.
	ErrCodeSendingPausedException = "SendingPausedException"

	// ErrCodeTooManyRequestsException for service response error code
	// "TooManyRequestsException".
	//
	// Too many requests have been made to the operation.
	ErrCodeTooManyRequestsException = "TooManyRequestsException"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type BehaviorOnMxFailure 

type BehaviorOnMxFailure string

The action that you want Amazon Pinpoint to take if it can't read the required MX record for a custom MAIL FROM domain. When you set this value to UseDefaultValue, Amazon Pinpoint uses amazonses.com as the MAIL FROM domain. When you set this value to RejectMessage, Amazon Pinpoint returns a MailFromDomainNotVerified error, and doesn't attempt to deliver the email.

These behaviors are taken when the custom MAIL FROM domain configuration is in the Pending, Failed, and TemporaryFailure states. 

const (
	BehaviorOnMxFailureUseDefaultValue BehaviorOnMxFailure = "USE_DEFAULT_VALUE"
	BehaviorOnMxFailureRejectMessage   BehaviorOnMxFailure = "REJECT_MESSAGE"
)

Enum values for BehaviorOnMxFailure

func (BehaviorOnMxFailure) MarshalValue 

func (enum BehaviorOnMxFailure) MarshalValue() (string, error)

func (BehaviorOnMxFailure) MarshalValueBuf 

func (enum BehaviorOnMxFailure) MarshalValueBuf(b []byte) ([]byte, error)

type BlacklistEntry added in v0.7.0 

type BlacklistEntry struct {

	// Additional information about the blacklisting event, as provided by the blacklist
	// maintainer.
	Description *string `type:"string"`

	// The time when the blacklisting event occurred, shown in Unix time format.
	ListingTime *time.Time `type:"timestamp"`

	// The name of the blacklist that the IP address appears on.
	RblName *string `type:"string"`
	// contains filtered or unexported fields
}

An object that contains information about a blacklisting event that impacts one of the dedicated IP addresses that is associated with your account.

func (BlacklistEntry) MarshalFields added in v0.7.0 

func (s BlacklistEntry) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (BlacklistEntry) String added in v0.7.0 

func (s BlacklistEntry) String() string

String returns the string representation

type Body 

type Body struct {

	// An object that represents the version of the message that is displayed in
	// email clients that support HTML. HTML messages can include formatted text,
	// hyperlinks, images, and more.
	Html *Content `type:"structure"`

	// An object that represents the version of the message that is displayed in
	// email clients that don't support HTML, or clients where the recipient has
	// disabled HTML rendering.
	Text *Content `type:"structure"`
	// contains filtered or unexported fields
}

Represents the body of the email message.

func (Body) MarshalFields 

func (s Body) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (Body) String 

func (s Body) String() string

String returns the string representation

func (*Body) Validate 

func (s *Body) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type Client added in v0.9.0 

type Client struct {
	*aws.Client
}

Client provides the API operation methods for making requests to Pinpoint Email. See this package's package overview docs for details on the service.

The client's methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New 

func New(config aws.Config) *Client

New creates a new instance of the client from the provided Config.

Example: 

// Create a client from just a config.
svc := pinpointemail.New(myConfig)

func (*Client) CreateConfigurationSetEventDestinationRequest added in v0.9.0 

func (c *Client) CreateConfigurationSetEventDestinationRequest(input *CreateConfigurationSetEventDestinationInput) CreateConfigurationSetEventDestinationRequest

CreateConfigurationSetEventDestinationRequest returns a request value for making API operation for Amazon Pinpoint Email Service.

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. 

// Example sending a request using CreateConfigurationSetEventDestinationRequest.
req := client.CreateConfigurationSetEventDestinationRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/CreateConfigurationSetEventDestination

func (*Client) CreateConfigurationSetRequest added in v0.9.0 

func (c *Client) CreateConfigurationSetRequest(input *CreateConfigurationSetInput) CreateConfigurationSetRequest

CreateConfigurationSetRequest returns a request value for making API operation for Amazon Pinpoint Email Service.

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. 

// Example sending a request using CreateConfigurationSetRequest.
req := client.CreateConfigurationSetRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/CreateConfigurationSet

func (*Client) CreateDedicatedIpPoolRequest added in v0.9.0 

func (c *Client) CreateDedicatedIpPoolRequest(input *CreateDedicatedIpPoolInput) CreateDedicatedIpPoolRequest

CreateDedicatedIpPoolRequest returns a request value for making API operation for Amazon Pinpoint Email Service.

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. 

// Example sending a request using CreateDedicatedIpPoolRequest.
req := client.CreateDedicatedIpPoolRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/CreateDedicatedIpPool

func (*Client) CreateDeliverabilityTestReportRequest added in v0.9.0 

func (c *Client) CreateDeliverabilityTestReportRequest(input *CreateDeliverabilityTestReportInput) CreateDeliverabilityTestReportRequest

CreateDeliverabilityTestReportRequest returns a request value for making API operation for Amazon Pinpoint Email Service.

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. 

// Example sending a request using CreateDeliverabilityTestReportRequest.
req := client.CreateDeliverabilityTestReportRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/CreateDeliverabilityTestReport

func (*Client) CreateEmailIdentityRequest added in v0.9.0 

func (c *Client) CreateEmailIdentityRequest(input *CreateEmailIdentityInput) CreateEmailIdentityRequest

CreateEmailIdentityRequest returns a request value for making API operation for Amazon Pinpoint Email Service.

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. 

// Example sending a request using CreateEmailIdentityRequest.
req := client.CreateEmailIdentityRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/CreateEmailIdentity

func (*Client) DeleteConfigurationSetEventDestinationRequest added in v0.9.0 

func (c *Client) DeleteConfigurationSetEventDestinationRequest(input *DeleteConfigurationSetEventDestinationInput) DeleteConfigurationSetEventDestinationRequest

DeleteConfigurationSetEventDestinationRequest returns a request value for making API operation for Amazon Pinpoint Email Service.

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. 

// Example sending a request using DeleteConfigurationSetEventDestinationRequest.
req := client.DeleteConfigurationSetEventDestinationRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/DeleteConfigurationSetEventDestination

func (*Client) DeleteConfigurationSetRequest added in v0.9.0 

func (c *Client) DeleteConfigurationSetRequest(input *DeleteConfigurationSetInput) DeleteConfigurationSetRequest

DeleteConfigurationSetRequest returns a request value for making API operation for Amazon Pinpoint Email Service.

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. 

// Example sending a request using DeleteConfigurationSetRequest.
req := client.DeleteConfigurationSetRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/DeleteConfigurationSet

func (*Client) DeleteDedicatedIpPoolRequest added in v0.9.0 

func (c *Client) DeleteDedicatedIpPoolRequest(input *DeleteDedicatedIpPoolInput) DeleteDedicatedIpPoolRequest

DeleteDedicatedIpPoolRequest returns a request value for making API operation for Amazon Pinpoint Email Service.

Delete a dedicated IP pool. 

// Example sending a request using DeleteDedicatedIpPoolRequest.
req := client.DeleteDedicatedIpPoolRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/DeleteDedicatedIpPool

func (*Client) DeleteEmailIdentityRequest added in v0.9.0 

func (c *Client) DeleteEmailIdentityRequest(input *DeleteEmailIdentityInput) DeleteEmailIdentityRequest

DeleteEmailIdentityRequest returns a request value for making API operation for Amazon Pinpoint Email Service.

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. 

// Example sending a request using DeleteEmailIdentityRequest.
req := client.DeleteEmailIdentityRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/DeleteEmailIdentity

func (*Client) GetAccountRequest added in v0.9.0 

func (c *Client) GetAccountRequest(input *GetAccountInput) GetAccountRequest

GetAccountRequest returns a request value for making API operation for Amazon Pinpoint Email Service.

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

// Example sending a request using GetAccountRequest.
req := client.GetAccountRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/GetAccount

func (*Client) GetBlacklistReportsRequest added in v0.9.0 

func (c *Client) GetBlacklistReportsRequest(input *GetBlacklistReportsInput) GetBlacklistReportsRequest

GetBlacklistReportsRequest returns a request value for making API operation for Amazon Pinpoint Email Service.

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

// Example sending a request using GetBlacklistReportsRequest.
req := client.GetBlacklistReportsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/GetBlacklistReports

func (*Client) GetConfigurationSetEventDestinationsRequest added in v0.9.0 

func (c *Client) GetConfigurationSetEventDestinationsRequest(input *GetConfigurationSetEventDestinationsInput) GetConfigurationSetEventDestinationsRequest

GetConfigurationSetEventDestinationsRequest returns a request value for making API operation for Amazon Pinpoint Email Service.

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. 

// Example sending a request using GetConfigurationSetEventDestinationsRequest.
req := client.GetConfigurationSetEventDestinationsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/GetConfigurationSetEventDestinations

func (*Client) GetConfigurationSetRequest added in v0.9.0 

func (c *Client) GetConfigurationSetRequest(input *GetConfigurationSetInput) GetConfigurationSetRequest

GetConfigurationSetRequest returns a request value for making API operation for Amazon Pinpoint Email Service.

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. 

// Example sending a request using GetConfigurationSetRequest.
req := client.GetConfigurationSetRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/GetConfigurationSet

func (*Client) GetDedicatedIpRequest added in v0.9.0 

func (c *Client) GetDedicatedIpRequest(input *GetDedicatedIpInput) GetDedicatedIpRequest

GetDedicatedIpRequest returns a request value for making API operation for Amazon Pinpoint Email Service.

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. 

// Example sending a request using GetDedicatedIpRequest.
req := client.GetDedicatedIpRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/GetDedicatedIp

func (*Client) GetDedicatedIpsRequest added in v0.9.0 

func (c *Client) GetDedicatedIpsRequest(input *GetDedicatedIpsInput) GetDedicatedIpsRequest

GetDedicatedIpsRequest returns a request value for making API operation for Amazon Pinpoint Email Service.

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

// Example sending a request using GetDedicatedIpsRequest.
req := client.GetDedicatedIpsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/GetDedicatedIps

func (*Client) GetDeliverabilityDashboardOptionsRequest added in v0.9.0 

func (c *Client) GetDeliverabilityDashboardOptionsRequest(input *GetDeliverabilityDashboardOptionsInput) GetDeliverabilityDashboardOptionsRequest

GetDeliverabilityDashboardOptionsRequest returns a request value for making API operation for Amazon Pinpoint Email Service.

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

// Example sending a request using GetDeliverabilityDashboardOptionsRequest.
req := client.GetDeliverabilityDashboardOptionsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/GetDeliverabilityDashboardOptions

func (*Client) GetDeliverabilityTestReportRequest added in v0.9.0 

func (c *Client) GetDeliverabilityTestReportRequest(input *GetDeliverabilityTestReportInput) GetDeliverabilityTestReportRequest

GetDeliverabilityTestReportRequest returns a request value for making API operation for Amazon Pinpoint Email Service.

Retrieve the results of a predictive inbox placement test. 

// Example sending a request using GetDeliverabilityTestReportRequest.
req := client.GetDeliverabilityTestReportRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/GetDeliverabilityTestReport

func (*Client) GetDomainDeliverabilityCampaignRequest added in v0.9.0 

func (c *Client) GetDomainDeliverabilityCampaignRequest(input *GetDomainDeliverabilityCampaignInput) GetDomainDeliverabilityCampaignRequest

GetDomainDeliverabilityCampaignRequest returns a request value for making API operation for Amazon Pinpoint Email Service.

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

// Example sending a request using GetDomainDeliverabilityCampaignRequest.
req := client.GetDomainDeliverabilityCampaignRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/GetDomainDeliverabilityCampaign

func (*Client) GetDomainStatisticsReportRequest added in v0.9.0 

func (c *Client) GetDomainStatisticsReportRequest(input *GetDomainStatisticsReportInput) GetDomainStatisticsReportRequest

GetDomainStatisticsReportRequest returns a request value for making API operation for Amazon Pinpoint Email Service.

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

// Example sending a request using GetDomainStatisticsReportRequest.
req := client.GetDomainStatisticsReportRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/GetDomainStatisticsReport

func (*Client) GetEmailIdentityRequest added in v0.9.0 

func (c *Client) GetEmailIdentityRequest(input *GetEmailIdentityInput) GetEmailIdentityRequest

GetEmailIdentityRequest returns a request value for making API operation for Amazon Pinpoint Email Service.

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. 

// Example sending a request using GetEmailIdentityRequest.
req := client.GetEmailIdentityRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/GetEmailIdentity

func (*Client) ListConfigurationSetsRequest added in v0.9.0 

func (c *Client) ListConfigurationSetsRequest(input *ListConfigurationSetsInput) ListConfigurationSetsRequest

ListConfigurationSetsRequest returns a request value for making API operation for Amazon Pinpoint Email Service.

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. 

// Example sending a request using ListConfigurationSetsRequest.
req := client.ListConfigurationSetsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/ListConfigurationSets

func (*Client) ListDedicatedIpPoolsRequest added in v0.9.0 

func (c *Client) ListDedicatedIpPoolsRequest(input *ListDedicatedIpPoolsInput) ListDedicatedIpPoolsRequest

ListDedicatedIpPoolsRequest returns a request value for making API operation for Amazon Pinpoint Email Service.

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

// Example sending a request using ListDedicatedIpPoolsRequest.
req := client.ListDedicatedIpPoolsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/ListDedicatedIpPools

func (*Client) ListDeliverabilityTestReportsRequest added in v0.9.0 

func (c *Client) ListDeliverabilityTestReportsRequest(input *ListDeliverabilityTestReportsInput) ListDeliverabilityTestReportsRequest

ListDeliverabilityTestReportsRequest returns a request value for making API operation for Amazon Pinpoint Email Service.

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. 

// Example sending a request using ListDeliverabilityTestReportsRequest.
req := client.ListDeliverabilityTestReportsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/ListDeliverabilityTestReports

func (*Client) ListDomainDeliverabilityCampaignsRequest added in v0.9.0 

func (c *Client) ListDomainDeliverabilityCampaignsRequest(input *ListDomainDeliverabilityCampaignsInput) ListDomainDeliverabilityCampaignsRequest

ListDomainDeliverabilityCampaignsRequest returns a request value for making API operation for Amazon Pinpoint Email Service.

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. 

// Example sending a request using ListDomainDeliverabilityCampaignsRequest.
req := client.ListDomainDeliverabilityCampaignsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/ListDomainDeliverabilityCampaigns

func (*Client) ListEmailIdentitiesRequest added in v0.9.0 

func (c *Client) ListEmailIdentitiesRequest(input *ListEmailIdentitiesInput) ListEmailIdentitiesRequest

ListEmailIdentitiesRequest returns a request value for making API operation for Amazon Pinpoint Email Service.

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. 

// Example sending a request using ListEmailIdentitiesRequest.
req := client.ListEmailIdentitiesRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/ListEmailIdentities

func (*Client) ListTagsForResourceRequest added in v0.9.0 

func (c *Client) ListTagsForResourceRequest(input *ListTagsForResourceInput) ListTagsForResourceRequest

ListTagsForResourceRequest returns a request value for making API operation for Amazon Pinpoint Email Service.

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. 

// Example sending a request using ListTagsForResourceRequest.
req := client.ListTagsForResourceRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/ListTagsForResource

func (*Client) PutAccountDedicatedIpWarmupAttributesRequest added in v0.9.0 

func (c *Client) PutAccountDedicatedIpWarmupAttributesRequest(input *PutAccountDedicatedIpWarmupAttributesInput) PutAccountDedicatedIpWarmupAttributesRequest

PutAccountDedicatedIpWarmupAttributesRequest returns a request value for making API operation for Amazon Pinpoint Email Service.

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

// Example sending a request using PutAccountDedicatedIpWarmupAttributesRequest.
req := client.PutAccountDedicatedIpWarmupAttributesRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/PutAccountDedicatedIpWarmupAttributes

func (*Client) PutAccountSendingAttributesRequest added in v0.9.0 

func (c *Client) PutAccountSendingAttributesRequest(input *PutAccountSendingAttributesInput) PutAccountSendingAttributesRequest

PutAccountSendingAttributesRequest returns a request value for making API operation for Amazon Pinpoint Email Service.

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

// Example sending a request using PutAccountSendingAttributesRequest.
req := client.PutAccountSendingAttributesRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/PutAccountSendingAttributes

func (*Client) PutConfigurationSetDeliveryOptionsRequest added in v0.9.0 

func (c *Client) PutConfigurationSetDeliveryOptionsRequest(input *PutConfigurationSetDeliveryOptionsInput) PutConfigurationSetDeliveryOptionsRequest

PutConfigurationSetDeliveryOptionsRequest returns a request value for making API operation for Amazon Pinpoint Email Service.

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. 

// Example sending a request using PutConfigurationSetDeliveryOptionsRequest.
req := client.PutConfigurationSetDeliveryOptionsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/PutConfigurationSetDeliveryOptions

func (*Client) PutConfigurationSetReputationOptionsRequest added in v0.9.0 

func (c *Client) PutConfigurationSetReputationOptionsRequest(input *PutConfigurationSetReputationOptionsInput) PutConfigurationSetReputationOptionsRequest

PutConfigurationSetReputationOptionsRequest returns a request value for making API operation for Amazon Pinpoint Email Service.

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

// Example sending a request using PutConfigurationSetReputationOptionsRequest.
req := client.PutConfigurationSetReputationOptionsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/PutConfigurationSetReputationOptions

func (*Client) PutConfigurationSetSendingOptionsRequest added in v0.9.0 

func (c *Client) PutConfigurationSetSendingOptionsRequest(input *PutConfigurationSetSendingOptionsInput) PutConfigurationSetSendingOptionsRequest

PutConfigurationSetSendingOptionsRequest returns a request value for making API operation for Amazon Pinpoint Email Service.

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

// Example sending a request using PutConfigurationSetSendingOptionsRequest.
req := client.PutConfigurationSetSendingOptionsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/PutConfigurationSetSendingOptions

func (*Client) PutConfigurationSetTrackingOptionsRequest added in v0.9.0 

func (c *Client) PutConfigurationSetTrackingOptionsRequest(input *PutConfigurationSetTrackingOptionsInput) PutConfigurationSetTrackingOptionsRequest

PutConfigurationSetTrackingOptionsRequest returns a request value for making API operation for Amazon Pinpoint Email Service.

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

// Example sending a request using PutConfigurationSetTrackingOptionsRequest.
req := client.PutConfigurationSetTrackingOptionsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/PutConfigurationSetTrackingOptions

func (*Client) PutDedicatedIpInPoolRequest added in v0.9.0 

func (c *Client) PutDedicatedIpInPoolRequest(input *PutDedicatedIpInPoolInput) PutDedicatedIpInPoolRequest

PutDedicatedIpInPoolRequest returns a request value for making API operation for Amazon Pinpoint Email Service.

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. 

// Example sending a request using PutDedicatedIpInPoolRequest.
req := client.PutDedicatedIpInPoolRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/PutDedicatedIpInPool

func (*Client) PutDedicatedIpWarmupAttributesRequest added in v0.9.0 

func (c *Client) PutDedicatedIpWarmupAttributesRequest(input *PutDedicatedIpWarmupAttributesInput) PutDedicatedIpWarmupAttributesRequest

PutDedicatedIpWarmupAttributesRequest returns a request value for making API operation for Amazon Pinpoint Email Service. 

// Example sending a request using PutDedicatedIpWarmupAttributesRequest.
req := client.PutDedicatedIpWarmupAttributesRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/PutDedicatedIpWarmupAttributes

func (*Client) PutDeliverabilityDashboardOptionRequest added in v0.9.0 

func (c *Client) PutDeliverabilityDashboardOptionRequest(input *PutDeliverabilityDashboardOptionInput) PutDeliverabilityDashboardOptionRequest

PutDeliverabilityDashboardOptionRequest returns a request value for making API operation for Amazon Pinpoint Email Service.

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

// Example sending a request using PutDeliverabilityDashboardOptionRequest.
req := client.PutDeliverabilityDashboardOptionRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/PutDeliverabilityDashboardOption

func (*Client) PutEmailIdentityDkimAttributesRequest added in v0.9.0 

func (c *Client) PutEmailIdentityDkimAttributesRequest(input *PutEmailIdentityDkimAttributesInput) PutEmailIdentityDkimAttributesRequest

PutEmailIdentityDkimAttributesRequest returns a request value for making API operation for Amazon Pinpoint Email Service.

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

// Example sending a request using PutEmailIdentityDkimAttributesRequest.
req := client.PutEmailIdentityDkimAttributesRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/PutEmailIdentityDkimAttributes

func (*Client) PutEmailIdentityFeedbackAttributesRequest added in v0.9.0 

func (c *Client) PutEmailIdentityFeedbackAttributesRequest(input *PutEmailIdentityFeedbackAttributesInput) PutEmailIdentityFeedbackAttributesRequest

PutEmailIdentityFeedbackAttributesRequest returns a request value for making API operation for Amazon Pinpoint Email Service.

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

// Example sending a request using PutEmailIdentityFeedbackAttributesRequest.
req := client.PutEmailIdentityFeedbackAttributesRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/PutEmailIdentityFeedbackAttributes

func (*Client) PutEmailIdentityMailFromAttributesRequest added in v0.9.0 

func (c *Client) PutEmailIdentityMailFromAttributesRequest(input *PutEmailIdentityMailFromAttributesInput) PutEmailIdentityMailFromAttributesRequest

PutEmailIdentityMailFromAttributesRequest returns a request value for making API operation for Amazon Pinpoint Email Service.

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

// Example sending a request using PutEmailIdentityMailFromAttributesRequest.
req := client.PutEmailIdentityMailFromAttributesRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/PutEmailIdentityMailFromAttributes

func (*Client) SendEmailRequest added in v0.9.0 

func (c *Client) SendEmailRequest(input *SendEmailInput) SendEmailRequest

SendEmailRequest returns a request value for making API operation for Amazon Pinpoint Email Service.

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.

    // Example sending a request using SendEmailRequest. req := client.SendEmailRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/SendEmail

func (*Client) TagResourceRequest added in v0.9.0 

func (c *Client) TagResourceRequest(input *TagResourceInput) TagResourceRequest

TagResourceRequest returns a request value for making API operation for Amazon Pinpoint Email Service.

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. 

// Example sending a request using TagResourceRequest.
req := client.TagResourceRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/TagResource

func (*Client) UntagResourceRequest added in v0.9.0 

func (c *Client) UntagResourceRequest(input *UntagResourceInput) UntagResourceRequest

UntagResourceRequest returns a request value for making API operation for Amazon Pinpoint Email Service.

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

// Example sending a request using UntagResourceRequest.
req := client.UntagResourceRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/UntagResource

func (*Client) UpdateConfigurationSetEventDestinationRequest added in v0.9.0 

func (c *Client) UpdateConfigurationSetEventDestinationRequest(input *UpdateConfigurationSetEventDestinationInput) UpdateConfigurationSetEventDestinationRequest

UpdateConfigurationSetEventDestinationRequest returns a request value for making API operation for Amazon Pinpoint Email Service.

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. 

// Example sending a request using UpdateConfigurationSetEventDestinationRequest.
req := client.UpdateConfigurationSetEventDestinationRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/UpdateConfigurationSetEventDestination

type CloudWatchDestination 

type CloudWatchDestination struct {

	// An array of objects that define the dimensions to use when you send email
	// events to Amazon CloudWatch.
	//
	// DimensionConfigurations is a required field
	DimensionConfigurations []CloudWatchDimensionConfiguration `type:"list" required:"true"`
	// contains filtered or unexported fields
}

An object that defines an Amazon CloudWatch destination for email events. You can use Amazon CloudWatch to monitor and gain insights on your email sending metrics.

func (CloudWatchDestination) MarshalFields 

func (s CloudWatchDestination) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CloudWatchDestination) String 

func (s CloudWatchDestination) String() string

String returns the string representation

func (*CloudWatchDestination) Validate 

func (s *CloudWatchDestination) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CloudWatchDimensionConfiguration 

type CloudWatchDimensionConfiguration struct {

	// The default value of the dimension that is published to Amazon CloudWatch
	// if you don't provide the value of the dimension when you send an email. This
	// value has to meet the following criteria:
	//
	//    * It can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores
	//    (_), or dashes (-).
	//
	//    * It can contain no more than 256 characters.
	//
	// DefaultDimensionValue is a required field
	DefaultDimensionValue *string `type:"string" required:"true"`

	// The name of an Amazon CloudWatch dimension associated with an email sending
	// metric. The name has to meet the following criteria:
	//
	//    * It can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores
	//    (_), or dashes (-).
	//
	//    * It can contain no more than 256 characters.
	//
	// DimensionName is a required field
	DimensionName *string `type:"string" required:"true"`

	// The location where Amazon Pinpoint finds the value of a dimension to publish
	// to Amazon CloudWatch. If you want Amazon Pinpoint to use the message tags
	// that you specify using an X-SES-MESSAGE-TAGS header or a parameter to the
	// SendEmail/SendRawEmail API, choose messageTag. If you want Amazon Pinpoint
	// to use your own email headers, choose emailHeader. If you want Amazon Pinpoint
	// to use link tags, choose linkTags.
	//
	// DimensionValueSource is a required field
	DimensionValueSource DimensionValueSource `type:"string" required:"true" enum:"true"`
	// contains filtered or unexported fields
}

An object that defines the dimension configuration to use when you send Amazon Pinpoint email events to Amazon CloudWatch.

func (CloudWatchDimensionConfiguration) MarshalFields 

func (s CloudWatchDimensionConfiguration) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CloudWatchDimensionConfiguration) String 

func (s CloudWatchDimensionConfiguration) String() string

String returns the string representation

func (*CloudWatchDimensionConfiguration) Validate 

func (s *CloudWatchDimensionConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type Content 

type Content struct {

	// The character set for the content. Because of the constraints of the SMTP
	// protocol, Amazon Pinpoint uses 7-bit ASCII by default. If the text includes
	// characters outside of the ASCII range, you have to specify a character set.
	// For example, you could specify UTF-8, ISO-8859-1, or Shift_JIS.
	Charset *string `type:"string"`

	// The content of the message itself.
	//
	// Data is a required field
	Data *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

An object that represents the content of the email, and optionally a character set specification.

func (Content) MarshalFields 

func (s Content) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (Content) String 

func (s Content) String() string

String returns the string representation

func (*Content) Validate 

func (s *Content) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateConfigurationSetEventDestinationInput 

type CreateConfigurationSetEventDestinationInput struct {

	// The name of the configuration set that you want to add an event destination
	// to.
	//
	// ConfigurationSetName is a required field
	ConfigurationSetName *string `location:"uri" locationName:"ConfigurationSetName" type:"string" required:"true"`

	// An object that defines the event destination.
	//
	// EventDestination is a required field
	EventDestination *EventDestinationDefinition `type:"structure" required:"true"`

	// A name that identifies the event destination within the configuration set.
	//
	// EventDestinationName is a required field
	EventDestinationName *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

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

func (CreateConfigurationSetEventDestinationInput) MarshalFields 

func (s CreateConfigurationSetEventDestinationInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CreateConfigurationSetEventDestinationInput) String 

func (s CreateConfigurationSetEventDestinationInput) String() string

String returns the string representation

func (*CreateConfigurationSetEventDestinationInput) Validate 

func (s *CreateConfigurationSetEventDestinationInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateConfigurationSetEventDestinationOutput 

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

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

func (CreateConfigurationSetEventDestinationOutput) MarshalFields 

func (s CreateConfigurationSetEventDestinationOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CreateConfigurationSetEventDestinationOutput) String 

func (s CreateConfigurationSetEventDestinationOutput) String() string

String returns the string representation

type CreateConfigurationSetEventDestinationRequest 

type CreateConfigurationSetEventDestinationRequest struct {
	*aws.Request
	Input *CreateConfigurationSetEventDestinationInput
	Copy  func(*CreateConfigurationSetEventDestinationInput) CreateConfigurationSetEventDestinationRequest
}

CreateConfigurationSetEventDestinationRequest is the request type for the CreateConfigurationSetEventDestination API operation.

func (CreateConfigurationSetEventDestinationRequest) Send 

func (r CreateConfigurationSetEventDestinationRequest) Send(ctx context.Context) (*CreateConfigurationSetEventDestinationResponse, error)

Send marshals and sends the CreateConfigurationSetEventDestination API request.

type CreateConfigurationSetEventDestinationResponse added in v0.9.0 

type CreateConfigurationSetEventDestinationResponse struct {
	*CreateConfigurationSetEventDestinationOutput
	// contains filtered or unexported fields
}

CreateConfigurationSetEventDestinationResponse is the response type for the CreateConfigurationSetEventDestination API operation.

func (*CreateConfigurationSetEventDestinationResponse) SDKResponseMetdata added in v0.9.0 

func (r *CreateConfigurationSetEventDestinationResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CreateConfigurationSetEventDestination request.

type CreateConfigurationSetInput 

type CreateConfigurationSetInput struct {

	// The name of the configuration set.
	//
	// ConfigurationSetName is a required field
	ConfigurationSetName *string `type:"string" required:"true"`

	// An object that defines the dedicated IP pool that is used to send emails
	// that you send using the configuration set.
	DeliveryOptions *DeliveryOptions `type:"structure"`

	// An object that defines whether or not Amazon Pinpoint collects reputation
	// metrics for the emails that you send that use the configuration set.
	ReputationOptions *ReputationOptions `type:"structure"`

	// An object that defines whether or not Amazon Pinpoint can send email that
	// you send using the configuration set.
	SendingOptions *SendingOptions `type:"structure"`

	// An array of objects that define the tags (keys and values) that you want
	// to associate with the configuration set.
	Tags []Tag `type:"list"`

	// An object that defines the open and click tracking options for emails that
	// you send using the configuration set.
	TrackingOptions *TrackingOptions `type:"structure"`
	// contains filtered or unexported fields
}

A request to create a configuration set.

func (CreateConfigurationSetInput) MarshalFields 

func (s CreateConfigurationSetInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CreateConfigurationSetInput) String 

func (s CreateConfigurationSetInput) String() string

String returns the string representation

func (*CreateConfigurationSetInput) Validate 

func (s *CreateConfigurationSetInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateConfigurationSetOutput 

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

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

func (CreateConfigurationSetOutput) MarshalFields 

func (s CreateConfigurationSetOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CreateConfigurationSetOutput) String 

func (s CreateConfigurationSetOutput) String() string

String returns the string representation

type CreateConfigurationSetRequest 

type CreateConfigurationSetRequest struct {
	*aws.Request
	Input *CreateConfigurationSetInput
	Copy  func(*CreateConfigurationSetInput) CreateConfigurationSetRequest
}

CreateConfigurationSetRequest is the request type for the CreateConfigurationSet API operation.

func (CreateConfigurationSetRequest) Send 

func (r CreateConfigurationSetRequest) Send(ctx context.Context) (*CreateConfigurationSetResponse, error)

Send marshals and sends the CreateConfigurationSet API request.

type CreateConfigurationSetResponse added in v0.9.0 

type CreateConfigurationSetResponse struct {
	*CreateConfigurationSetOutput
	// contains filtered or unexported fields
}

CreateConfigurationSetResponse is the response type for the CreateConfigurationSet API operation.

func (*CreateConfigurationSetResponse) SDKResponseMetdata added in v0.9.0 

func (r *CreateConfigurationSetResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CreateConfigurationSet request.

type CreateDedicatedIpPoolInput 

type CreateDedicatedIpPoolInput struct {

	// The name of the dedicated IP pool.
	//
	// PoolName is a required field
	PoolName *string `type:"string" required:"true"`

	// An object that defines the tags (keys and values) that you want to associate
	// with the pool.
	Tags []Tag `type:"list"`
	// contains filtered or unexported fields
}

A request to create a new dedicated IP pool.

func (CreateDedicatedIpPoolInput) MarshalFields 

func (s CreateDedicatedIpPoolInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CreateDedicatedIpPoolInput) String 

func (s CreateDedicatedIpPoolInput) String() string

String returns the string representation

func (*CreateDedicatedIpPoolInput) Validate 

func (s *CreateDedicatedIpPoolInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateDedicatedIpPoolOutput 

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

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

func (CreateDedicatedIpPoolOutput) MarshalFields 

func (s CreateDedicatedIpPoolOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CreateDedicatedIpPoolOutput) String 

func (s CreateDedicatedIpPoolOutput) String() string

String returns the string representation

type CreateDedicatedIpPoolRequest 

type CreateDedicatedIpPoolRequest struct {
	*aws.Request
	Input *CreateDedicatedIpPoolInput
	Copy  func(*CreateDedicatedIpPoolInput) CreateDedicatedIpPoolRequest
}

CreateDedicatedIpPoolRequest is the request type for the CreateDedicatedIpPool API operation.

func (CreateDedicatedIpPoolRequest) Send 

func (r CreateDedicatedIpPoolRequest) Send(ctx context.Context) (*CreateDedicatedIpPoolResponse, error)

Send marshals and sends the CreateDedicatedIpPool API request.

type CreateDedicatedIpPoolResponse added in v0.9.0 

type CreateDedicatedIpPoolResponse struct {
	*CreateDedicatedIpPoolOutput
	// contains filtered or unexported fields
}

CreateDedicatedIpPoolResponse is the response type for the CreateDedicatedIpPool API operation.

func (*CreateDedicatedIpPoolResponse) SDKResponseMetdata added in v0.9.0 

func (r *CreateDedicatedIpPoolResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CreateDedicatedIpPool request.

type CreateDeliverabilityTestReportInput added in v0.7.0 

type CreateDeliverabilityTestReportInput struct {

	// The HTML body of the message that you sent when you performed the predictive
	// inbox placement test.
	//
	// Content is a required field
	Content *EmailContent `type:"structure" required:"true"`

	// The email address that the predictive inbox placement test email was sent
	// from.
	//
	// FromEmailAddress is a required field
	FromEmailAddress *string `type:"string" required:"true"`

	// A unique name that helps you to identify the predictive inbox placement test
	// when you retrieve the results.
	ReportName *string `type:"string"`

	// An array of objects that define the tags (keys and values) that you want
	// to associate with the predictive inbox placement test.
	Tags []Tag `type:"list"`
	// contains filtered or unexported fields
}

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.

func (CreateDeliverabilityTestReportInput) MarshalFields added in v0.7.0 

func (s CreateDeliverabilityTestReportInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CreateDeliverabilityTestReportInput) String added in v0.7.0 

func (s CreateDeliverabilityTestReportInput) String() string

String returns the string representation

func (*CreateDeliverabilityTestReportInput) Validate added in v0.7.0 

func (s *CreateDeliverabilityTestReportInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateDeliverabilityTestReportOutput added in v0.7.0 

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 is a required field
	DeliverabilityTestStatus DeliverabilityTestStatus `type:"string" required:"true" enum:"true"`

	// A unique string that identifies the predictive inbox placement test.
	//
	// ReportId is a required field
	ReportId *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Information about the predictive inbox placement test that you created.

func (CreateDeliverabilityTestReportOutput) MarshalFields added in v0.7.0 

func (s CreateDeliverabilityTestReportOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CreateDeliverabilityTestReportOutput) String added in v0.7.0 

func (s CreateDeliverabilityTestReportOutput) String() string

String returns the string representation

type CreateDeliverabilityTestReportRequest added in v0.7.0 

type CreateDeliverabilityTestReportRequest struct {
	*aws.Request
	Input *CreateDeliverabilityTestReportInput
	Copy  func(*CreateDeliverabilityTestReportInput) CreateDeliverabilityTestReportRequest
}

CreateDeliverabilityTestReportRequest is the request type for the CreateDeliverabilityTestReport API operation.

func (CreateDeliverabilityTestReportRequest) Send added in v0.7.0 

func (r CreateDeliverabilityTestReportRequest) Send(ctx context.Context) (*CreateDeliverabilityTestReportResponse, error)

Send marshals and sends the CreateDeliverabilityTestReport API request.

type CreateDeliverabilityTestReportResponse added in v0.9.0 

type CreateDeliverabilityTestReportResponse struct {
	*CreateDeliverabilityTestReportOutput
	// contains filtered or unexported fields
}

CreateDeliverabilityTestReportResponse is the response type for the CreateDeliverabilityTestReport API operation.

func (*CreateDeliverabilityTestReportResponse) SDKResponseMetdata added in v0.9.0 

func (r *CreateDeliverabilityTestReportResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CreateDeliverabilityTestReport request.

type CreateEmailIdentityInput 

type CreateEmailIdentityInput struct {

	// The email address or domain that you want to verify.
	//
	// EmailIdentity is a required field
	EmailIdentity *string `type:"string" required:"true"`

	// An array of objects that define the tags (keys and values) that you want
	// to associate with the email identity.
	Tags []Tag `type:"list"`
	// contains filtered or unexported fields
}

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

func (CreateEmailIdentityInput) MarshalFields 

func (s CreateEmailIdentityInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CreateEmailIdentityInput) String 

func (s CreateEmailIdentityInput) String() string

String returns the string representation

func (*CreateEmailIdentityInput) Validate 

func (s *CreateEmailIdentityInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateEmailIdentityOutput 

type CreateEmailIdentityOutput struct {

	// An object that contains information about the DKIM attributes for the identity.
	// This object includes the tokens that you use to create the CNAME records
	// that are required to complete the DKIM verification process.
	DkimAttributes *DkimAttributes `type:"structure"`

	// The email identity type.
	IdentityType IdentityType `type:"string" enum:"true"`

	// 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 `type:"boolean"`
	// contains filtered or unexported fields
}

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.

func (CreateEmailIdentityOutput) MarshalFields 

func (s CreateEmailIdentityOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CreateEmailIdentityOutput) String 

func (s CreateEmailIdentityOutput) String() string

String returns the string representation

type CreateEmailIdentityRequest 

type CreateEmailIdentityRequest struct {
	*aws.Request
	Input *CreateEmailIdentityInput
	Copy  func(*CreateEmailIdentityInput) CreateEmailIdentityRequest
}

CreateEmailIdentityRequest is the request type for the CreateEmailIdentity API operation.

func (CreateEmailIdentityRequest) Send 

func (r CreateEmailIdentityRequest) Send(ctx context.Context) (*CreateEmailIdentityResponse, error)

Send marshals and sends the CreateEmailIdentity API request.

type CreateEmailIdentityResponse added in v0.9.0 

type CreateEmailIdentityResponse struct {
	*CreateEmailIdentityOutput
	// contains filtered or unexported fields
}

CreateEmailIdentityResponse is the response type for the CreateEmailIdentity API operation.

func (*CreateEmailIdentityResponse) SDKResponseMetdata added in v0.9.0 

func (r *CreateEmailIdentityResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CreateEmailIdentity request.

type DailyVolume added in v0.7.0 

type DailyVolume struct {

	// An object that contains inbox placement metrics for a specified day in the
	// analysis period, broken out by the recipient's email provider.
	DomainIspPlacements []DomainIspPlacement `type:"list"`

	// The date that the DailyVolume metrics apply to, in Unix time.
	StartDate *time.Time `type:"timestamp"`

	// An object that contains inbox placement metrics for a specific day in the
	// analysis period.
	VolumeStatistics *VolumeStatistics `type:"structure"`
	// contains filtered or unexported fields
}

An object that contains information about the volume of email sent on each day of the analysis period.

func (DailyVolume) MarshalFields added in v0.7.0 

func (s DailyVolume) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DailyVolume) String added in v0.7.0 

func (s DailyVolume) String() string

String returns the string representation

type DedicatedIp 

type DedicatedIp struct {

	// An IP address that is reserved for use by your Amazon Pinpoint account.
	//
	// Ip is a required field
	Ip *string `type:"string" required:"true"`

	// The name of the dedicated IP pool that the IP address is associated with.
	PoolName *string `type:"string"`

	// Indicates how complete the dedicated IP warm-up process is. When this value
	// equals 1, the address has completed the warm-up process and is ready for
	// use.
	//
	// WarmupPercentage is a required field
	WarmupPercentage *int64 `type:"integer" required:"true"`

	// The warm-up status of a dedicated IP address. The status can have one of
	// the following values:
	//
	//    * IN_PROGRESS – The IP address isn't ready to use because the dedicated
	//    IP warm-up process is ongoing.
	//
	//    * DONE – The dedicated IP warm-up process is complete, and the IP address
	//    is ready to use.
	//
	// WarmupStatus is a required field
	WarmupStatus WarmupStatus `type:"string" required:"true" enum:"true"`
	// contains filtered or unexported fields
}

Contains information about a dedicated IP address that is associated with your Amazon Pinpoint account.

func (DedicatedIp) MarshalFields 

func (s DedicatedIp) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DedicatedIp) String 

func (s DedicatedIp) String() string

String returns the string representation

type DeleteConfigurationSetEventDestinationInput 

type DeleteConfigurationSetEventDestinationInput struct {

	// The name of the configuration set that contains the event destination that
	// you want to delete.
	//
	// ConfigurationSetName is a required field
	ConfigurationSetName *string `location:"uri" locationName:"ConfigurationSetName" type:"string" required:"true"`

	// The name of the event destination that you want to delete.
	//
	// EventDestinationName is a required field
	EventDestinationName *string `location:"uri" locationName:"EventDestinationName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

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

func (DeleteConfigurationSetEventDestinationInput) MarshalFields 

func (s DeleteConfigurationSetEventDestinationInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeleteConfigurationSetEventDestinationInput) String 

func (s DeleteConfigurationSetEventDestinationInput) String() string

String returns the string representation

func (*DeleteConfigurationSetEventDestinationInput) Validate 

func (s *DeleteConfigurationSetEventDestinationInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteConfigurationSetEventDestinationOutput 

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

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

func (DeleteConfigurationSetEventDestinationOutput) MarshalFields 

func (s DeleteConfigurationSetEventDestinationOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeleteConfigurationSetEventDestinationOutput) String 

func (s DeleteConfigurationSetEventDestinationOutput) String() string

String returns the string representation

type DeleteConfigurationSetEventDestinationRequest 

type DeleteConfigurationSetEventDestinationRequest struct {
	*aws.Request
	Input *DeleteConfigurationSetEventDestinationInput
	Copy  func(*DeleteConfigurationSetEventDestinationInput) DeleteConfigurationSetEventDestinationRequest
}

DeleteConfigurationSetEventDestinationRequest is the request type for the DeleteConfigurationSetEventDestination API operation.

func (DeleteConfigurationSetEventDestinationRequest) Send 

func (r DeleteConfigurationSetEventDestinationRequest) Send(ctx context.Context) (*DeleteConfigurationSetEventDestinationResponse, error)

Send marshals and sends the DeleteConfigurationSetEventDestination API request.

type DeleteConfigurationSetEventDestinationResponse added in v0.9.0 

type DeleteConfigurationSetEventDestinationResponse struct {
	*DeleteConfigurationSetEventDestinationOutput
	// contains filtered or unexported fields
}

DeleteConfigurationSetEventDestinationResponse is the response type for the DeleteConfigurationSetEventDestination API operation.

func (*DeleteConfigurationSetEventDestinationResponse) SDKResponseMetdata added in v0.9.0 

func (r *DeleteConfigurationSetEventDestinationResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteConfigurationSetEventDestination request.

type DeleteConfigurationSetInput 

type DeleteConfigurationSetInput struct {

	// The name of the configuration set that you want to delete.
	//
	// ConfigurationSetName is a required field
	ConfigurationSetName *string `location:"uri" locationName:"ConfigurationSetName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

A request to delete a configuration set.

func (DeleteConfigurationSetInput) MarshalFields 

func (s DeleteConfigurationSetInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeleteConfigurationSetInput) String 

func (s DeleteConfigurationSetInput) String() string

String returns the string representation

func (*DeleteConfigurationSetInput) Validate 

func (s *DeleteConfigurationSetInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteConfigurationSetOutput 

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

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

func (DeleteConfigurationSetOutput) MarshalFields 

func (s DeleteConfigurationSetOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeleteConfigurationSetOutput) String 

func (s DeleteConfigurationSetOutput) String() string

String returns the string representation

type DeleteConfigurationSetRequest 

type DeleteConfigurationSetRequest struct {
	*aws.Request
	Input *DeleteConfigurationSetInput
	Copy  func(*DeleteConfigurationSetInput) DeleteConfigurationSetRequest
}

DeleteConfigurationSetRequest is the request type for the DeleteConfigurationSet API operation.

func (DeleteConfigurationSetRequest) Send 

func (r DeleteConfigurationSetRequest) Send(ctx context.Context) (*DeleteConfigurationSetResponse, error)

Send marshals and sends the DeleteConfigurationSet API request.

type DeleteConfigurationSetResponse added in v0.9.0 

type DeleteConfigurationSetResponse struct {
	*DeleteConfigurationSetOutput
	// contains filtered or unexported fields
}

DeleteConfigurationSetResponse is the response type for the DeleteConfigurationSet API operation.

func (*DeleteConfigurationSetResponse) SDKResponseMetdata added in v0.9.0 

func (r *DeleteConfigurationSetResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteConfigurationSet request.

type DeleteDedicatedIpPoolInput 

type DeleteDedicatedIpPoolInput struct {

	// The name of the dedicated IP pool that you want to delete.
	//
	// PoolName is a required field
	PoolName *string `location:"uri" locationName:"PoolName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

A request to delete a dedicated IP pool.

func (DeleteDedicatedIpPoolInput) MarshalFields 

func (s DeleteDedicatedIpPoolInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeleteDedicatedIpPoolInput) String 

func (s DeleteDedicatedIpPoolInput) String() string

String returns the string representation

func (*DeleteDedicatedIpPoolInput) Validate 

func (s *DeleteDedicatedIpPoolInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteDedicatedIpPoolOutput 

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

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

func (DeleteDedicatedIpPoolOutput) MarshalFields 

func (s DeleteDedicatedIpPoolOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeleteDedicatedIpPoolOutput) String 

func (s DeleteDedicatedIpPoolOutput) String() string

String returns the string representation

type DeleteDedicatedIpPoolRequest 

type DeleteDedicatedIpPoolRequest struct {
	*aws.Request
	Input *DeleteDedicatedIpPoolInput
	Copy  func(*DeleteDedicatedIpPoolInput) DeleteDedicatedIpPoolRequest
}

DeleteDedicatedIpPoolRequest is the request type for the DeleteDedicatedIpPool API operation.

func (DeleteDedicatedIpPoolRequest) Send 

func (r DeleteDedicatedIpPoolRequest) Send(ctx context.Context) (*DeleteDedicatedIpPoolResponse, error)

Send marshals and sends the DeleteDedicatedIpPool API request.

type DeleteDedicatedIpPoolResponse added in v0.9.0 

type DeleteDedicatedIpPoolResponse struct {
	*DeleteDedicatedIpPoolOutput
	// contains filtered or unexported fields
}

DeleteDedicatedIpPoolResponse is the response type for the DeleteDedicatedIpPool API operation.

func (*DeleteDedicatedIpPoolResponse) SDKResponseMetdata added in v0.9.0 

func (r *DeleteDedicatedIpPoolResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteDedicatedIpPool request.

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 is a required field
	EmailIdentity *string `location:"uri" locationName:"EmailIdentity" type:"string" required:"true"`
	// contains filtered or unexported fields
}

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.

func (DeleteEmailIdentityInput) MarshalFields 

func (s DeleteEmailIdentityInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeleteEmailIdentityInput) String 

func (s DeleteEmailIdentityInput) String() string

String returns the string representation

func (*DeleteEmailIdentityInput) Validate 

func (s *DeleteEmailIdentityInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteEmailIdentityOutput 

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

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

func (DeleteEmailIdentityOutput) MarshalFields 

func (s DeleteEmailIdentityOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeleteEmailIdentityOutput) String 

func (s DeleteEmailIdentityOutput) String() string

String returns the string representation

type DeleteEmailIdentityRequest 

type DeleteEmailIdentityRequest struct {
	*aws.Request
	Input *DeleteEmailIdentityInput
	Copy  func(*DeleteEmailIdentityInput) DeleteEmailIdentityRequest
}

DeleteEmailIdentityRequest is the request type for the DeleteEmailIdentity API operation.

func (DeleteEmailIdentityRequest) Send 

func (r DeleteEmailIdentityRequest) Send(ctx context.Context) (*DeleteEmailIdentityResponse, error)

Send marshals and sends the DeleteEmailIdentity API request.

type DeleteEmailIdentityResponse added in v0.9.0 

type DeleteEmailIdentityResponse struct {
	*DeleteEmailIdentityOutput
	// contains filtered or unexported fields
}

DeleteEmailIdentityResponse is the response type for the DeleteEmailIdentity API operation.

func (*DeleteEmailIdentityResponse) SDKResponseMetdata added in v0.9.0 

func (r *DeleteEmailIdentityResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteEmailIdentity request.

type DeliverabilityDashboardAccountStatus added in v0.9.0 

type DeliverabilityDashboardAccountStatus string

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. 

const (
	DeliverabilityDashboardAccountStatusActive            DeliverabilityDashboardAccountStatus = "ACTIVE"
	DeliverabilityDashboardAccountStatusPendingExpiration DeliverabilityDashboardAccountStatus = "PENDING_EXPIRATION"
	DeliverabilityDashboardAccountStatusDisabled          DeliverabilityDashboardAccountStatus = "DISABLED"
)

Enum values for DeliverabilityDashboardAccountStatus

func (DeliverabilityDashboardAccountStatus) MarshalValue added in v0.9.0 

func (enum DeliverabilityDashboardAccountStatus) MarshalValue() (string, error)

func (DeliverabilityDashboardAccountStatus) MarshalValueBuf added in v0.9.0 

func (enum DeliverabilityDashboardAccountStatus) MarshalValueBuf(b []byte) ([]byte, error)

type DeliverabilityTestReport added in v0.7.0 

type DeliverabilityTestReport struct {

	// The date and time when the predictive inbox placement test was created, in
	// Unix time format.
	CreateDate *time.Time `type:"timestamp"`

	// 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 DeliverabilityTestStatus `type:"string" enum:"true"`

	// The sender address that you specified for the predictive inbox placement
	// test.
	FromEmailAddress *string `type:"string"`

	// A unique string that identifies the predictive inbox placement test.
	ReportId *string `type:"string"`

	// A name that helps you identify a predictive inbox placement test report.
	ReportName *string `type:"string"`

	// The subject line for an email that you submitted in a predictive inbox placement
	// test.
	Subject *string `type:"string"`
	// contains filtered or unexported fields
}

An object that contains metadata related to a predictive inbox placement test.

func (DeliverabilityTestReport) MarshalFields added in v0.7.0 

func (s DeliverabilityTestReport) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeliverabilityTestReport) String added in v0.7.0 

func (s DeliverabilityTestReport) String() string

String returns the string representation

type DeliverabilityTestStatus added in v0.7.0 

type DeliverabilityTestStatus string

The status of a 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 operation to view the results of the test. 

const (
	DeliverabilityTestStatusInProgress DeliverabilityTestStatus = "IN_PROGRESS"
	DeliverabilityTestStatusCompleted  DeliverabilityTestStatus = "COMPLETED"
)

Enum values for DeliverabilityTestStatus

func (DeliverabilityTestStatus) MarshalValue added in v0.7.0 

func (enum DeliverabilityTestStatus) MarshalValue() (string, error)

func (DeliverabilityTestStatus) MarshalValueBuf added in v0.7.0 

func (enum DeliverabilityTestStatus) MarshalValueBuf(b []byte) ([]byte, error)

type DeliveryOptions 

type DeliveryOptions struct {

	// The name of the dedicated IP pool that you want to associate with the configuration
	// set.
	SendingPoolName *string `type:"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 TlsPolicy `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

Used to associate a configuration set with a dedicated IP pool.

func (DeliveryOptions) MarshalFields 

func (s DeliveryOptions) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeliveryOptions) String 

func (s DeliveryOptions) String() string

String returns the string representation

type Destination 

type Destination struct {

	// An array that contains the email addresses of the "BCC" (blind carbon copy)
	// recipients for the email.
	BccAddresses []string `type:"list"`

	// An array that contains the email addresses of the "CC" (carbon copy) recipients
	// for the email.
	CcAddresses []string `type:"list"`

	// An array that contains the email addresses of the "To" recipients for the
	// email.
	ToAddresses []string `type:"list"`
	// contains filtered or unexported fields
}

An object that describes the recipients for an email.

func (Destination) MarshalFields 

func (s Destination) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (Destination) String 

func (s Destination) String() string

String returns the string representation

type DimensionValueSource 

type DimensionValueSource string

The location where Amazon Pinpoint finds the value of a dimension to publish to Amazon CloudWatch. If you want Amazon Pinpoint to use the message tags that you specify using an X-SES-MESSAGE-TAGS header or a parameter to the SendEmail/SendRawEmail API, choose messageTag. If you want Amazon Pinpoint to use your own email headers, choose emailHeader. If you want Amazon Pinpoint to use link tags, choose linkTags. 

const (
	DimensionValueSourceMessageTag  DimensionValueSource = "MESSAGE_TAG"
	DimensionValueSourceEmailHeader DimensionValueSource = "EMAIL_HEADER"
	DimensionValueSourceLinkTag     DimensionValueSource = "LINK_TAG"
)

Enum values for DimensionValueSource

func (DimensionValueSource) MarshalValue 

func (enum DimensionValueSource) MarshalValue() (string, error)

func (DimensionValueSource) MarshalValueBuf 

func (enum DimensionValueSource) MarshalValueBuf(b []byte) ([]byte, error)

type DkimAttributes 

type DkimAttributes struct {

	// If the value is true, then the messages that Amazon Pinpoint sends from the
	// identity are DKIM-signed. If the value is false, then the messages that Amazon
	// Pinpoint sends from the identity aren't DKIM-signed.
	SigningEnabled *bool `type:"boolean"`

	// Describes whether or not Amazon Pinpoint has successfully located the DKIM
	// records in the DNS records for the domain. The status can be one of the following:
	//
	//    * PENDING – Amazon Pinpoint hasn't yet located the DKIM records in the
	//    DNS configuration for the domain, but will continue to attempt to locate
	//    them.
	//
	//    * SUCCESS – Amazon Pinpoint located the DKIM records in the DNS configuration
	//    for the domain and determined that they're correct. Amazon Pinpoint can
	//    now send DKIM-signed email from the identity.
	//
	//    * FAILED – Amazon Pinpoint was unable to locate the DKIM records in
	//    the DNS settings for the domain, and won't continue to search for them.
	//
	//    * TEMPORARY_FAILURE – A temporary issue occurred, which prevented Amazon
	//    Pinpoint from determining the DKIM status for the domain.
	//
	//    * NOT_STARTED – Amazon Pinpoint hasn't yet started searching for the
	//    DKIM records in the DKIM records for the domain.
	Status DkimStatus `type:"string" enum:"true"`

	// A set of unique strings that you use to create a set of CNAME records that
	// you add to the DNS configuration for your domain. When Amazon Pinpoint detects
	// these records in the DNS configuration for your domain, the DKIM authentication
	// process is complete. Amazon Pinpoint usually detects these records within
	// about 72 hours of adding them to the DNS configuration for your domain.
	Tokens []string `type:"list"`
	// contains filtered or unexported fields
}

An object that contains information about the DKIM configuration for an email identity.

func (DkimAttributes) MarshalFields 

func (s DkimAttributes) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DkimAttributes) String 

func (s DkimAttributes) String() string

String returns the string representation

type DkimStatus 

type DkimStatus string

The DKIM authentication status of the identity. The status can be one of the following:

  • PENDING – The DKIM verification process was initiated, and Amazon Pinpoint is still waiting for the required CNAME records to appear in the DNS configuration for the domain.

  • SUCCESS – The DKIM authentication process completed successfully.

  • FAILED – The DKIM authentication process failed. This can happen when Amazon Pinpoint fails to find the required CNAME records in the DNS configuration of the domain.

  • TEMPORARY_FAILURE – A temporary issue is preventing Amazon Pinpoint from determining the DKIM authentication status of the domain.

  • NOT_STARTED – The DKIM verification process hasn't been initiated for the domain. 

const (
	DkimStatusPending          DkimStatus = "PENDING"
	DkimStatusSuccess          DkimStatus = "SUCCESS"
	DkimStatusFailed           DkimStatus = "FAILED"
	DkimStatusTemporaryFailure DkimStatus = "TEMPORARY_FAILURE"
	DkimStatusNotStarted       DkimStatus = "NOT_STARTED"
)

Enum values for DkimStatus

func (DkimStatus) MarshalValue 

func (enum DkimStatus) MarshalValue() (string, error)

func (DkimStatus) MarshalValueBuf 

func (enum DkimStatus) MarshalValueBuf(b []byte) ([]byte, error)

type DomainDeliverabilityCampaign added in v0.9.0 

type DomainDeliverabilityCampaign 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 `type:"string"`

	// The percentage of email messages that were deleted by recipients, without
	// being opened first. Due to technical limitations, this value only includes
	// recipients who opened the message by using an email client that supports
	// images.
	DeleteRate *float64 `type:"double"`

	// The major email providers who handled the email message.
	Esps []string `type:"list"`

	// The first time, in Unix time format, when the email message was delivered
	// to any recipient's inbox. This value can help you determine how long it took
	// for a campaign to deliver an email message.
	FirstSeenDateTime *time.Time `type:"timestamp"`

	// The verified email address that the email message was sent from.
	FromAddress *string `type:"string"`

	// The URL of an image that contains a snapshot of the email message that was
	// sent.
	ImageUrl *string `type:"string"`

	// The number of email messages that were delivered to recipients’ inboxes.
	InboxCount *int64 `type:"long"`

	// The last time, in Unix time format, when the email message was delivered
	// to any recipient's inbox. This value can help you determine how long it took
	// for a campaign to deliver an email message.
	LastSeenDateTime *time.Time `type:"timestamp"`

	// The projected number of recipients that the email message was sent to.
	ProjectedVolume *int64 `type:"long"`

	// The percentage of email messages that were opened and then deleted by recipients.
	// Due to technical limitations, this value only includes recipients who opened
	// the message by using an email client that supports images.
	ReadDeleteRate *float64 `type:"double"`

	// The percentage of email messages that were opened by recipients. Due to technical
	// limitations, this value only includes recipients who opened the message by
	// using an email client that supports images.
	ReadRate *float64 `type:"double"`

	// The IP addresses that were used to send the email message.
	SendingIps []string `type:"list"`

	// The number of email messages that were delivered to recipients' spam or junk
	// mail folders.
	SpamCount *int64 `type:"long"`

	// The subject line, or title, of the email message.
	Subject *string `type:"string"`
	// contains filtered or unexported fields
}

An object that contains the deliverability data for a specific campaign. This data is available for a campaign only if the campaign sent email by using a domain that the Deliverability dashboard is enabled for (PutDeliverabilityDashboardOption operation).

func (DomainDeliverabilityCampaign) MarshalFields added in v0.9.0 

func (s DomainDeliverabilityCampaign) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DomainDeliverabilityCampaign) String added in v0.9.0 

func (s DomainDeliverabilityCampaign) String() string

String returns the string representation

type DomainDeliverabilityTrackingOption added in v0.9.0 

type DomainDeliverabilityTrackingOption struct {

	// A verified domain that’s associated with your AWS account and currently
	// has an active Deliverability dashboard subscription.
	Domain *string `type:"string"`

	// An object that contains information about the inbox placement data settings
	// for the domain.
	InboxPlacementTrackingOption *InboxPlacementTrackingOption `type:"structure"`

	// The date, in Unix time format, when you enabled the Deliverability dashboard
	// for the domain.
	SubscriptionStartDate *time.Time `type:"timestamp"`
	// contains filtered or unexported fields
}

An object that contains information about the Deliverability dashboard subscription for a verified domain that you use to send email and currently has an active Deliverability dashboard subscription. If a Deliverability dashboard subscription is active for a domain, you gain access to reputation, inbox placement, and other metrics for the domain.

func (DomainDeliverabilityTrackingOption) MarshalFields added in v0.9.0 

func (s DomainDeliverabilityTrackingOption) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DomainDeliverabilityTrackingOption) String added in v0.9.0 

func (s DomainDeliverabilityTrackingOption) String() string

String returns the string representation

type DomainIspPlacement added in v0.7.0 

type DomainIspPlacement struct {

	// The percentage of messages that were sent from the selected domain to the
	// specified email provider that arrived in recipients' inboxes.
	InboxPercentage *float64 `type:"double"`

	// The total number of messages that were sent from the selected domain to the
	// specified email provider that arrived in recipients' inboxes.
	InboxRawCount *int64 `type:"long"`

	// The name of the email provider that the inbox placement data applies to.
	IspName *string `type:"string"`

	// The percentage of messages that were sent from the selected domain to the
	// specified email provider that arrived in recipients' spam or junk mail folders.
	SpamPercentage *float64 `type:"double"`

	// The total number of messages that were sent from the selected domain to the
	// specified email provider that arrived in recipients' spam or junk mail folders.
	SpamRawCount *int64 `type:"long"`
	// contains filtered or unexported fields
}

An object that contains inbox placement data for email sent from one of your email domains to a specific email provider.

func (DomainIspPlacement) MarshalFields added in v0.7.0 

func (s DomainIspPlacement) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DomainIspPlacement) String added in v0.7.0 

func (s DomainIspPlacement) String() string

String returns the string representation

type EmailContent 

type EmailContent struct {

	// The raw email message. The message has to meet the following criteria:
	//
	//    * The message has to contain a header and a body, separated by one blank
	//    line.
	//
	//    * All of the required header fields must be present in the message.
	//
	//    * Each part of a multipart MIME message must be formatted properly.
	//
	//    * If you include attachments, they must be in a file format that Amazon
	//    Pinpoint supports.
	//
	//    * The entire message must be Base64 encoded.
	//
	//    * If any of the MIME parts in your message contain content that is outside
	//    of the 7-bit ASCII character range, you should encode that content to
	//    ensure that recipients' email clients render the message properly.
	//
	//    * The length of any single line of text in the message can't exceed 1,000
	//    characters. This restriction is defined in RFC 5321 (https://tools.ietf.org/html/rfc5321).
	Raw *RawMessage `type:"structure"`

	// The simple email message. The message consists of a subject and a message
	// body.
	Simple *Message `type:"structure"`

	// The template to use for the email message.
	Template *Template `type:"structure"`
	// contains filtered or unexported fields
}

An object that defines the entire content of the email, including the message headers and the body content. You can create a simple email message, in which you specify the subject and the text and HTML versions of the message body. You can also create raw messages, in which you specify a complete MIME-formatted message. Raw messages can include attachments and custom headers.

func (EmailContent) MarshalFields 

func (s EmailContent) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (EmailContent) String 

func (s EmailContent) String() string

String returns the string representation

func (*EmailContent) Validate 

func (s *EmailContent) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type EventDestination 

type EventDestination struct {

	// An object that defines an Amazon CloudWatch destination for email events.
	// You can use Amazon CloudWatch to monitor and gain insights on your email
	// sending metrics.
	CloudWatchDestination *CloudWatchDestination `type:"structure"`

	// If true, the event destination is enabled. When the event destination is
	// enabled, the specified event types are sent to the destinations in this EventDestinationDefinition.
	//
	// If false, the event destination is disabled. When the event destination is
	// disabled, events aren't sent to the specified destinations.
	Enabled *bool `type:"boolean"`

	// An object that defines an Amazon Kinesis Data Firehose destination for email
	// events. You can use Amazon Kinesis Data Firehose to stream data to other
	// services, such as Amazon S3 and Amazon Redshift.
	KinesisFirehoseDestination *KinesisFirehoseDestination `type:"structure"`

	// The types of events that Amazon Pinpoint sends to the specified event destinations.
	//
	// MatchingEventTypes is a required field
	MatchingEventTypes []EventType `type:"list" required:"true"`

	// A name that identifies the event destination.
	//
	// Name is a required field
	Name *string `type:"string" required:"true"`

	// An object that defines a Amazon Pinpoint destination for email events. You
	// can use Amazon Pinpoint events to create attributes in Amazon Pinpoint projects.
	// You can use these attributes to create segments for your campaigns.
	PinpointDestination *PinpointDestination `type:"structure"`

	// An object that defines an Amazon SNS destination for email events. You can
	// use Amazon SNS to send notification when certain email events occur.
	SnsDestination *SnsDestination `type:"structure"`
	// contains filtered or unexported fields
}

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 (EventDestination) MarshalFields 

func (s EventDestination) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (EventDestination) String 

func (s EventDestination) String() string

String returns the string representation

type EventDestinationDefinition 

type EventDestinationDefinition struct {

	// An object that defines an Amazon CloudWatch destination for email events.
	// You can use Amazon CloudWatch to monitor and gain insights on your email
	// sending metrics.
	CloudWatchDestination *CloudWatchDestination `type:"structure"`

	// If true, the event destination is enabled. When the event destination is
	// enabled, the specified event types are sent to the destinations in this EventDestinationDefinition.
	//
	// If false, the event destination is disabled. When the event destination is
	// disabled, events aren't sent to the specified destinations.
	Enabled *bool `type:"boolean"`

	// An object that defines an Amazon Kinesis Data Firehose destination for email
	// events. You can use Amazon Kinesis Data Firehose to stream data to other
	// services, such as Amazon S3 and Amazon Redshift.
	KinesisFirehoseDestination *KinesisFirehoseDestination `type:"structure"`

	// An array that specifies which events Amazon Pinpoint should send to the destinations
	// in this EventDestinationDefinition.
	MatchingEventTypes []EventType `type:"list"`

	// An object that defines a Amazon Pinpoint destination for email events. You
	// can use Amazon Pinpoint events to create attributes in Amazon Pinpoint projects.
	// You can use these attributes to create segments for your campaigns.
	PinpointDestination *PinpointDestination `type:"structure"`

	// An object that defines an Amazon SNS destination for email events. You can
	// use Amazon SNS to send notification when certain email events occur.
	SnsDestination *SnsDestination `type:"structure"`
	// contains filtered or unexported fields
}

An object that defines the event destination. Specifically, it defines which services receive events from emails sent using the configuration set that the event destination is associated with. Also defines the types of events that are sent to the event destination.

func (EventDestinationDefinition) MarshalFields 

func (s EventDestinationDefinition) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (EventDestinationDefinition) String 

func (s EventDestinationDefinition) String() string

String returns the string representation

func (*EventDestinationDefinition) Validate 

func (s *EventDestinationDefinition) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type EventType 

type EventType string

An email sending event type. For example, email sends, opens, and bounces are all email events. 

const (
	EventTypeSend             EventType = "SEND"
	EventTypeReject           EventType = "REJECT"
	EventTypeBounce           EventType = "BOUNCE"
	EventTypeComplaint        EventType = "COMPLAINT"
	EventTypeDelivery         EventType = "DELIVERY"
	EventTypeOpen             EventType = "OPEN"
	EventTypeClick            EventType = "CLICK"
	EventTypeRenderingFailure EventType = "RENDERING_FAILURE"
)

Enum values for EventType

func (EventType) MarshalValue 

func (enum EventType) MarshalValue() (string, error)

func (EventType) MarshalValueBuf 

func (enum EventType) MarshalValueBuf(b []byte) ([]byte, error)

type GetAccountInput 

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

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

func (GetAccountInput) MarshalFields 

func (s GetAccountInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetAccountInput) String 

func (s GetAccountInput) String() string

String returns the string representation

type GetAccountOutput 

type GetAccountOutput struct {

	// Indicates whether or not the automatic warm-up feature is enabled for dedicated
	// IP addresses that are associated with your account.
	DedicatedIpAutoWarmupEnabled *bool `type:"boolean"`

	// The reputation status of your Amazon Pinpoint account. The status can be
	// one of the following:
	//
	//    * HEALTHY – There are no reputation-related issues that currently impact
	//    your account.
	//
	//    * PROBATION – We've identified some issues with your Amazon Pinpoint
	//    account. We're placing your account under review while you work on correcting
	//    these issues.
	//
	//    * SHUTDOWN – Your account's ability to send email is currently paused
	//    because of an issue with the email sent from your account. When you correct
	//    the issue, you can contact us and request that your account's ability
	//    to send email is resumed.
	EnforcementStatus *string `type:"string"`

	// 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 `type:"boolean"`

	// An object that contains information about the per-day and per-second sending
	// limits for your Amazon Pinpoint account in the current AWS Region.
	SendQuota *SendQuota `type:"structure"`

	// Indicates whether or not email sending is enabled for your Amazon Pinpoint
	// account in the current AWS Region.
	SendingEnabled *bool `type:"boolean"`
	// contains filtered or unexported fields
}

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

func (GetAccountOutput) MarshalFields 

func (s GetAccountOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetAccountOutput) String 

func (s GetAccountOutput) String() string

String returns the string representation

type GetAccountRequest 

type GetAccountRequest struct {
	*aws.Request
	Input *GetAccountInput
	Copy  func(*GetAccountInput) GetAccountRequest
}

GetAccountRequest is the request type for the GetAccount API operation.

func (GetAccountRequest) Send 

func (r GetAccountRequest) Send(ctx context.Context) (*GetAccountResponse, error)

Send marshals and sends the GetAccount API request.

type GetAccountResponse added in v0.9.0 

type GetAccountResponse struct {
	*GetAccountOutput
	// contains filtered or unexported fields
}

GetAccountResponse is the response type for the GetAccount API operation.

func (*GetAccountResponse) SDKResponseMetdata added in v0.9.0 

func (r *GetAccountResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetAccount request.

type GetBlacklistReportsInput added in v0.7.0 

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 is a required field
	BlacklistItemNames []string `location:"querystring" locationName:"BlacklistItemNames" type:"list" required:"true"`
	// contains filtered or unexported fields
}

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

func (GetBlacklistReportsInput) MarshalFields added in v0.7.0 

func (s GetBlacklistReportsInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetBlacklistReportsInput) String added in v0.7.0 

func (s GetBlacklistReportsInput) String() string

String returns the string representation

func (*GetBlacklistReportsInput) Validate added in v0.7.0 

func (s *GetBlacklistReportsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetBlacklistReportsOutput added in v0.7.0 

type GetBlacklistReportsOutput struct {

	// An object that contains information about a blacklist that one of your dedicated
	// IP addresses appears on.
	//
	// BlacklistReport is a required field
	BlacklistReport map[string][]BlacklistEntry `type:"map" required:"true"`
	// contains filtered or unexported fields
}

An object that contains information about blacklist events.

func (GetBlacklistReportsOutput) MarshalFields added in v0.7.0 

func (s GetBlacklistReportsOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetBlacklistReportsOutput) String added in v0.7.0 

func (s GetBlacklistReportsOutput) String() string

String returns the string representation

type GetBlacklistReportsRequest added in v0.7.0 

type GetBlacklistReportsRequest struct {
	*aws.Request
	Input *GetBlacklistReportsInput
	Copy  func(*GetBlacklistReportsInput) GetBlacklistReportsRequest
}

GetBlacklistReportsRequest is the request type for the GetBlacklistReports API operation.

func (GetBlacklistReportsRequest) Send added in v0.7.0 

func (r GetBlacklistReportsRequest) Send(ctx context.Context) (*GetBlacklistReportsResponse, error)

Send marshals and sends the GetBlacklistReports API request.

type GetBlacklistReportsResponse added in v0.9.0 

type GetBlacklistReportsResponse struct {
	*GetBlacklistReportsOutput
	// contains filtered or unexported fields
}

GetBlacklistReportsResponse is the response type for the GetBlacklistReports API operation.

func (*GetBlacklistReportsResponse) SDKResponseMetdata added in v0.9.0 

func (r *GetBlacklistReportsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetBlacklistReports request.

type GetConfigurationSetEventDestinationsInput 

type GetConfigurationSetEventDestinationsInput struct {

	// The name of the configuration set that contains the event destination.
	//
	// ConfigurationSetName is a required field
	ConfigurationSetName *string `location:"uri" locationName:"ConfigurationSetName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

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

func (GetConfigurationSetEventDestinationsInput) MarshalFields 

func (s GetConfigurationSetEventDestinationsInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetConfigurationSetEventDestinationsInput) String 

func (s GetConfigurationSetEventDestinationsInput) String() string

String returns the string representation

func (*GetConfigurationSetEventDestinationsInput) Validate 

func (s *GetConfigurationSetEventDestinationsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetConfigurationSetEventDestinationsOutput 

type GetConfigurationSetEventDestinationsOutput struct {

	// An array that includes all of the events destinations that have been configured
	// for the configuration set.
	EventDestinations []EventDestination `type:"list"`
	// contains filtered or unexported fields
}

Information about an event destination for a configuration set.

func (GetConfigurationSetEventDestinationsOutput) MarshalFields 

func (s GetConfigurationSetEventDestinationsOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetConfigurationSetEventDestinationsOutput) String 

func (s GetConfigurationSetEventDestinationsOutput) String() string

String returns the string representation

type GetConfigurationSetEventDestinationsRequest 

type GetConfigurationSetEventDestinationsRequest struct {
	*aws.Request
	Input *GetConfigurationSetEventDestinationsInput
	Copy  func(*GetConfigurationSetEventDestinationsInput) GetConfigurationSetEventDestinationsRequest
}

GetConfigurationSetEventDestinationsRequest is the request type for the GetConfigurationSetEventDestinations API operation.

func (GetConfigurationSetEventDestinationsRequest) Send 

func (r GetConfigurationSetEventDestinationsRequest) Send(ctx context.Context) (*GetConfigurationSetEventDestinationsResponse, error)

Send marshals and sends the GetConfigurationSetEventDestinations API request.

type GetConfigurationSetEventDestinationsResponse added in v0.9.0 

type GetConfigurationSetEventDestinationsResponse struct {
	*GetConfigurationSetEventDestinationsOutput
	// contains filtered or unexported fields
}

GetConfigurationSetEventDestinationsResponse is the response type for the GetConfigurationSetEventDestinations API operation.

func (*GetConfigurationSetEventDestinationsResponse) SDKResponseMetdata added in v0.9.0 

func (r *GetConfigurationSetEventDestinationsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetConfigurationSetEventDestinations request.

type GetConfigurationSetInput 

type GetConfigurationSetInput struct {

	// The name of the configuration set that you want to obtain more information
	// about.
	//
	// ConfigurationSetName is a required field
	ConfigurationSetName *string `location:"uri" locationName:"ConfigurationSetName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

A request to obtain information about a configuration set.

func (GetConfigurationSetInput) MarshalFields 

func (s GetConfigurationSetInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetConfigurationSetInput) String 

func (s GetConfigurationSetInput) String() string

String returns the string representation

func (*GetConfigurationSetInput) Validate 

func (s *GetConfigurationSetInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetConfigurationSetOutput 

type GetConfigurationSetOutput struct {

	// The name of the configuration set.
	ConfigurationSetName *string `type:"string"`

	// An object that defines the dedicated IP pool that is used to send emails
	// that you send using the configuration set.
	DeliveryOptions *DeliveryOptions `type:"structure"`

	// An object that defines whether or not Amazon Pinpoint collects reputation
	// metrics for the emails that you send that use the configuration set.
	ReputationOptions *ReputationOptions `type:"structure"`

	// An object that defines whether or not Amazon Pinpoint can send email that
	// you send using the configuration set.
	SendingOptions *SendingOptions `type:"structure"`

	// An array of objects that define the tags (keys and values) that are associated
	// with the configuration set.
	Tags []Tag `type:"list"`

	// An object that defines the open and click tracking options for emails that
	// you send using the configuration set.
	TrackingOptions *TrackingOptions `type:"structure"`
	// contains filtered or unexported fields
}

Information about a configuration set.

func (GetConfigurationSetOutput) MarshalFields 

func (s GetConfigurationSetOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetConfigurationSetOutput) String 

func (s GetConfigurationSetOutput) String() string

String returns the string representation

type GetConfigurationSetRequest 

type GetConfigurationSetRequest struct {
	*aws.Request
	Input *GetConfigurationSetInput
	Copy  func(*GetConfigurationSetInput) GetConfigurationSetRequest
}

GetConfigurationSetRequest is the request type for the GetConfigurationSet API operation.

func (GetConfigurationSetRequest) Send 

func (r GetConfigurationSetRequest) Send(ctx context.Context) (*GetConfigurationSetResponse, error)

Send marshals and sends the GetConfigurationSet API request.

type GetConfigurationSetResponse added in v0.9.0 

type GetConfigurationSetResponse struct {
	*GetConfigurationSetOutput
	// contains filtered or unexported fields
}

GetConfigurationSetResponse is the response type for the GetConfigurationSet API operation.

func (*GetConfigurationSetResponse) SDKResponseMetdata added in v0.9.0 

func (r *GetConfigurationSetResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetConfigurationSet request.

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 is a required field
	Ip *string `location:"uri" locationName:"IP" type:"string" required:"true"`
	// contains filtered or unexported fields
}

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

func (GetDedicatedIpInput) MarshalFields 

func (s GetDedicatedIpInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetDedicatedIpInput) String 

func (s GetDedicatedIpInput) String() string

String returns the string representation

func (*GetDedicatedIpInput) Validate 

func (s *GetDedicatedIpInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetDedicatedIpOutput 

type GetDedicatedIpOutput struct {

	// An object that contains information about a dedicated IP address.
	DedicatedIp *DedicatedIp `type:"structure"`
	// contains filtered or unexported fields
}

Information about a dedicated IP address.

func (GetDedicatedIpOutput) MarshalFields 

func (s GetDedicatedIpOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetDedicatedIpOutput) String 

func (s GetDedicatedIpOutput) String() string

String returns the string representation

type GetDedicatedIpRequest 

type GetDedicatedIpRequest struct {
	*aws.Request
	Input *GetDedicatedIpInput
	Copy  func(*GetDedicatedIpInput) GetDedicatedIpRequest
}

GetDedicatedIpRequest is the request type for the GetDedicatedIp API operation.

func (GetDedicatedIpRequest) Send 

func (r GetDedicatedIpRequest) Send(ctx context.Context) (*GetDedicatedIpResponse, error)

Send marshals and sends the GetDedicatedIp API request.

type GetDedicatedIpResponse added in v0.9.0 

type GetDedicatedIpResponse struct {
	*GetDedicatedIpOutput
	// contains filtered or unexported fields
}

GetDedicatedIpResponse is the response type for the GetDedicatedIp API operation.

func (*GetDedicatedIpResponse) SDKResponseMetdata added in v0.9.0 

func (r *GetDedicatedIpResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetDedicatedIp request.

type GetDedicatedIpsInput 

type GetDedicatedIpsInput struct {

	// 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 `location:"querystring" locationName:"NextToken" type:"string"`

	// 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 *int64 `location:"querystring" locationName:"PageSize" type:"integer"`

	// The name of the IP pool that the dedicated IP address is associated with.
	PoolName *string `location:"querystring" locationName:"PoolName" type:"string"`
	// contains filtered or unexported fields
}

A request to obtain more information about dedicated IP pools.

func (GetDedicatedIpsInput) MarshalFields 

func (s GetDedicatedIpsInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetDedicatedIpsInput) String 

func (s GetDedicatedIpsInput) String() string

String returns the string representation

type GetDedicatedIpsOutput 

type GetDedicatedIpsOutput struct {

	// A list of dedicated IP addresses that are reserved for use by your Amazon
	// Pinpoint account.
	DedicatedIps []DedicatedIp `type:"list"`

	// 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 `type:"string"`
	// contains filtered or unexported fields
}

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

func (GetDedicatedIpsOutput) MarshalFields 

func (s GetDedicatedIpsOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetDedicatedIpsOutput) String 

func (s GetDedicatedIpsOutput) String() string

String returns the string representation

type GetDedicatedIpsPaginator added in v0.9.0 

type GetDedicatedIpsPaginator struct {
	aws.Pager
}

GetDedicatedIpsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewGetDedicatedIpsPaginator added in v0.9.0 

func NewGetDedicatedIpsPaginator(req GetDedicatedIpsRequest) GetDedicatedIpsPaginator

NewGetDedicatedIpsRequestPaginator returns a paginator for GetDedicatedIps. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service. 

// Example iterating over pages.
req := client.GetDedicatedIpsRequest(input)
p := pinpointemail.NewGetDedicatedIpsRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*GetDedicatedIpsPaginator) CurrentPage added in v0.9.0 

func (p *GetDedicatedIpsPaginator) CurrentPage() *GetDedicatedIpsOutput

type GetDedicatedIpsRequest 

type GetDedicatedIpsRequest struct {
	*aws.Request
	Input *GetDedicatedIpsInput
	Copy  func(*GetDedicatedIpsInput) GetDedicatedIpsRequest
}

GetDedicatedIpsRequest is the request type for the GetDedicatedIps API operation.

func (GetDedicatedIpsRequest) Send 

func (r GetDedicatedIpsRequest) Send(ctx context.Context) (*GetDedicatedIpsResponse, error)

Send marshals and sends the GetDedicatedIps API request.

type GetDedicatedIpsResponse added in v0.9.0 

type GetDedicatedIpsResponse struct {
	*GetDedicatedIpsOutput
	// contains filtered or unexported fields
}

GetDedicatedIpsResponse is the response type for the GetDedicatedIps API operation.

func (*GetDedicatedIpsResponse) SDKResponseMetdata added in v0.9.0 

func (r *GetDedicatedIpsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetDedicatedIps request.

type GetDeliverabilityDashboardOptionsInput added in v0.7.0 

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

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 (GetDeliverabilityDashboardOptionsInput) MarshalFields added in v0.7.0 

func (s GetDeliverabilityDashboardOptionsInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetDeliverabilityDashboardOptionsInput) String added in v0.7.0 

func (s GetDeliverabilityDashboardOptionsInput) String() string

String returns the string representation

type GetDeliverabilityDashboardOptionsOutput added in v0.7.0 

type GetDeliverabilityDashboardOptionsOutput struct {

	// 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 DeliverabilityDashboardAccountStatus `type:"string" enum:"true"`

	// 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 []DomainDeliverabilityTrackingOption `type:"list"`

	// Specifies whether the Deliverability dashboard is enabled for your Amazon
	// Pinpoint account. If this value is true, the dashboard is enabled.
	//
	// DashboardEnabled is a required field
	DashboardEnabled *bool `type:"boolean" required:"true"`

	// 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 []DomainDeliverabilityTrackingOption `type:"list"`

	// 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 `type:"timestamp"`
	// contains filtered or unexported fields
}

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

func (GetDeliverabilityDashboardOptionsOutput) MarshalFields added in v0.7.0 

func (s GetDeliverabilityDashboardOptionsOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetDeliverabilityDashboardOptionsOutput) String added in v0.7.0 

func (s GetDeliverabilityDashboardOptionsOutput) String() string

String returns the string representation

type GetDeliverabilityDashboardOptionsRequest added in v0.7.0 

type GetDeliverabilityDashboardOptionsRequest struct {
	*aws.Request
	Input *GetDeliverabilityDashboardOptionsInput
	Copy  func(*GetDeliverabilityDashboardOptionsInput) GetDeliverabilityDashboardOptionsRequest
}

GetDeliverabilityDashboardOptionsRequest is the request type for the GetDeliverabilityDashboardOptions API operation.

func (GetDeliverabilityDashboardOptionsRequest) Send added in v0.7.0 

func (r GetDeliverabilityDashboardOptionsRequest) Send(ctx context.Context) (*GetDeliverabilityDashboardOptionsResponse, error)

Send marshals and sends the GetDeliverabilityDashboardOptions API request.

type GetDeliverabilityDashboardOptionsResponse added in v0.9.0 

type GetDeliverabilityDashboardOptionsResponse struct {
	*GetDeliverabilityDashboardOptionsOutput
	// contains filtered or unexported fields
}

GetDeliverabilityDashboardOptionsResponse is the response type for the GetDeliverabilityDashboardOptions API operation.

func (*GetDeliverabilityDashboardOptionsResponse) SDKResponseMetdata added in v0.9.0 

func (r *GetDeliverabilityDashboardOptionsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetDeliverabilityDashboardOptions request.

type GetDeliverabilityTestReportInput added in v0.7.0 

type GetDeliverabilityTestReportInput struct {

	// A unique string that identifies the predictive inbox placement test.
	//
	// ReportId is a required field
	ReportId *string `location:"uri" locationName:"ReportId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

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

func (GetDeliverabilityTestReportInput) MarshalFields added in v0.7.0 

func (s GetDeliverabilityTestReportInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetDeliverabilityTestReportInput) String added in v0.7.0 

func (s GetDeliverabilityTestReportInput) String() string

String returns the string representation

func (*GetDeliverabilityTestReportInput) Validate added in v0.7.0 

func (s *GetDeliverabilityTestReportInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetDeliverabilityTestReportOutput added in v0.7.0 

type GetDeliverabilityTestReportOutput struct {

	// An object that contains the results of the predictive inbox placement test.
	//
	// DeliverabilityTestReport is a required field
	DeliverabilityTestReport *DeliverabilityTestReport `type:"structure" required:"true"`

	// An object that describes how the test email was handled by several email
	// providers, including Gmail, Hotmail, Yahoo, AOL, and others.
	//
	// IspPlacements is a required field
	IspPlacements []IspPlacement `type:"list" required:"true"`

	// An object that contains the message that you sent when you performed this
	// predictive inbox placement test.
	Message *string `type:"string"`

	// An object that specifies how many test messages that were sent during the
	// predictive inbox placement test were delivered to recipients' inboxes, how
	// many were sent to recipients' spam folders, and how many weren't delivered.
	//
	// OverallPlacement is a required field
	OverallPlacement *PlacementStatistics `type:"structure" required:"true"`

	// An array of objects that define the tags (keys and values) that are associated
	// with the predictive inbox placement test.
	Tags []Tag `type:"list"`
	// contains filtered or unexported fields
}

The results of the predictive inbox placement test.

func (GetDeliverabilityTestReportOutput) MarshalFields added in v0.7.0 

func (s GetDeliverabilityTestReportOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetDeliverabilityTestReportOutput) String added in v0.7.0 

func (s GetDeliverabilityTestReportOutput) String() string

String returns the string representation

type GetDeliverabilityTestReportRequest added in v0.7.0 

type GetDeliverabilityTestReportRequest struct {
	*aws.Request
	Input *GetDeliverabilityTestReportInput
	Copy  func(*GetDeliverabilityTestReportInput) GetDeliverabilityTestReportRequest
}

GetDeliverabilityTestReportRequest is the request type for the GetDeliverabilityTestReport API operation.

func (GetDeliverabilityTestReportRequest) Send added in v0.7.0 

func (r GetDeliverabilityTestReportRequest) Send(ctx context.Context) (*GetDeliverabilityTestReportResponse, error)

Send marshals and sends the GetDeliverabilityTestReport API request.

type GetDeliverabilityTestReportResponse added in v0.9.0 

type GetDeliverabilityTestReportResponse struct {
	*GetDeliverabilityTestReportOutput
	// contains filtered or unexported fields
}

GetDeliverabilityTestReportResponse is the response type for the GetDeliverabilityTestReport API operation.

func (*GetDeliverabilityTestReportResponse) SDKResponseMetdata added in v0.9.0 

func (r *GetDeliverabilityTestReportResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetDeliverabilityTestReport request.

type GetDomainDeliverabilityCampaignInput added in v0.9.0 

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 is a required field
	CampaignId *string `location:"uri" locationName:"CampaignId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

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 (GetDomainDeliverabilityCampaignInput) MarshalFields added in v0.9.0 

func (s GetDomainDeliverabilityCampaignInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetDomainDeliverabilityCampaignInput) String added in v0.9.0 

func (s GetDomainDeliverabilityCampaignInput) String() string

String returns the string representation

func (*GetDomainDeliverabilityCampaignInput) Validate added in v0.9.0 

func (s *GetDomainDeliverabilityCampaignInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetDomainDeliverabilityCampaignOutput added in v0.9.0 

type GetDomainDeliverabilityCampaignOutput struct {

	// An object that contains the deliverability data for the campaign.
	//
	// DomainDeliverabilityCampaign is a required field
	DomainDeliverabilityCampaign *DomainDeliverabilityCampaign `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

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

func (GetDomainDeliverabilityCampaignOutput) MarshalFields added in v0.9.0 

func (s GetDomainDeliverabilityCampaignOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetDomainDeliverabilityCampaignOutput) String added in v0.9.0 

func (s GetDomainDeliverabilityCampaignOutput) String() string

String returns the string representation

type GetDomainDeliverabilityCampaignRequest added in v0.9.0 

type GetDomainDeliverabilityCampaignRequest struct {
	*aws.Request
	Input *GetDomainDeliverabilityCampaignInput
	Copy  func(*GetDomainDeliverabilityCampaignInput) GetDomainDeliverabilityCampaignRequest
}

GetDomainDeliverabilityCampaignRequest is the request type for the GetDomainDeliverabilityCampaign API operation.

func (GetDomainDeliverabilityCampaignRequest) Send added in v0.9.0 

func (r GetDomainDeliverabilityCampaignRequest) Send(ctx context.Context) (*GetDomainDeliverabilityCampaignResponse, error)

Send marshals and sends the GetDomainDeliverabilityCampaign API request.

type GetDomainDeliverabilityCampaignResponse added in v0.9.0 

type GetDomainDeliverabilityCampaignResponse struct {
	*GetDomainDeliverabilityCampaignOutput
	// contains filtered or unexported fields
}

GetDomainDeliverabilityCampaignResponse is the response type for the GetDomainDeliverabilityCampaign API operation.

func (*GetDomainDeliverabilityCampaignResponse) SDKResponseMetdata added in v0.9.0 

func (r *GetDomainDeliverabilityCampaignResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetDomainDeliverabilityCampaign request.

type GetDomainStatisticsReportInput added in v0.7.0 

type GetDomainStatisticsReportInput struct {

	// The domain that you want to obtain deliverability metrics for.
	//
	// Domain is a required field
	Domain *string `location:"uri" locationName:"Domain" type:"string" required:"true"`

	// 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 is a required field
	EndDate *time.Time `location:"querystring" locationName:"EndDate" type:"timestamp" required:"true"`

	// The first day (in Unix time) that you want to obtain domain deliverability
	// metrics for.
	//
	// StartDate is a required field
	StartDate *time.Time `location:"querystring" locationName:"StartDate" type:"timestamp" required:"true"`
	// contains filtered or unexported fields
}

A request to obtain deliverability metrics for a domain.

func (GetDomainStatisticsReportInput) MarshalFields added in v0.7.0 

func (s GetDomainStatisticsReportInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetDomainStatisticsReportInput) String added in v0.7.0 

func (s GetDomainStatisticsReportInput) String() string

String returns the string representation

func (*GetDomainStatisticsReportInput) Validate added in v0.7.0 

func (s *GetDomainStatisticsReportInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetDomainStatisticsReportOutput added in v0.7.0 

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 is a required field
	DailyVolumes []DailyVolume `type:"list" required:"true"`

	// 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 is a required field
	OverallVolume *OverallVolume `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

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

func (GetDomainStatisticsReportOutput) MarshalFields added in v0.7.0 

func (s GetDomainStatisticsReportOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetDomainStatisticsReportOutput) String added in v0.7.0 

func (s GetDomainStatisticsReportOutput) String() string

String returns the string representation

type GetDomainStatisticsReportRequest added in v0.7.0 

type GetDomainStatisticsReportRequest struct {
	*aws.Request
	Input *GetDomainStatisticsReportInput
	Copy  func(*GetDomainStatisticsReportInput) GetDomainStatisticsReportRequest
}

GetDomainStatisticsReportRequest is the request type for the GetDomainStatisticsReport API operation.

func (GetDomainStatisticsReportRequest) Send added in v0.7.0 

func (r GetDomainStatisticsReportRequest) Send(ctx context.Context) (*GetDomainStatisticsReportResponse, error)

Send marshals and sends the GetDomainStatisticsReport API request.

type GetDomainStatisticsReportResponse added in v0.9.0 

type GetDomainStatisticsReportResponse struct {
	*GetDomainStatisticsReportOutput
	// contains filtered or unexported fields
}

GetDomainStatisticsReportResponse is the response type for the GetDomainStatisticsReport API operation.

func (*GetDomainStatisticsReportResponse) SDKResponseMetdata added in v0.9.0 

func (r *GetDomainStatisticsReportResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetDomainStatisticsReport request.

type GetEmailIdentityInput 

type GetEmailIdentityInput struct {

	// The email identity that you want to retrieve details for.
	//
	// EmailIdentity is a required field
	EmailIdentity *string `location:"uri" locationName:"EmailIdentity" type:"string" required:"true"`
	// contains filtered or unexported fields
}

A request to return details about an email identity.

func (GetEmailIdentityInput) MarshalFields 

func (s GetEmailIdentityInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetEmailIdentityInput) String 

func (s GetEmailIdentityInput) String() string

String returns the string representation

func (*GetEmailIdentityInput) Validate 

func (s *GetEmailIdentityInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetEmailIdentityOutput 

type GetEmailIdentityOutput struct {

	// An object that contains information about the DKIM attributes for the identity.
	// This object includes the tokens that you use to create the CNAME records
	// that are required to complete the DKIM verification process.
	DkimAttributes *DkimAttributes `type:"structure"`

	// 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 `type:"boolean"`

	// The email identity type.
	IdentityType IdentityType `type:"string" enum:"true"`

	// An object that contains information about the Mail-From attributes for the
	// email identity.
	MailFromAttributes *MailFromAttributes `type:"structure"`

	// An array of objects that define the tags (keys and values) that are associated
	// with the email identity.
	Tags []Tag `type:"list"`

	// 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 `type:"boolean"`
	// contains filtered or unexported fields
}

Details about an email identity.

func (GetEmailIdentityOutput) MarshalFields 

func (s GetEmailIdentityOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetEmailIdentityOutput) String 

func (s GetEmailIdentityOutput) String() string

String returns the string representation

type GetEmailIdentityRequest 

type GetEmailIdentityRequest struct {
	*aws.Request
	Input *GetEmailIdentityInput
	Copy  func(*GetEmailIdentityInput) GetEmailIdentityRequest
}

GetEmailIdentityRequest is the request type for the GetEmailIdentity API operation.

func (GetEmailIdentityRequest) Send 

func (r GetEmailIdentityRequest) Send(ctx context.Context) (*GetEmailIdentityResponse, error)

Send marshals and sends the GetEmailIdentity API request.

type GetEmailIdentityResponse added in v0.9.0 

type GetEmailIdentityResponse struct {
	*GetEmailIdentityOutput
	// contains filtered or unexported fields
}

GetEmailIdentityResponse is the response type for the GetEmailIdentity API operation.

func (*GetEmailIdentityResponse) SDKResponseMetdata added in v0.9.0 

func (r *GetEmailIdentityResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetEmailIdentity request.

type IdentityInfo 

type IdentityInfo struct {

	// The address or domain of the identity.
	IdentityName *string `type:"string"`

	// The email identity type. The identity type can be one of the following:
	//
	//    * EMAIL_ADDRESS – The identity is an email address.
	//
	//    * DOMAIN – The identity is a domain.
	//
	//    * MANAGED_DOMAIN – The identity is a domain that is managed by AWS.
	IdentityType IdentityType `type:"string" enum:"true"`

	// Indicates whether or not you can send email from the identity.
	//
	// In Amazon Pinpoint, an identity is an email address or domain that you send
	// email from. Before you can send email from an identity, you have to demostrate
	// that you own the identity, and that you authorize Amazon Pinpoint to send
	// email from that identity.
	SendingEnabled *bool `type:"boolean"`
	// contains filtered or unexported fields
}

Information about an email identity.

func (IdentityInfo) MarshalFields 

func (s IdentityInfo) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (IdentityInfo) String 

func (s IdentityInfo) String() string

String returns the string representation

type IdentityType 

type IdentityType string

The email identity type. The identity type can be one of the following:

  • EMAIL_ADDRESS – The identity is an email address.

  • DOMAIN – The identity is a domain. 

const (
	IdentityTypeEmailAddress  IdentityType = "EMAIL_ADDRESS"
	IdentityTypeDomain        IdentityType = "DOMAIN"
	IdentityTypeManagedDomain IdentityType = "MANAGED_DOMAIN"
)

Enum values for IdentityType

func (IdentityType) MarshalValue 

func (enum IdentityType) MarshalValue() (string, error)

func (IdentityType) MarshalValueBuf 

func (enum IdentityType) MarshalValueBuf(b []byte) ([]byte, error)

type InboxPlacementTrackingOption added in v0.9.0 

type InboxPlacementTrackingOption struct {

	// Specifies whether inbox placement data is being tracked for the domain.
	Global *bool `type:"boolean"`

	// An array of strings, one for each major email provider that the inbox placement
	// data applies to.
	TrackedIsps []string `type:"list"`
	// contains filtered or unexported fields
}

An object that contains information about the inbox placement data settings for a verified domain that’s associated with your AWS account. This data is available only if you enabled the Deliverability dashboard for the domain (PutDeliverabilityDashboardOption operation).

func (InboxPlacementTrackingOption) MarshalFields added in v0.9.0 

func (s InboxPlacementTrackingOption) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (InboxPlacementTrackingOption) String added in v0.9.0 

func (s InboxPlacementTrackingOption) String() string

String returns the string representation

type IspPlacement added in v0.7.0 

type IspPlacement struct {

	// The name of the email provider that the inbox placement data applies to.
	IspName *string `type:"string"`

	// An object that contains inbox placement metrics for a specific email provider.
	PlacementStatistics *PlacementStatistics `type:"structure"`
	// contains filtered or unexported fields
}

An object that describes how email sent during the predictive inbox placement test was handled by a certain email provider.

func (IspPlacement) MarshalFields added in v0.7.0 

func (s IspPlacement) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (IspPlacement) String added in v0.7.0 

func (s IspPlacement) String() string

String returns the string representation

type KinesisFirehoseDestination 

type KinesisFirehoseDestination struct {

	// The Amazon Resource Name (ARN) of the Amazon Kinesis Data Firehose stream
	// that Amazon Pinpoint sends email events to.
	//
	// DeliveryStreamArn is a required field
	DeliveryStreamArn *string `type:"string" required:"true"`

	// The Amazon Resource Name (ARN) of the IAM role that Amazon Pinpoint uses
	// when sending email events to the Amazon Kinesis Data Firehose stream.
	//
	// IamRoleArn is a required field
	IamRoleArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

An object that defines an Amazon Kinesis Data Firehose destination for email events. You can use Amazon Kinesis Data Firehose to stream data to other services, such as Amazon S3 and Amazon Redshift.

func (KinesisFirehoseDestination) MarshalFields 

func (s KinesisFirehoseDestination) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (KinesisFirehoseDestination) String 

func (s KinesisFirehoseDestination) String() string

String returns the string representation

func (*KinesisFirehoseDestination) Validate 

func (s *KinesisFirehoseDestination) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListConfigurationSetsInput 

type ListConfigurationSetsInput struct {

	// A token returned from a previous call to ListConfigurationSets to indicate
	// the position in the list of configuration sets.
	NextToken *string `location:"querystring" locationName:"NextToken" type:"string"`

	// 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 *int64 `location:"querystring" locationName:"PageSize" type:"integer"`
	// contains filtered or unexported fields
}

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

func (ListConfigurationSetsInput) MarshalFields 

func (s ListConfigurationSetsInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListConfigurationSetsInput) String 

func (s ListConfigurationSetsInput) String() string

String returns the string representation

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 `type:"list"`

	// 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 `type:"string"`
	// contains filtered or unexported fields
}

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

func (ListConfigurationSetsOutput) MarshalFields 

func (s ListConfigurationSetsOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListConfigurationSetsOutput) String 

func (s ListConfigurationSetsOutput) String() string

String returns the string representation

type ListConfigurationSetsPaginator added in v0.9.0 

type ListConfigurationSetsPaginator struct {
	aws.Pager
}

ListConfigurationSetsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewListConfigurationSetsPaginator added in v0.9.0 

func NewListConfigurationSetsPaginator(req ListConfigurationSetsRequest) ListConfigurationSetsPaginator

NewListConfigurationSetsRequestPaginator returns a paginator for ListConfigurationSets. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service. 

// Example iterating over pages.
req := client.ListConfigurationSetsRequest(input)
p := pinpointemail.NewListConfigurationSetsRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*ListConfigurationSetsPaginator) CurrentPage added in v0.9.0 

func (p *ListConfigurationSetsPaginator) CurrentPage() *ListConfigurationSetsOutput

type ListConfigurationSetsRequest 

type ListConfigurationSetsRequest struct {
	*aws.Request
	Input *ListConfigurationSetsInput
	Copy  func(*ListConfigurationSetsInput) ListConfigurationSetsRequest
}

ListConfigurationSetsRequest is the request type for the ListConfigurationSets API operation.

func (ListConfigurationSetsRequest) Send 

func (r ListConfigurationSetsRequest) Send(ctx context.Context) (*ListConfigurationSetsResponse, error)

Send marshals and sends the ListConfigurationSets API request.

type ListConfigurationSetsResponse added in v0.9.0 

type ListConfigurationSetsResponse struct {
	*ListConfigurationSetsOutput
	// contains filtered or unexported fields
}

ListConfigurationSetsResponse is the response type for the ListConfigurationSets API operation.

func (*ListConfigurationSetsResponse) SDKResponseMetdata added in v0.9.0 

func (r *ListConfigurationSetsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListConfigurationSets request.

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 `location:"querystring" locationName:"NextToken" type:"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 *int64 `location:"querystring" locationName:"PageSize" type:"integer"`
	// contains filtered or unexported fields
}

A request to obtain a list of dedicated IP pools.

func (ListDedicatedIpPoolsInput) MarshalFields 

func (s ListDedicatedIpPoolsInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListDedicatedIpPoolsInput) String 

func (s ListDedicatedIpPoolsInput) String() string

String returns the string representation

type ListDedicatedIpPoolsOutput 

type ListDedicatedIpPoolsOutput struct {

	// A list of all of the dedicated IP pools that are associated with your Amazon
	// Pinpoint account.
	DedicatedIpPools []string `type:"list"`

	// 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 `type:"string"`
	// contains filtered or unexported fields
}

A list of dedicated IP pools.

func (ListDedicatedIpPoolsOutput) MarshalFields 

func (s ListDedicatedIpPoolsOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListDedicatedIpPoolsOutput) String 

func (s ListDedicatedIpPoolsOutput) String() string

String returns the string representation

type ListDedicatedIpPoolsPaginator added in v0.9.0 

type ListDedicatedIpPoolsPaginator struct {
	aws.Pager
}

ListDedicatedIpPoolsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewListDedicatedIpPoolsPaginator added in v0.9.0 

func NewListDedicatedIpPoolsPaginator(req ListDedicatedIpPoolsRequest) ListDedicatedIpPoolsPaginator

NewListDedicatedIpPoolsRequestPaginator returns a paginator for ListDedicatedIpPools. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service. 

// Example iterating over pages.
req := client.ListDedicatedIpPoolsRequest(input)
p := pinpointemail.NewListDedicatedIpPoolsRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*ListDedicatedIpPoolsPaginator) CurrentPage added in v0.9.0 

func (p *ListDedicatedIpPoolsPaginator) CurrentPage() *ListDedicatedIpPoolsOutput

type ListDedicatedIpPoolsRequest 

type ListDedicatedIpPoolsRequest struct {
	*aws.Request
	Input *ListDedicatedIpPoolsInput
	Copy  func(*ListDedicatedIpPoolsInput) ListDedicatedIpPoolsRequest
}

ListDedicatedIpPoolsRequest is the request type for the ListDedicatedIpPools API operation.

func (ListDedicatedIpPoolsRequest) Send 

func (r ListDedicatedIpPoolsRequest) Send(ctx context.Context) (*ListDedicatedIpPoolsResponse, error)

Send marshals and sends the ListDedicatedIpPools API request.

type ListDedicatedIpPoolsResponse added in v0.9.0 

type ListDedicatedIpPoolsResponse struct {
	*ListDedicatedIpPoolsOutput
	// contains filtered or unexported fields
}

ListDedicatedIpPoolsResponse is the response type for the ListDedicatedIpPools API operation.

func (*ListDedicatedIpPoolsResponse) SDKResponseMetdata added in v0.9.0 

func (r *ListDedicatedIpPoolsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListDedicatedIpPools request.

type ListDeliverabilityTestReportsInput added in v0.7.0 

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 `location:"querystring" locationName:"NextToken" type:"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 *int64 `location:"querystring" locationName:"PageSize" type:"integer"`
	// contains filtered or unexported fields
}

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

func (ListDeliverabilityTestReportsInput) MarshalFields added in v0.7.0 

func (s ListDeliverabilityTestReportsInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListDeliverabilityTestReportsInput) String added in v0.7.0 

func (s ListDeliverabilityTestReportsInput) String() string

String returns the string representation

type ListDeliverabilityTestReportsOutput added in v0.7.0 

type ListDeliverabilityTestReportsOutput struct {

	// An object that contains a lists of predictive inbox placement tests that
	// you've performed.
	//
	// DeliverabilityTestReports is a required field
	DeliverabilityTestReports []DeliverabilityTestReport `type:"list" required:"true"`

	// 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 `type:"string"`
	// contains filtered or unexported fields
}

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

func (ListDeliverabilityTestReportsOutput) MarshalFields added in v0.7.0 

func (s ListDeliverabilityTestReportsOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListDeliverabilityTestReportsOutput) String added in v0.7.0 

func (s ListDeliverabilityTestReportsOutput) String() string

String returns the string representation

type ListDeliverabilityTestReportsPaginator added in v0.9.0 

type ListDeliverabilityTestReportsPaginator struct {
	aws.Pager
}

ListDeliverabilityTestReportsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewListDeliverabilityTestReportsPaginator added in v0.9.0 

func NewListDeliverabilityTestReportsPaginator(req ListDeliverabilityTestReportsRequest) ListDeliverabilityTestReportsPaginator

NewListDeliverabilityTestReportsRequestPaginator returns a paginator for ListDeliverabilityTestReports. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service. 

// Example iterating over pages.
req := client.ListDeliverabilityTestReportsRequest(input)
p := pinpointemail.NewListDeliverabilityTestReportsRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*ListDeliverabilityTestReportsPaginator) CurrentPage added in v0.9.0 

func (p *ListDeliverabilityTestReportsPaginator) CurrentPage() *ListDeliverabilityTestReportsOutput

type ListDeliverabilityTestReportsRequest added in v0.7.0 

type ListDeliverabilityTestReportsRequest struct {
	*aws.Request
	Input *ListDeliverabilityTestReportsInput
	Copy  func(*ListDeliverabilityTestReportsInput) ListDeliverabilityTestReportsRequest
}

ListDeliverabilityTestReportsRequest is the request type for the ListDeliverabilityTestReports API operation.

func (ListDeliverabilityTestReportsRequest) Send added in v0.7.0 

func (r ListDeliverabilityTestReportsRequest) Send(ctx context.Context) (*ListDeliverabilityTestReportsResponse, error)

Send marshals and sends the ListDeliverabilityTestReports API request.

type ListDeliverabilityTestReportsResponse added in v0.9.0 

type ListDeliverabilityTestReportsResponse struct {
	*ListDeliverabilityTestReportsOutput
	// contains filtered or unexported fields
}

ListDeliverabilityTestReportsResponse is the response type for the ListDeliverabilityTestReports API operation.

func (*ListDeliverabilityTestReportsResponse) SDKResponseMetdata added in v0.9.0 

func (r *ListDeliverabilityTestReportsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListDeliverabilityTestReports request.

type ListDomainDeliverabilityCampaignsInput added in v0.9.0 

type ListDomainDeliverabilityCampaignsInput struct {

	// 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 is a required field
	EndDate *time.Time `location:"querystring" locationName:"EndDate" type:"timestamp" required:"true"`

	// 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 `location:"querystring" locationName:"NextToken" type:"string"`

	// 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 *int64 `location:"querystring" locationName:"PageSize" type:"integer"`

	// The first day, in Unix time format, that you want to obtain deliverability
	// data for.
	//
	// StartDate is a required field
	StartDate *time.Time `location:"querystring" locationName:"StartDate" type:"timestamp" required:"true"`

	// The domain to obtain deliverability data for.
	//
	// SubscribedDomain is a required field
	SubscribedDomain *string `location:"uri" locationName:"SubscribedDomain" type:"string" required:"true"`
	// contains filtered or unexported fields
}

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 (ListDomainDeliverabilityCampaignsInput) MarshalFields added in v0.9.0 

func (s ListDomainDeliverabilityCampaignsInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListDomainDeliverabilityCampaignsInput) String added in v0.9.0 

func (s ListDomainDeliverabilityCampaignsInput) String() string

String returns the string representation

func (*ListDomainDeliverabilityCampaignsInput) Validate added in v0.9.0 

func (s *ListDomainDeliverabilityCampaignsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListDomainDeliverabilityCampaignsOutput added in v0.9.0 

type ListDomainDeliverabilityCampaignsOutput struct {

	// An array of responses, one for each campaign that used the domain to send
	// email during the specified time range.
	//
	// DomainDeliverabilityCampaigns is a required field
	DomainDeliverabilityCampaigns []DomainDeliverabilityCampaign `type:"list" required:"true"`

	// 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 `type:"string"`
	// contains filtered or unexported fields
}

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.

func (ListDomainDeliverabilityCampaignsOutput) MarshalFields added in v0.9.0 

func (s ListDomainDeliverabilityCampaignsOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListDomainDeliverabilityCampaignsOutput) String added in v0.9.0 

func (s ListDomainDeliverabilityCampaignsOutput) String() string

String returns the string representation

type ListDomainDeliverabilityCampaignsPaginator added in v0.9.0 

type ListDomainDeliverabilityCampaignsPaginator struct {
	aws.Pager
}

ListDomainDeliverabilityCampaignsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewListDomainDeliverabilityCampaignsPaginator added in v0.9.0 

func NewListDomainDeliverabilityCampaignsPaginator(req ListDomainDeliverabilityCampaignsRequest) ListDomainDeliverabilityCampaignsPaginator

NewListDomainDeliverabilityCampaignsRequestPaginator returns a paginator for ListDomainDeliverabilityCampaigns. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service. 

// Example iterating over pages.
req := client.ListDomainDeliverabilityCampaignsRequest(input)
p := pinpointemail.NewListDomainDeliverabilityCampaignsRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*ListDomainDeliverabilityCampaignsPaginator) CurrentPage added in v0.9.0 

func (p *ListDomainDeliverabilityCampaignsPaginator) CurrentPage() *ListDomainDeliverabilityCampaignsOutput

type ListDomainDeliverabilityCampaignsRequest added in v0.9.0 

type ListDomainDeliverabilityCampaignsRequest struct {
	*aws.Request
	Input *ListDomainDeliverabilityCampaignsInput
	Copy  func(*ListDomainDeliverabilityCampaignsInput) ListDomainDeliverabilityCampaignsRequest
}

ListDomainDeliverabilityCampaignsRequest is the request type for the ListDomainDeliverabilityCampaigns API operation.

func (ListDomainDeliverabilityCampaignsRequest) Send added in v0.9.0 

func (r ListDomainDeliverabilityCampaignsRequest) Send(ctx context.Context) (*ListDomainDeliverabilityCampaignsResponse, error)

Send marshals and sends the ListDomainDeliverabilityCampaigns API request.

type ListDomainDeliverabilityCampaignsResponse added in v0.9.0 

type ListDomainDeliverabilityCampaignsResponse struct {
	*ListDomainDeliverabilityCampaignsOutput
	// contains filtered or unexported fields
}

ListDomainDeliverabilityCampaignsResponse is the response type for the ListDomainDeliverabilityCampaigns API operation.

func (*ListDomainDeliverabilityCampaignsResponse) SDKResponseMetdata added in v0.9.0 

func (r *ListDomainDeliverabilityCampaignsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListDomainDeliverabilityCampaigns request.

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 `location:"querystring" locationName:"NextToken" type:"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 *int64 `location:"querystring" locationName:"PageSize" type:"integer"`
	// contains filtered or unexported fields
}

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.

func (ListEmailIdentitiesInput) MarshalFields 

func (s ListEmailIdentitiesInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListEmailIdentitiesInput) String 

func (s ListEmailIdentitiesInput) String() string

String returns the string representation

type ListEmailIdentitiesOutput 

type ListEmailIdentitiesOutput struct {

	// An array that includes all of the identities associated with your Amazon
	// Pinpoint account.
	EmailIdentities []IdentityInfo `type:"list"`

	// 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 `type:"string"`
	// contains filtered or unexported fields
}

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.

func (ListEmailIdentitiesOutput) MarshalFields 

func (s ListEmailIdentitiesOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListEmailIdentitiesOutput) String 

func (s ListEmailIdentitiesOutput) String() string

String returns the string representation

type ListEmailIdentitiesPaginator added in v0.9.0 

type ListEmailIdentitiesPaginator struct {
	aws.Pager
}

ListEmailIdentitiesPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewListEmailIdentitiesPaginator added in v0.9.0 

func NewListEmailIdentitiesPaginator(req ListEmailIdentitiesRequest) ListEmailIdentitiesPaginator

NewListEmailIdentitiesRequestPaginator returns a paginator for ListEmailIdentities. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service. 

// Example iterating over pages.
req := client.ListEmailIdentitiesRequest(input)
p := pinpointemail.NewListEmailIdentitiesRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*ListEmailIdentitiesPaginator) CurrentPage added in v0.9.0 

func (p *ListEmailIdentitiesPaginator) CurrentPage() *ListEmailIdentitiesOutput

type ListEmailIdentitiesRequest 

type ListEmailIdentitiesRequest struct {
	*aws.Request
	Input *ListEmailIdentitiesInput
	Copy  func(*ListEmailIdentitiesInput) ListEmailIdentitiesRequest
}

ListEmailIdentitiesRequest is the request type for the ListEmailIdentities API operation.

func (ListEmailIdentitiesRequest) Send 

func (r ListEmailIdentitiesRequest) Send(ctx context.Context) (*ListEmailIdentitiesResponse, error)

Send marshals and sends the ListEmailIdentities API request.

type ListEmailIdentitiesResponse added in v0.9.0 

type ListEmailIdentitiesResponse struct {
	*ListEmailIdentitiesOutput
	// contains filtered or unexported fields
}

ListEmailIdentitiesResponse is the response type for the ListEmailIdentities API operation.

func (*ListEmailIdentitiesResponse) SDKResponseMetdata added in v0.9.0 

func (r *ListEmailIdentitiesResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListEmailIdentities request.

type ListTagsForResourceInput added in v0.8.0 

type ListTagsForResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource that you want to retrieve
	// tag information for.
	//
	// ResourceArn is a required field
	ResourceArn *string `location:"querystring" locationName:"ResourceArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceInput) MarshalFields added in v0.8.0 

func (s ListTagsForResourceInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListTagsForResourceInput) String added in v0.8.0 

func (s ListTagsForResourceInput) String() string

String returns the string representation

func (*ListTagsForResourceInput) Validate added in v0.8.0 

func (s *ListTagsForResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListTagsForResourceOutput added in v0.8.0 

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 is a required field
	Tags []Tag `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceOutput) MarshalFields added in v0.8.0 

func (s ListTagsForResourceOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListTagsForResourceOutput) String added in v0.8.0 

func (s ListTagsForResourceOutput) String() string

String returns the string representation

type ListTagsForResourceRequest added in v0.8.0 

type ListTagsForResourceRequest struct {
	*aws.Request
	Input *ListTagsForResourceInput
	Copy  func(*ListTagsForResourceInput) ListTagsForResourceRequest
}

ListTagsForResourceRequest is the request type for the ListTagsForResource API operation.

func (ListTagsForResourceRequest) Send added in v0.8.0 

func (r ListTagsForResourceRequest) Send(ctx context.Context) (*ListTagsForResourceResponse, error)

Send marshals and sends the ListTagsForResource API request.

type ListTagsForResourceResponse added in v0.9.0 

type ListTagsForResourceResponse struct {
	*ListTagsForResourceOutput
	// contains filtered or unexported fields
}

ListTagsForResourceResponse is the response type for the ListTagsForResource API operation.

func (*ListTagsForResourceResponse) SDKResponseMetdata added in v0.9.0 

func (r *ListTagsForResourceResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListTagsForResource request.

type MailFromAttributes 

type MailFromAttributes struct {

	// The action that Amazon Pinpoint to takes if it can't read the required MX
	// record for a custom MAIL FROM domain. When you set this value to UseDefaultValue,
	// Amazon Pinpoint uses amazonses.com as the MAIL FROM domain. When you set
	// this value to RejectMessage, Amazon Pinpoint returns a MailFromDomainNotVerified
	// error, and doesn't attempt to deliver the email.
	//
	// These behaviors are taken when the custom MAIL FROM domain configuration
	// is in the Pending, Failed, and TemporaryFailure states.
	//
	// BehaviorOnMxFailure is a required field
	BehaviorOnMxFailure BehaviorOnMxFailure `type:"string" required:"true" enum:"true"`

	// The name of a domain that an email identity uses as a custom MAIL FROM domain.
	//
	// MailFromDomain is a required field
	MailFromDomain *string `type:"string" required:"true"`

	// The status of the MAIL FROM domain. This status can have the following values:
	//
	//    * PENDING – Amazon Pinpoint hasn't started searching for the MX record
	//    yet.
	//
	//    * SUCCESS – Amazon Pinpoint detected the required MX record for the
	//    MAIL FROM domain.
	//
	//    * FAILED – Amazon Pinpoint can't find the required MX record, or the
	//    record no longer exists.
	//
	//    * TEMPORARY_FAILURE – A temporary issue occurred, which prevented Amazon
	//    Pinpoint from determining the status of the MAIL FROM domain.
	//
	// MailFromDomainStatus is a required field
	MailFromDomainStatus MailFromDomainStatus `type:"string" required:"true" enum:"true"`
	// contains filtered or unexported fields
}

A list of attributes that are associated with a MAIL FROM domain.

func (MailFromAttributes) MarshalFields 

func (s MailFromAttributes) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (MailFromAttributes) String 

func (s MailFromAttributes) String() string

String returns the string representation

type MailFromDomainStatus 

type MailFromDomainStatus string

The status of the MAIL FROM domain. This status can have the following values:

  • PENDING – Amazon Pinpoint hasn't started searching for the MX record yet.

  • SUCCESS – Amazon Pinpoint detected the required MX record for the MAIL FROM domain.

  • FAILED – Amazon Pinpoint can't find the required MX record, or the record no longer exists.

  • TEMPORARY_FAILURE – A temporary issue occurred, which prevented Amazon Pinpoint from determining the status of the MAIL FROM domain. 

const (
	MailFromDomainStatusPending          MailFromDomainStatus = "PENDING"
	MailFromDomainStatusSuccess          MailFromDomainStatus = "SUCCESS"
	MailFromDomainStatusFailed           MailFromDomainStatus = "FAILED"
	MailFromDomainStatusTemporaryFailure MailFromDomainStatus = "TEMPORARY_FAILURE"
)

Enum values for MailFromDomainStatus

func (MailFromDomainStatus) MarshalValue 

func (enum MailFromDomainStatus) MarshalValue() (string, error)

func (MailFromDomainStatus) MarshalValueBuf 

func (enum MailFromDomainStatus) MarshalValueBuf(b []byte) ([]byte, error)

type Message 

type Message struct {

	// The body of the message. You can specify an HTML version of the message,
	// a text-only version of the message, or both.
	//
	// Body is a required field
	Body *Body `type:"structure" required:"true"`

	// The subject line of the email. The subject line can only contain 7-bit ASCII
	// characters. However, you can specify non-ASCII characters in the subject
	// line by using encoded-word syntax, as described in RFC 2047 (https://tools.ietf.org/html/rfc2047).
	//
	// Subject is a required field
	Subject *Content `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Represents the email message that you're sending. The Message object consists of a subject line and a message body.

func (Message) MarshalFields 

func (s Message) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (Message) String 

func (s Message) String() string

String returns the string representation

func (*Message) Validate 

func (s *Message) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type MessageTag 

type MessageTag struct {

	// The name of the message tag. The message tag name has to meet the following
	// criteria:
	//
	//    * It can only contain ASCII letters (a–z, A–Z), numbers (0–9), underscores
	//    (_), or dashes (-).
	//
	//    * It can contain no more than 256 characters.
	//
	// Name is a required field
	Name *string `type:"string" required:"true"`

	// The value of the message tag. The message tag value has to meet the following
	// criteria:
	//
	//    * It can only contain ASCII letters (a–z, A–Z), numbers (0–9), underscores
	//    (_), or dashes (-).
	//
	//    * It can contain no more than 256 characters.
	//
	// Value is a required field
	Value *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Contains the name and value of a tag that you apply to an email. You can use message tags when you publish email sending events.

func (MessageTag) MarshalFields 

func (s MessageTag) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (MessageTag) String 

func (s MessageTag) String() string

String returns the string representation

func (*MessageTag) Validate 

func (s *MessageTag) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type OverallVolume added in v0.7.0 

type OverallVolume struct {

	// An object that contains inbox and junk mail placement metrics for individual
	// email providers.
	DomainIspPlacements []DomainIspPlacement `type:"list"`

	// The percentage of emails that were sent from the domain that were read by
	// their recipients.
	ReadRatePercent *float64 `type:"double"`

	// An object that contains information about the numbers of messages that arrived
	// in recipients' inboxes and junk mail folders.
	VolumeStatistics *VolumeStatistics `type:"structure"`
	// contains filtered or unexported fields
}

An object that contains information about email that was sent from the selected domain.

func (OverallVolume) MarshalFields added in v0.7.0 

func (s OverallVolume) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (OverallVolume) String added in v0.7.0 

func (s OverallVolume) String() string

String returns the string representation

type PinpointDestination 

type PinpointDestination struct {

	// The Amazon Resource Name (ARN) of the Amazon Pinpoint project that you want
	// to send email events to.
	ApplicationArn *string `type:"string"`
	// contains filtered or unexported fields
}

An object that defines a Amazon Pinpoint destination for email events. You can use Amazon Pinpoint events to create attributes in Amazon Pinpoint projects. You can use these attributes to create segments for your campaigns.

func (PinpointDestination) MarshalFields 

func (s PinpointDestination) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PinpointDestination) String 

func (s PinpointDestination) String() string

String returns the string representation

type PlacementStatistics added in v0.7.0 

type PlacementStatistics struct {

	// The percentage of emails that were authenticated by using DomainKeys Identified
	// Mail (DKIM) during the predictive inbox placement test.
	DkimPercentage *float64 `type:"double"`

	// The percentage of emails that arrived in recipients' inboxes during the predictive
	// inbox placement test.
	InboxPercentage *float64 `type:"double"`

	// The percentage of emails that didn't arrive in recipients' inboxes at all
	// during the predictive inbox placement test.
	MissingPercentage *float64 `type:"double"`

	// The percentage of emails that arrived in recipients' spam or junk mail folders
	// during the predictive inbox placement test.
	SpamPercentage *float64 `type:"double"`

	// The percentage of emails that were authenticated by using Sender Policy Framework
	// (SPF) during the predictive inbox placement test.
	SpfPercentage *float64 `type:"double"`
	// contains filtered or unexported fields
}

An object that contains inbox placement data for an email provider.

func (PlacementStatistics) MarshalFields added in v0.7.0 

func (s PlacementStatistics) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PlacementStatistics) String added in v0.7.0 

func (s PlacementStatistics) String() string

String returns the string representation

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 `type:"boolean"`
	// contains filtered or unexported fields
}

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

func (PutAccountDedicatedIpWarmupAttributesInput) MarshalFields 

func (s PutAccountDedicatedIpWarmupAttributesInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PutAccountDedicatedIpWarmupAttributesInput) String 

func (s PutAccountDedicatedIpWarmupAttributesInput) String() string

String returns the string representation

type PutAccountDedicatedIpWarmupAttributesOutput 

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

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

func (PutAccountDedicatedIpWarmupAttributesOutput) MarshalFields 

func (s PutAccountDedicatedIpWarmupAttributesOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PutAccountDedicatedIpWarmupAttributesOutput) String 

func (s PutAccountDedicatedIpWarmupAttributesOutput) String() string

String returns the string representation

type PutAccountDedicatedIpWarmupAttributesRequest 

type PutAccountDedicatedIpWarmupAttributesRequest struct {
	*aws.Request
	Input *PutAccountDedicatedIpWarmupAttributesInput
	Copy  func(*PutAccountDedicatedIpWarmupAttributesInput) PutAccountDedicatedIpWarmupAttributesRequest
}

PutAccountDedicatedIpWarmupAttributesRequest is the request type for the PutAccountDedicatedIpWarmupAttributes API operation.

func (PutAccountDedicatedIpWarmupAttributesRequest) Send 

func (r PutAccountDedicatedIpWarmupAttributesRequest) Send(ctx context.Context) (*PutAccountDedicatedIpWarmupAttributesResponse, error)

Send marshals and sends the PutAccountDedicatedIpWarmupAttributes API request.

type PutAccountDedicatedIpWarmupAttributesResponse added in v0.9.0 

type PutAccountDedicatedIpWarmupAttributesResponse struct {
	*PutAccountDedicatedIpWarmupAttributesOutput
	// contains filtered or unexported fields
}

PutAccountDedicatedIpWarmupAttributesResponse is the response type for the PutAccountDedicatedIpWarmupAttributes API operation.

func (*PutAccountDedicatedIpWarmupAttributesResponse) SDKResponseMetdata added in v0.9.0 

func (r *PutAccountDedicatedIpWarmupAttributesResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the PutAccountDedicatedIpWarmupAttributes request.

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 `type:"boolean"`
	// contains filtered or unexported fields
}

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

func (PutAccountSendingAttributesInput) MarshalFields 

func (s PutAccountSendingAttributesInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PutAccountSendingAttributesInput) String 

func (s PutAccountSendingAttributesInput) String() string

String returns the string representation

type PutAccountSendingAttributesOutput 

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

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

func (PutAccountSendingAttributesOutput) MarshalFields 

func (s PutAccountSendingAttributesOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PutAccountSendingAttributesOutput) String 

func (s PutAccountSendingAttributesOutput) String() string

String returns the string representation

type PutAccountSendingAttributesRequest 

type PutAccountSendingAttributesRequest struct {
	*aws.Request
	Input *PutAccountSendingAttributesInput
	Copy  func(*PutAccountSendingAttributesInput) PutAccountSendingAttributesRequest
}

PutAccountSendingAttributesRequest is the request type for the PutAccountSendingAttributes API operation.

func (PutAccountSendingAttributesRequest) Send 

func (r PutAccountSendingAttributesRequest) Send(ctx context.Context) (*PutAccountSendingAttributesResponse, error)

Send marshals and sends the PutAccountSendingAttributes API request.

type PutAccountSendingAttributesResponse added in v0.9.0 

type PutAccountSendingAttributesResponse struct {
	*PutAccountSendingAttributesOutput
	// contains filtered or unexported fields
}

PutAccountSendingAttributesResponse is the response type for the PutAccountSendingAttributes API operation.

func (*PutAccountSendingAttributesResponse) SDKResponseMetdata added in v0.9.0 

func (r *PutAccountSendingAttributesResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the PutAccountSendingAttributes request.

type PutConfigurationSetDeliveryOptionsInput 

type PutConfigurationSetDeliveryOptionsInput struct {

	// The name of the configuration set that you want to associate with a dedicated
	// IP pool.
	//
	// ConfigurationSetName is a required field
	ConfigurationSetName *string `location:"uri" locationName:"ConfigurationSetName" type:"string" required:"true"`

	// The name of the dedicated IP pool that you want to associate with the configuration
	// set.
	SendingPoolName *string `type:"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 TlsPolicy `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

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

func (PutConfigurationSetDeliveryOptionsInput) MarshalFields 

func (s PutConfigurationSetDeliveryOptionsInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PutConfigurationSetDeliveryOptionsInput) String 

func (s PutConfigurationSetDeliveryOptionsInput) String() string

String returns the string representation

func (*PutConfigurationSetDeliveryOptionsInput) Validate 

func (s *PutConfigurationSetDeliveryOptionsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PutConfigurationSetDeliveryOptionsOutput 

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

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

func (PutConfigurationSetDeliveryOptionsOutput) MarshalFields 

func (s PutConfigurationSetDeliveryOptionsOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PutConfigurationSetDeliveryOptionsOutput) String 

func (s PutConfigurationSetDeliveryOptionsOutput) String() string

String returns the string representation

type PutConfigurationSetDeliveryOptionsRequest 

type PutConfigurationSetDeliveryOptionsRequest struct {
	*aws.Request
	Input *PutConfigurationSetDeliveryOptionsInput
	Copy  func(*PutConfigurationSetDeliveryOptionsInput) PutConfigurationSetDeliveryOptionsRequest
}

PutConfigurationSetDeliveryOptionsRequest is the request type for the PutConfigurationSetDeliveryOptions API operation.

func (PutConfigurationSetDeliveryOptionsRequest) Send 

func (r PutConfigurationSetDeliveryOptionsRequest) Send(ctx context.Context) (*PutConfigurationSetDeliveryOptionsResponse, error)

Send marshals and sends the PutConfigurationSetDeliveryOptions API request.

type PutConfigurationSetDeliveryOptionsResponse added in v0.9.0 

type PutConfigurationSetDeliveryOptionsResponse struct {
	*PutConfigurationSetDeliveryOptionsOutput
	// contains filtered or unexported fields
}

PutConfigurationSetDeliveryOptionsResponse is the response type for the PutConfigurationSetDeliveryOptions API operation.

func (*PutConfigurationSetDeliveryOptionsResponse) SDKResponseMetdata added in v0.9.0 

func (r *PutConfigurationSetDeliveryOptionsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the PutConfigurationSetDeliveryOptions request.

type PutConfigurationSetReputationOptionsInput 

type PutConfigurationSetReputationOptionsInput struct {

	// The name of the configuration set that you want to enable or disable reputation
	// metric tracking for.
	//
	// ConfigurationSetName is a required field
	ConfigurationSetName *string `location:"uri" locationName:"ConfigurationSetName" type:"string" required:"true"`

	// 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 `type:"boolean"`
	// contains filtered or unexported fields
}

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

func (PutConfigurationSetReputationOptionsInput) MarshalFields 

func (s PutConfigurationSetReputationOptionsInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PutConfigurationSetReputationOptionsInput) String 

func (s PutConfigurationSetReputationOptionsInput) String() string

String returns the string representation

func (*PutConfigurationSetReputationOptionsInput) Validate 

func (s *PutConfigurationSetReputationOptionsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PutConfigurationSetReputationOptionsOutput 

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

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

func (PutConfigurationSetReputationOptionsOutput) MarshalFields 

func (s PutConfigurationSetReputationOptionsOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PutConfigurationSetReputationOptionsOutput) String 

func (s PutConfigurationSetReputationOptionsOutput) String() string

String returns the string representation

type PutConfigurationSetReputationOptionsRequest 

type PutConfigurationSetReputationOptionsRequest struct {
	*aws.Request
	Input *PutConfigurationSetReputationOptionsInput
	Copy  func(*PutConfigurationSetReputationOptionsInput) PutConfigurationSetReputationOptionsRequest
}

PutConfigurationSetReputationOptionsRequest is the request type for the PutConfigurationSetReputationOptions API operation.

func (PutConfigurationSetReputationOptionsRequest) Send 

func (r PutConfigurationSetReputationOptionsRequest) Send(ctx context.Context) (*PutConfigurationSetReputationOptionsResponse, error)

Send marshals and sends the PutConfigurationSetReputationOptions API request.

type PutConfigurationSetReputationOptionsResponse added in v0.9.0 

type PutConfigurationSetReputationOptionsResponse struct {
	*PutConfigurationSetReputationOptionsOutput
	// contains filtered or unexported fields
}

PutConfigurationSetReputationOptionsResponse is the response type for the PutConfigurationSetReputationOptions API operation.

func (*PutConfigurationSetReputationOptionsResponse) SDKResponseMetdata added in v0.9.0 

func (r *PutConfigurationSetReputationOptionsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the PutConfigurationSetReputationOptions request.

type PutConfigurationSetSendingOptionsInput 

type PutConfigurationSetSendingOptionsInput struct {

	// The name of the configuration set that you want to enable or disable email
	// sending for.
	//
	// ConfigurationSetName is a required field
	ConfigurationSetName *string `location:"uri" locationName:"ConfigurationSetName" type:"string" required:"true"`

	// If true, email sending is enabled for the configuration set. If false, email
	// sending is disabled for the configuration set.
	SendingEnabled *bool `type:"boolean"`
	// contains filtered or unexported fields
}

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

func (PutConfigurationSetSendingOptionsInput) MarshalFields 

func (s PutConfigurationSetSendingOptionsInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PutConfigurationSetSendingOptionsInput) String 

func (s PutConfigurationSetSendingOptionsInput) String() string

String returns the string representation

func (*PutConfigurationSetSendingOptionsInput) Validate 

func (s *PutConfigurationSetSendingOptionsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PutConfigurationSetSendingOptionsOutput 

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

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

func (PutConfigurationSetSendingOptionsOutput) MarshalFields 

func (s PutConfigurationSetSendingOptionsOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PutConfigurationSetSendingOptionsOutput) String 

func (s PutConfigurationSetSendingOptionsOutput) String() string

String returns the string representation

type PutConfigurationSetSendingOptionsRequest 

type PutConfigurationSetSendingOptionsRequest struct {
	*aws.Request
	Input *PutConfigurationSetSendingOptionsInput
	Copy  func(*PutConfigurationSetSendingOptionsInput) PutConfigurationSetSendingOptionsRequest
}

PutConfigurationSetSendingOptionsRequest is the request type for the PutConfigurationSetSendingOptions API operation.

func (PutConfigurationSetSendingOptionsRequest) Send 

func (r PutConfigurationSetSendingOptionsRequest) Send(ctx context.Context) (*PutConfigurationSetSendingOptionsResponse, error)

Send marshals and sends the PutConfigurationSetSendingOptions API request.

type PutConfigurationSetSendingOptionsResponse added in v0.9.0 

type PutConfigurationSetSendingOptionsResponse struct {
	*PutConfigurationSetSendingOptionsOutput
	// contains filtered or unexported fields
}

PutConfigurationSetSendingOptionsResponse is the response type for the PutConfigurationSetSendingOptions API operation.

func (*PutConfigurationSetSendingOptionsResponse) SDKResponseMetdata added in v0.9.0 

func (r *PutConfigurationSetSendingOptionsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the PutConfigurationSetSendingOptions request.

type PutConfigurationSetTrackingOptionsInput 

type PutConfigurationSetTrackingOptionsInput struct {

	// The name of the configuration set that you want to add a custom tracking
	// domain to.
	//
	// ConfigurationSetName is a required field
	ConfigurationSetName *string `location:"uri" locationName:"ConfigurationSetName" type:"string" required:"true"`

	// The domain that you want to use to track open and click events.
	CustomRedirectDomain *string `type:"string"`
	// contains filtered or unexported fields
}

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

func (PutConfigurationSetTrackingOptionsInput) MarshalFields 

func (s PutConfigurationSetTrackingOptionsInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PutConfigurationSetTrackingOptionsInput) String 

func (s PutConfigurationSetTrackingOptionsInput) String() string

String returns the string representation

func (*PutConfigurationSetTrackingOptionsInput) Validate 

func (s *PutConfigurationSetTrackingOptionsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PutConfigurationSetTrackingOptionsOutput 

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

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

func (PutConfigurationSetTrackingOptionsOutput) MarshalFields 

func (s PutConfigurationSetTrackingOptionsOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PutConfigurationSetTrackingOptionsOutput) String 

func (s PutConfigurationSetTrackingOptionsOutput) String() string

String returns the string representation

type PutConfigurationSetTrackingOptionsRequest 

type PutConfigurationSetTrackingOptionsRequest struct {
	*aws.Request
	Input *PutConfigurationSetTrackingOptionsInput
	Copy  func(*PutConfigurationSetTrackingOptionsInput) PutConfigurationSetTrackingOptionsRequest
}

PutConfigurationSetTrackingOptionsRequest is the request type for the PutConfigurationSetTrackingOptions API operation.

func (PutConfigurationSetTrackingOptionsRequest) Send 

func (r PutConfigurationSetTrackingOptionsRequest) Send(ctx context.Context) (*PutConfigurationSetTrackingOptionsResponse, error)

Send marshals and sends the PutConfigurationSetTrackingOptions API request.

type PutConfigurationSetTrackingOptionsResponse added in v0.9.0 

type PutConfigurationSetTrackingOptionsResponse struct {
	*PutConfigurationSetTrackingOptionsOutput
	// contains filtered or unexported fields
}

PutConfigurationSetTrackingOptionsResponse is the response type for the PutConfigurationSetTrackingOptions API operation.

func (*PutConfigurationSetTrackingOptionsResponse) SDKResponseMetdata added in v0.9.0 

func (r *PutConfigurationSetTrackingOptionsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the PutConfigurationSetTrackingOptions request.

type PutDedicatedIpInPoolInput 

type PutDedicatedIpInPoolInput struct {

	// 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 is a required field
	DestinationPoolName *string `type:"string" required:"true"`

	// 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 is a required field
	Ip *string `location:"uri" locationName:"IP" type:"string" required:"true"`
	// contains filtered or unexported fields
}

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

func (PutDedicatedIpInPoolInput) MarshalFields 

func (s PutDedicatedIpInPoolInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PutDedicatedIpInPoolInput) String 

func (s PutDedicatedIpInPoolInput) String() string

String returns the string representation

func (*PutDedicatedIpInPoolInput) Validate 

func (s *PutDedicatedIpInPoolInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PutDedicatedIpInPoolOutput 

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

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

func (PutDedicatedIpInPoolOutput) MarshalFields 

func (s PutDedicatedIpInPoolOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PutDedicatedIpInPoolOutput) String 

func (s PutDedicatedIpInPoolOutput) String() string

String returns the string representation

type PutDedicatedIpInPoolRequest 

type PutDedicatedIpInPoolRequest struct {
	*aws.Request
	Input *PutDedicatedIpInPoolInput
	Copy  func(*PutDedicatedIpInPoolInput) PutDedicatedIpInPoolRequest
}

PutDedicatedIpInPoolRequest is the request type for the PutDedicatedIpInPool API operation.

func (PutDedicatedIpInPoolRequest) Send 

func (r PutDedicatedIpInPoolRequest) Send(ctx context.Context) (*PutDedicatedIpInPoolResponse, error)

Send marshals and sends the PutDedicatedIpInPool API request.

type PutDedicatedIpInPoolResponse added in v0.9.0 

type PutDedicatedIpInPoolResponse struct {
	*PutDedicatedIpInPoolOutput
	// contains filtered or unexported fields
}

PutDedicatedIpInPoolResponse is the response type for the PutDedicatedIpInPool API operation.

func (*PutDedicatedIpInPoolResponse) SDKResponseMetdata added in v0.9.0 

func (r *PutDedicatedIpInPoolResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the PutDedicatedIpInPool request.

type PutDedicatedIpWarmupAttributesInput 

type PutDedicatedIpWarmupAttributesInput struct {

	// The dedicated IP address that you want to update the warm-up attributes for.
	//
	// Ip is a required field
	Ip *string `location:"uri" locationName:"IP" type:"string" required:"true"`

	// The warm-up percentage that you want to associate with the dedicated IP address.
	//
	// WarmupPercentage is a required field
	WarmupPercentage *int64 `type:"integer" required:"true"`
	// contains filtered or unexported fields
}

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.

func (PutDedicatedIpWarmupAttributesInput) MarshalFields 

func (s PutDedicatedIpWarmupAttributesInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PutDedicatedIpWarmupAttributesInput) String 

func (s PutDedicatedIpWarmupAttributesInput) String() string

String returns the string representation

func (*PutDedicatedIpWarmupAttributesInput) Validate 

func (s *PutDedicatedIpWarmupAttributesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PutDedicatedIpWarmupAttributesOutput 

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

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

func (PutDedicatedIpWarmupAttributesOutput) MarshalFields 

func (s PutDedicatedIpWarmupAttributesOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PutDedicatedIpWarmupAttributesOutput) String 

func (s PutDedicatedIpWarmupAttributesOutput) String() string

String returns the string representation

type PutDedicatedIpWarmupAttributesRequest 

type PutDedicatedIpWarmupAttributesRequest struct {
	*aws.Request
	Input *PutDedicatedIpWarmupAttributesInput
	Copy  func(*PutDedicatedIpWarmupAttributesInput) PutDedicatedIpWarmupAttributesRequest
}

PutDedicatedIpWarmupAttributesRequest is the request type for the PutDedicatedIpWarmupAttributes API operation.

func (PutDedicatedIpWarmupAttributesRequest) Send 

func (r PutDedicatedIpWarmupAttributesRequest) Send(ctx context.Context) (*PutDedicatedIpWarmupAttributesResponse, error)

Send marshals and sends the PutDedicatedIpWarmupAttributes API request.

type PutDedicatedIpWarmupAttributesResponse added in v0.9.0 

type PutDedicatedIpWarmupAttributesResponse struct {
	*PutDedicatedIpWarmupAttributesOutput
	// contains filtered or unexported fields
}

PutDedicatedIpWarmupAttributesResponse is the response type for the PutDedicatedIpWarmupAttributes API operation.

func (*PutDedicatedIpWarmupAttributesResponse) SDKResponseMetdata added in v0.9.0 

func (r *PutDedicatedIpWarmupAttributesResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the PutDedicatedIpWarmupAttributes request.

type PutDeliverabilityDashboardOptionInput added in v0.7.0 

type PutDeliverabilityDashboardOptionInput struct {

	// Specifies whether to enable the Deliverability dashboard for your Amazon
	// Pinpoint account. To enable the dashboard, set this value to true.
	//
	// DashboardEnabled is a required field
	DashboardEnabled *bool `type:"boolean" required:"true"`

	// An array of objects, one for each verified domain that you use to send email
	// and enabled the Deliverability dashboard for.
	SubscribedDomains []DomainDeliverabilityTrackingOption `type:"list"`
	// contains filtered or unexported fields
}

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 (PutDeliverabilityDashboardOptionInput) MarshalFields added in v0.7.0 

func (s PutDeliverabilityDashboardOptionInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PutDeliverabilityDashboardOptionInput) String added in v0.7.0 

func (s PutDeliverabilityDashboardOptionInput) String() string

String returns the string representation

func (*PutDeliverabilityDashboardOptionInput) Validate added in v0.7.0 

func (s *PutDeliverabilityDashboardOptionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PutDeliverabilityDashboardOptionOutput added in v0.7.0 

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

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

func (PutDeliverabilityDashboardOptionOutput) MarshalFields added in v0.7.0 

func (s PutDeliverabilityDashboardOptionOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PutDeliverabilityDashboardOptionOutput) String added in v0.7.0 

func (s PutDeliverabilityDashboardOptionOutput) String() string

String returns the string representation

type PutDeliverabilityDashboardOptionRequest added in v0.7.0 

type PutDeliverabilityDashboardOptionRequest struct {
	*aws.Request
	Input *PutDeliverabilityDashboardOptionInput
	Copy  func(*PutDeliverabilityDashboardOptionInput) PutDeliverabilityDashboardOptionRequest
}

PutDeliverabilityDashboardOptionRequest is the request type for the PutDeliverabilityDashboardOption API operation.

func (PutDeliverabilityDashboardOptionRequest) Send added in v0.7.0 

func (r PutDeliverabilityDashboardOptionRequest) Send(ctx context.Context) (*PutDeliverabilityDashboardOptionResponse, error)

Send marshals and sends the PutDeliverabilityDashboardOption API request.

type PutDeliverabilityDashboardOptionResponse added in v0.9.0 

type PutDeliverabilityDashboardOptionResponse struct {
	*PutDeliverabilityDashboardOptionOutput
	// contains filtered or unexported fields
}

PutDeliverabilityDashboardOptionResponse is the response type for the PutDeliverabilityDashboardOption API operation.

func (*PutDeliverabilityDashboardOptionResponse) SDKResponseMetdata added in v0.9.0 

func (r *PutDeliverabilityDashboardOptionResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the PutDeliverabilityDashboardOption request.

type PutEmailIdentityDkimAttributesInput 

type PutEmailIdentityDkimAttributesInput struct {

	// The email identity that you want to change the DKIM settings for.
	//
	// EmailIdentity is a required field
	EmailIdentity *string `location:"uri" locationName:"EmailIdentity" type:"string" required:"true"`

	// 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 `type:"boolean"`
	// contains filtered or unexported fields
}

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

func (PutEmailIdentityDkimAttributesInput) MarshalFields 

func (s PutEmailIdentityDkimAttributesInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PutEmailIdentityDkimAttributesInput) String 

func (s PutEmailIdentityDkimAttributesInput) String() string

String returns the string representation

func (*PutEmailIdentityDkimAttributesInput) Validate 

func (s *PutEmailIdentityDkimAttributesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PutEmailIdentityDkimAttributesOutput 

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

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

func (PutEmailIdentityDkimAttributesOutput) MarshalFields 

func (s PutEmailIdentityDkimAttributesOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PutEmailIdentityDkimAttributesOutput) String 

func (s PutEmailIdentityDkimAttributesOutput) String() string

String returns the string representation

type PutEmailIdentityDkimAttributesRequest 

type PutEmailIdentityDkimAttributesRequest struct {
	*aws.Request
	Input *PutEmailIdentityDkimAttributesInput
	Copy  func(*PutEmailIdentityDkimAttributesInput) PutEmailIdentityDkimAttributesRequest
}

PutEmailIdentityDkimAttributesRequest is the request type for the PutEmailIdentityDkimAttributes API operation.

func (PutEmailIdentityDkimAttributesRequest) Send 

func (r PutEmailIdentityDkimAttributesRequest) Send(ctx context.Context) (*PutEmailIdentityDkimAttributesResponse, error)

Send marshals and sends the PutEmailIdentityDkimAttributes API request.

type PutEmailIdentityDkimAttributesResponse added in v0.9.0 

type PutEmailIdentityDkimAttributesResponse struct {
	*PutEmailIdentityDkimAttributesOutput
	// contains filtered or unexported fields
}

PutEmailIdentityDkimAttributesResponse is the response type for the PutEmailIdentityDkimAttributes API operation.

func (*PutEmailIdentityDkimAttributesResponse) SDKResponseMetdata added in v0.9.0 

func (r *PutEmailIdentityDkimAttributesResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the PutEmailIdentityDkimAttributes request.

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 `type:"boolean"`

	// The email identity that you want to configure bounce and complaint feedback
	// forwarding for.
	//
	// EmailIdentity is a required field
	EmailIdentity *string `location:"uri" locationName:"EmailIdentity" type:"string" required:"true"`
	// contains filtered or unexported fields
}

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

func (PutEmailIdentityFeedbackAttributesInput) MarshalFields 

func (s PutEmailIdentityFeedbackAttributesInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PutEmailIdentityFeedbackAttributesInput) String 

func (s PutEmailIdentityFeedbackAttributesInput) String() string

String returns the string representation

func (*PutEmailIdentityFeedbackAttributesInput) Validate 

func (s *PutEmailIdentityFeedbackAttributesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PutEmailIdentityFeedbackAttributesOutput 

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

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

func (PutEmailIdentityFeedbackAttributesOutput) MarshalFields 

func (s PutEmailIdentityFeedbackAttributesOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PutEmailIdentityFeedbackAttributesOutput) String 

func (s PutEmailIdentityFeedbackAttributesOutput) String() string

String returns the string representation

type PutEmailIdentityFeedbackAttributesRequest 

type PutEmailIdentityFeedbackAttributesRequest struct {
	*aws.Request
	Input *PutEmailIdentityFeedbackAttributesInput
	Copy  func(*PutEmailIdentityFeedbackAttributesInput) PutEmailIdentityFeedbackAttributesRequest
}

PutEmailIdentityFeedbackAttributesRequest is the request type for the PutEmailIdentityFeedbackAttributes API operation.

func (PutEmailIdentityFeedbackAttributesRequest) Send 

func (r PutEmailIdentityFeedbackAttributesRequest) Send(ctx context.Context) (*PutEmailIdentityFeedbackAttributesResponse, error)

Send marshals and sends the PutEmailIdentityFeedbackAttributes API request.

type PutEmailIdentityFeedbackAttributesResponse added in v0.9.0 

type PutEmailIdentityFeedbackAttributesResponse struct {
	*PutEmailIdentityFeedbackAttributesOutput
	// contains filtered or unexported fields
}

PutEmailIdentityFeedbackAttributesResponse is the response type for the PutEmailIdentityFeedbackAttributes API operation.

func (*PutEmailIdentityFeedbackAttributesResponse) SDKResponseMetdata added in v0.9.0 

func (r *PutEmailIdentityFeedbackAttributesResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the PutEmailIdentityFeedbackAttributes request.

type PutEmailIdentityMailFromAttributesInput 

type PutEmailIdentityMailFromAttributesInput struct {

	// 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 BehaviorOnMxFailure `type:"string" enum:"true"`

	// The verified email identity that you want to set up the custom MAIL FROM
	// domain for.
	//
	// EmailIdentity is a required field
	EmailIdentity *string `location:"uri" locationName:"EmailIdentity" type:"string" required:"true"`

	// 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 `type:"string"`
	// contains filtered or unexported fields
}

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

func (PutEmailIdentityMailFromAttributesInput) MarshalFields 

func (s PutEmailIdentityMailFromAttributesInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PutEmailIdentityMailFromAttributesInput) String 

func (s PutEmailIdentityMailFromAttributesInput) String() string

String returns the string representation

func (*PutEmailIdentityMailFromAttributesInput) Validate 

func (s *PutEmailIdentityMailFromAttributesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PutEmailIdentityMailFromAttributesOutput 

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

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

func (PutEmailIdentityMailFromAttributesOutput) MarshalFields 

func (s PutEmailIdentityMailFromAttributesOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PutEmailIdentityMailFromAttributesOutput) String 

func (s PutEmailIdentityMailFromAttributesOutput) String() string

String returns the string representation

type PutEmailIdentityMailFromAttributesRequest 

type PutEmailIdentityMailFromAttributesRequest struct {
	*aws.Request
	Input *PutEmailIdentityMailFromAttributesInput
	Copy  func(*PutEmailIdentityMailFromAttributesInput) PutEmailIdentityMailFromAttributesRequest
}

PutEmailIdentityMailFromAttributesRequest is the request type for the PutEmailIdentityMailFromAttributes API operation.

func (PutEmailIdentityMailFromAttributesRequest) Send 

func (r PutEmailIdentityMailFromAttributesRequest) Send(ctx context.Context) (*PutEmailIdentityMailFromAttributesResponse, error)

Send marshals and sends the PutEmailIdentityMailFromAttributes API request.

type PutEmailIdentityMailFromAttributesResponse added in v0.9.0 

type PutEmailIdentityMailFromAttributesResponse struct {
	*PutEmailIdentityMailFromAttributesOutput
	// contains filtered or unexported fields
}

PutEmailIdentityMailFromAttributesResponse is the response type for the PutEmailIdentityMailFromAttributes API operation.

func (*PutEmailIdentityMailFromAttributesResponse) SDKResponseMetdata added in v0.9.0 

func (r *PutEmailIdentityMailFromAttributesResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the PutEmailIdentityMailFromAttributes request.

type RawMessage 

type RawMessage struct {

	// The raw email message. The message has to meet the following criteria:
	//
	//    * The message has to contain a header and a body, separated by one blank
	//    line.
	//
	//    * All of the required header fields must be present in the message.
	//
	//    * Each part of a multipart MIME message must be formatted properly.
	//
	//    * Attachments must be in a file format that Amazon Pinpoint supports.
	//
	//    * The entire message must be Base64 encoded.
	//
	//    * If any of the MIME parts in your message contain content that is outside
	//    of the 7-bit ASCII character range, you should encode that content to
	//    ensure that recipients' email clients render the message properly.
	//
	//    * The length of any single line of text in the message can't exceed 1,000
	//    characters. This restriction is defined in RFC 5321 (https://tools.ietf.org/html/rfc5321).
	//
	// Data is automatically base64 encoded/decoded by the SDK.
	//
	// Data is a required field
	Data []byte `type:"blob" required:"true"`
	// contains filtered or unexported fields
}

The raw email message.

func (RawMessage) MarshalFields 

func (s RawMessage) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (RawMessage) String 

func (s RawMessage) String() string

String returns the string representation

func (*RawMessage) Validate 

func (s *RawMessage) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ReputationOptions 

type ReputationOptions struct {

	// The date and time (in Unix time) when the reputation metrics were last given
	// a fresh start. When your account is given a fresh start, your reputation
	// metrics are calculated starting from the date of the fresh start.
	LastFreshStart *time.Time `type:"timestamp"`

	// 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 `type:"boolean"`
	// contains filtered or unexported fields
}

Enable or disable collection of reputation metrics for emails that you send using this configuration set in the current AWS Region.

func (ReputationOptions) MarshalFields 

func (s ReputationOptions) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ReputationOptions) String 

func (s ReputationOptions) String() string

String returns the string representation

type SendEmailInput 

type SendEmailInput struct {

	// The name of the configuration set that you want to use when sending the email.
	ConfigurationSetName *string `type:"string"`

	// An object that contains the body of the message. You can send either a Simple
	// message or a Raw message.
	//
	// Content is a required field
	Content *EmailContent `type:"structure" required:"true"`

	// An object that contains the recipients of the email message.
	//
	// Destination is a required field
	Destination *Destination `type:"structure" required:"true"`

	// 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 []MessageTag `type:"list"`

	// The address that Amazon Pinpoint should send bounce and complaint notifications
	// to.
	FeedbackForwardingEmailAddress *string `type:"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 `type:"string"`

	// The "Reply-to" email addresses for the message. When the recipient replies
	// to the message, each Reply-to address receives the reply.
	ReplyToAddresses []string `type:"list"`
	// contains filtered or unexported fields
}

A request to send an email message.

func (SendEmailInput) MarshalFields 

func (s SendEmailInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (SendEmailInput) String 

func (s SendEmailInput) String() string

String returns the string representation

func (*SendEmailInput) Validate 

func (s *SendEmailInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

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 `type:"string"`
	// contains filtered or unexported fields
}

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

func (SendEmailOutput) MarshalFields 

func (s SendEmailOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (SendEmailOutput) String 

func (s SendEmailOutput) String() string

String returns the string representation

type SendEmailRequest 

type SendEmailRequest struct {
	*aws.Request
	Input *SendEmailInput
	Copy  func(*SendEmailInput) SendEmailRequest
}

SendEmailRequest is the request type for the SendEmail API operation.

func (SendEmailRequest) Send 

func (r SendEmailRequest) Send(ctx context.Context) (*SendEmailResponse, error)

Send marshals and sends the SendEmail API request.

type SendEmailResponse added in v0.9.0 

type SendEmailResponse struct {
	*SendEmailOutput
	// contains filtered or unexported fields
}

SendEmailResponse is the response type for the SendEmail API operation.

func (*SendEmailResponse) SDKResponseMetdata added in v0.9.0 

func (r *SendEmailResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the SendEmail request.

type SendQuota 

type SendQuota struct {

	// The maximum number of emails that you can send in the current AWS Region
	// over a 24-hour period. This value is also called your sending quota.
	Max24HourSend *float64 `type:"double"`

	// The maximum number of emails that you can send per second in the current
	// AWS Region. This value is also called your maximum sending rate or your maximum
	// TPS (transactions per second) rate.
	MaxSendRate *float64 `type:"double"`

	// The number of emails sent from your Amazon Pinpoint account in the current
	// AWS Region over the past 24 hours.
	SentLast24Hours *float64 `type:"double"`
	// contains filtered or unexported fields
}

An object that contains information about the per-day and per-second sending limits for your Amazon Pinpoint account in the current AWS Region.

func (SendQuota) MarshalFields 

func (s SendQuota) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (SendQuota) String 

func (s SendQuota) String() string

String returns the string representation

type SendingOptions 

type SendingOptions struct {

	// If true, email sending is enabled for the configuration set. If false, email
	// sending is disabled for the configuration set.
	SendingEnabled *bool `type:"boolean"`
	// contains filtered or unexported fields
}

Used to enable or disable email sending for messages that use this configuration set in the current AWS Region.

func (SendingOptions) MarshalFields 

func (s SendingOptions) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (SendingOptions) String 

func (s SendingOptions) String() string

String returns the string representation

type SnsDestination 

type SnsDestination struct {

	// The Amazon Resource Name (ARN) of the Amazon SNS topic that you want to publish
	// email events to. For more information about Amazon SNS topics, see the Amazon
	// SNS Developer Guide (https://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html).
	//
	// TopicArn is a required field
	TopicArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

An object that defines an Amazon SNS destination for email events. You can use Amazon SNS to send notification when certain email events occur.

func (SnsDestination) MarshalFields 

func (s SnsDestination) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (SnsDestination) String 

func (s SnsDestination) String() string

String returns the string representation

func (*SnsDestination) Validate 

func (s *SnsDestination) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type Tag added in v0.8.0 

type Tag struct {

	// One part of a key-value pair that defines a tag. The maximum length of a
	// tag key is 128 characters. The minimum length is 1 character.
	//
	// Key is a required field
	Key *string `type:"string" required:"true"`

	// The optional part of a key-value pair that defines a tag. The maximum length
	// of a tag value is 256 characters. The minimum length is 0 characters. If
	// you don’t want a resource to have a specific tag value, don’t specify
	// a value for this parameter. Amazon Pinpoint will set the value to an empty
	// string.
	//
	// Value is a required field
	Value *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

An object that defines the tags that are associated with a resource. A tag is a label that you optionally define and associate with a resource in Amazon Pinpoint. Tags can help you categorize and manage resources in different ways, such as by purpose, owner, environment, or other criteria. A resource can have as many as 50 tags.

Each tag consists of a required tag key and an associated tag value, both of which you define. A tag key is a general label that acts as a category for a more specific tag value. A tag value acts as a descriptor within a tag key. A tag key can contain as many as 128 characters. A tag value can contain as many as 256 characters. The characters can be Unicode letters, digits, white space, or one of the following symbols: _ . : / = + -. The following additional restrictions apply to tags:

  • Tag keys and values are case sensitive.

  • For each associated resource, each tag key must be unique and it can have only one value.

  • The aws: prefix is reserved for use by AWS; you can’t use it in any tag keys or values that you define. In addition, you can't edit or remove tag keys or values that use this prefix. Tags that use this prefix don’t count against the limit of 50 tags per resource.

  • You can associate tags with public or shared resources, but the tags are available only for your AWS account, not any other accounts that share the resource. In addition, the tags are available only for resources that are located in the specified AWS Region for your AWS account.

func (Tag) MarshalFields added in v0.8.0 

func (s Tag) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (Tag) String added in v0.8.0 

func (s Tag) String() string

String returns the string representation

func (*Tag) Validate added in v0.8.0 

func (s *Tag) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TagResourceInput added in v0.8.0 

type TagResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource that you want to add one or
	// more tags to.
	//
	// ResourceArn is a required field
	ResourceArn *string `type:"string" required:"true"`

	// 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 is a required field
	Tags []Tag `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (TagResourceInput) MarshalFields added in v0.8.0 

func (s TagResourceInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (TagResourceInput) String added in v0.8.0 

func (s TagResourceInput) String() string

String returns the string representation

func (*TagResourceInput) Validate added in v0.8.0 

func (s *TagResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TagResourceOutput added in v0.8.0 

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

func (TagResourceOutput) MarshalFields added in v0.8.0 

func (s TagResourceOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (TagResourceOutput) String added in v0.8.0 

func (s TagResourceOutput) String() string

String returns the string representation

type TagResourceRequest added in v0.8.0 

type TagResourceRequest struct {
	*aws.Request
	Input *TagResourceInput
	Copy  func(*TagResourceInput) TagResourceRequest
}

TagResourceRequest is the request type for the TagResource API operation.

func (TagResourceRequest) Send added in v0.8.0 

func (r TagResourceRequest) Send(ctx context.Context) (*TagResourceResponse, error)

Send marshals and sends the TagResource API request.

type TagResourceResponse added in v0.9.0 

type TagResourceResponse struct {
	*TagResourceOutput
	// contains filtered or unexported fields
}

TagResourceResponse is the response type for the TagResource API operation.

func (*TagResourceResponse) SDKResponseMetdata added in v0.9.0 

func (r *TagResourceResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the TagResource request.

type Template added in v0.14.0 

type Template struct {

	// The Amazon Resource Name (ARN) of the template.
	TemplateArn *string `type:"string"`

	// An object that defines the values to use for message variables in the template.
	// This object is a set of key-value pairs. Each key defines a message variable
	// in the template. The corresponding value defines the value to use for that
	// variable.
	TemplateData *string `type:"string"`
	// contains filtered or unexported fields
}

func (Template) MarshalFields added in v0.14.0 

func (s Template) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (Template) String added in v0.14.0 

func (s Template) String() string

String returns the string representation

type TlsPolicy added in v0.10.0 

type TlsPolicy 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. 

const (
	TlsPolicyRequire  TlsPolicy = "REQUIRE"
	TlsPolicyOptional TlsPolicy = "OPTIONAL"
)

Enum values for TlsPolicy

func (TlsPolicy) MarshalValue added in v0.10.0 

func (enum TlsPolicy) MarshalValue() (string, error)

func (TlsPolicy) MarshalValueBuf added in v0.10.0 

func (enum TlsPolicy) MarshalValueBuf(b []byte) ([]byte, error)

type TrackingOptions 

type TrackingOptions struct {

	// The domain that you want to use for tracking open and click events.
	//
	// CustomRedirectDomain is a required field
	CustomRedirectDomain *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

An object that defines the tracking options for a configuration set. When you use Amazon Pinpoint to send an email, it contains an invisible image that's used to track when recipients open your email. If your email contains links, those links are changed slightly in order to track when recipients click them.

These images and links include references to a domain operated by AWS. You can optionally configure Amazon Pinpoint to use a domain that you operate for these images and links.

func (TrackingOptions) MarshalFields 

func (s TrackingOptions) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (TrackingOptions) String 

func (s TrackingOptions) String() string

String returns the string representation

func (*TrackingOptions) Validate 

func (s *TrackingOptions) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UntagResourceInput added in v0.8.0 

type UntagResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource that you want to remove one
	// or more tags from.
	//
	// ResourceArn is a required field
	ResourceArn *string `location:"querystring" locationName:"ResourceArn" type:"string" required:"true"`

	// 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 is a required field
	TagKeys []string `location:"querystring" locationName:"TagKeys" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (UntagResourceInput) MarshalFields added in v0.8.0 

func (s UntagResourceInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UntagResourceInput) String added in v0.8.0 

func (s UntagResourceInput) String() string

String returns the string representation

func (*UntagResourceInput) Validate added in v0.8.0 

func (s *UntagResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UntagResourceOutput added in v0.8.0 

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

func (UntagResourceOutput) MarshalFields added in v0.8.0 

func (s UntagResourceOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UntagResourceOutput) String added in v0.8.0 

func (s UntagResourceOutput) String() string

String returns the string representation

type UntagResourceRequest added in v0.8.0 

type UntagResourceRequest struct {
	*aws.Request
	Input *UntagResourceInput
	Copy  func(*UntagResourceInput) UntagResourceRequest
}

UntagResourceRequest is the request type for the UntagResource API operation.

func (UntagResourceRequest) Send added in v0.8.0 

func (r UntagResourceRequest) Send(ctx context.Context) (*UntagResourceResponse, error)

Send marshals and sends the UntagResource API request.

type UntagResourceResponse added in v0.9.0 

type UntagResourceResponse struct {
	*UntagResourceOutput
	// contains filtered or unexported fields
}

UntagResourceResponse is the response type for the UntagResource API operation.

func (*UntagResourceResponse) SDKResponseMetdata added in v0.9.0 

func (r *UntagResourceResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UntagResource request.

type UpdateConfigurationSetEventDestinationInput 

type UpdateConfigurationSetEventDestinationInput struct {

	// The name of the configuration set that contains the event destination that
	// you want to modify.
	//
	// ConfigurationSetName is a required field
	ConfigurationSetName *string `location:"uri" locationName:"ConfigurationSetName" type:"string" required:"true"`

	// An object that defines the event destination.
	//
	// EventDestination is a required field
	EventDestination *EventDestinationDefinition `type:"structure" required:"true"`

	// The name of the event destination that you want to modify.
	//
	// EventDestinationName is a required field
	EventDestinationName *string `location:"uri" locationName:"EventDestinationName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

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

func (UpdateConfigurationSetEventDestinationInput) MarshalFields 

func (s UpdateConfigurationSetEventDestinationInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateConfigurationSetEventDestinationInput) String 

func (s UpdateConfigurationSetEventDestinationInput) String() string

String returns the string representation

func (*UpdateConfigurationSetEventDestinationInput) Validate 

func (s *UpdateConfigurationSetEventDestinationInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateConfigurationSetEventDestinationOutput 

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

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

func (UpdateConfigurationSetEventDestinationOutput) MarshalFields 

func (s UpdateConfigurationSetEventDestinationOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateConfigurationSetEventDestinationOutput) String 

func (s UpdateConfigurationSetEventDestinationOutput) String() string

String returns the string representation

type UpdateConfigurationSetEventDestinationRequest 

type UpdateConfigurationSetEventDestinationRequest struct {
	*aws.Request
	Input *UpdateConfigurationSetEventDestinationInput
	Copy  func(*UpdateConfigurationSetEventDestinationInput) UpdateConfigurationSetEventDestinationRequest
}

UpdateConfigurationSetEventDestinationRequest is the request type for the UpdateConfigurationSetEventDestination API operation.

func (UpdateConfigurationSetEventDestinationRequest) Send 

func (r UpdateConfigurationSetEventDestinationRequest) Send(ctx context.Context) (*UpdateConfigurationSetEventDestinationResponse, error)

Send marshals and sends the UpdateConfigurationSetEventDestination API request.

type UpdateConfigurationSetEventDestinationResponse added in v0.9.0 

type UpdateConfigurationSetEventDestinationResponse struct {
	*UpdateConfigurationSetEventDestinationOutput
	// contains filtered or unexported fields
}

UpdateConfigurationSetEventDestinationResponse is the response type for the UpdateConfigurationSetEventDestination API operation.

func (*UpdateConfigurationSetEventDestinationResponse) SDKResponseMetdata added in v0.9.0 

func (r *UpdateConfigurationSetEventDestinationResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UpdateConfigurationSetEventDestination request.

type VolumeStatistics added in v0.7.0 

type VolumeStatistics struct {

	// The total number of emails that arrived in recipients' inboxes.
	InboxRawCount *int64 `type:"long"`

	// An estimate of the percentage of emails sent from the current domain that
	// will arrive in recipients' inboxes.
	ProjectedInbox *int64 `type:"long"`

	// An estimate of the percentage of emails sent from the current domain that
	// will arrive in recipients' spam or junk mail folders.
	ProjectedSpam *int64 `type:"long"`

	// The total number of emails that arrived in recipients' spam or junk mail
	// folders.
	SpamRawCount *int64 `type:"long"`
	// contains filtered or unexported fields
}

An object that contains information about the amount of email that was delivered to recipients.

func (VolumeStatistics) MarshalFields added in v0.7.0 

func (s VolumeStatistics) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (VolumeStatistics) String added in v0.7.0 

func (s VolumeStatistics) String() string

String returns the string representation

type WarmupStatus 

type WarmupStatus string

The warmup status of a dedicated IP. 

const (
	WarmupStatusInProgress WarmupStatus = "IN_PROGRESS"
	WarmupStatusDone       WarmupStatus = "DONE"
)

Enum values for WarmupStatus

func (WarmupStatus) MarshalValue 

func (enum WarmupStatus) MarshalValue() (string, error)

func (WarmupStatus) MarshalValueBuf 

func (enum WarmupStatus) MarshalValueBuf(b []byte) ([]byte, error)

Source Files

View all Source files

Directories

Path Synopsis
Package pinpointemailiface provides an interface to enable mocking the Amazon Pinpoint Email Service service client for testing your code.
 Package pinpointemailiface provides an interface to enable mocking the Amazon Pinpoint Email Service service client for testing your code.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.