pinpointemail

package
v1.44.245 Latest Latest
Warning

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

 Go to latest Published: Apr 17, 2023 License: Apache-2.0 Imports: 10 Imported by: 23

Documentation

Overview

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

Welcome to the Amazon Pinpoint Email API Reference. This guide provides information about the Amazon Pinpoint Email API (version 1.0), including supported operations, data types, parameters, and schemas.

Amazon Pinpoint (https://aws.amazon.com/pinpoint) is an AWS service that you can use to engage with your customers across multiple messaging channels. You can use Amazon Pinpoint to send email, SMS text messages, voice messages, and push notifications. The Amazon Pinpoint Email API provides programmatic access to options that are unique to the email channel and supplement the options provided by the Amazon Pinpoint API.

If you're new to Amazon Pinpoint, you might find it helpful to also review the Amazon Pinpoint Developer Guide (https://docs.aws.amazon.com/pinpoint/latest/developerguide/welcome.html). The Amazon Pinpoint Developer Guide provides tutorials, code samples, and procedures that demonstrate how to use Amazon Pinpoint features programmatically and how to integrate Amazon Pinpoint functionality into mobile apps and other types of applications. The guide also provides information about key topics such as Amazon Pinpoint integration with other AWS services and the limits that apply to using the service.

The Amazon Pinpoint Email API is available in several AWS Regions and it provides an endpoint for each of these Regions. For a list of all the Regions and endpoints where the API is currently available, see AWS Service Endpoints (https://docs.aws.amazon.com/general/latest/gr/rande.html#pinpoint_region) in the Amazon Web Services General Reference. To learn more about AWS Regions, see Managing AWS Regions (https://docs.aws.amazon.com/general/latest/gr/rande-manage.html) in the Amazon Web Services General Reference.

In each Region, AWS maintains multiple Availability Zones. These Availability Zones are physically isolated from each other, but are united by private, low-latency, high-throughput, and highly redundant network connections. These Availability Zones enable us to provide very high levels of availability and redundancy, while also minimizing latency. To learn more about the number of Availability Zones that are available in each Region, see AWS Global Infrastructure (http://aws.amazon.com/about-aws/global-infrastructure/).

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 contact Amazon Pinpoint Email Service 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 Amazon Pinpoint Email Service client PinpointEmail 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 (
	// BehaviorOnMxFailureUseDefaultValue is a BehaviorOnMxFailure enum value
	BehaviorOnMxFailureUseDefaultValue = "USE_DEFAULT_VALUE"

	// BehaviorOnMxFailureRejectMessage is a BehaviorOnMxFailure enum value
	BehaviorOnMxFailureRejectMessage = "REJECT_MESSAGE"
)

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.

View Source 
const (
	// DeliverabilityDashboardAccountStatusActive is a DeliverabilityDashboardAccountStatus enum value
	DeliverabilityDashboardAccountStatusActive = "ACTIVE"

	// DeliverabilityDashboardAccountStatusPendingExpiration is a DeliverabilityDashboardAccountStatus enum value
	DeliverabilityDashboardAccountStatusPendingExpiration = "PENDING_EXPIRATION"

	// DeliverabilityDashboardAccountStatusDisabled is a DeliverabilityDashboardAccountStatus enum value
	DeliverabilityDashboardAccountStatusDisabled = "DISABLED"
)

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.

View Source 
const (
	// DeliverabilityTestStatusInProgress is a DeliverabilityTestStatus enum value
	DeliverabilityTestStatusInProgress = "IN_PROGRESS"

	// DeliverabilityTestStatusCompleted is a DeliverabilityTestStatus enum value
	DeliverabilityTestStatusCompleted = "COMPLETED"
)

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.

View Source 
const (
	// DimensionValueSourceMessageTag is a DimensionValueSource enum value
	DimensionValueSourceMessageTag = "MESSAGE_TAG"

	// DimensionValueSourceEmailHeader is a DimensionValueSource enum value
	DimensionValueSourceEmailHeader = "EMAIL_HEADER"

	// DimensionValueSourceLinkTag is a DimensionValueSource enum value
	DimensionValueSourceLinkTag = "LINK_TAG"
)

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.

View Source 
const (
	// DkimStatusPending is a DkimStatus enum value
	DkimStatusPending = "PENDING"

	// DkimStatusSuccess is a DkimStatus enum value
	DkimStatusSuccess = "SUCCESS"

	// DkimStatusFailed is a DkimStatus enum value
	DkimStatusFailed = "FAILED"

	// DkimStatusTemporaryFailure is a DkimStatus enum value
	DkimStatusTemporaryFailure = "TEMPORARY_FAILURE"

	// DkimStatusNotStarted is a DkimStatus enum value
	DkimStatusNotStarted = "NOT_STARTED"
)

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.

View Source 
const (
	// EventTypeSend is a EventType enum value
	EventTypeSend = "SEND"

	// EventTypeReject is a EventType enum value
	EventTypeReject = "REJECT"

	// EventTypeBounce is a EventType enum value
	EventTypeBounce = "BOUNCE"

	// EventTypeComplaint is a EventType enum value
	EventTypeComplaint = "COMPLAINT"

	// EventTypeDelivery is a EventType enum value
	EventTypeDelivery = "DELIVERY"

	// EventTypeOpen is a EventType enum value
	EventTypeOpen = "OPEN"

	// EventTypeClick is a EventType enum value
	EventTypeClick = "CLICK"

	// EventTypeRenderingFailure is a EventType enum value
	EventTypeRenderingFailure = "RENDERING_FAILURE"
)

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

View Source 
const (
	// IdentityTypeEmailAddress is a IdentityType enum value
	IdentityTypeEmailAddress = "EMAIL_ADDRESS"

	// IdentityTypeDomain is a IdentityType enum value
	IdentityTypeDomain = "DOMAIN"

	// IdentityTypeManagedDomain is a IdentityType enum value
	IdentityTypeManagedDomain = "MANAGED_DOMAIN"
)

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.

View Source 
const (
	// MailFromDomainStatusPending is a MailFromDomainStatus enum value
	MailFromDomainStatusPending = "PENDING"

	// MailFromDomainStatusSuccess is a MailFromDomainStatus enum value
	MailFromDomainStatusSuccess = "SUCCESS"

	// MailFromDomainStatusFailed is a MailFromDomainStatus enum value
	MailFromDomainStatusFailed = "FAILED"

	// MailFromDomainStatusTemporaryFailure is a MailFromDomainStatus enum value
	MailFromDomainStatusTemporaryFailure = "TEMPORARY_FAILURE"
)

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.

View Source 
const (
	// TlsPolicyRequire is a TlsPolicy enum value
	TlsPolicyRequire = "REQUIRE"

	// TlsPolicyOptional is a TlsPolicy enum value
	TlsPolicyOptional = "OPTIONAL"
)

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.

View Source 
const (
	// WarmupStatusInProgress is a WarmupStatus enum value
	WarmupStatusInProgress = "IN_PROGRESS"

	// WarmupStatusDone is a WarmupStatus enum value
	WarmupStatusDone = "DONE"
)

The warmup status of a dedicated IP.

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"
)
View Source 
const (
	ServiceName = "Pinpoint Email" // Name of service.
	EndpointsID = "email"          // ID to lookup a service endpoint with.
	ServiceID   = "Pinpoint Email" // ServiceID is a unique identifier of a specific service.
)

Service information constants

Variables

This section is empty.

Functions

func BehaviorOnMxFailure_Values added in v1.34.3 

func BehaviorOnMxFailure_Values() []string

BehaviorOnMxFailure_Values returns all elements of the BehaviorOnMxFailure enum

func DeliverabilityDashboardAccountStatus_Values added in v1.34.3 

func DeliverabilityDashboardAccountStatus_Values() []string

DeliverabilityDashboardAccountStatus_Values returns all elements of the DeliverabilityDashboardAccountStatus enum

func DeliverabilityTestStatus_Values added in v1.34.3 

func DeliverabilityTestStatus_Values() []string

DeliverabilityTestStatus_Values returns all elements of the DeliverabilityTestStatus enum

func DimensionValueSource_Values added in v1.34.3 

func DimensionValueSource_Values() []string

DimensionValueSource_Values returns all elements of the DimensionValueSource enum

func DkimStatus_Values added in v1.34.3 

func DkimStatus_Values() []string

DkimStatus_Values returns all elements of the DkimStatus enum

func EventType_Values added in v1.34.3 

func EventType_Values() []string

EventType_Values returns all elements of the EventType enum

func IdentityType_Values added in v1.34.3 

func IdentityType_Values() []string

IdentityType_Values returns all elements of the IdentityType enum

func MailFromDomainStatus_Values added in v1.34.3 

func MailFromDomainStatus_Values() []string

MailFromDomainStatus_Values returns all elements of the MailFromDomainStatus enum

func TlsPolicy_Values added in v1.34.3 

func TlsPolicy_Values() []string

TlsPolicy_Values returns all elements of the TlsPolicy enum

func WarmupStatus_Values added in v1.34.3 

func WarmupStatus_Values() []string

WarmupStatus_Values returns all elements of the WarmupStatus enum

Types

type AccountSuspendedException added in v1.28.0 

type AccountSuspendedException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The message can't be sent because the account's ability to send email has been permanently restricted.

func (*AccountSuspendedException) Code added in v1.28.0 

func (s *AccountSuspendedException) Code() string

Code returns the exception type name.

func (*AccountSuspendedException) Error added in v1.28.0 

func (s *AccountSuspendedException) Error() string

func (AccountSuspendedException) GoString added in v1.28.0 

func (s AccountSuspendedException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AccountSuspendedException) Message added in v1.28.0 

func (s *AccountSuspendedException) Message() string

Message returns the exception's message.

func (*AccountSuspendedException) OrigErr added in v1.28.0 

func (s *AccountSuspendedException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*AccountSuspendedException) RequestID added in v1.28.0 

func (s *AccountSuspendedException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*AccountSuspendedException) StatusCode added in v1.28.0 

func (s *AccountSuspendedException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (AccountSuspendedException) String added in v1.28.0 

func (s AccountSuspendedException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AlreadyExistsException added in v1.28.0 

type AlreadyExistsException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The resource specified in your request already exists.

func (*AlreadyExistsException) Code added in v1.28.0 

func (s *AlreadyExistsException) Code() string

Code returns the exception type name.

func (*AlreadyExistsException) Error added in v1.28.0 

func (s *AlreadyExistsException) Error() string

func (AlreadyExistsException) GoString added in v1.28.0 

func (s AlreadyExistsException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AlreadyExistsException) Message added in v1.28.0 

func (s *AlreadyExistsException) Message() string

Message returns the exception's message.

func (*AlreadyExistsException) OrigErr added in v1.28.0 

func (s *AlreadyExistsException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*AlreadyExistsException) RequestID added in v1.28.0 

func (s *AlreadyExistsException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*AlreadyExistsException) StatusCode added in v1.28.0 

func (s *AlreadyExistsException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (AlreadyExistsException) String added in v1.28.0 

func (s AlreadyExistsException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type BadRequestException added in v1.28.0 

type BadRequestException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The input you provided is invalid.

func (*BadRequestException) Code added in v1.28.0 

func (s *BadRequestException) Code() string

Code returns the exception type name.

func (*BadRequestException) Error added in v1.28.0 

func (s *BadRequestException) Error() string

func (BadRequestException) GoString added in v1.28.0 

func (s BadRequestException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BadRequestException) Message added in v1.28.0 

func (s *BadRequestException) Message() string

Message returns the exception's message.

func (*BadRequestException) OrigErr added in v1.28.0 

func (s *BadRequestException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*BadRequestException) RequestID added in v1.28.0 

func (s *BadRequestException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*BadRequestException) StatusCode added in v1.28.0 

func (s *BadRequestException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (BadRequestException) String added in v1.28.0 

func (s BadRequestException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type BlacklistEntry added in v1.16.5 

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) GoString added in v1.16.5 

func (s BlacklistEntry) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BlacklistEntry) SetDescription added in v1.16.5 

func (s *BlacklistEntry) SetDescription(v string) *BlacklistEntry

SetDescription sets the Description field's value.

func (*BlacklistEntry) SetListingTime added in v1.16.5 

func (s *BlacklistEntry) SetListingTime(v time.Time) *BlacklistEntry

SetListingTime sets the ListingTime field's value.

func (*BlacklistEntry) SetRblName added in v1.16.5 

func (s *BlacklistEntry) SetRblName(v string) *BlacklistEntry

SetRblName sets the RblName field's value.

func (BlacklistEntry) String added in v1.16.5 

func (s BlacklistEntry) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s Body) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Body) SetHtml 

func (s *Body) SetHtml(v *Content) *Body

SetHtml sets the Html field's value.

func (*Body) SetText 

func (s *Body) SetText(v *Content) *Body

SetText sets the Text field's value.

func (Body) String 

func (s Body) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Body) Validate 

func (s *Body) Validate() error

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

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

func (s CloudWatchDestination) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CloudWatchDestination) SetDimensionConfigurations 

func (s *CloudWatchDestination) SetDimensionConfigurations(v []*CloudWatchDimensionConfiguration) *CloudWatchDestination

SetDimensionConfigurations sets the DimensionConfigurations field's value.

func (CloudWatchDestination) String 

func (s CloudWatchDestination) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 *string `type:"string" required:"true" enum:"DimensionValueSource"`
	// 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) GoString 

func (s CloudWatchDimensionConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CloudWatchDimensionConfiguration) SetDefaultDimensionValue 

func (s *CloudWatchDimensionConfiguration) SetDefaultDimensionValue(v string) *CloudWatchDimensionConfiguration

SetDefaultDimensionValue sets the DefaultDimensionValue field's value.

func (*CloudWatchDimensionConfiguration) SetDimensionName 

func (s *CloudWatchDimensionConfiguration) SetDimensionName(v string) *CloudWatchDimensionConfiguration

SetDimensionName sets the DimensionName field's value.

func (*CloudWatchDimensionConfiguration) SetDimensionValueSource 

func (s *CloudWatchDimensionConfiguration) SetDimensionValueSource(v string) *CloudWatchDimensionConfiguration

SetDimensionValueSource sets the DimensionValueSource field's value.

func (CloudWatchDimensionConfiguration) String 

func (s CloudWatchDimensionConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CloudWatchDimensionConfiguration) Validate 

func (s *CloudWatchDimensionConfiguration) Validate() error

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

type ConcurrentModificationException added in v1.28.0 

type ConcurrentModificationException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The resource is being modified by another operation or thread.

func (*ConcurrentModificationException) Code added in v1.28.0 

func (s *ConcurrentModificationException) Code() string

Code returns the exception type name.

func (*ConcurrentModificationException) Error added in v1.28.0 

func (s *ConcurrentModificationException) Error() string

func (ConcurrentModificationException) GoString added in v1.28.0 

func (s ConcurrentModificationException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ConcurrentModificationException) Message added in v1.28.0 

func (s *ConcurrentModificationException) Message() string

Message returns the exception's message.

func (*ConcurrentModificationException) OrigErr added in v1.28.0 

func (s *ConcurrentModificationException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ConcurrentModificationException) RequestID added in v1.28.0 

func (s *ConcurrentModificationException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ConcurrentModificationException) StatusCode added in v1.28.0 

func (s *ConcurrentModificationException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ConcurrentModificationException) String added in v1.28.0 

func (s ConcurrentModificationException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s Content) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Content) SetCharset 

func (s *Content) SetCharset(v string) *Content

SetCharset sets the Charset field's value.

func (*Content) SetData 

func (s *Content) SetData(v string) *Content

SetData sets the Data field's value.

func (Content) String 

func (s Content) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s CreateConfigurationSetEventDestinationInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateConfigurationSetEventDestinationInput) SetConfigurationSetName 

func (s *CreateConfigurationSetEventDestinationInput) SetConfigurationSetName(v string) *CreateConfigurationSetEventDestinationInput

SetConfigurationSetName sets the ConfigurationSetName field's value.

func (*CreateConfigurationSetEventDestinationInput) SetEventDestination 

func (s *CreateConfigurationSetEventDestinationInput) SetEventDestination(v *EventDestinationDefinition) *CreateConfigurationSetEventDestinationInput

SetEventDestination sets the EventDestination field's value.

func (*CreateConfigurationSetEventDestinationInput) SetEventDestinationName 

func (s *CreateConfigurationSetEventDestinationInput) SetEventDestinationName(v string) *CreateConfigurationSetEventDestinationInput

SetEventDestinationName sets the EventDestinationName field's value.

func (CreateConfigurationSetEventDestinationInput) String 

func (s CreateConfigurationSetEventDestinationInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s CreateConfigurationSetEventDestinationOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (CreateConfigurationSetEventDestinationOutput) String 

func (s CreateConfigurationSetEventDestinationOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s CreateConfigurationSetInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateConfigurationSetInput) SetConfigurationSetName 

func (s *CreateConfigurationSetInput) SetConfigurationSetName(v string) *CreateConfigurationSetInput

SetConfigurationSetName sets the ConfigurationSetName field's value.

func (*CreateConfigurationSetInput) SetDeliveryOptions 

func (s *CreateConfigurationSetInput) SetDeliveryOptions(v *DeliveryOptions) *CreateConfigurationSetInput

SetDeliveryOptions sets the DeliveryOptions field's value.

func (*CreateConfigurationSetInput) SetReputationOptions 

func (s *CreateConfigurationSetInput) SetReputationOptions(v *ReputationOptions) *CreateConfigurationSetInput

SetReputationOptions sets the ReputationOptions field's value.

func (*CreateConfigurationSetInput) SetSendingOptions 

func (s *CreateConfigurationSetInput) SetSendingOptions(v *SendingOptions) *CreateConfigurationSetInput

SetSendingOptions sets the SendingOptions field's value.

func (*CreateConfigurationSetInput) SetTags added in v1.19.5 

func (s *CreateConfigurationSetInput) SetTags(v []*Tag) *CreateConfigurationSetInput

SetTags sets the Tags field's value.

func (*CreateConfigurationSetInput) SetTrackingOptions 

func (s *CreateConfigurationSetInput) SetTrackingOptions(v *TrackingOptions) *CreateConfigurationSetInput

SetTrackingOptions sets the TrackingOptions field's value.

func (CreateConfigurationSetInput) String 

func (s CreateConfigurationSetInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s CreateConfigurationSetOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (CreateConfigurationSetOutput) String 

func (s CreateConfigurationSetOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s CreateDedicatedIpPoolInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateDedicatedIpPoolInput) SetPoolName 

func (s *CreateDedicatedIpPoolInput) SetPoolName(v string) *CreateDedicatedIpPoolInput

SetPoolName sets the PoolName field's value.

func (*CreateDedicatedIpPoolInput) SetTags added in v1.19.5 

func (s *CreateDedicatedIpPoolInput) SetTags(v []*Tag) *CreateDedicatedIpPoolInput

SetTags sets the Tags field's value.

func (CreateDedicatedIpPoolInput) String 

func (s CreateDedicatedIpPoolInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s CreateDedicatedIpPoolOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (CreateDedicatedIpPoolOutput) String 

func (s CreateDedicatedIpPoolOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateDeliverabilityTestReportInput added in v1.16.5 

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) GoString added in v1.16.5 

func (s CreateDeliverabilityTestReportInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateDeliverabilityTestReportInput) SetContent added in v1.16.5 

func (s *CreateDeliverabilityTestReportInput) SetContent(v *EmailContent) *CreateDeliverabilityTestReportInput

SetContent sets the Content field's value.

func (*CreateDeliverabilityTestReportInput) SetFromEmailAddress added in v1.16.5 

func (s *CreateDeliverabilityTestReportInput) SetFromEmailAddress(v string) *CreateDeliverabilityTestReportInput

SetFromEmailAddress sets the FromEmailAddress field's value.

func (*CreateDeliverabilityTestReportInput) SetReportName added in v1.16.5 

func (s *CreateDeliverabilityTestReportInput) SetReportName(v string) *CreateDeliverabilityTestReportInput

SetReportName sets the ReportName field's value.

func (*CreateDeliverabilityTestReportInput) SetTags added in v1.19.5 

func (s *CreateDeliverabilityTestReportInput) SetTags(v []*Tag) *CreateDeliverabilityTestReportInput

SetTags sets the Tags field's value.

func (CreateDeliverabilityTestReportInput) String added in v1.16.5 

func (s CreateDeliverabilityTestReportInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateDeliverabilityTestReportInput) Validate added in v1.16.5 

func (s *CreateDeliverabilityTestReportInput) Validate() error

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

type CreateDeliverabilityTestReportOutput added in v1.16.5 

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

	// 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) GoString added in v1.16.5 

func (s CreateDeliverabilityTestReportOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateDeliverabilityTestReportOutput) SetDeliverabilityTestStatus added in v1.16.5 

func (s *CreateDeliverabilityTestReportOutput) SetDeliverabilityTestStatus(v string) *CreateDeliverabilityTestReportOutput

SetDeliverabilityTestStatus sets the DeliverabilityTestStatus field's value.

func (*CreateDeliverabilityTestReportOutput) SetReportId added in v1.16.5 

func (s *CreateDeliverabilityTestReportOutput) SetReportId(v string) *CreateDeliverabilityTestReportOutput

SetReportId sets the ReportId field's value.

func (CreateDeliverabilityTestReportOutput) String added in v1.16.5 

func (s CreateDeliverabilityTestReportOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s CreateEmailIdentityInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateEmailIdentityInput) SetEmailIdentity 

func (s *CreateEmailIdentityInput) SetEmailIdentity(v string) *CreateEmailIdentityInput

SetEmailIdentity sets the EmailIdentity field's value.

func (*CreateEmailIdentityInput) SetTags added in v1.19.5 

func (s *CreateEmailIdentityInput) SetTags(v []*Tag) *CreateEmailIdentityInput

SetTags sets the Tags field's value.

func (CreateEmailIdentityInput) String 

func (s CreateEmailIdentityInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 *string `type:"string" enum:"IdentityType"`

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

func (s CreateEmailIdentityOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateEmailIdentityOutput) SetDkimAttributes 

func (s *CreateEmailIdentityOutput) SetDkimAttributes(v *DkimAttributes) *CreateEmailIdentityOutput

SetDkimAttributes sets the DkimAttributes field's value.

func (*CreateEmailIdentityOutput) SetIdentityType 

func (s *CreateEmailIdentityOutput) SetIdentityType(v string) *CreateEmailIdentityOutput

SetIdentityType sets the IdentityType field's value.

func (*CreateEmailIdentityOutput) SetVerifiedForSendingStatus 

func (s *CreateEmailIdentityOutput) SetVerifiedForSendingStatus(v bool) *CreateEmailIdentityOutput

SetVerifiedForSendingStatus sets the VerifiedForSendingStatus field's value.

func (CreateEmailIdentityOutput) String 

func (s CreateEmailIdentityOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DailyVolume added in v1.16.5 

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) GoString added in v1.16.5 

func (s DailyVolume) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DailyVolume) SetDomainIspPlacements added in v1.16.5 

func (s *DailyVolume) SetDomainIspPlacements(v []*DomainIspPlacement) *DailyVolume

SetDomainIspPlacements sets the DomainIspPlacements field's value.

func (*DailyVolume) SetStartDate added in v1.16.5 

func (s *DailyVolume) SetStartDate(v time.Time) *DailyVolume

SetStartDate sets the StartDate field's value.

func (*DailyVolume) SetVolumeStatistics added in v1.16.5 

func (s *DailyVolume) SetVolumeStatistics(v *VolumeStatistics) *DailyVolume

SetVolumeStatistics sets the VolumeStatistics field's value.

func (DailyVolume) String added in v1.16.5 

func (s DailyVolume) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

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

func (DedicatedIp) GoString 

func (s DedicatedIp) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DedicatedIp) SetIp 

func (s *DedicatedIp) SetIp(v string) *DedicatedIp

SetIp sets the Ip field's value.

func (*DedicatedIp) SetPoolName 

func (s *DedicatedIp) SetPoolName(v string) *DedicatedIp

SetPoolName sets the PoolName field's value.

func (*DedicatedIp) SetWarmupPercentage 

func (s *DedicatedIp) SetWarmupPercentage(v int64) *DedicatedIp

SetWarmupPercentage sets the WarmupPercentage field's value.

func (*DedicatedIp) SetWarmupStatus 

func (s *DedicatedIp) SetWarmupStatus(v string) *DedicatedIp

SetWarmupStatus sets the WarmupStatus field's value.

func (DedicatedIp) String 

func (s DedicatedIp) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s DeleteConfigurationSetEventDestinationInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteConfigurationSetEventDestinationInput) SetConfigurationSetName 

func (s *DeleteConfigurationSetEventDestinationInput) SetConfigurationSetName(v string) *DeleteConfigurationSetEventDestinationInput

SetConfigurationSetName sets the ConfigurationSetName field's value.

func (*DeleteConfigurationSetEventDestinationInput) SetEventDestinationName 

func (s *DeleteConfigurationSetEventDestinationInput) SetEventDestinationName(v string) *DeleteConfigurationSetEventDestinationInput

SetEventDestinationName sets the EventDestinationName field's value.

func (DeleteConfigurationSetEventDestinationInput) String 

func (s DeleteConfigurationSetEventDestinationInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s DeleteConfigurationSetEventDestinationOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteConfigurationSetEventDestinationOutput) String 

func (s DeleteConfigurationSetEventDestinationOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s DeleteConfigurationSetInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteConfigurationSetInput) SetConfigurationSetName 

func (s *DeleteConfigurationSetInput) SetConfigurationSetName(v string) *DeleteConfigurationSetInput

SetConfigurationSetName sets the ConfigurationSetName field's value.

func (DeleteConfigurationSetInput) String 

func (s DeleteConfigurationSetInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s DeleteConfigurationSetOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteConfigurationSetOutput) String 

func (s DeleteConfigurationSetOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s DeleteDedicatedIpPoolInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteDedicatedIpPoolInput) SetPoolName 

func (s *DeleteDedicatedIpPoolInput) SetPoolName(v string) *DeleteDedicatedIpPoolInput

SetPoolName sets the PoolName field's value.

func (DeleteDedicatedIpPoolInput) String 

func (s DeleteDedicatedIpPoolInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s DeleteDedicatedIpPoolOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteDedicatedIpPoolOutput) String 

func (s DeleteDedicatedIpPoolOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s DeleteEmailIdentityInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteEmailIdentityInput) SetEmailIdentity 

func (s *DeleteEmailIdentityInput) SetEmailIdentity(v string) *DeleteEmailIdentityInput

SetEmailIdentity sets the EmailIdentity field's value.

func (DeleteEmailIdentityInput) String 

func (s DeleteEmailIdentityInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s DeleteEmailIdentityOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteEmailIdentityOutput) String 

func (s DeleteEmailIdentityOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeliverabilityTestReport added in v1.16.5 

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

	// 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) GoString added in v1.16.5 

func (s DeliverabilityTestReport) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeliverabilityTestReport) SetCreateDate added in v1.16.5 

func (s *DeliverabilityTestReport) SetCreateDate(v time.Time) *DeliverabilityTestReport

SetCreateDate sets the CreateDate field's value.

func (*DeliverabilityTestReport) SetDeliverabilityTestStatus added in v1.16.5 

func (s *DeliverabilityTestReport) SetDeliverabilityTestStatus(v string) *DeliverabilityTestReport

SetDeliverabilityTestStatus sets the DeliverabilityTestStatus field's value.

func (*DeliverabilityTestReport) SetFromEmailAddress added in v1.16.5 

func (s *DeliverabilityTestReport) SetFromEmailAddress(v string) *DeliverabilityTestReport

SetFromEmailAddress sets the FromEmailAddress field's value.

func (*DeliverabilityTestReport) SetReportId added in v1.16.5 

func (s *DeliverabilityTestReport) SetReportId(v string) *DeliverabilityTestReport

SetReportId sets the ReportId field's value.

func (*DeliverabilityTestReport) SetReportName added in v1.16.5 

func (s *DeliverabilityTestReport) SetReportName(v string) *DeliverabilityTestReport

SetReportName sets the ReportName field's value.

func (*DeliverabilityTestReport) SetSubject added in v1.16.5 

func (s *DeliverabilityTestReport) SetSubject(v string) *DeliverabilityTestReport

SetSubject sets the Subject field's value.

func (DeliverabilityTestReport) String added in v1.16.5 

func (s DeliverabilityTestReport) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

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

func (DeliveryOptions) GoString 

func (s DeliveryOptions) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeliveryOptions) SetSendingPoolName 

func (s *DeliveryOptions) SetSendingPoolName(v string) *DeliveryOptions

SetSendingPoolName sets the SendingPoolName field's value.

func (*DeliveryOptions) SetTlsPolicy added in v1.19.41 

func (s *DeliveryOptions) SetTlsPolicy(v string) *DeliveryOptions

SetTlsPolicy sets the TlsPolicy field's value.

func (DeliveryOptions) String 

func (s DeliveryOptions) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s Destination) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Destination) SetBccAddresses 

func (s *Destination) SetBccAddresses(v []*string) *Destination

SetBccAddresses sets the BccAddresses field's value.

func (*Destination) SetCcAddresses 

func (s *Destination) SetCcAddresses(v []*string) *Destination

SetCcAddresses sets the CcAddresses field's value.

func (*Destination) SetToAddresses 

func (s *Destination) SetToAddresses(v []*string) *Destination

SetToAddresses sets the ToAddresses field's value.

func (Destination) String 

func (s Destination) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 *string `type:"string" enum:"DkimStatus"`

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

func (s DkimAttributes) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DkimAttributes) SetSigningEnabled 

func (s *DkimAttributes) SetSigningEnabled(v bool) *DkimAttributes

SetSigningEnabled sets the SigningEnabled field's value.

func (*DkimAttributes) SetStatus 

func (s *DkimAttributes) SetStatus(v string) *DkimAttributes

SetStatus sets the Status field's value.

func (*DkimAttributes) SetTokens 

func (s *DkimAttributes) SetTokens(v []*string) *DkimAttributes

SetTokens sets the Tokens field's value.

func (DkimAttributes) String 

func (s DkimAttributes) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DomainDeliverabilityCampaign added in v1.19.39 

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) GoString added in v1.19.39 

func (s DomainDeliverabilityCampaign) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DomainDeliverabilityCampaign) SetCampaignId added in v1.19.39 

func (s *DomainDeliverabilityCampaign) SetCampaignId(v string) *DomainDeliverabilityCampaign

SetCampaignId sets the CampaignId field's value.

func (*DomainDeliverabilityCampaign) SetDeleteRate added in v1.19.39 

func (s *DomainDeliverabilityCampaign) SetDeleteRate(v float64) *DomainDeliverabilityCampaign

SetDeleteRate sets the DeleteRate field's value.

func (*DomainDeliverabilityCampaign) SetEsps added in v1.19.39 

func (s *DomainDeliverabilityCampaign) SetEsps(v []*string) *DomainDeliverabilityCampaign

SetEsps sets the Esps field's value.

func (*DomainDeliverabilityCampaign) SetFirstSeenDateTime added in v1.19.39 

func (s *DomainDeliverabilityCampaign) SetFirstSeenDateTime(v time.Time) *DomainDeliverabilityCampaign

SetFirstSeenDateTime sets the FirstSeenDateTime field's value.

func (*DomainDeliverabilityCampaign) SetFromAddress added in v1.19.39 

func (s *DomainDeliverabilityCampaign) SetFromAddress(v string) *DomainDeliverabilityCampaign

SetFromAddress sets the FromAddress field's value.

func (*DomainDeliverabilityCampaign) SetImageUrl added in v1.19.39 

func (s *DomainDeliverabilityCampaign) SetImageUrl(v string) *DomainDeliverabilityCampaign

SetImageUrl sets the ImageUrl field's value.

func (*DomainDeliverabilityCampaign) SetInboxCount added in v1.19.39 

func (s *DomainDeliverabilityCampaign) SetInboxCount(v int64) *DomainDeliverabilityCampaign

SetInboxCount sets the InboxCount field's value.

func (*DomainDeliverabilityCampaign) SetLastSeenDateTime added in v1.19.39 

func (s *DomainDeliverabilityCampaign) SetLastSeenDateTime(v time.Time) *DomainDeliverabilityCampaign

SetLastSeenDateTime sets the LastSeenDateTime field's value.

func (*DomainDeliverabilityCampaign) SetProjectedVolume added in v1.19.39 

func (s *DomainDeliverabilityCampaign) SetProjectedVolume(v int64) *DomainDeliverabilityCampaign

SetProjectedVolume sets the ProjectedVolume field's value.

func (*DomainDeliverabilityCampaign) SetReadDeleteRate added in v1.19.39 

func (s *DomainDeliverabilityCampaign) SetReadDeleteRate(v float64) *DomainDeliverabilityCampaign

SetReadDeleteRate sets the ReadDeleteRate field's value.

func (*DomainDeliverabilityCampaign) SetReadRate added in v1.19.39 

func (s *DomainDeliverabilityCampaign) SetReadRate(v float64) *DomainDeliverabilityCampaign

SetReadRate sets the ReadRate field's value.

func (*DomainDeliverabilityCampaign) SetSendingIps added in v1.19.39 

func (s *DomainDeliverabilityCampaign) SetSendingIps(v []*string) *DomainDeliverabilityCampaign

SetSendingIps sets the SendingIps field's value.

func (*DomainDeliverabilityCampaign) SetSpamCount added in v1.19.39 

func (s *DomainDeliverabilityCampaign) SetSpamCount(v int64) *DomainDeliverabilityCampaign

SetSpamCount sets the SpamCount field's value.

func (*DomainDeliverabilityCampaign) SetSubject added in v1.19.39 

func (s *DomainDeliverabilityCampaign) SetSubject(v string) *DomainDeliverabilityCampaign

SetSubject sets the Subject field's value.

func (DomainDeliverabilityCampaign) String added in v1.19.39 

func (s DomainDeliverabilityCampaign) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DomainDeliverabilityTrackingOption added in v1.19.39 

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) GoString added in v1.19.39 

func (s DomainDeliverabilityTrackingOption) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DomainDeliverabilityTrackingOption) SetDomain added in v1.19.39 

func (s *DomainDeliverabilityTrackingOption) SetDomain(v string) *DomainDeliverabilityTrackingOption

SetDomain sets the Domain field's value.

func (*DomainDeliverabilityTrackingOption) SetInboxPlacementTrackingOption added in v1.19.39 

func (s *DomainDeliverabilityTrackingOption) SetInboxPlacementTrackingOption(v *InboxPlacementTrackingOption) *DomainDeliverabilityTrackingOption

SetInboxPlacementTrackingOption sets the InboxPlacementTrackingOption field's value.

func (*DomainDeliverabilityTrackingOption) SetSubscriptionStartDate added in v1.19.39 

func (s *DomainDeliverabilityTrackingOption) SetSubscriptionStartDate(v time.Time) *DomainDeliverabilityTrackingOption

SetSubscriptionStartDate sets the SubscriptionStartDate field's value.

func (DomainDeliverabilityTrackingOption) String added in v1.19.39 

func (s DomainDeliverabilityTrackingOption) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DomainIspPlacement added in v1.16.5 

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) GoString added in v1.16.5 

func (s DomainIspPlacement) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DomainIspPlacement) SetInboxPercentage added in v1.16.5 

func (s *DomainIspPlacement) SetInboxPercentage(v float64) *DomainIspPlacement

SetInboxPercentage sets the InboxPercentage field's value.

func (*DomainIspPlacement) SetInboxRawCount added in v1.16.5 

func (s *DomainIspPlacement) SetInboxRawCount(v int64) *DomainIspPlacement

SetInboxRawCount sets the InboxRawCount field's value.

func (*DomainIspPlacement) SetIspName added in v1.16.5 

func (s *DomainIspPlacement) SetIspName(v string) *DomainIspPlacement

SetIspName sets the IspName field's value.

func (*DomainIspPlacement) SetSpamPercentage added in v1.16.5 

func (s *DomainIspPlacement) SetSpamPercentage(v float64) *DomainIspPlacement

SetSpamPercentage sets the SpamPercentage field's value.

func (*DomainIspPlacement) SetSpamRawCount added in v1.16.5 

func (s *DomainIspPlacement) SetSpamRawCount(v int64) *DomainIspPlacement

SetSpamRawCount sets the SpamRawCount field's value.

func (DomainIspPlacement) String added in v1.16.5 

func (s DomainIspPlacement) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s EmailContent) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EmailContent) SetRaw 

func (s *EmailContent) SetRaw(v *RawMessage) *EmailContent

SetRaw sets the Raw field's value.

func (*EmailContent) SetSimple 

func (s *EmailContent) SetSimple(v *Message) *EmailContent

SetSimple sets the Simple field's value.

func (*EmailContent) SetTemplate added in v1.25.7 

func (s *EmailContent) SetTemplate(v *Template) *EmailContent

SetTemplate sets the Template field's value.

func (EmailContent) String 

func (s EmailContent) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 []*string `type:"list" required:"true" enum:"EventType"`

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

func (s EventDestination) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EventDestination) SetCloudWatchDestination 

func (s *EventDestination) SetCloudWatchDestination(v *CloudWatchDestination) *EventDestination

SetCloudWatchDestination sets the CloudWatchDestination field's value.

func (*EventDestination) SetEnabled 

func (s *EventDestination) SetEnabled(v bool) *EventDestination

SetEnabled sets the Enabled field's value.

func (*EventDestination) SetKinesisFirehoseDestination 

func (s *EventDestination) SetKinesisFirehoseDestination(v *KinesisFirehoseDestination) *EventDestination

SetKinesisFirehoseDestination sets the KinesisFirehoseDestination field's value.

func (*EventDestination) SetMatchingEventTypes 

func (s *EventDestination) SetMatchingEventTypes(v []*string) *EventDestination

SetMatchingEventTypes sets the MatchingEventTypes field's value.

func (*EventDestination) SetName 

func (s *EventDestination) SetName(v string) *EventDestination

SetName sets the Name field's value.

func (*EventDestination) SetPinpointDestination 

func (s *EventDestination) SetPinpointDestination(v *PinpointDestination) *EventDestination

SetPinpointDestination sets the PinpointDestination field's value.

func (*EventDestination) SetSnsDestination 

func (s *EventDestination) SetSnsDestination(v *SnsDestination) *EventDestination

SetSnsDestination sets the SnsDestination field's value.

func (EventDestination) String 

func (s EventDestination) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 []*string `type:"list" enum:"EventType"`

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

func (s EventDestinationDefinition) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EventDestinationDefinition) SetCloudWatchDestination 

func (s *EventDestinationDefinition) SetCloudWatchDestination(v *CloudWatchDestination) *EventDestinationDefinition

SetCloudWatchDestination sets the CloudWatchDestination field's value.

func (*EventDestinationDefinition) SetEnabled 

func (s *EventDestinationDefinition) SetEnabled(v bool) *EventDestinationDefinition

SetEnabled sets the Enabled field's value.

func (*EventDestinationDefinition) SetKinesisFirehoseDestination 

func (s *EventDestinationDefinition) SetKinesisFirehoseDestination(v *KinesisFirehoseDestination) *EventDestinationDefinition

SetKinesisFirehoseDestination sets the KinesisFirehoseDestination field's value.

func (*EventDestinationDefinition) SetMatchingEventTypes 

func (s *EventDestinationDefinition) SetMatchingEventTypes(v []*string) *EventDestinationDefinition

SetMatchingEventTypes sets the MatchingEventTypes field's value.

func (*EventDestinationDefinition) SetPinpointDestination 

func (s *EventDestinationDefinition) SetPinpointDestination(v *PinpointDestination) *EventDestinationDefinition

SetPinpointDestination sets the PinpointDestination field's value.

func (*EventDestinationDefinition) SetSnsDestination 

func (s *EventDestinationDefinition) SetSnsDestination(v *SnsDestination) *EventDestinationDefinition

SetSnsDestination sets the SnsDestination field's value.

func (EventDestinationDefinition) String 

func (s EventDestinationDefinition) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EventDestinationDefinition) Validate 

func (s *EventDestinationDefinition) Validate() error

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

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

func (s GetAccountInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (GetAccountInput) String 

func (s GetAccountInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s GetAccountOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetAccountOutput) SetDedicatedIpAutoWarmupEnabled 

func (s *GetAccountOutput) SetDedicatedIpAutoWarmupEnabled(v bool) *GetAccountOutput

SetDedicatedIpAutoWarmupEnabled sets the DedicatedIpAutoWarmupEnabled field's value.

func (*GetAccountOutput) SetEnforcementStatus 

func (s *GetAccountOutput) SetEnforcementStatus(v string) *GetAccountOutput

SetEnforcementStatus sets the EnforcementStatus field's value.

func (*GetAccountOutput) SetProductionAccessEnabled 

func (s *GetAccountOutput) SetProductionAccessEnabled(v bool) *GetAccountOutput

SetProductionAccessEnabled sets the ProductionAccessEnabled field's value.

func (*GetAccountOutput) SetSendQuota 

func (s *GetAccountOutput) SetSendQuota(v *SendQuota) *GetAccountOutput

SetSendQuota sets the SendQuota field's value.

func (*GetAccountOutput) SetSendingEnabled 

func (s *GetAccountOutput) SetSendingEnabled(v bool) *GetAccountOutput

SetSendingEnabled sets the SendingEnabled field's value.

func (GetAccountOutput) String 

func (s GetAccountOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetBlacklistReportsInput added in v1.16.5 

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) GoString added in v1.16.5 

func (s GetBlacklistReportsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetBlacklistReportsInput) SetBlacklistItemNames added in v1.16.5 

func (s *GetBlacklistReportsInput) SetBlacklistItemNames(v []*string) *GetBlacklistReportsInput

SetBlacklistItemNames sets the BlacklistItemNames field's value.

func (GetBlacklistReportsInput) String added in v1.16.5 

func (s GetBlacklistReportsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetBlacklistReportsInput) Validate added in v1.16.5 

func (s *GetBlacklistReportsInput) Validate() error

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

type GetBlacklistReportsOutput added in v1.16.5 

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) GoString added in v1.16.5 

func (s GetBlacklistReportsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetBlacklistReportsOutput) SetBlacklistReport added in v1.16.5 

func (s *GetBlacklistReportsOutput) SetBlacklistReport(v map[string][]*BlacklistEntry) *GetBlacklistReportsOutput

SetBlacklistReport sets the BlacklistReport field's value.

func (GetBlacklistReportsOutput) String added in v1.16.5 

func (s GetBlacklistReportsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s GetConfigurationSetEventDestinationsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetConfigurationSetEventDestinationsInput) SetConfigurationSetName 

func (s *GetConfigurationSetEventDestinationsInput) SetConfigurationSetName(v string) *GetConfigurationSetEventDestinationsInput

SetConfigurationSetName sets the ConfigurationSetName field's value.

func (GetConfigurationSetEventDestinationsInput) String 

func (s GetConfigurationSetEventDestinationsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s GetConfigurationSetEventDestinationsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetConfigurationSetEventDestinationsOutput) SetEventDestinations 

func (s *GetConfigurationSetEventDestinationsOutput) SetEventDestinations(v []*EventDestination) *GetConfigurationSetEventDestinationsOutput

SetEventDestinations sets the EventDestinations field's value.

func (GetConfigurationSetEventDestinationsOutput) String 

func (s GetConfigurationSetEventDestinationsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s GetConfigurationSetInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetConfigurationSetInput) SetConfigurationSetName 

func (s *GetConfigurationSetInput) SetConfigurationSetName(v string) *GetConfigurationSetInput

SetConfigurationSetName sets the ConfigurationSetName field's value.

func (GetConfigurationSetInput) String 

func (s GetConfigurationSetInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s GetConfigurationSetOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetConfigurationSetOutput) SetConfigurationSetName 

func (s *GetConfigurationSetOutput) SetConfigurationSetName(v string) *GetConfigurationSetOutput

SetConfigurationSetName sets the ConfigurationSetName field's value.

func (*GetConfigurationSetOutput) SetDeliveryOptions 

func (s *GetConfigurationSetOutput) SetDeliveryOptions(v *DeliveryOptions) *GetConfigurationSetOutput

SetDeliveryOptions sets the DeliveryOptions field's value.

func (*GetConfigurationSetOutput) SetReputationOptions 

func (s *GetConfigurationSetOutput) SetReputationOptions(v *ReputationOptions) *GetConfigurationSetOutput

SetReputationOptions sets the ReputationOptions field's value.

func (*GetConfigurationSetOutput) SetSendingOptions 

func (s *GetConfigurationSetOutput) SetSendingOptions(v *SendingOptions) *GetConfigurationSetOutput

SetSendingOptions sets the SendingOptions field's value.

func (*GetConfigurationSetOutput) SetTags added in v1.19.39 

func (s *GetConfigurationSetOutput) SetTags(v []*Tag) *GetConfigurationSetOutput

SetTags sets the Tags field's value.

func (*GetConfigurationSetOutput) SetTrackingOptions 

func (s *GetConfigurationSetOutput) SetTrackingOptions(v *TrackingOptions) *GetConfigurationSetOutput

SetTrackingOptions sets the TrackingOptions field's value.

func (GetConfigurationSetOutput) String 

func (s GetConfigurationSetOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s GetDedicatedIpInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetDedicatedIpInput) SetIp 

func (s *GetDedicatedIpInput) SetIp(v string) *GetDedicatedIpInput

SetIp sets the Ip field's value.

func (GetDedicatedIpInput) String 

func (s GetDedicatedIpInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s GetDedicatedIpOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetDedicatedIpOutput) SetDedicatedIp 

func (s *GetDedicatedIpOutput) SetDedicatedIp(v *DedicatedIp) *GetDedicatedIpOutput

SetDedicatedIp sets the DedicatedIp field's value.

func (GetDedicatedIpOutput) String 

func (s GetDedicatedIpOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s GetDedicatedIpsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetDedicatedIpsInput) SetNextToken 

func (s *GetDedicatedIpsInput) SetNextToken(v string) *GetDedicatedIpsInput

SetNextToken sets the NextToken field's value.

func (*GetDedicatedIpsInput) SetPageSize 

func (s *GetDedicatedIpsInput) SetPageSize(v int64) *GetDedicatedIpsInput

SetPageSize sets the PageSize field's value.

func (*GetDedicatedIpsInput) SetPoolName 

func (s *GetDedicatedIpsInput) SetPoolName(v string) *GetDedicatedIpsInput

SetPoolName sets the PoolName field's value.

func (GetDedicatedIpsInput) String 

func (s GetDedicatedIpsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s GetDedicatedIpsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetDedicatedIpsOutput) SetDedicatedIps 

func (s *GetDedicatedIpsOutput) SetDedicatedIps(v []*DedicatedIp) *GetDedicatedIpsOutput

SetDedicatedIps sets the DedicatedIps field's value.

func (*GetDedicatedIpsOutput) SetNextToken 

func (s *GetDedicatedIpsOutput) SetNextToken(v string) *GetDedicatedIpsOutput

SetNextToken sets the NextToken field's value.

func (GetDedicatedIpsOutput) String 

func (s GetDedicatedIpsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetDeliverabilityDashboardOptionsInput added in v1.16.5 

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) GoString added in v1.16.5 

func (s GetDeliverabilityDashboardOptionsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (GetDeliverabilityDashboardOptionsInput) String added in v1.16.5 

func (s GetDeliverabilityDashboardOptionsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetDeliverabilityDashboardOptionsOutput added in v1.16.5 

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

	// 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) GoString added in v1.16.5 

func (s GetDeliverabilityDashboardOptionsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetDeliverabilityDashboardOptionsOutput) SetAccountStatus added in v1.19.39 

func (s *GetDeliverabilityDashboardOptionsOutput) SetAccountStatus(v string) *GetDeliverabilityDashboardOptionsOutput

SetAccountStatus sets the AccountStatus field's value.

func (*GetDeliverabilityDashboardOptionsOutput) SetActiveSubscribedDomains added in v1.19.39 

func (s *GetDeliverabilityDashboardOptionsOutput) SetActiveSubscribedDomains(v []*DomainDeliverabilityTrackingOption) *GetDeliverabilityDashboardOptionsOutput

SetActiveSubscribedDomains sets the ActiveSubscribedDomains field's value.

func (*GetDeliverabilityDashboardOptionsOutput) SetDashboardEnabled added in v1.16.5 

func (s *GetDeliverabilityDashboardOptionsOutput) SetDashboardEnabled(v bool) *GetDeliverabilityDashboardOptionsOutput

SetDashboardEnabled sets the DashboardEnabled field's value.

func (*GetDeliverabilityDashboardOptionsOutput) SetPendingExpirationSubscribedDomains added in v1.19.39 

func (s *GetDeliverabilityDashboardOptionsOutput) SetPendingExpirationSubscribedDomains(v []*DomainDeliverabilityTrackingOption) *GetDeliverabilityDashboardOptionsOutput

SetPendingExpirationSubscribedDomains sets the PendingExpirationSubscribedDomains field's value.

func (*GetDeliverabilityDashboardOptionsOutput) SetSubscriptionExpiryDate added in v1.19.39 

func (s *GetDeliverabilityDashboardOptionsOutput) SetSubscriptionExpiryDate(v time.Time) *GetDeliverabilityDashboardOptionsOutput

SetSubscriptionExpiryDate sets the SubscriptionExpiryDate field's value.

func (GetDeliverabilityDashboardOptionsOutput) String added in v1.16.5 

func (s GetDeliverabilityDashboardOptionsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetDeliverabilityTestReportInput added in v1.16.5 

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) GoString added in v1.16.5 

func (s GetDeliverabilityTestReportInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetDeliverabilityTestReportInput) SetReportId added in v1.16.5 

func (s *GetDeliverabilityTestReportInput) SetReportId(v string) *GetDeliverabilityTestReportInput

SetReportId sets the ReportId field's value.

func (GetDeliverabilityTestReportInput) String added in v1.16.5 

func (s GetDeliverabilityTestReportInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetDeliverabilityTestReportInput) Validate added in v1.16.5 

func (s *GetDeliverabilityTestReportInput) Validate() error

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

type GetDeliverabilityTestReportOutput added in v1.16.5 

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) GoString added in v1.16.5 

func (s GetDeliverabilityTestReportOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetDeliverabilityTestReportOutput) SetDeliverabilityTestReport added in v1.16.5 

func (s *GetDeliverabilityTestReportOutput) SetDeliverabilityTestReport(v *DeliverabilityTestReport) *GetDeliverabilityTestReportOutput

SetDeliverabilityTestReport sets the DeliverabilityTestReport field's value.

func (*GetDeliverabilityTestReportOutput) SetIspPlacements added in v1.16.5 

func (s *GetDeliverabilityTestReportOutput) SetIspPlacements(v []*IspPlacement) *GetDeliverabilityTestReportOutput

SetIspPlacements sets the IspPlacements field's value.

func (*GetDeliverabilityTestReportOutput) SetMessage added in v1.16.5 

func (s *GetDeliverabilityTestReportOutput) SetMessage(v string) *GetDeliverabilityTestReportOutput

SetMessage sets the Message field's value.

func (*GetDeliverabilityTestReportOutput) SetOverallPlacement added in v1.16.5 

func (s *GetDeliverabilityTestReportOutput) SetOverallPlacement(v *PlacementStatistics) *GetDeliverabilityTestReportOutput

SetOverallPlacement sets the OverallPlacement field's value.

func (*GetDeliverabilityTestReportOutput) SetTags added in v1.19.39 

func (s *GetDeliverabilityTestReportOutput) SetTags(v []*Tag) *GetDeliverabilityTestReportOutput

SetTags sets the Tags field's value.

func (GetDeliverabilityTestReportOutput) String added in v1.16.5 

func (s GetDeliverabilityTestReportOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetDomainDeliverabilityCampaignInput added in v1.19.39 

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) GoString added in v1.19.39 

func (s GetDomainDeliverabilityCampaignInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetDomainDeliverabilityCampaignInput) SetCampaignId added in v1.19.39 

func (s *GetDomainDeliverabilityCampaignInput) SetCampaignId(v string) *GetDomainDeliverabilityCampaignInput

SetCampaignId sets the CampaignId field's value.

func (GetDomainDeliverabilityCampaignInput) String added in v1.19.39 

func (s GetDomainDeliverabilityCampaignInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetDomainDeliverabilityCampaignInput) Validate added in v1.19.39 

func (s *GetDomainDeliverabilityCampaignInput) Validate() error

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

type GetDomainDeliverabilityCampaignOutput added in v1.19.39 

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) GoString added in v1.19.39 

func (s GetDomainDeliverabilityCampaignOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetDomainDeliverabilityCampaignOutput) SetDomainDeliverabilityCampaign added in v1.19.39 

func (s *GetDomainDeliverabilityCampaignOutput) SetDomainDeliverabilityCampaign(v *DomainDeliverabilityCampaign) *GetDomainDeliverabilityCampaignOutput

SetDomainDeliverabilityCampaign sets the DomainDeliverabilityCampaign field's value.

func (GetDomainDeliverabilityCampaignOutput) String added in v1.19.39 

func (s GetDomainDeliverabilityCampaignOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetDomainStatisticsReportInput added in v1.16.5 

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) GoString added in v1.16.5 

func (s GetDomainStatisticsReportInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetDomainStatisticsReportInput) SetDomain added in v1.16.5 

func (s *GetDomainStatisticsReportInput) SetDomain(v string) *GetDomainStatisticsReportInput

SetDomain sets the Domain field's value.

func (*GetDomainStatisticsReportInput) SetEndDate added in v1.16.5 

func (s *GetDomainStatisticsReportInput) SetEndDate(v time.Time) *GetDomainStatisticsReportInput

SetEndDate sets the EndDate field's value.

func (*GetDomainStatisticsReportInput) SetStartDate added in v1.16.5 

func (s *GetDomainStatisticsReportInput) SetStartDate(v time.Time) *GetDomainStatisticsReportInput

SetStartDate sets the StartDate field's value.

func (GetDomainStatisticsReportInput) String added in v1.16.5 

func (s GetDomainStatisticsReportInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetDomainStatisticsReportInput) Validate added in v1.16.5 

func (s *GetDomainStatisticsReportInput) Validate() error

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

type GetDomainStatisticsReportOutput added in v1.16.5 

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) GoString added in v1.16.5 

func (s GetDomainStatisticsReportOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetDomainStatisticsReportOutput) SetDailyVolumes added in v1.16.5 

func (s *GetDomainStatisticsReportOutput) SetDailyVolumes(v []*DailyVolume) *GetDomainStatisticsReportOutput

SetDailyVolumes sets the DailyVolumes field's value.

func (*GetDomainStatisticsReportOutput) SetOverallVolume added in v1.16.5 

func (s *GetDomainStatisticsReportOutput) SetOverallVolume(v *OverallVolume) *GetDomainStatisticsReportOutput

SetOverallVolume sets the OverallVolume field's value.

func (GetDomainStatisticsReportOutput) String added in v1.16.5 

func (s GetDomainStatisticsReportOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s GetEmailIdentityInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetEmailIdentityInput) SetEmailIdentity 

func (s *GetEmailIdentityInput) SetEmailIdentity(v string) *GetEmailIdentityInput

SetEmailIdentity sets the EmailIdentity field's value.

func (GetEmailIdentityInput) String 

func (s GetEmailIdentityInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 *string `type:"string" enum:"IdentityType"`

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

func (s GetEmailIdentityOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetEmailIdentityOutput) SetDkimAttributes 

func (s *GetEmailIdentityOutput) SetDkimAttributes(v *DkimAttributes) *GetEmailIdentityOutput

SetDkimAttributes sets the DkimAttributes field's value.

func (*GetEmailIdentityOutput) SetFeedbackForwardingStatus 

func (s *GetEmailIdentityOutput) SetFeedbackForwardingStatus(v bool) *GetEmailIdentityOutput

SetFeedbackForwardingStatus sets the FeedbackForwardingStatus field's value.

func (*GetEmailIdentityOutput) SetIdentityType 

func (s *GetEmailIdentityOutput) SetIdentityType(v string) *GetEmailIdentityOutput

SetIdentityType sets the IdentityType field's value.

func (*GetEmailIdentityOutput) SetMailFromAttributes 

func (s *GetEmailIdentityOutput) SetMailFromAttributes(v *MailFromAttributes) *GetEmailIdentityOutput

SetMailFromAttributes sets the MailFromAttributes field's value.

func (*GetEmailIdentityOutput) SetTags added in v1.19.39 

func (s *GetEmailIdentityOutput) SetTags(v []*Tag) *GetEmailIdentityOutput

SetTags sets the Tags field's value.

func (*GetEmailIdentityOutput) SetVerifiedForSendingStatus 

func (s *GetEmailIdentityOutput) SetVerifiedForSendingStatus(v bool) *GetEmailIdentityOutput

SetVerifiedForSendingStatus sets the VerifiedForSendingStatus field's value.

func (GetEmailIdentityOutput) String 

func (s GetEmailIdentityOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 *string `type:"string" enum:"IdentityType"`

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

func (s IdentityInfo) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*IdentityInfo) SetIdentityName 

func (s *IdentityInfo) SetIdentityName(v string) *IdentityInfo

SetIdentityName sets the IdentityName field's value.

func (*IdentityInfo) SetIdentityType 

func (s *IdentityInfo) SetIdentityType(v string) *IdentityInfo

SetIdentityType sets the IdentityType field's value.

func (*IdentityInfo) SetSendingEnabled 

func (s *IdentityInfo) SetSendingEnabled(v bool) *IdentityInfo

SetSendingEnabled sets the SendingEnabled field's value.

func (IdentityInfo) String 

func (s IdentityInfo) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InboxPlacementTrackingOption added in v1.19.39 

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) GoString added in v1.19.39 

func (s InboxPlacementTrackingOption) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InboxPlacementTrackingOption) SetGlobal added in v1.19.39 

func (s *InboxPlacementTrackingOption) SetGlobal(v bool) *InboxPlacementTrackingOption

SetGlobal sets the Global field's value.

func (*InboxPlacementTrackingOption) SetTrackedIsps added in v1.19.39 

func (s *InboxPlacementTrackingOption) SetTrackedIsps(v []*string) *InboxPlacementTrackingOption

SetTrackedIsps sets the TrackedIsps field's value.

func (InboxPlacementTrackingOption) String added in v1.19.39 

func (s InboxPlacementTrackingOption) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type IspPlacement added in v1.16.5 

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) GoString added in v1.16.5 

func (s IspPlacement) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*IspPlacement) SetIspName added in v1.16.5 

func (s *IspPlacement) SetIspName(v string) *IspPlacement

SetIspName sets the IspName field's value.

func (*IspPlacement) SetPlacementStatistics added in v1.16.5 

func (s *IspPlacement) SetPlacementStatistics(v *PlacementStatistics) *IspPlacement

SetPlacementStatistics sets the PlacementStatistics field's value.

func (IspPlacement) String added in v1.16.5 

func (s IspPlacement) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s KinesisFirehoseDestination) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*KinesisFirehoseDestination) SetDeliveryStreamArn 

func (s *KinesisFirehoseDestination) SetDeliveryStreamArn(v string) *KinesisFirehoseDestination

SetDeliveryStreamArn sets the DeliveryStreamArn field's value.

func (*KinesisFirehoseDestination) SetIamRoleArn 

func (s *KinesisFirehoseDestination) SetIamRoleArn(v string) *KinesisFirehoseDestination

SetIamRoleArn sets the IamRoleArn field's value.

func (KinesisFirehoseDestination) String 

func (s KinesisFirehoseDestination) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*KinesisFirehoseDestination) Validate 

func (s *KinesisFirehoseDestination) Validate() error

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

type LimitExceededException added in v1.28.0 

type LimitExceededException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

There are too many instances of the specified resource type.

func (*LimitExceededException) Code added in v1.28.0 

func (s *LimitExceededException) Code() string

Code returns the exception type name.

func (*LimitExceededException) Error added in v1.28.0 

func (s *LimitExceededException) Error() string

func (LimitExceededException) GoString added in v1.28.0 

func (s LimitExceededException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LimitExceededException) Message added in v1.28.0 

func (s *LimitExceededException) Message() string

Message returns the exception's message.

func (*LimitExceededException) OrigErr added in v1.28.0 

func (s *LimitExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*LimitExceededException) RequestID added in v1.28.0 

func (s *LimitExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*LimitExceededException) StatusCode added in v1.28.0 

func (s *LimitExceededException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (LimitExceededException) String added in v1.28.0 

func (s LimitExceededException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s ListConfigurationSetsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListConfigurationSetsInput) SetNextToken 

func (s *ListConfigurationSetsInput) SetNextToken(v string) *ListConfigurationSetsInput

SetNextToken sets the NextToken field's value.

func (*ListConfigurationSetsInput) SetPageSize 

func (s *ListConfigurationSetsInput) SetPageSize(v int64) *ListConfigurationSetsInput

SetPageSize sets the PageSize field's value.

func (ListConfigurationSetsInput) String 

func (s ListConfigurationSetsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s ListConfigurationSetsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListConfigurationSetsOutput) SetConfigurationSets 

func (s *ListConfigurationSetsOutput) SetConfigurationSets(v []*string) *ListConfigurationSetsOutput

SetConfigurationSets sets the ConfigurationSets field's value.

func (*ListConfigurationSetsOutput) SetNextToken 

func (s *ListConfigurationSetsOutput) SetNextToken(v string) *ListConfigurationSetsOutput

SetNextToken sets the NextToken field's value.

func (ListConfigurationSetsOutput) String 

func (s ListConfigurationSetsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s ListDedicatedIpPoolsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListDedicatedIpPoolsInput) SetNextToken 

func (s *ListDedicatedIpPoolsInput) SetNextToken(v string) *ListDedicatedIpPoolsInput

SetNextToken sets the NextToken field's value.

func (*ListDedicatedIpPoolsInput) SetPageSize 

func (s *ListDedicatedIpPoolsInput) SetPageSize(v int64) *ListDedicatedIpPoolsInput

SetPageSize sets the PageSize field's value.

func (ListDedicatedIpPoolsInput) String 

func (s ListDedicatedIpPoolsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s ListDedicatedIpPoolsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListDedicatedIpPoolsOutput) SetDedicatedIpPools 

func (s *ListDedicatedIpPoolsOutput) SetDedicatedIpPools(v []*string) *ListDedicatedIpPoolsOutput

SetDedicatedIpPools sets the DedicatedIpPools field's value.

func (*ListDedicatedIpPoolsOutput) SetNextToken 

func (s *ListDedicatedIpPoolsOutput) SetNextToken(v string) *ListDedicatedIpPoolsOutput

SetNextToken sets the NextToken field's value.

func (ListDedicatedIpPoolsOutput) String 

func (s ListDedicatedIpPoolsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListDeliverabilityTestReportsInput added in v1.16.5 

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) GoString added in v1.16.5 

func (s ListDeliverabilityTestReportsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListDeliverabilityTestReportsInput) SetNextToken added in v1.16.5 

func (s *ListDeliverabilityTestReportsInput) SetNextToken(v string) *ListDeliverabilityTestReportsInput

SetNextToken sets the NextToken field's value.

func (*ListDeliverabilityTestReportsInput) SetPageSize added in v1.16.5 

func (s *ListDeliverabilityTestReportsInput) SetPageSize(v int64) *ListDeliverabilityTestReportsInput

SetPageSize sets the PageSize field's value.

func (ListDeliverabilityTestReportsInput) String added in v1.16.5 

func (s ListDeliverabilityTestReportsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListDeliverabilityTestReportsOutput added in v1.16.5 

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) GoString added in v1.16.5 

func (s ListDeliverabilityTestReportsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListDeliverabilityTestReportsOutput) SetDeliverabilityTestReports added in v1.16.5 

func (s *ListDeliverabilityTestReportsOutput) SetDeliverabilityTestReports(v []*DeliverabilityTestReport) *ListDeliverabilityTestReportsOutput

SetDeliverabilityTestReports sets the DeliverabilityTestReports field's value.

func (*ListDeliverabilityTestReportsOutput) SetNextToken added in v1.16.5 

func (s *ListDeliverabilityTestReportsOutput) SetNextToken(v string) *ListDeliverabilityTestReportsOutput

SetNextToken sets the NextToken field's value.

func (ListDeliverabilityTestReportsOutput) String added in v1.16.5 

func (s ListDeliverabilityTestReportsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListDomainDeliverabilityCampaignsInput added in v1.19.39 

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) GoString added in v1.19.39 

func (s ListDomainDeliverabilityCampaignsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListDomainDeliverabilityCampaignsInput) SetEndDate added in v1.19.39 

func (s *ListDomainDeliverabilityCampaignsInput) SetEndDate(v time.Time) *ListDomainDeliverabilityCampaignsInput

SetEndDate sets the EndDate field's value.

func (*ListDomainDeliverabilityCampaignsInput) SetNextToken added in v1.19.39 

func (s *ListDomainDeliverabilityCampaignsInput) SetNextToken(v string) *ListDomainDeliverabilityCampaignsInput

SetNextToken sets the NextToken field's value.

func (*ListDomainDeliverabilityCampaignsInput) SetPageSize added in v1.19.39 

func (s *ListDomainDeliverabilityCampaignsInput) SetPageSize(v int64) *ListDomainDeliverabilityCampaignsInput

SetPageSize sets the PageSize field's value.

func (*ListDomainDeliverabilityCampaignsInput) SetStartDate added in v1.19.39 

func (s *ListDomainDeliverabilityCampaignsInput) SetStartDate(v time.Time) *ListDomainDeliverabilityCampaignsInput

SetStartDate sets the StartDate field's value.

func (*ListDomainDeliverabilityCampaignsInput) SetSubscribedDomain added in v1.19.39 

func (s *ListDomainDeliverabilityCampaignsInput) SetSubscribedDomain(v string) *ListDomainDeliverabilityCampaignsInput

SetSubscribedDomain sets the SubscribedDomain field's value.

func (ListDomainDeliverabilityCampaignsInput) String added in v1.19.39 

func (s ListDomainDeliverabilityCampaignsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListDomainDeliverabilityCampaignsInput) Validate added in v1.19.39 

func (s *ListDomainDeliverabilityCampaignsInput) Validate() error

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

type ListDomainDeliverabilityCampaignsOutput added in v1.19.39 

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) GoString added in v1.19.39 

func (s ListDomainDeliverabilityCampaignsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListDomainDeliverabilityCampaignsOutput) SetDomainDeliverabilityCampaigns added in v1.19.39 

func (s *ListDomainDeliverabilityCampaignsOutput) SetDomainDeliverabilityCampaigns(v []*DomainDeliverabilityCampaign) *ListDomainDeliverabilityCampaignsOutput

SetDomainDeliverabilityCampaigns sets the DomainDeliverabilityCampaigns field's value.

func (*ListDomainDeliverabilityCampaignsOutput) SetNextToken added in v1.19.39 

func (s *ListDomainDeliverabilityCampaignsOutput) SetNextToken(v string) *ListDomainDeliverabilityCampaignsOutput

SetNextToken sets the NextToken field's value.

func (ListDomainDeliverabilityCampaignsOutput) String added in v1.19.39 

func (s ListDomainDeliverabilityCampaignsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s ListEmailIdentitiesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListEmailIdentitiesInput) SetNextToken 

func (s *ListEmailIdentitiesInput) SetNextToken(v string) *ListEmailIdentitiesInput

SetNextToken sets the NextToken field's value.

func (*ListEmailIdentitiesInput) SetPageSize 

func (s *ListEmailIdentitiesInput) SetPageSize(v int64) *ListEmailIdentitiesInput

SetPageSize sets the PageSize field's value.

func (ListEmailIdentitiesInput) String 

func (s ListEmailIdentitiesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s ListEmailIdentitiesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListEmailIdentitiesOutput) SetEmailIdentities 

func (s *ListEmailIdentitiesOutput) SetEmailIdentities(v []*IdentityInfo) *ListEmailIdentitiesOutput

SetEmailIdentities sets the EmailIdentities field's value.

func (*ListEmailIdentitiesOutput) SetNextToken 

func (s *ListEmailIdentitiesOutput) SetNextToken(v string) *ListEmailIdentitiesOutput

SetNextToken sets the NextToken field's value.

func (ListEmailIdentitiesOutput) String 

func (s ListEmailIdentitiesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListTagsForResourceInput added in v1.19.5 

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) GoString added in v1.19.5 

func (s ListTagsForResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceInput) SetResourceArn added in v1.19.5 

func (s *ListTagsForResourceInput) SetResourceArn(v string) *ListTagsForResourceInput

SetResourceArn sets the ResourceArn field's value.

func (ListTagsForResourceInput) String added in v1.19.5 

func (s ListTagsForResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceInput) Validate added in v1.19.5 

func (s *ListTagsForResourceInput) Validate() error

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

type ListTagsForResourceOutput added in v1.19.5 

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) GoString added in v1.19.5 

func (s ListTagsForResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceOutput) SetTags added in v1.19.5 

func (s *ListTagsForResourceOutput) SetTags(v []*Tag) *ListTagsForResourceOutput

SetTags sets the Tags field's value.

func (ListTagsForResourceOutput) String added in v1.19.5 

func (s ListTagsForResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 *string `type:"string" required:"true" enum:"BehaviorOnMxFailure"`

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

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

func (MailFromAttributes) GoString 

func (s MailFromAttributes) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MailFromAttributes) SetBehaviorOnMxFailure 

func (s *MailFromAttributes) SetBehaviorOnMxFailure(v string) *MailFromAttributes

SetBehaviorOnMxFailure sets the BehaviorOnMxFailure field's value.

func (*MailFromAttributes) SetMailFromDomain 

func (s *MailFromAttributes) SetMailFromDomain(v string) *MailFromAttributes

SetMailFromDomain sets the MailFromDomain field's value.

func (*MailFromAttributes) SetMailFromDomainStatus 

func (s *MailFromAttributes) SetMailFromDomainStatus(v string) *MailFromAttributes

SetMailFromDomainStatus sets the MailFromDomainStatus field's value.

func (MailFromAttributes) String 

func (s MailFromAttributes) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type MailFromDomainNotVerifiedException added in v1.28.0 

type MailFromDomainNotVerifiedException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The message can't be sent because the sending domain isn't verified.

func (*MailFromDomainNotVerifiedException) Code added in v1.28.0 

func (s *MailFromDomainNotVerifiedException) Code() string

Code returns the exception type name.

func (*MailFromDomainNotVerifiedException) Error added in v1.28.0 

func (s *MailFromDomainNotVerifiedException) Error() string

func (MailFromDomainNotVerifiedException) GoString added in v1.28.0 

func (s MailFromDomainNotVerifiedException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MailFromDomainNotVerifiedException) Message added in v1.28.0 

func (s *MailFromDomainNotVerifiedException) Message() string

Message returns the exception's message.

func (*MailFromDomainNotVerifiedException) OrigErr added in v1.28.0 

func (s *MailFromDomainNotVerifiedException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*MailFromDomainNotVerifiedException) RequestID added in v1.28.0 

func (s *MailFromDomainNotVerifiedException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*MailFromDomainNotVerifiedException) StatusCode added in v1.28.0 

func (s *MailFromDomainNotVerifiedException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (MailFromDomainNotVerifiedException) String added in v1.28.0 

func (s MailFromDomainNotVerifiedException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s Message) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Message) SetBody 

func (s *Message) SetBody(v *Body) *Message

SetBody sets the Body field's value.

func (*Message) SetSubject 

func (s *Message) SetSubject(v *Content) *Message

SetSubject sets the Subject field's value.

func (Message) String 

func (s Message) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Message) Validate 

func (s *Message) Validate() error

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

type MessageRejected added in v1.28.0 

type MessageRejected struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The message can't be sent because it contains invalid content.

func (*MessageRejected) Code added in v1.28.0 

func (s *MessageRejected) Code() string

Code returns the exception type name.

func (*MessageRejected) Error added in v1.28.0 

func (s *MessageRejected) Error() string

func (MessageRejected) GoString added in v1.28.0 

func (s MessageRejected) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MessageRejected) Message added in v1.28.0 

func (s *MessageRejected) Message() string

Message returns the exception's message.

func (*MessageRejected) OrigErr added in v1.28.0 

func (s *MessageRejected) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*MessageRejected) RequestID added in v1.28.0 

func (s *MessageRejected) RequestID() string

RequestID returns the service's response RequestID for request.

func (*MessageRejected) StatusCode added in v1.28.0 

func (s *MessageRejected) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (MessageRejected) String added in v1.28.0 

func (s MessageRejected) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s MessageTag) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MessageTag) SetName 

func (s *MessageTag) SetName(v string) *MessageTag

SetName sets the Name field's value.

func (*MessageTag) SetValue 

func (s *MessageTag) SetValue(v string) *MessageTag

SetValue sets the Value field's value.

func (MessageTag) String 

func (s MessageTag) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MessageTag) Validate 

func (s *MessageTag) Validate() error

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

type NotFoundException added in v1.28.0 

type NotFoundException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The resource you attempted to access doesn't exist.

func (*NotFoundException) Code added in v1.28.0 

func (s *NotFoundException) Code() string

Code returns the exception type name.

func (*NotFoundException) Error added in v1.28.0 

func (s *NotFoundException) Error() string

func (NotFoundException) GoString added in v1.28.0 

func (s NotFoundException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*NotFoundException) Message added in v1.28.0 

func (s *NotFoundException) Message() string

Message returns the exception's message.

func (*NotFoundException) OrigErr added in v1.28.0 

func (s *NotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*NotFoundException) RequestID added in v1.28.0 

func (s *NotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*NotFoundException) StatusCode added in v1.28.0 

func (s *NotFoundException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (NotFoundException) String added in v1.28.0 

func (s NotFoundException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type OverallVolume added in v1.16.5 

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) GoString added in v1.16.5 

func (s OverallVolume) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*OverallVolume) SetDomainIspPlacements added in v1.16.5 

func (s *OverallVolume) SetDomainIspPlacements(v []*DomainIspPlacement) *OverallVolume

SetDomainIspPlacements sets the DomainIspPlacements field's value.

func (*OverallVolume) SetReadRatePercent added in v1.16.5 

func (s *OverallVolume) SetReadRatePercent(v float64) *OverallVolume

SetReadRatePercent sets the ReadRatePercent field's value.

func (*OverallVolume) SetVolumeStatistics added in v1.16.5 

func (s *OverallVolume) SetVolumeStatistics(v *VolumeStatistics) *OverallVolume

SetVolumeStatistics sets the VolumeStatistics field's value.

func (OverallVolume) String added in v1.16.5 

func (s OverallVolume) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s PinpointDestination) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PinpointDestination) SetApplicationArn 

func (s *PinpointDestination) SetApplicationArn(v string) *PinpointDestination

SetApplicationArn sets the ApplicationArn field's value.

func (PinpointDestination) String 

func (s PinpointDestination) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PinpointEmail 

type PinpointEmail struct {
	*client.Client
}

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

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

func New 

func New(p client.ConfigProvider, cfgs ...*aws.Config) *PinpointEmail

New creates a new instance of the PinpointEmail client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example: 

mySession := session.Must(session.NewSession())

// Create a PinpointEmail client from just a session.
svc := pinpointemail.New(mySession)

// Create a PinpointEmail client with additional configuration
svc := pinpointemail.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*PinpointEmail) CreateConfigurationSet 

func (c *PinpointEmail) CreateConfigurationSet(input *CreateConfigurationSetInput) (*CreateConfigurationSetOutput, error)

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint Email Service's API operation CreateConfigurationSet for usage and error information.

Returned Error Types:

  • AlreadyExistsException The resource specified in your request already exists.

  • NotFoundException The resource you attempted to access doesn't exist.

  • TooManyRequestsException Too many requests have been made to the operation.

  • LimitExceededException There are too many instances of the specified resource type.

  • BadRequestException The input you provided is invalid.

  • ConcurrentModificationException The resource is being modified by another operation or thread.

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

func (*PinpointEmail) CreateConfigurationSetEventDestination 

func (c *PinpointEmail) CreateConfigurationSetEventDestination(input *CreateConfigurationSetEventDestinationInput) (*CreateConfigurationSetEventDestinationOutput, error)

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint Email Service's API operation CreateConfigurationSetEventDestination for usage and error information.

Returned Error Types:

  • NotFoundException The resource you attempted to access doesn't exist.

  • AlreadyExistsException The resource specified in your request already exists.

  • LimitExceededException There are too many instances of the specified resource type.

  • TooManyRequestsException Too many requests have been made to the operation.

  • BadRequestException The input you provided is invalid.

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

func (*PinpointEmail) CreateConfigurationSetEventDestinationRequest 

func (c *PinpointEmail) CreateConfigurationSetEventDestinationRequest(input *CreateConfigurationSetEventDestinationInput) (req *request.Request, output *CreateConfigurationSetEventDestinationOutput)

CreateConfigurationSetEventDestinationRequest generates a "aws/request.Request" representing the client's request for the CreateConfigurationSetEventDestination operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateConfigurationSetEventDestination for more information on using the CreateConfigurationSetEventDestination API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CreateConfigurationSetEventDestinationRequest method.
req, resp := client.CreateConfigurationSetEventDestinationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*PinpointEmail) CreateConfigurationSetEventDestinationWithContext 

func (c *PinpointEmail) CreateConfigurationSetEventDestinationWithContext(ctx aws.Context, input *CreateConfigurationSetEventDestinationInput, opts ...request.Option) (*CreateConfigurationSetEventDestinationOutput, error)

CreateConfigurationSetEventDestinationWithContext is the same as CreateConfigurationSetEventDestination with the addition of the ability to pass a context and additional request options.

See CreateConfigurationSetEventDestination for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*PinpointEmail) CreateConfigurationSetRequest 

func (c *PinpointEmail) CreateConfigurationSetRequest(input *CreateConfigurationSetInput) (req *request.Request, output *CreateConfigurationSetOutput)

CreateConfigurationSetRequest generates a "aws/request.Request" representing the client's request for the CreateConfigurationSet operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateConfigurationSet for more information on using the CreateConfigurationSet API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CreateConfigurationSetRequest method.
req, resp := client.CreateConfigurationSetRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*PinpointEmail) CreateConfigurationSetWithContext 

func (c *PinpointEmail) CreateConfigurationSetWithContext(ctx aws.Context, input *CreateConfigurationSetInput, opts ...request.Option) (*CreateConfigurationSetOutput, error)

CreateConfigurationSetWithContext is the same as CreateConfigurationSet with the addition of the ability to pass a context and additional request options.

See CreateConfigurationSet for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*PinpointEmail) CreateDedicatedIpPool 

func (c *PinpointEmail) CreateDedicatedIpPool(input *CreateDedicatedIpPoolInput) (*CreateDedicatedIpPoolOutput, error)

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint Email Service's API operation CreateDedicatedIpPool for usage and error information.

Returned Error Types:

  • AlreadyExistsException The resource specified in your request already exists.

  • LimitExceededException There are too many instances of the specified resource type.

  • TooManyRequestsException Too many requests have been made to the operation.

  • BadRequestException The input you provided is invalid.

  • ConcurrentModificationException The resource is being modified by another operation or thread.

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

func (*PinpointEmail) CreateDedicatedIpPoolRequest 

func (c *PinpointEmail) CreateDedicatedIpPoolRequest(input *CreateDedicatedIpPoolInput) (req *request.Request, output *CreateDedicatedIpPoolOutput)

CreateDedicatedIpPoolRequest generates a "aws/request.Request" representing the client's request for the CreateDedicatedIpPool operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateDedicatedIpPool for more information on using the CreateDedicatedIpPool API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CreateDedicatedIpPoolRequest method.
req, resp := client.CreateDedicatedIpPoolRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*PinpointEmail) CreateDedicatedIpPoolWithContext 

func (c *PinpointEmail) CreateDedicatedIpPoolWithContext(ctx aws.Context, input *CreateDedicatedIpPoolInput, opts ...request.Option) (*CreateDedicatedIpPoolOutput, error)

CreateDedicatedIpPoolWithContext is the same as CreateDedicatedIpPool with the addition of the ability to pass a context and additional request options.

See CreateDedicatedIpPool for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*PinpointEmail) CreateDeliverabilityTestReport added in v1.16.5 

func (c *PinpointEmail) CreateDeliverabilityTestReport(input *CreateDeliverabilityTestReportInput) (*CreateDeliverabilityTestReportOutput, error)

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint Email Service's API operation CreateDeliverabilityTestReport for usage and error information.

Returned Error Types:

  • AccountSuspendedException The message can't be sent because the account's ability to send email has been permanently restricted.

  • SendingPausedException The message can't be sent because the account's ability to send email is currently paused.

  • MessageRejected The message can't be sent because it contains invalid content.

  • MailFromDomainNotVerifiedException The message can't be sent because the sending domain isn't verified.

  • NotFoundException The resource you attempted to access doesn't exist.

  • TooManyRequestsException Too many requests have been made to the operation.

  • LimitExceededException There are too many instances of the specified resource type.

  • BadRequestException The input you provided is invalid.

  • ConcurrentModificationException The resource is being modified by another operation or thread.

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

func (*PinpointEmail) CreateDeliverabilityTestReportRequest added in v1.16.5 

func (c *PinpointEmail) CreateDeliverabilityTestReportRequest(input *CreateDeliverabilityTestReportInput) (req *request.Request, output *CreateDeliverabilityTestReportOutput)

CreateDeliverabilityTestReportRequest generates a "aws/request.Request" representing the client's request for the CreateDeliverabilityTestReport operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateDeliverabilityTestReport for more information on using the CreateDeliverabilityTestReport API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CreateDeliverabilityTestReportRequest method.
req, resp := client.CreateDeliverabilityTestReportRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*PinpointEmail) CreateDeliverabilityTestReportWithContext added in v1.16.5 

func (c *PinpointEmail) CreateDeliverabilityTestReportWithContext(ctx aws.Context, input *CreateDeliverabilityTestReportInput, opts ...request.Option) (*CreateDeliverabilityTestReportOutput, error)

CreateDeliverabilityTestReportWithContext is the same as CreateDeliverabilityTestReport with the addition of the ability to pass a context and additional request options.

See CreateDeliverabilityTestReport for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*PinpointEmail) CreateEmailIdentity 

func (c *PinpointEmail) CreateEmailIdentity(input *CreateEmailIdentityInput) (*CreateEmailIdentityOutput, error)

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint Email Service's API operation CreateEmailIdentity for usage and error information.

Returned Error Types:

  • LimitExceededException There are too many instances of the specified resource type.

  • TooManyRequestsException Too many requests have been made to the operation.

  • BadRequestException The input you provided is invalid.

  • ConcurrentModificationException The resource is being modified by another operation or thread.

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

func (*PinpointEmail) CreateEmailIdentityRequest 

func (c *PinpointEmail) CreateEmailIdentityRequest(input *CreateEmailIdentityInput) (req *request.Request, output *CreateEmailIdentityOutput)

CreateEmailIdentityRequest generates a "aws/request.Request" representing the client's request for the CreateEmailIdentity operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateEmailIdentity for more information on using the CreateEmailIdentity API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CreateEmailIdentityRequest method.
req, resp := client.CreateEmailIdentityRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*PinpointEmail) CreateEmailIdentityWithContext 

func (c *PinpointEmail) CreateEmailIdentityWithContext(ctx aws.Context, input *CreateEmailIdentityInput, opts ...request.Option) (*CreateEmailIdentityOutput, error)

CreateEmailIdentityWithContext is the same as CreateEmailIdentity with the addition of the ability to pass a context and additional request options.

See CreateEmailIdentity for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*PinpointEmail) DeleteConfigurationSet 

func (c *PinpointEmail) DeleteConfigurationSet(input *DeleteConfigurationSetInput) (*DeleteConfigurationSetOutput, error)

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint Email Service's API operation DeleteConfigurationSet for usage and error information.

Returned Error Types:

  • NotFoundException The resource you attempted to access doesn't exist.

  • TooManyRequestsException Too many requests have been made to the operation.

  • BadRequestException The input you provided is invalid.

  • ConcurrentModificationException The resource is being modified by another operation or thread.

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

func (*PinpointEmail) DeleteConfigurationSetEventDestination 

func (c *PinpointEmail) DeleteConfigurationSetEventDestination(input *DeleteConfigurationSetEventDestinationInput) (*DeleteConfigurationSetEventDestinationOutput, error)

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint Email Service's API operation DeleteConfigurationSetEventDestination for usage and error information.

Returned Error Types:

  • NotFoundException The resource you attempted to access doesn't exist.

  • TooManyRequestsException Too many requests have been made to the operation.

  • BadRequestException The input you provided is invalid.

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

func (*PinpointEmail) DeleteConfigurationSetEventDestinationRequest 

func (c *PinpointEmail) DeleteConfigurationSetEventDestinationRequest(input *DeleteConfigurationSetEventDestinationInput) (req *request.Request, output *DeleteConfigurationSetEventDestinationOutput)

DeleteConfigurationSetEventDestinationRequest generates a "aws/request.Request" representing the client's request for the DeleteConfigurationSetEventDestination operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteConfigurationSetEventDestination for more information on using the DeleteConfigurationSetEventDestination API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteConfigurationSetEventDestinationRequest method.
req, resp := client.DeleteConfigurationSetEventDestinationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*PinpointEmail) DeleteConfigurationSetEventDestinationWithContext 

func (c *PinpointEmail) DeleteConfigurationSetEventDestinationWithContext(ctx aws.Context, input *DeleteConfigurationSetEventDestinationInput, opts ...request.Option) (*DeleteConfigurationSetEventDestinationOutput, error)

DeleteConfigurationSetEventDestinationWithContext is the same as DeleteConfigurationSetEventDestination with the addition of the ability to pass a context and additional request options.

See DeleteConfigurationSetEventDestination for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*PinpointEmail) DeleteConfigurationSetRequest 

func (c *PinpointEmail) DeleteConfigurationSetRequest(input *DeleteConfigurationSetInput) (req *request.Request, output *DeleteConfigurationSetOutput)

DeleteConfigurationSetRequest generates a "aws/request.Request" representing the client's request for the DeleteConfigurationSet operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteConfigurationSet for more information on using the DeleteConfigurationSet API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteConfigurationSetRequest method.
req, resp := client.DeleteConfigurationSetRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*PinpointEmail) DeleteConfigurationSetWithContext 

func (c *PinpointEmail) DeleteConfigurationSetWithContext(ctx aws.Context, input *DeleteConfigurationSetInput, opts ...request.Option) (*DeleteConfigurationSetOutput, error)

DeleteConfigurationSetWithContext is the same as DeleteConfigurationSet with the addition of the ability to pass a context and additional request options.

See DeleteConfigurationSet for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*PinpointEmail) DeleteDedicatedIpPool 

func (c *PinpointEmail) DeleteDedicatedIpPool(input *DeleteDedicatedIpPoolInput) (*DeleteDedicatedIpPoolOutput, error)

DeleteDedicatedIpPool API operation for Amazon Pinpoint Email Service.

Delete a dedicated IP pool.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint Email Service's API operation DeleteDedicatedIpPool for usage and error information.

Returned Error Types:

  • NotFoundException The resource you attempted to access doesn't exist.

  • TooManyRequestsException Too many requests have been made to the operation.

  • BadRequestException The input you provided is invalid.

  • ConcurrentModificationException The resource is being modified by another operation or thread.

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

func (*PinpointEmail) DeleteDedicatedIpPoolRequest 

func (c *PinpointEmail) DeleteDedicatedIpPoolRequest(input *DeleteDedicatedIpPoolInput) (req *request.Request, output *DeleteDedicatedIpPoolOutput)

DeleteDedicatedIpPoolRequest generates a "aws/request.Request" representing the client's request for the DeleteDedicatedIpPool operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteDedicatedIpPool for more information on using the DeleteDedicatedIpPool API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteDedicatedIpPoolRequest method.
req, resp := client.DeleteDedicatedIpPoolRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*PinpointEmail) DeleteDedicatedIpPoolWithContext 

func (c *PinpointEmail) DeleteDedicatedIpPoolWithContext(ctx aws.Context, input *DeleteDedicatedIpPoolInput, opts ...request.Option) (*DeleteDedicatedIpPoolOutput, error)

DeleteDedicatedIpPoolWithContext is the same as DeleteDedicatedIpPool with the addition of the ability to pass a context and additional request options.

See DeleteDedicatedIpPool for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*PinpointEmail) DeleteEmailIdentity 

func (c *PinpointEmail) DeleteEmailIdentity(input *DeleteEmailIdentityInput) (*DeleteEmailIdentityOutput, error)

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint Email Service's API operation DeleteEmailIdentity for usage and error information.

Returned Error Types:

  • NotFoundException The resource you attempted to access doesn't exist.

  • TooManyRequestsException Too many requests have been made to the operation.

  • BadRequestException The input you provided is invalid.

  • ConcurrentModificationException The resource is being modified by another operation or thread.

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

func (*PinpointEmail) DeleteEmailIdentityRequest 

func (c *PinpointEmail) DeleteEmailIdentityRequest(input *DeleteEmailIdentityInput) (req *request.Request, output *DeleteEmailIdentityOutput)

DeleteEmailIdentityRequest generates a "aws/request.Request" representing the client's request for the DeleteEmailIdentity operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteEmailIdentity for more information on using the DeleteEmailIdentity API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteEmailIdentityRequest method.
req, resp := client.DeleteEmailIdentityRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*PinpointEmail) DeleteEmailIdentityWithContext 

func (c *PinpointEmail) DeleteEmailIdentityWithContext(ctx aws.Context, input *DeleteEmailIdentityInput, opts ...request.Option) (*DeleteEmailIdentityOutput, error)

DeleteEmailIdentityWithContext is the same as DeleteEmailIdentity with the addition of the ability to pass a context and additional request options.

See DeleteEmailIdentity for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*PinpointEmail) GetAccount 

func (c *PinpointEmail) GetAccount(input *GetAccountInput) (*GetAccountOutput, error)

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint Email Service's API operation GetAccount for usage and error information.

Returned Error Types:

  • TooManyRequestsException Too many requests have been made to the operation.

  • BadRequestException The input you provided is invalid.

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

func (*PinpointEmail) GetAccountRequest 

func (c *PinpointEmail) GetAccountRequest(input *GetAccountInput) (req *request.Request, output *GetAccountOutput)

GetAccountRequest generates a "aws/request.Request" representing the client's request for the GetAccount operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetAccount for more information on using the GetAccount API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetAccountRequest method.
req, resp := client.GetAccountRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*PinpointEmail) GetAccountWithContext 

func (c *PinpointEmail) GetAccountWithContext(ctx aws.Context, input *GetAccountInput, opts ...request.Option) (*GetAccountOutput, error)

GetAccountWithContext is the same as GetAccount with the addition of the ability to pass a context and additional request options.

See GetAccount for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*PinpointEmail) GetBlacklistReports added in v1.16.5 

func (c *PinpointEmail) GetBlacklistReports(input *GetBlacklistReportsInput) (*GetBlacklistReportsOutput, error)

GetBlacklistReports API operation for Amazon Pinpoint Email Service.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint Email Service's API operation GetBlacklistReports for usage and error information.

Returned Error Types:

  • TooManyRequestsException Too many requests have been made to the operation.

  • NotFoundException The resource you attempted to access doesn't exist.

  • BadRequestException The input you provided is invalid.

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

func (*PinpointEmail) GetBlacklistReportsRequest added in v1.16.5 

func (c *PinpointEmail) GetBlacklistReportsRequest(input *GetBlacklistReportsInput) (req *request.Request, output *GetBlacklistReportsOutput)

GetBlacklistReportsRequest generates a "aws/request.Request" representing the client's request for the GetBlacklistReports operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetBlacklistReports for more information on using the GetBlacklistReports API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetBlacklistReportsRequest method.
req, resp := client.GetBlacklistReportsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*PinpointEmail) GetBlacklistReportsWithContext added in v1.16.5 

func (c *PinpointEmail) GetBlacklistReportsWithContext(ctx aws.Context, input *GetBlacklistReportsInput, opts ...request.Option) (*GetBlacklistReportsOutput, error)

GetBlacklistReportsWithContext is the same as GetBlacklistReports with the addition of the ability to pass a context and additional request options.

See GetBlacklistReports for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*PinpointEmail) GetConfigurationSet 

func (c *PinpointEmail) GetConfigurationSet(input *GetConfigurationSetInput) (*GetConfigurationSetOutput, error)

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint Email Service's API operation GetConfigurationSet for usage and error information.

Returned Error Types:

  • NotFoundException The resource you attempted to access doesn't exist.

  • TooManyRequestsException Too many requests have been made to the operation.

  • BadRequestException The input you provided is invalid.

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

func (*PinpointEmail) GetConfigurationSetEventDestinations 

func (c *PinpointEmail) GetConfigurationSetEventDestinations(input *GetConfigurationSetEventDestinationsInput) (*GetConfigurationSetEventDestinationsOutput, error)

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint Email Service's API operation GetConfigurationSetEventDestinations for usage and error information.

Returned Error Types:

  • NotFoundException The resource you attempted to access doesn't exist.

  • TooManyRequestsException Too many requests have been made to the operation.

  • BadRequestException The input you provided is invalid.

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

func (*PinpointEmail) GetConfigurationSetEventDestinationsRequest 

func (c *PinpointEmail) GetConfigurationSetEventDestinationsRequest(input *GetConfigurationSetEventDestinationsInput) (req *request.Request, output *GetConfigurationSetEventDestinationsOutput)

GetConfigurationSetEventDestinationsRequest generates a "aws/request.Request" representing the client's request for the GetConfigurationSetEventDestinations operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetConfigurationSetEventDestinations for more information on using the GetConfigurationSetEventDestinations API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetConfigurationSetEventDestinationsRequest method.
req, resp := client.GetConfigurationSetEventDestinationsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*PinpointEmail) GetConfigurationSetEventDestinationsWithContext 

func (c *PinpointEmail) GetConfigurationSetEventDestinationsWithContext(ctx aws.Context, input *GetConfigurationSetEventDestinationsInput, opts ...request.Option) (*GetConfigurationSetEventDestinationsOutput, error)

GetConfigurationSetEventDestinationsWithContext is the same as GetConfigurationSetEventDestinations with the addition of the ability to pass a context and additional request options.

See GetConfigurationSetEventDestinations for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*PinpointEmail) GetConfigurationSetRequest 

func (c *PinpointEmail) GetConfigurationSetRequest(input *GetConfigurationSetInput) (req *request.Request, output *GetConfigurationSetOutput)

GetConfigurationSetRequest generates a "aws/request.Request" representing the client's request for the GetConfigurationSet operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetConfigurationSet for more information on using the GetConfigurationSet API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetConfigurationSetRequest method.
req, resp := client.GetConfigurationSetRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*PinpointEmail) GetConfigurationSetWithContext 

func (c *PinpointEmail) GetConfigurationSetWithContext(ctx aws.Context, input *GetConfigurationSetInput, opts ...request.Option) (*GetConfigurationSetOutput, error)

GetConfigurationSetWithContext is the same as GetConfigurationSet with the addition of the ability to pass a context and additional request options.

See GetConfigurationSet for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*PinpointEmail) GetDedicatedIp 

func (c *PinpointEmail) GetDedicatedIp(input *GetDedicatedIpInput) (*GetDedicatedIpOutput, error)

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint Email Service's API operation GetDedicatedIp for usage and error information.

Returned Error Types:

  • TooManyRequestsException Too many requests have been made to the operation.

  • NotFoundException The resource you attempted to access doesn't exist.

  • BadRequestException The input you provided is invalid.

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

func (*PinpointEmail) GetDedicatedIpRequest 

func (c *PinpointEmail) GetDedicatedIpRequest(input *GetDedicatedIpInput) (req *request.Request, output *GetDedicatedIpOutput)

GetDedicatedIpRequest generates a "aws/request.Request" representing the client's request for the GetDedicatedIp operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetDedicatedIp for more information on using the GetDedicatedIp API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetDedicatedIpRequest method.
req, resp := client.GetDedicatedIpRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*PinpointEmail) GetDedicatedIpWithContext 

func (c *PinpointEmail) GetDedicatedIpWithContext(ctx aws.Context, input *GetDedicatedIpInput, opts ...request.Option) (*GetDedicatedIpOutput, error)

GetDedicatedIpWithContext is the same as GetDedicatedIp with the addition of the ability to pass a context and additional request options.

See GetDedicatedIp for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*PinpointEmail) GetDedicatedIps 

func (c *PinpointEmail) GetDedicatedIps(input *GetDedicatedIpsInput) (*GetDedicatedIpsOutput, error)

GetDedicatedIps API operation for Amazon Pinpoint Email Service.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint Email Service's API operation GetDedicatedIps for usage and error information.

Returned Error Types:

  • TooManyRequestsException Too many requests have been made to the operation.

  • NotFoundException The resource you attempted to access doesn't exist.

  • BadRequestException The input you provided is invalid.

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

func (*PinpointEmail) GetDedicatedIpsPages 

func (c *PinpointEmail) GetDedicatedIpsPages(input *GetDedicatedIpsInput, fn func(*GetDedicatedIpsOutput, bool) bool) error

GetDedicatedIpsPages iterates over the pages of a GetDedicatedIps operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See GetDedicatedIps method for more information on how to use this operation.

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

// Example iterating over at most 3 pages of a GetDedicatedIps operation.
pageNum := 0
err := client.GetDedicatedIpsPages(params,
    func(page *pinpointemail.GetDedicatedIpsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*PinpointEmail) GetDedicatedIpsPagesWithContext 

func (c *PinpointEmail) GetDedicatedIpsPagesWithContext(ctx aws.Context, input *GetDedicatedIpsInput, fn func(*GetDedicatedIpsOutput, bool) bool, opts ...request.Option) error

GetDedicatedIpsPagesWithContext same as GetDedicatedIpsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*PinpointEmail) GetDedicatedIpsRequest 

func (c *PinpointEmail) GetDedicatedIpsRequest(input *GetDedicatedIpsInput) (req *request.Request, output *GetDedicatedIpsOutput)

GetDedicatedIpsRequest generates a "aws/request.Request" representing the client's request for the GetDedicatedIps operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetDedicatedIps for more information on using the GetDedicatedIps API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetDedicatedIpsRequest method.
req, resp := client.GetDedicatedIpsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*PinpointEmail) GetDedicatedIpsWithContext 

func (c *PinpointEmail) GetDedicatedIpsWithContext(ctx aws.Context, input *GetDedicatedIpsInput, opts ...request.Option) (*GetDedicatedIpsOutput, error)

GetDedicatedIpsWithContext is the same as GetDedicatedIps with the addition of the ability to pass a context and additional request options.

See GetDedicatedIps for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*PinpointEmail) GetDeliverabilityDashboardOptions added in v1.16.5 

func (c *PinpointEmail) GetDeliverabilityDashboardOptions(input *GetDeliverabilityDashboardOptionsInput) (*GetDeliverabilityDashboardOptionsOutput, error)

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint Email Service's API operation GetDeliverabilityDashboardOptions for usage and error information.

Returned Error Types:

  • TooManyRequestsException Too many requests have been made to the operation.

  • LimitExceededException There are too many instances of the specified resource type.

  • BadRequestException The input you provided is invalid.

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

func (*PinpointEmail) GetDeliverabilityDashboardOptionsRequest added in v1.16.5 

func (c *PinpointEmail) GetDeliverabilityDashboardOptionsRequest(input *GetDeliverabilityDashboardOptionsInput) (req *request.Request, output *GetDeliverabilityDashboardOptionsOutput)

GetDeliverabilityDashboardOptionsRequest generates a "aws/request.Request" representing the client's request for the GetDeliverabilityDashboardOptions operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetDeliverabilityDashboardOptions for more information on using the GetDeliverabilityDashboardOptions API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetDeliverabilityDashboardOptionsRequest method.
req, resp := client.GetDeliverabilityDashboardOptionsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*PinpointEmail) GetDeliverabilityDashboardOptionsWithContext added in v1.16.5 

func (c *PinpointEmail) GetDeliverabilityDashboardOptionsWithContext(ctx aws.Context, input *GetDeliverabilityDashboardOptionsInput, opts ...request.Option) (*GetDeliverabilityDashboardOptionsOutput, error)

GetDeliverabilityDashboardOptionsWithContext is the same as GetDeliverabilityDashboardOptions with the addition of the ability to pass a context and additional request options.

See GetDeliverabilityDashboardOptions for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*PinpointEmail) GetDeliverabilityTestReport added in v1.16.5 

func (c *PinpointEmail) GetDeliverabilityTestReport(input *GetDeliverabilityTestReportInput) (*GetDeliverabilityTestReportOutput, error)

GetDeliverabilityTestReport API operation for Amazon Pinpoint Email Service.

Retrieve the results of a predictive inbox placement test.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint Email Service's API operation GetDeliverabilityTestReport for usage and error information.

Returned Error Types:

  • TooManyRequestsException Too many requests have been made to the operation.

  • NotFoundException The resource you attempted to access doesn't exist.

  • BadRequestException The input you provided is invalid.

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

func (*PinpointEmail) GetDeliverabilityTestReportRequest added in v1.16.5 

func (c *PinpointEmail) GetDeliverabilityTestReportRequest(input *GetDeliverabilityTestReportInput) (req *request.Request, output *GetDeliverabilityTestReportOutput)

GetDeliverabilityTestReportRequest generates a "aws/request.Request" representing the client's request for the GetDeliverabilityTestReport operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetDeliverabilityTestReport for more information on using the GetDeliverabilityTestReport API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetDeliverabilityTestReportRequest method.
req, resp := client.GetDeliverabilityTestReportRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*PinpointEmail) GetDeliverabilityTestReportWithContext added in v1.16.5 

func (c *PinpointEmail) GetDeliverabilityTestReportWithContext(ctx aws.Context, input *GetDeliverabilityTestReportInput, opts ...request.Option) (*GetDeliverabilityTestReportOutput, error)

GetDeliverabilityTestReportWithContext is the same as GetDeliverabilityTestReport with the addition of the ability to pass a context and additional request options.

See GetDeliverabilityTestReport for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*PinpointEmail) GetDomainDeliverabilityCampaign added in v1.19.39 

func (c *PinpointEmail) GetDomainDeliverabilityCampaign(input *GetDomainDeliverabilityCampaignInput) (*GetDomainDeliverabilityCampaignOutput, error)

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint Email Service's API operation GetDomainDeliverabilityCampaign for usage and error information.

Returned Error Types:

  • TooManyRequestsException Too many requests have been made to the operation.

  • BadRequestException The input you provided is invalid.

  • NotFoundException The resource you attempted to access doesn't exist.

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

func (*PinpointEmail) GetDomainDeliverabilityCampaignRequest added in v1.19.39 

func (c *PinpointEmail) GetDomainDeliverabilityCampaignRequest(input *GetDomainDeliverabilityCampaignInput) (req *request.Request, output *GetDomainDeliverabilityCampaignOutput)

GetDomainDeliverabilityCampaignRequest generates a "aws/request.Request" representing the client's request for the GetDomainDeliverabilityCampaign operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetDomainDeliverabilityCampaign for more information on using the GetDomainDeliverabilityCampaign API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetDomainDeliverabilityCampaignRequest method.
req, resp := client.GetDomainDeliverabilityCampaignRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*PinpointEmail) GetDomainDeliverabilityCampaignWithContext added in v1.19.39 

func (c *PinpointEmail) GetDomainDeliverabilityCampaignWithContext(ctx aws.Context, input *GetDomainDeliverabilityCampaignInput, opts ...request.Option) (*GetDomainDeliverabilityCampaignOutput, error)

GetDomainDeliverabilityCampaignWithContext is the same as GetDomainDeliverabilityCampaign with the addition of the ability to pass a context and additional request options.

See GetDomainDeliverabilityCampaign for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*PinpointEmail) GetDomainStatisticsReport added in v1.16.5 

func (c *PinpointEmail) GetDomainStatisticsReport(input *GetDomainStatisticsReportInput) (*GetDomainStatisticsReportOutput, error)

GetDomainStatisticsReport API operation for Amazon Pinpoint Email Service.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint Email Service's API operation GetDomainStatisticsReport for usage and error information.

Returned Error Types:

  • TooManyRequestsException Too many requests have been made to the operation.

  • NotFoundException The resource you attempted to access doesn't exist.

  • BadRequestException The input you provided is invalid.

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

func (*PinpointEmail) GetDomainStatisticsReportRequest added in v1.16.5 

func (c *PinpointEmail) GetDomainStatisticsReportRequest(input *GetDomainStatisticsReportInput) (req *request.Request, output *GetDomainStatisticsReportOutput)

GetDomainStatisticsReportRequest generates a "aws/request.Request" representing the client's request for the GetDomainStatisticsReport operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetDomainStatisticsReport for more information on using the GetDomainStatisticsReport API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetDomainStatisticsReportRequest method.
req, resp := client.GetDomainStatisticsReportRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*PinpointEmail) GetDomainStatisticsReportWithContext added in v1.16.5 

func (c *PinpointEmail) GetDomainStatisticsReportWithContext(ctx aws.Context, input *GetDomainStatisticsReportInput, opts ...request.Option) (*GetDomainStatisticsReportOutput, error)

GetDomainStatisticsReportWithContext is the same as GetDomainStatisticsReport with the addition of the ability to pass a context and additional request options.

See GetDomainStatisticsReport for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*PinpointEmail) GetEmailIdentity 

func (c *PinpointEmail) GetEmailIdentity(input *GetEmailIdentityInput) (*GetEmailIdentityOutput, error)

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint Email Service's API operation GetEmailIdentity for usage and error information.

Returned Error Types:

  • NotFoundException The resource you attempted to access doesn't exist.

  • TooManyRequestsException Too many requests have been made to the operation.

  • BadRequestException The input you provided is invalid.

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

func (*PinpointEmail) GetEmailIdentityRequest 

func (c *PinpointEmail) GetEmailIdentityRequest(input *GetEmailIdentityInput) (req *request.Request, output *GetEmailIdentityOutput)

GetEmailIdentityRequest generates a "aws/request.Request" representing the client's request for the GetEmailIdentity operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetEmailIdentity for more information on using the GetEmailIdentity API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetEmailIdentityRequest method.
req, resp := client.GetEmailIdentityRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*PinpointEmail) GetEmailIdentityWithContext 

func (c *PinpointEmail) GetEmailIdentityWithContext(ctx aws.Context, input *GetEmailIdentityInput, opts ...request.Option) (*GetEmailIdentityOutput, error)

GetEmailIdentityWithContext is the same as GetEmailIdentity with the addition of the ability to pass a context and additional request options.

See GetEmailIdentity for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*PinpointEmail) ListConfigurationSets 

func (c *PinpointEmail) ListConfigurationSets(input *ListConfigurationSetsInput) (*ListConfigurationSetsOutput, error)

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint Email Service's API operation ListConfigurationSets for usage and error information.

Returned Error Types:

  • TooManyRequestsException Too many requests have been made to the operation.

  • BadRequestException The input you provided is invalid.

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

func (*PinpointEmail) ListConfigurationSetsPages 

func (c *PinpointEmail) ListConfigurationSetsPages(input *ListConfigurationSetsInput, fn func(*ListConfigurationSetsOutput, bool) bool) error

ListConfigurationSetsPages iterates over the pages of a ListConfigurationSets operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListConfigurationSets method for more information on how to use this operation.

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

// Example iterating over at most 3 pages of a ListConfigurationSets operation.
pageNum := 0
err := client.ListConfigurationSetsPages(params,
    func(page *pinpointemail.ListConfigurationSetsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*PinpointEmail) ListConfigurationSetsPagesWithContext 

func (c *PinpointEmail) ListConfigurationSetsPagesWithContext(ctx aws.Context, input *ListConfigurationSetsInput, fn func(*ListConfigurationSetsOutput, bool) bool, opts ...request.Option) error

ListConfigurationSetsPagesWithContext same as ListConfigurationSetsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*PinpointEmail) ListConfigurationSetsRequest 

func (c *PinpointEmail) ListConfigurationSetsRequest(input *ListConfigurationSetsInput) (req *request.Request, output *ListConfigurationSetsOutput)

ListConfigurationSetsRequest generates a "aws/request.Request" representing the client's request for the ListConfigurationSets operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListConfigurationSets for more information on using the ListConfigurationSets API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListConfigurationSetsRequest method.
req, resp := client.ListConfigurationSetsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*PinpointEmail) ListConfigurationSetsWithContext 

func (c *PinpointEmail) ListConfigurationSetsWithContext(ctx aws.Context, input *ListConfigurationSetsInput, opts ...request.Option) (*ListConfigurationSetsOutput, error)

ListConfigurationSetsWithContext is the same as ListConfigurationSets with the addition of the ability to pass a context and additional request options.

See ListConfigurationSets for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*PinpointEmail) ListDedicatedIpPools 

func (c *PinpointEmail) ListDedicatedIpPools(input *ListDedicatedIpPoolsInput) (*ListDedicatedIpPoolsOutput, error)

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint Email Service's API operation ListDedicatedIpPools for usage and error information.

Returned Error Types:

  • TooManyRequestsException Too many requests have been made to the operation.

  • BadRequestException The input you provided is invalid.

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

func (*PinpointEmail) ListDedicatedIpPoolsPages 

func (c *PinpointEmail) ListDedicatedIpPoolsPages(input *ListDedicatedIpPoolsInput, fn func(*ListDedicatedIpPoolsOutput, bool) bool) error

ListDedicatedIpPoolsPages iterates over the pages of a ListDedicatedIpPools operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListDedicatedIpPools method for more information on how to use this operation.

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

// Example iterating over at most 3 pages of a ListDedicatedIpPools operation.
pageNum := 0
err := client.ListDedicatedIpPoolsPages(params,
    func(page *pinpointemail.ListDedicatedIpPoolsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*PinpointEmail) ListDedicatedIpPoolsPagesWithContext 

func (c *PinpointEmail) ListDedicatedIpPoolsPagesWithContext(ctx aws.Context, input *ListDedicatedIpPoolsInput, fn func(*ListDedicatedIpPoolsOutput, bool) bool, opts ...request.Option) error

ListDedicatedIpPoolsPagesWithContext same as ListDedicatedIpPoolsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*PinpointEmail) ListDedicatedIpPoolsRequest 

func (c *PinpointEmail) ListDedicatedIpPoolsRequest(input *ListDedicatedIpPoolsInput) (req *request.Request, output *ListDedicatedIpPoolsOutput)

ListDedicatedIpPoolsRequest generates a "aws/request.Request" representing the client's request for the ListDedicatedIpPools operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListDedicatedIpPools for more information on using the ListDedicatedIpPools API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListDedicatedIpPoolsRequest method.
req, resp := client.ListDedicatedIpPoolsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*PinpointEmail) ListDedicatedIpPoolsWithContext 

func (c *PinpointEmail) ListDedicatedIpPoolsWithContext(ctx aws.Context, input *ListDedicatedIpPoolsInput, opts ...request.Option) (*ListDedicatedIpPoolsOutput, error)

ListDedicatedIpPoolsWithContext is the same as ListDedicatedIpPools with the addition of the ability to pass a context and additional request options.

See ListDedicatedIpPools for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*PinpointEmail) ListDeliverabilityTestReports added in v1.16.5 

func (c *PinpointEmail) ListDeliverabilityTestReports(input *ListDeliverabilityTestReportsInput) (*ListDeliverabilityTestReportsOutput, error)

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint Email Service's API operation ListDeliverabilityTestReports for usage and error information.

Returned Error Types:

  • TooManyRequestsException Too many requests have been made to the operation.

  • NotFoundException The resource you attempted to access doesn't exist.

  • BadRequestException The input you provided is invalid.

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

func (*PinpointEmail) ListDeliverabilityTestReportsPages added in v1.16.5 

func (c *PinpointEmail) ListDeliverabilityTestReportsPages(input *ListDeliverabilityTestReportsInput, fn func(*ListDeliverabilityTestReportsOutput, bool) bool) error

ListDeliverabilityTestReportsPages iterates over the pages of a ListDeliverabilityTestReports operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListDeliverabilityTestReports method for more information on how to use this operation.

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

// Example iterating over at most 3 pages of a ListDeliverabilityTestReports operation.
pageNum := 0
err := client.ListDeliverabilityTestReportsPages(params,
    func(page *pinpointemail.ListDeliverabilityTestReportsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*PinpointEmail) ListDeliverabilityTestReportsPagesWithContext added in v1.16.5 

func (c *PinpointEmail) ListDeliverabilityTestReportsPagesWithContext(ctx aws.Context, input *ListDeliverabilityTestReportsInput, fn func(*ListDeliverabilityTestReportsOutput, bool) bool, opts ...request.Option) error

ListDeliverabilityTestReportsPagesWithContext same as ListDeliverabilityTestReportsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*PinpointEmail) ListDeliverabilityTestReportsRequest added in v1.16.5 

func (c *PinpointEmail) ListDeliverabilityTestReportsRequest(input *ListDeliverabilityTestReportsInput) (req *request.Request, output *ListDeliverabilityTestReportsOutput)

ListDeliverabilityTestReportsRequest generates a "aws/request.Request" representing the client's request for the ListDeliverabilityTestReports operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListDeliverabilityTestReports for more information on using the ListDeliverabilityTestReports API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListDeliverabilityTestReportsRequest method.
req, resp := client.ListDeliverabilityTestReportsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*PinpointEmail) ListDeliverabilityTestReportsWithContext added in v1.16.5 

func (c *PinpointEmail) ListDeliverabilityTestReportsWithContext(ctx aws.Context, input *ListDeliverabilityTestReportsInput, opts ...request.Option) (*ListDeliverabilityTestReportsOutput, error)

ListDeliverabilityTestReportsWithContext is the same as ListDeliverabilityTestReports with the addition of the ability to pass a context and additional request options.

See ListDeliverabilityTestReports for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*PinpointEmail) ListDomainDeliverabilityCampaigns added in v1.19.39 

func (c *PinpointEmail) ListDomainDeliverabilityCampaigns(input *ListDomainDeliverabilityCampaignsInput) (*ListDomainDeliverabilityCampaignsOutput, error)

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint Email Service's API operation ListDomainDeliverabilityCampaigns for usage and error information.

Returned Error Types:

  • TooManyRequestsException Too many requests have been made to the operation.

  • BadRequestException The input you provided is invalid.

  • NotFoundException The resource you attempted to access doesn't exist.

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

func (*PinpointEmail) ListDomainDeliverabilityCampaignsPages added in v1.19.39 

func (c *PinpointEmail) ListDomainDeliverabilityCampaignsPages(input *ListDomainDeliverabilityCampaignsInput, fn func(*ListDomainDeliverabilityCampaignsOutput, bool) bool) error

ListDomainDeliverabilityCampaignsPages iterates over the pages of a ListDomainDeliverabilityCampaigns operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListDomainDeliverabilityCampaigns method for more information on how to use this operation.

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

// Example iterating over at most 3 pages of a ListDomainDeliverabilityCampaigns operation.
pageNum := 0
err := client.ListDomainDeliverabilityCampaignsPages(params,
    func(page *pinpointemail.ListDomainDeliverabilityCampaignsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*PinpointEmail) ListDomainDeliverabilityCampaignsPagesWithContext added in v1.19.39 

func (c *PinpointEmail) ListDomainDeliverabilityCampaignsPagesWithContext(ctx aws.Context, input *ListDomainDeliverabilityCampaignsInput, fn func(*ListDomainDeliverabilityCampaignsOutput, bool) bool, opts ...request.Option) error

ListDomainDeliverabilityCampaignsPagesWithContext same as ListDomainDeliverabilityCampaignsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*PinpointEmail) ListDomainDeliverabilityCampaignsRequest added in v1.19.39 

func (c *PinpointEmail) ListDomainDeliverabilityCampaignsRequest(input *ListDomainDeliverabilityCampaignsInput) (req *request.Request, output *ListDomainDeliverabilityCampaignsOutput)

ListDomainDeliverabilityCampaignsRequest generates a "aws/request.Request" representing the client's request for the ListDomainDeliverabilityCampaigns operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListDomainDeliverabilityCampaigns for more information on using the ListDomainDeliverabilityCampaigns API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListDomainDeliverabilityCampaignsRequest method.
req, resp := client.ListDomainDeliverabilityCampaignsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*PinpointEmail) ListDomainDeliverabilityCampaignsWithContext added in v1.19.39 

func (c *PinpointEmail) ListDomainDeliverabilityCampaignsWithContext(ctx aws.Context, input *ListDomainDeliverabilityCampaignsInput, opts ...request.Option) (*ListDomainDeliverabilityCampaignsOutput, error)

ListDomainDeliverabilityCampaignsWithContext is the same as ListDomainDeliverabilityCampaigns with the addition of the ability to pass a context and additional request options.

See ListDomainDeliverabilityCampaigns for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*PinpointEmail) ListEmailIdentities 

func (c *PinpointEmail) ListEmailIdentities(input *ListEmailIdentitiesInput) (*ListEmailIdentitiesOutput, error)

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint Email Service's API operation ListEmailIdentities for usage and error information.

Returned Error Types:

  • TooManyRequestsException Too many requests have been made to the operation.

  • BadRequestException The input you provided is invalid.

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

func (*PinpointEmail) ListEmailIdentitiesPages 

func (c *PinpointEmail) ListEmailIdentitiesPages(input *ListEmailIdentitiesInput, fn func(*ListEmailIdentitiesOutput, bool) bool) error

ListEmailIdentitiesPages iterates over the pages of a ListEmailIdentities operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListEmailIdentities method for more information on how to use this operation.

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

// Example iterating over at most 3 pages of a ListEmailIdentities operation.
pageNum := 0
err := client.ListEmailIdentitiesPages(params,
    func(page *pinpointemail.ListEmailIdentitiesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*PinpointEmail) ListEmailIdentitiesPagesWithContext 

func (c *PinpointEmail) ListEmailIdentitiesPagesWithContext(ctx aws.Context, input *ListEmailIdentitiesInput, fn func(*ListEmailIdentitiesOutput, bool) bool, opts ...request.Option) error

ListEmailIdentitiesPagesWithContext same as ListEmailIdentitiesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*PinpointEmail) ListEmailIdentitiesRequest 

func (c *PinpointEmail) ListEmailIdentitiesRequest(input *ListEmailIdentitiesInput) (req *request.Request, output *ListEmailIdentitiesOutput)

ListEmailIdentitiesRequest generates a "aws/request.Request" representing the client's request for the ListEmailIdentities operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListEmailIdentities for more information on using the ListEmailIdentities API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListEmailIdentitiesRequest method.
req, resp := client.ListEmailIdentitiesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*PinpointEmail) ListEmailIdentitiesWithContext 

func (c *PinpointEmail) ListEmailIdentitiesWithContext(ctx aws.Context, input *ListEmailIdentitiesInput, opts ...request.Option) (*ListEmailIdentitiesOutput, error)

ListEmailIdentitiesWithContext is the same as ListEmailIdentities with the addition of the ability to pass a context and additional request options.

See ListEmailIdentities for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*PinpointEmail) ListTagsForResource added in v1.19.5 

func (c *PinpointEmail) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error)

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint Email Service's API operation ListTagsForResource for usage and error information.

Returned Error Types:

  • BadRequestException The input you provided is invalid.

  • NotFoundException The resource you attempted to access doesn't exist.

  • TooManyRequestsException Too many requests have been made to the operation.

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

func (*PinpointEmail) ListTagsForResourceRequest added in v1.19.5 

func (c *PinpointEmail) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput)

ListTagsForResourceRequest generates a "aws/request.Request" representing the client's request for the ListTagsForResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListTagsForResource for more information on using the ListTagsForResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListTagsForResourceRequest method.
req, resp := client.ListTagsForResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*PinpointEmail) ListTagsForResourceWithContext added in v1.19.5 

func (c *PinpointEmail) ListTagsForResourceWithContext(ctx aws.Context, input *ListTagsForResourceInput, opts ...request.Option) (*ListTagsForResourceOutput, error)

ListTagsForResourceWithContext is the same as ListTagsForResource with the addition of the ability to pass a context and additional request options.

See ListTagsForResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*PinpointEmail) PutAccountDedicatedIpWarmupAttributes 

func (c *PinpointEmail) PutAccountDedicatedIpWarmupAttributes(input *PutAccountDedicatedIpWarmupAttributesInput) (*PutAccountDedicatedIpWarmupAttributesOutput, error)

PutAccountDedicatedIpWarmupAttributes API operation for Amazon Pinpoint Email Service.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint Email Service's API operation PutAccountDedicatedIpWarmupAttributes for usage and error information.

Returned Error Types:

  • TooManyRequestsException Too many requests have been made to the operation.

  • BadRequestException The input you provided is invalid.

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

func (*PinpointEmail) PutAccountDedicatedIpWarmupAttributesRequest 

func (c *PinpointEmail) PutAccountDedicatedIpWarmupAttributesRequest(input *PutAccountDedicatedIpWarmupAttributesInput) (req *request.Request, output *PutAccountDedicatedIpWarmupAttributesOutput)

PutAccountDedicatedIpWarmupAttributesRequest generates a "aws/request.Request" representing the client's request for the PutAccountDedicatedIpWarmupAttributes operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See PutAccountDedicatedIpWarmupAttributes for more information on using the PutAccountDedicatedIpWarmupAttributes API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the PutAccountDedicatedIpWarmupAttributesRequest method.
req, resp := client.PutAccountDedicatedIpWarmupAttributesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*PinpointEmail) PutAccountDedicatedIpWarmupAttributesWithContext 

func (c *PinpointEmail) PutAccountDedicatedIpWarmupAttributesWithContext(ctx aws.Context, input *PutAccountDedicatedIpWarmupAttributesInput, opts ...request.Option) (*PutAccountDedicatedIpWarmupAttributesOutput, error)

PutAccountDedicatedIpWarmupAttributesWithContext is the same as PutAccountDedicatedIpWarmupAttributes with the addition of the ability to pass a context and additional request options.

See PutAccountDedicatedIpWarmupAttributes for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*PinpointEmail) PutAccountSendingAttributes 

func (c *PinpointEmail) PutAccountSendingAttributes(input *PutAccountSendingAttributesInput) (*PutAccountSendingAttributesOutput, error)

PutAccountSendingAttributes API operation for Amazon Pinpoint Email Service.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint Email Service's API operation PutAccountSendingAttributes for usage and error information.

Returned Error Types:

  • TooManyRequestsException Too many requests have been made to the operation.

  • BadRequestException The input you provided is invalid.

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

func (*PinpointEmail) PutAccountSendingAttributesRequest 

func (c *PinpointEmail) PutAccountSendingAttributesRequest(input *PutAccountSendingAttributesInput) (req *request.Request, output *PutAccountSendingAttributesOutput)

PutAccountSendingAttributesRequest generates a "aws/request.Request" representing the client's request for the PutAccountSendingAttributes operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See PutAccountSendingAttributes for more information on using the PutAccountSendingAttributes API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the PutAccountSendingAttributesRequest method.
req, resp := client.PutAccountSendingAttributesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*PinpointEmail) PutAccountSendingAttributesWithContext 

func (c *PinpointEmail) PutAccountSendingAttributesWithContext(ctx aws.Context, input *PutAccountSendingAttributesInput, opts ...request.Option) (*PutAccountSendingAttributesOutput, error)

PutAccountSendingAttributesWithContext is the same as PutAccountSendingAttributes with the addition of the ability to pass a context and additional request options.

See PutAccountSendingAttributes for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*PinpointEmail) PutConfigurationSetDeliveryOptions 

func (c *PinpointEmail) PutConfigurationSetDeliveryOptions(input *PutConfigurationSetDeliveryOptionsInput) (*PutConfigurationSetDeliveryOptionsOutput, error)

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint Email Service's API operation PutConfigurationSetDeliveryOptions for usage and error information.

Returned Error Types:

  • NotFoundException The resource you attempted to access doesn't exist.

  • TooManyRequestsException Too many requests have been made to the operation.

  • BadRequestException The input you provided is invalid.

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

func (*PinpointEmail) PutConfigurationSetDeliveryOptionsRequest 

func (c *PinpointEmail) PutConfigurationSetDeliveryOptionsRequest(input *PutConfigurationSetDeliveryOptionsInput) (req *request.Request, output *PutConfigurationSetDeliveryOptionsOutput)

PutConfigurationSetDeliveryOptionsRequest generates a "aws/request.Request" representing the client's request for the PutConfigurationSetDeliveryOptions operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See PutConfigurationSetDeliveryOptions for more information on using the PutConfigurationSetDeliveryOptions API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the PutConfigurationSetDeliveryOptionsRequest method.
req, resp := client.PutConfigurationSetDeliveryOptionsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*PinpointEmail) PutConfigurationSetDeliveryOptionsWithContext 

func (c *PinpointEmail) PutConfigurationSetDeliveryOptionsWithContext(ctx aws.Context, input *PutConfigurationSetDeliveryOptionsInput, opts ...request.Option) (*PutConfigurationSetDeliveryOptionsOutput, error)

PutConfigurationSetDeliveryOptionsWithContext is the same as PutConfigurationSetDeliveryOptions with the addition of the ability to pass a context and additional request options.

See PutConfigurationSetDeliveryOptions for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*PinpointEmail) PutConfigurationSetReputationOptions 

func (c *PinpointEmail) PutConfigurationSetReputationOptions(input *PutConfigurationSetReputationOptionsInput) (*PutConfigurationSetReputationOptionsOutput, error)

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint Email Service's API operation PutConfigurationSetReputationOptions for usage and error information.

Returned Error Types:

  • NotFoundException The resource you attempted to access doesn't exist.

  • TooManyRequestsException Too many requests have been made to the operation.

  • BadRequestException The input you provided is invalid.

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

func (*PinpointEmail) PutConfigurationSetReputationOptionsRequest 

func (c *PinpointEmail) PutConfigurationSetReputationOptionsRequest(input *PutConfigurationSetReputationOptionsInput) (req *request.Request, output *PutConfigurationSetReputationOptionsOutput)

PutConfigurationSetReputationOptionsRequest generates a "aws/request.Request" representing the client's request for the PutConfigurationSetReputationOptions operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See PutConfigurationSetReputationOptions for more information on using the PutConfigurationSetReputationOptions API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the PutConfigurationSetReputationOptionsRequest method.
req, resp := client.PutConfigurationSetReputationOptionsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*PinpointEmail) PutConfigurationSetReputationOptionsWithContext 

func (c *PinpointEmail) PutConfigurationSetReputationOptionsWithContext(ctx aws.Context, input *PutConfigurationSetReputationOptionsInput, opts ...request.Option) (*PutConfigurationSetReputationOptionsOutput, error)

PutConfigurationSetReputationOptionsWithContext is the same as PutConfigurationSetReputationOptions with the addition of the ability to pass a context and additional request options.

See PutConfigurationSetReputationOptions for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*PinpointEmail) PutConfigurationSetSendingOptions 

func (c *PinpointEmail) PutConfigurationSetSendingOptions(input *PutConfigurationSetSendingOptionsInput) (*PutConfigurationSetSendingOptionsOutput, error)

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint Email Service's API operation PutConfigurationSetSendingOptions for usage and error information.

Returned Error Types:

  • NotFoundException The resource you attempted to access doesn't exist.

  • TooManyRequestsException Too many requests have been made to the operation.

  • BadRequestException The input you provided is invalid.

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

func (*PinpointEmail) PutConfigurationSetSendingOptionsRequest 

func (c *PinpointEmail) PutConfigurationSetSendingOptionsRequest(input *PutConfigurationSetSendingOptionsInput) (req *request.Request, output *PutConfigurationSetSendingOptionsOutput)

PutConfigurationSetSendingOptionsRequest generates a "aws/request.Request" representing the client's request for the PutConfigurationSetSendingOptions operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See PutConfigurationSetSendingOptions for more information on using the PutConfigurationSetSendingOptions API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the PutConfigurationSetSendingOptionsRequest method.
req, resp := client.PutConfigurationSetSendingOptionsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*PinpointEmail) PutConfigurationSetSendingOptionsWithContext 

func (c *PinpointEmail) PutConfigurationSetSendingOptionsWithContext(ctx aws.Context, input *PutConfigurationSetSendingOptionsInput, opts ...request.Option) (*PutConfigurationSetSendingOptionsOutput, error)

PutConfigurationSetSendingOptionsWithContext is the same as PutConfigurationSetSendingOptions with the addition of the ability to pass a context and additional request options.

See PutConfigurationSetSendingOptions for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*PinpointEmail) PutConfigurationSetTrackingOptions 

func (c *PinpointEmail) PutConfigurationSetTrackingOptions(input *PutConfigurationSetTrackingOptionsInput) (*PutConfigurationSetTrackingOptionsOutput, error)

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint Email Service's API operation PutConfigurationSetTrackingOptions for usage and error information.

Returned Error Types:

  • NotFoundException The resource you attempted to access doesn't exist.

  • TooManyRequestsException Too many requests have been made to the operation.

  • BadRequestException The input you provided is invalid.

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

func (*PinpointEmail) PutConfigurationSetTrackingOptionsRequest 

func (c *PinpointEmail) PutConfigurationSetTrackingOptionsRequest(input *PutConfigurationSetTrackingOptionsInput) (req *request.Request, output *PutConfigurationSetTrackingOptionsOutput)

PutConfigurationSetTrackingOptionsRequest generates a "aws/request.Request" representing the client's request for the PutConfigurationSetTrackingOptions operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See PutConfigurationSetTrackingOptions for more information on using the PutConfigurationSetTrackingOptions API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the PutConfigurationSetTrackingOptionsRequest method.
req, resp := client.PutConfigurationSetTrackingOptionsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*PinpointEmail) PutConfigurationSetTrackingOptionsWithContext 

func (c *PinpointEmail) PutConfigurationSetTrackingOptionsWithContext(ctx aws.Context, input *PutConfigurationSetTrackingOptionsInput, opts ...request.Option) (*PutConfigurationSetTrackingOptionsOutput, error)

PutConfigurationSetTrackingOptionsWithContext is the same as PutConfigurationSetTrackingOptions with the addition of the ability to pass a context and additional request options.

See PutConfigurationSetTrackingOptions for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*PinpointEmail) PutDedicatedIpInPool 

func (c *PinpointEmail) PutDedicatedIpInPool(input *PutDedicatedIpInPoolInput) (*PutDedicatedIpInPoolOutput, error)

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint Email Service's API operation PutDedicatedIpInPool for usage and error information.

Returned Error Types:

  • NotFoundException The resource you attempted to access doesn't exist.

  • TooManyRequestsException Too many requests have been made to the operation.

  • BadRequestException The input you provided is invalid.

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

func (*PinpointEmail) PutDedicatedIpInPoolRequest 

func (c *PinpointEmail) PutDedicatedIpInPoolRequest(input *PutDedicatedIpInPoolInput) (req *request.Request, output *PutDedicatedIpInPoolOutput)

PutDedicatedIpInPoolRequest generates a "aws/request.Request" representing the client's request for the PutDedicatedIpInPool operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See PutDedicatedIpInPool for more information on using the PutDedicatedIpInPool API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the PutDedicatedIpInPoolRequest method.
req, resp := client.PutDedicatedIpInPoolRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*PinpointEmail) PutDedicatedIpInPoolWithContext 

func (c *PinpointEmail) PutDedicatedIpInPoolWithContext(ctx aws.Context, input *PutDedicatedIpInPoolInput, opts ...request.Option) (*PutDedicatedIpInPoolOutput, error)

PutDedicatedIpInPoolWithContext is the same as PutDedicatedIpInPool with the addition of the ability to pass a context and additional request options.

See PutDedicatedIpInPool for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*PinpointEmail) PutDedicatedIpWarmupAttributes 

func (c *PinpointEmail) PutDedicatedIpWarmupAttributes(input *PutDedicatedIpWarmupAttributesInput) (*PutDedicatedIpWarmupAttributesOutput, error)

PutDedicatedIpWarmupAttributes API operation for Amazon Pinpoint Email Service.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint Email Service's API operation PutDedicatedIpWarmupAttributes for usage and error information.

Returned Error Types:

  • NotFoundException The resource you attempted to access doesn't exist.

  • TooManyRequestsException Too many requests have been made to the operation.

  • BadRequestException The input you provided is invalid.

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

func (*PinpointEmail) PutDedicatedIpWarmupAttributesRequest 

func (c *PinpointEmail) PutDedicatedIpWarmupAttributesRequest(input *PutDedicatedIpWarmupAttributesInput) (req *request.Request, output *PutDedicatedIpWarmupAttributesOutput)

PutDedicatedIpWarmupAttributesRequest generates a "aws/request.Request" representing the client's request for the PutDedicatedIpWarmupAttributes operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See PutDedicatedIpWarmupAttributes for more information on using the PutDedicatedIpWarmupAttributes API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the PutDedicatedIpWarmupAttributesRequest method.
req, resp := client.PutDedicatedIpWarmupAttributesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*PinpointEmail) PutDedicatedIpWarmupAttributesWithContext 

func (c *PinpointEmail) PutDedicatedIpWarmupAttributesWithContext(ctx aws.Context, input *PutDedicatedIpWarmupAttributesInput, opts ...request.Option) (*PutDedicatedIpWarmupAttributesOutput, error)

PutDedicatedIpWarmupAttributesWithContext is the same as PutDedicatedIpWarmupAttributes with the addition of the ability to pass a context and additional request options.

See PutDedicatedIpWarmupAttributes for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*PinpointEmail) PutDeliverabilityDashboardOption added in v1.16.5 

func (c *PinpointEmail) PutDeliverabilityDashboardOption(input *PutDeliverabilityDashboardOptionInput) (*PutDeliverabilityDashboardOptionOutput, error)

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint Email Service's API operation PutDeliverabilityDashboardOption for usage and error information.

Returned Error Types:

  • AlreadyExistsException The resource specified in your request already exists.

  • NotFoundException The resource you attempted to access doesn't exist.

  • TooManyRequestsException Too many requests have been made to the operation.

  • LimitExceededException There are too many instances of the specified resource type.

  • BadRequestException The input you provided is invalid.

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

func (*PinpointEmail) PutDeliverabilityDashboardOptionRequest added in v1.16.5 

func (c *PinpointEmail) PutDeliverabilityDashboardOptionRequest(input *PutDeliverabilityDashboardOptionInput) (req *request.Request, output *PutDeliverabilityDashboardOptionOutput)

PutDeliverabilityDashboardOptionRequest generates a "aws/request.Request" representing the client's request for the PutDeliverabilityDashboardOption operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See PutDeliverabilityDashboardOption for more information on using the PutDeliverabilityDashboardOption API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the PutDeliverabilityDashboardOptionRequest method.
req, resp := client.PutDeliverabilityDashboardOptionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*PinpointEmail) PutDeliverabilityDashboardOptionWithContext added in v1.16.5 

func (c *PinpointEmail) PutDeliverabilityDashboardOptionWithContext(ctx aws.Context, input *PutDeliverabilityDashboardOptionInput, opts ...request.Option) (*PutDeliverabilityDashboardOptionOutput, error)

PutDeliverabilityDashboardOptionWithContext is the same as PutDeliverabilityDashboardOption with the addition of the ability to pass a context and additional request options.

See PutDeliverabilityDashboardOption for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*PinpointEmail) PutEmailIdentityDkimAttributes 

func (c *PinpointEmail) PutEmailIdentityDkimAttributes(input *PutEmailIdentityDkimAttributesInput) (*PutEmailIdentityDkimAttributesOutput, error)

PutEmailIdentityDkimAttributes API operation for Amazon Pinpoint Email Service.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint Email Service's API operation PutEmailIdentityDkimAttributes for usage and error information.

Returned Error Types:

  • NotFoundException The resource you attempted to access doesn't exist.

  • TooManyRequestsException Too many requests have been made to the operation.

  • BadRequestException The input you provided is invalid.

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

func (*PinpointEmail) PutEmailIdentityDkimAttributesRequest 

func (c *PinpointEmail) PutEmailIdentityDkimAttributesRequest(input *PutEmailIdentityDkimAttributesInput) (req *request.Request, output *PutEmailIdentityDkimAttributesOutput)

PutEmailIdentityDkimAttributesRequest generates a "aws/request.Request" representing the client's request for the PutEmailIdentityDkimAttributes operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See PutEmailIdentityDkimAttributes for more information on using the PutEmailIdentityDkimAttributes API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the PutEmailIdentityDkimAttributesRequest method.
req, resp := client.PutEmailIdentityDkimAttributesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*PinpointEmail) PutEmailIdentityDkimAttributesWithContext 

func (c *PinpointEmail) PutEmailIdentityDkimAttributesWithContext(ctx aws.Context, input *PutEmailIdentityDkimAttributesInput, opts ...request.Option) (*PutEmailIdentityDkimAttributesOutput, error)

PutEmailIdentityDkimAttributesWithContext is the same as PutEmailIdentityDkimAttributes with the addition of the ability to pass a context and additional request options.

See PutEmailIdentityDkimAttributes for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*PinpointEmail) PutEmailIdentityFeedbackAttributes 

func (c *PinpointEmail) PutEmailIdentityFeedbackAttributes(input *PutEmailIdentityFeedbackAttributesInput) (*PutEmailIdentityFeedbackAttributesOutput, error)

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint Email Service's API operation PutEmailIdentityFeedbackAttributes for usage and error information.

Returned Error Types:

  • NotFoundException The resource you attempted to access doesn't exist.

  • TooManyRequestsException Too many requests have been made to the operation.

  • BadRequestException The input you provided is invalid.

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

func (*PinpointEmail) PutEmailIdentityFeedbackAttributesRequest 

func (c *PinpointEmail) PutEmailIdentityFeedbackAttributesRequest(input *PutEmailIdentityFeedbackAttributesInput) (req *request.Request, output *PutEmailIdentityFeedbackAttributesOutput)

PutEmailIdentityFeedbackAttributesRequest generates a "aws/request.Request" representing the client's request for the PutEmailIdentityFeedbackAttributes operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See PutEmailIdentityFeedbackAttributes for more information on using the PutEmailIdentityFeedbackAttributes API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the PutEmailIdentityFeedbackAttributesRequest method.
req, resp := client.PutEmailIdentityFeedbackAttributesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*PinpointEmail) PutEmailIdentityFeedbackAttributesWithContext 

func (c *PinpointEmail) PutEmailIdentityFeedbackAttributesWithContext(ctx aws.Context, input *PutEmailIdentityFeedbackAttributesInput, opts ...request.Option) (*PutEmailIdentityFeedbackAttributesOutput, error)

PutEmailIdentityFeedbackAttributesWithContext is the same as PutEmailIdentityFeedbackAttributes with the addition of the ability to pass a context and additional request options.

See PutEmailIdentityFeedbackAttributes for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*PinpointEmail) PutEmailIdentityMailFromAttributes 

func (c *PinpointEmail) PutEmailIdentityMailFromAttributes(input *PutEmailIdentityMailFromAttributesInput) (*PutEmailIdentityMailFromAttributesOutput, error)

PutEmailIdentityMailFromAttributes API operation for Amazon Pinpoint Email Service.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint Email Service's API operation PutEmailIdentityMailFromAttributes for usage and error information.

Returned Error Types:

  • NotFoundException The resource you attempted to access doesn't exist.

  • TooManyRequestsException Too many requests have been made to the operation.

  • BadRequestException The input you provided is invalid.

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

func (*PinpointEmail) PutEmailIdentityMailFromAttributesRequest 

func (c *PinpointEmail) PutEmailIdentityMailFromAttributesRequest(input *PutEmailIdentityMailFromAttributesInput) (req *request.Request, output *PutEmailIdentityMailFromAttributesOutput)

PutEmailIdentityMailFromAttributesRequest generates a "aws/request.Request" representing the client's request for the PutEmailIdentityMailFromAttributes operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See PutEmailIdentityMailFromAttributes for more information on using the PutEmailIdentityMailFromAttributes API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the PutEmailIdentityMailFromAttributesRequest method.
req, resp := client.PutEmailIdentityMailFromAttributesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*PinpointEmail) PutEmailIdentityMailFromAttributesWithContext 

func (c *PinpointEmail) PutEmailIdentityMailFromAttributesWithContext(ctx aws.Context, input *PutEmailIdentityMailFromAttributesInput, opts ...request.Option) (*PutEmailIdentityMailFromAttributesOutput, error)

PutEmailIdentityMailFromAttributesWithContext is the same as PutEmailIdentityMailFromAttributes with the addition of the ability to pass a context and additional request options.

See PutEmailIdentityMailFromAttributes for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*PinpointEmail) SendEmail 

func (c *PinpointEmail) SendEmail(input *SendEmailInput) (*SendEmailOutput, error)

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint Email Service's API operation SendEmail for usage and error information.

Returned Error Types:

  • TooManyRequestsException Too many requests have been made to the operation.

  • LimitExceededException There are too many instances of the specified resource type.

  • AccountSuspendedException The message can't be sent because the account's ability to send email has been permanently restricted.

  • SendingPausedException The message can't be sent because the account's ability to send email is currently paused.

  • MessageRejected The message can't be sent because it contains invalid content.

  • MailFromDomainNotVerifiedException The message can't be sent because the sending domain isn't verified.

  • NotFoundException The resource you attempted to access doesn't exist.

  • BadRequestException The input you provided is invalid.

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

func (*PinpointEmail) SendEmailRequest 

func (c *PinpointEmail) SendEmailRequest(input *SendEmailInput) (req *request.Request, output *SendEmailOutput)

SendEmailRequest generates a "aws/request.Request" representing the client's request for the SendEmail operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See SendEmail for more information on using the SendEmail API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the SendEmailRequest method.
req, resp := client.SendEmailRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*PinpointEmail) SendEmailWithContext 

func (c *PinpointEmail) SendEmailWithContext(ctx aws.Context, input *SendEmailInput, opts ...request.Option) (*SendEmailOutput, error)

SendEmailWithContext is the same as SendEmail with the addition of the ability to pass a context and additional request options.

See SendEmail for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*PinpointEmail) TagResource added in v1.19.5 

func (c *PinpointEmail) TagResource(input *TagResourceInput) (*TagResourceOutput, error)

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint Email Service's API operation TagResource for usage and error information.

Returned Error Types:

  • BadRequestException The input you provided is invalid.

  • ConcurrentModificationException The resource is being modified by another operation or thread.

  • NotFoundException The resource you attempted to access doesn't exist.

  • TooManyRequestsException Too many requests have been made to the operation.

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

func (*PinpointEmail) TagResourceRequest added in v1.19.5 

func (c *PinpointEmail) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput)

TagResourceRequest generates a "aws/request.Request" representing the client's request for the TagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See TagResource for more information on using the TagResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the TagResourceRequest method.
req, resp := client.TagResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*PinpointEmail) TagResourceWithContext added in v1.19.5 

func (c *PinpointEmail) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error)

TagResourceWithContext is the same as TagResource with the addition of the ability to pass a context and additional request options.

See TagResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*PinpointEmail) UntagResource added in v1.19.5 

func (c *PinpointEmail) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error)

UntagResource API operation for Amazon Pinpoint Email Service.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint Email Service's API operation UntagResource for usage and error information.

Returned Error Types:

  • BadRequestException The input you provided is invalid.

  • ConcurrentModificationException The resource is being modified by another operation or thread.

  • NotFoundException The resource you attempted to access doesn't exist.

  • TooManyRequestsException Too many requests have been made to the operation.

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

func (*PinpointEmail) UntagResourceRequest added in v1.19.5 

func (c *PinpointEmail) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput)

UntagResourceRequest generates a "aws/request.Request" representing the client's request for the UntagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UntagResource for more information on using the UntagResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UntagResourceRequest method.
req, resp := client.UntagResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*PinpointEmail) UntagResourceWithContext added in v1.19.5 

func (c *PinpointEmail) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error)

UntagResourceWithContext is the same as UntagResource with the addition of the ability to pass a context and additional request options.

See UntagResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*PinpointEmail) UpdateConfigurationSetEventDestination 

func (c *PinpointEmail) UpdateConfigurationSetEventDestination(input *UpdateConfigurationSetEventDestinationInput) (*UpdateConfigurationSetEventDestinationOutput, error)

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint Email Service's API operation UpdateConfigurationSetEventDestination for usage and error information.

Returned Error Types:

  • NotFoundException The resource you attempted to access doesn't exist.

  • TooManyRequestsException Too many requests have been made to the operation.

  • BadRequestException The input you provided is invalid.

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

func (*PinpointEmail) UpdateConfigurationSetEventDestinationRequest 

func (c *PinpointEmail) UpdateConfigurationSetEventDestinationRequest(input *UpdateConfigurationSetEventDestinationInput) (req *request.Request, output *UpdateConfigurationSetEventDestinationOutput)

UpdateConfigurationSetEventDestinationRequest generates a "aws/request.Request" representing the client's request for the UpdateConfigurationSetEventDestination operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateConfigurationSetEventDestination for more information on using the UpdateConfigurationSetEventDestination API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UpdateConfigurationSetEventDestinationRequest method.
req, resp := client.UpdateConfigurationSetEventDestinationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*PinpointEmail) UpdateConfigurationSetEventDestinationWithContext 

func (c *PinpointEmail) UpdateConfigurationSetEventDestinationWithContext(ctx aws.Context, input *UpdateConfigurationSetEventDestinationInput, opts ...request.Option) (*UpdateConfigurationSetEventDestinationOutput, error)

UpdateConfigurationSetEventDestinationWithContext is the same as UpdateConfigurationSetEventDestination with the addition of the ability to pass a context and additional request options.

See UpdateConfigurationSetEventDestination for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

type PlacementStatistics added in v1.16.5 

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) GoString added in v1.16.5 

func (s PlacementStatistics) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PlacementStatistics) SetDkimPercentage added in v1.16.5 

func (s *PlacementStatistics) SetDkimPercentage(v float64) *PlacementStatistics

SetDkimPercentage sets the DkimPercentage field's value.

func (*PlacementStatistics) SetInboxPercentage added in v1.16.5 

func (s *PlacementStatistics) SetInboxPercentage(v float64) *PlacementStatistics

SetInboxPercentage sets the InboxPercentage field's value.

func (*PlacementStatistics) SetMissingPercentage added in v1.16.5 

func (s *PlacementStatistics) SetMissingPercentage(v float64) *PlacementStatistics

SetMissingPercentage sets the MissingPercentage field's value.

func (*PlacementStatistics) SetSpamPercentage added in v1.16.5 

func (s *PlacementStatistics) SetSpamPercentage(v float64) *PlacementStatistics

SetSpamPercentage sets the SpamPercentage field's value.

func (*PlacementStatistics) SetSpfPercentage added in v1.16.5 

func (s *PlacementStatistics) SetSpfPercentage(v float64) *PlacementStatistics

SetSpfPercentage sets the SpfPercentage field's value.

func (PlacementStatistics) String added in v1.16.5 

func (s PlacementStatistics) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s PutAccountDedicatedIpWarmupAttributesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutAccountDedicatedIpWarmupAttributesInput) SetAutoWarmupEnabled 

func (s *PutAccountDedicatedIpWarmupAttributesInput) SetAutoWarmupEnabled(v bool) *PutAccountDedicatedIpWarmupAttributesInput

SetAutoWarmupEnabled sets the AutoWarmupEnabled field's value.

func (PutAccountDedicatedIpWarmupAttributesInput) String 

func (s PutAccountDedicatedIpWarmupAttributesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s PutAccountDedicatedIpWarmupAttributesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (PutAccountDedicatedIpWarmupAttributesOutput) String 

func (s PutAccountDedicatedIpWarmupAttributesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s PutAccountSendingAttributesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutAccountSendingAttributesInput) SetSendingEnabled 

func (s *PutAccountSendingAttributesInput) SetSendingEnabled(v bool) *PutAccountSendingAttributesInput

SetSendingEnabled sets the SendingEnabled field's value.

func (PutAccountSendingAttributesInput) String 

func (s PutAccountSendingAttributesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s PutAccountSendingAttributesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (PutAccountSendingAttributesOutput) String 

func (s PutAccountSendingAttributesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

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

func (PutConfigurationSetDeliveryOptionsInput) GoString 

func (s PutConfigurationSetDeliveryOptionsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutConfigurationSetDeliveryOptionsInput) SetConfigurationSetName 

func (s *PutConfigurationSetDeliveryOptionsInput) SetConfigurationSetName(v string) *PutConfigurationSetDeliveryOptionsInput

SetConfigurationSetName sets the ConfigurationSetName field's value.

func (*PutConfigurationSetDeliveryOptionsInput) SetSendingPoolName 

func (s *PutConfigurationSetDeliveryOptionsInput) SetSendingPoolName(v string) *PutConfigurationSetDeliveryOptionsInput

SetSendingPoolName sets the SendingPoolName field's value.

func (*PutConfigurationSetDeliveryOptionsInput) SetTlsPolicy added in v1.19.41 

func (s *PutConfigurationSetDeliveryOptionsInput) SetTlsPolicy(v string) *PutConfigurationSetDeliveryOptionsInput

SetTlsPolicy sets the TlsPolicy field's value.

func (PutConfigurationSetDeliveryOptionsInput) String 

func (s PutConfigurationSetDeliveryOptionsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s PutConfigurationSetDeliveryOptionsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (PutConfigurationSetDeliveryOptionsOutput) String 

func (s PutConfigurationSetDeliveryOptionsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s PutConfigurationSetReputationOptionsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutConfigurationSetReputationOptionsInput) SetConfigurationSetName 

func (s *PutConfigurationSetReputationOptionsInput) SetConfigurationSetName(v string) *PutConfigurationSetReputationOptionsInput

SetConfigurationSetName sets the ConfigurationSetName field's value.

func (*PutConfigurationSetReputationOptionsInput) SetReputationMetricsEnabled 

func (s *PutConfigurationSetReputationOptionsInput) SetReputationMetricsEnabled(v bool) *PutConfigurationSetReputationOptionsInput

SetReputationMetricsEnabled sets the ReputationMetricsEnabled field's value.

func (PutConfigurationSetReputationOptionsInput) String 

func (s PutConfigurationSetReputationOptionsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s PutConfigurationSetReputationOptionsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (PutConfigurationSetReputationOptionsOutput) String 

func (s PutConfigurationSetReputationOptionsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s PutConfigurationSetSendingOptionsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutConfigurationSetSendingOptionsInput) SetConfigurationSetName 

func (s *PutConfigurationSetSendingOptionsInput) SetConfigurationSetName(v string) *PutConfigurationSetSendingOptionsInput

SetConfigurationSetName sets the ConfigurationSetName field's value.

func (*PutConfigurationSetSendingOptionsInput) SetSendingEnabled 

func (s *PutConfigurationSetSendingOptionsInput) SetSendingEnabled(v bool) *PutConfigurationSetSendingOptionsInput

SetSendingEnabled sets the SendingEnabled field's value.

func (PutConfigurationSetSendingOptionsInput) String 

func (s PutConfigurationSetSendingOptionsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s PutConfigurationSetSendingOptionsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (PutConfigurationSetSendingOptionsOutput) String 

func (s PutConfigurationSetSendingOptionsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s PutConfigurationSetTrackingOptionsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutConfigurationSetTrackingOptionsInput) SetConfigurationSetName 

func (s *PutConfigurationSetTrackingOptionsInput) SetConfigurationSetName(v string) *PutConfigurationSetTrackingOptionsInput

SetConfigurationSetName sets the ConfigurationSetName field's value.

func (*PutConfigurationSetTrackingOptionsInput) SetCustomRedirectDomain 

func (s *PutConfigurationSetTrackingOptionsInput) SetCustomRedirectDomain(v string) *PutConfigurationSetTrackingOptionsInput

SetCustomRedirectDomain sets the CustomRedirectDomain field's value.

func (PutConfigurationSetTrackingOptionsInput) String 

func (s PutConfigurationSetTrackingOptionsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s PutConfigurationSetTrackingOptionsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (PutConfigurationSetTrackingOptionsOutput) String 

func (s PutConfigurationSetTrackingOptionsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s PutDedicatedIpInPoolInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutDedicatedIpInPoolInput) SetDestinationPoolName 

func (s *PutDedicatedIpInPoolInput) SetDestinationPoolName(v string) *PutDedicatedIpInPoolInput

SetDestinationPoolName sets the DestinationPoolName field's value.

func (*PutDedicatedIpInPoolInput) SetIp 

func (s *PutDedicatedIpInPoolInput) SetIp(v string) *PutDedicatedIpInPoolInput

SetIp sets the Ip field's value.

func (PutDedicatedIpInPoolInput) String 

func (s PutDedicatedIpInPoolInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s PutDedicatedIpInPoolOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (PutDedicatedIpInPoolOutput) String 

func (s PutDedicatedIpInPoolOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s PutDedicatedIpWarmupAttributesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutDedicatedIpWarmupAttributesInput) SetIp 

func (s *PutDedicatedIpWarmupAttributesInput) SetIp(v string) *PutDedicatedIpWarmupAttributesInput

SetIp sets the Ip field's value.

func (*PutDedicatedIpWarmupAttributesInput) SetWarmupPercentage 

func (s *PutDedicatedIpWarmupAttributesInput) SetWarmupPercentage(v int64) *PutDedicatedIpWarmupAttributesInput

SetWarmupPercentage sets the WarmupPercentage field's value.

func (PutDedicatedIpWarmupAttributesInput) String 

func (s PutDedicatedIpWarmupAttributesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s PutDedicatedIpWarmupAttributesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (PutDedicatedIpWarmupAttributesOutput) String 

func (s PutDedicatedIpWarmupAttributesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PutDeliverabilityDashboardOptionInput added in v1.16.5 

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) GoString added in v1.16.5 

func (s PutDeliverabilityDashboardOptionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutDeliverabilityDashboardOptionInput) SetDashboardEnabled added in v1.16.5 

func (s *PutDeliverabilityDashboardOptionInput) SetDashboardEnabled(v bool) *PutDeliverabilityDashboardOptionInput

SetDashboardEnabled sets the DashboardEnabled field's value.

func (*PutDeliverabilityDashboardOptionInput) SetSubscribedDomains added in v1.19.39 

func (s *PutDeliverabilityDashboardOptionInput) SetSubscribedDomains(v []*DomainDeliverabilityTrackingOption) *PutDeliverabilityDashboardOptionInput

SetSubscribedDomains sets the SubscribedDomains field's value.

func (PutDeliverabilityDashboardOptionInput) String added in v1.16.5 

func (s PutDeliverabilityDashboardOptionInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutDeliverabilityDashboardOptionInput) Validate added in v1.16.5 

func (s *PutDeliverabilityDashboardOptionInput) Validate() error

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

type PutDeliverabilityDashboardOptionOutput added in v1.16.5 

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) GoString added in v1.16.5 

func (s PutDeliverabilityDashboardOptionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (PutDeliverabilityDashboardOptionOutput) String added in v1.16.5 

func (s PutDeliverabilityDashboardOptionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s PutEmailIdentityDkimAttributesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutEmailIdentityDkimAttributesInput) SetEmailIdentity 

func (s *PutEmailIdentityDkimAttributesInput) SetEmailIdentity(v string) *PutEmailIdentityDkimAttributesInput

SetEmailIdentity sets the EmailIdentity field's value.

func (*PutEmailIdentityDkimAttributesInput) SetSigningEnabled 

func (s *PutEmailIdentityDkimAttributesInput) SetSigningEnabled(v bool) *PutEmailIdentityDkimAttributesInput

SetSigningEnabled sets the SigningEnabled field's value.

func (PutEmailIdentityDkimAttributesInput) String 

func (s PutEmailIdentityDkimAttributesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s PutEmailIdentityDkimAttributesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (PutEmailIdentityDkimAttributesOutput) String 

func (s PutEmailIdentityDkimAttributesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s PutEmailIdentityFeedbackAttributesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutEmailIdentityFeedbackAttributesInput) SetEmailForwardingEnabled 

func (s *PutEmailIdentityFeedbackAttributesInput) SetEmailForwardingEnabled(v bool) *PutEmailIdentityFeedbackAttributesInput

SetEmailForwardingEnabled sets the EmailForwardingEnabled field's value.

func (*PutEmailIdentityFeedbackAttributesInput) SetEmailIdentity 

func (s *PutEmailIdentityFeedbackAttributesInput) SetEmailIdentity(v string) *PutEmailIdentityFeedbackAttributesInput

SetEmailIdentity sets the EmailIdentity field's value.

func (PutEmailIdentityFeedbackAttributesInput) String 

func (s PutEmailIdentityFeedbackAttributesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s PutEmailIdentityFeedbackAttributesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (PutEmailIdentityFeedbackAttributesOutput) String 

func (s PutEmailIdentityFeedbackAttributesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 *string `type:"string" enum:"BehaviorOnMxFailure"`

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

func (s PutEmailIdentityMailFromAttributesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutEmailIdentityMailFromAttributesInput) SetBehaviorOnMxFailure 

func (s *PutEmailIdentityMailFromAttributesInput) SetBehaviorOnMxFailure(v string) *PutEmailIdentityMailFromAttributesInput

SetBehaviorOnMxFailure sets the BehaviorOnMxFailure field's value.

func (*PutEmailIdentityMailFromAttributesInput) SetEmailIdentity 

func (s *PutEmailIdentityMailFromAttributesInput) SetEmailIdentity(v string) *PutEmailIdentityMailFromAttributesInput

SetEmailIdentity sets the EmailIdentity field's value.

func (*PutEmailIdentityMailFromAttributesInput) SetMailFromDomain 

func (s *PutEmailIdentityMailFromAttributesInput) SetMailFromDomain(v string) *PutEmailIdentityMailFromAttributesInput

SetMailFromDomain sets the MailFromDomain field's value.

func (PutEmailIdentityMailFromAttributesInput) String 

func (s PutEmailIdentityMailFromAttributesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s PutEmailIdentityMailFromAttributesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (PutEmailIdentityMailFromAttributesOutput) String 

func (s PutEmailIdentityMailFromAttributesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s RawMessage) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RawMessage) SetData 

func (s *RawMessage) SetData(v []byte) *RawMessage

SetData sets the Data field's value.

func (RawMessage) String 

func (s RawMessage) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s ReputationOptions) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ReputationOptions) SetLastFreshStart 

func (s *ReputationOptions) SetLastFreshStart(v time.Time) *ReputationOptions

SetLastFreshStart sets the LastFreshStart field's value.

func (*ReputationOptions) SetReputationMetricsEnabled 

func (s *ReputationOptions) SetReputationMetricsEnabled(v bool) *ReputationOptions

SetReputationMetricsEnabled sets the ReputationMetricsEnabled field's value.

func (ReputationOptions) String 

func (s ReputationOptions) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s SendEmailInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SendEmailInput) SetConfigurationSetName 

func (s *SendEmailInput) SetConfigurationSetName(v string) *SendEmailInput

SetConfigurationSetName sets the ConfigurationSetName field's value.

func (*SendEmailInput) SetContent 

func (s *SendEmailInput) SetContent(v *EmailContent) *SendEmailInput

SetContent sets the Content field's value.

func (*SendEmailInput) SetDestination 

func (s *SendEmailInput) SetDestination(v *Destination) *SendEmailInput

SetDestination sets the Destination field's value.

func (*SendEmailInput) SetEmailTags 

func (s *SendEmailInput) SetEmailTags(v []*MessageTag) *SendEmailInput

SetEmailTags sets the EmailTags field's value.

func (*SendEmailInput) SetFeedbackForwardingEmailAddress 

func (s *SendEmailInput) SetFeedbackForwardingEmailAddress(v string) *SendEmailInput

SetFeedbackForwardingEmailAddress sets the FeedbackForwardingEmailAddress field's value.

func (*SendEmailInput) SetFromEmailAddress 

func (s *SendEmailInput) SetFromEmailAddress(v string) *SendEmailInput

SetFromEmailAddress sets the FromEmailAddress field's value.

func (*SendEmailInput) SetReplyToAddresses 

func (s *SendEmailInput) SetReplyToAddresses(v []*string) *SendEmailInput

SetReplyToAddresses sets the ReplyToAddresses field's value.

func (SendEmailInput) String 

func (s SendEmailInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s SendEmailOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SendEmailOutput) SetMessageId 

func (s *SendEmailOutput) SetMessageId(v string) *SendEmailOutput

SetMessageId sets the MessageId field's value.

func (SendEmailOutput) String 

func (s SendEmailOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s SendQuota) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SendQuota) SetMax24HourSend 

func (s *SendQuota) SetMax24HourSend(v float64) *SendQuota

SetMax24HourSend sets the Max24HourSend field's value.

func (*SendQuota) SetMaxSendRate 

func (s *SendQuota) SetMaxSendRate(v float64) *SendQuota

SetMaxSendRate sets the MaxSendRate field's value.

func (*SendQuota) SetSentLast24Hours 

func (s *SendQuota) SetSentLast24Hours(v float64) *SendQuota

SetSentLast24Hours sets the SentLast24Hours field's value.

func (SendQuota) String 

func (s SendQuota) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s SendingOptions) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SendingOptions) SetSendingEnabled 

func (s *SendingOptions) SetSendingEnabled(v bool) *SendingOptions

SetSendingEnabled sets the SendingEnabled field's value.

func (SendingOptions) String 

func (s SendingOptions) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SendingPausedException added in v1.28.0 

type SendingPausedException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The message can't be sent because the account's ability to send email is currently paused.

func (*SendingPausedException) Code added in v1.28.0 

func (s *SendingPausedException) Code() string

Code returns the exception type name.

func (*SendingPausedException) Error added in v1.28.0 

func (s *SendingPausedException) Error() string

func (SendingPausedException) GoString added in v1.28.0 

func (s SendingPausedException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SendingPausedException) Message added in v1.28.0 

func (s *SendingPausedException) Message() string

Message returns the exception's message.

func (*SendingPausedException) OrigErr added in v1.28.0 

func (s *SendingPausedException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*SendingPausedException) RequestID added in v1.28.0 

func (s *SendingPausedException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*SendingPausedException) StatusCode added in v1.28.0 

func (s *SendingPausedException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (SendingPausedException) String added in v1.28.0 

func (s SendingPausedException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s SnsDestination) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SnsDestination) SetTopicArn 

func (s *SnsDestination) SetTopicArn(v string) *SnsDestination

SetTopicArn sets the TopicArn field's value.

func (SnsDestination) String 

func (s SnsDestination) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 v1.19.5 

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) GoString added in v1.19.5 

func (s Tag) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Tag) SetKey added in v1.19.5 

func (s *Tag) SetKey(v string) *Tag

SetKey sets the Key field's value.

func (*Tag) SetValue added in v1.19.5 

func (s *Tag) SetValue(v string) *Tag

SetValue sets the Value field's value.

func (Tag) String added in v1.19.5 

func (s Tag) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Tag) Validate added in v1.19.5 

func (s *Tag) Validate() error

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

type TagResourceInput added in v1.19.5 

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) GoString added in v1.19.5 

func (s TagResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TagResourceInput) SetResourceArn added in v1.19.5 

func (s *TagResourceInput) SetResourceArn(v string) *TagResourceInput

SetResourceArn sets the ResourceArn field's value.

func (*TagResourceInput) SetTags added in v1.19.5 

func (s *TagResourceInput) SetTags(v []*Tag) *TagResourceInput

SetTags sets the Tags field's value.

func (TagResourceInput) String added in v1.19.5 

func (s TagResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TagResourceInput) Validate added in v1.19.5 

func (s *TagResourceInput) Validate() error

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

type TagResourceOutput added in v1.19.5 

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

func (TagResourceOutput) GoString added in v1.19.5 

func (s TagResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (TagResourceOutput) String added in v1.19.5 

func (s TagResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Template added in v1.25.7 

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) GoString added in v1.25.7 

func (s Template) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Template) SetTemplateArn added in v1.25.7 

func (s *Template) SetTemplateArn(v string) *Template

SetTemplateArn sets the TemplateArn field's value.

func (*Template) SetTemplateData added in v1.25.7 

func (s *Template) SetTemplateData(v string) *Template

SetTemplateData sets the TemplateData field's value.

func (Template) String added in v1.25.7 

func (s Template) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TooManyRequestsException added in v1.28.0 

type TooManyRequestsException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

Too many requests have been made to the operation.

func (*TooManyRequestsException) Code added in v1.28.0 

func (s *TooManyRequestsException) Code() string

Code returns the exception type name.

func (*TooManyRequestsException) Error added in v1.28.0 

func (s *TooManyRequestsException) Error() string

func (TooManyRequestsException) GoString added in v1.28.0 

func (s TooManyRequestsException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TooManyRequestsException) Message added in v1.28.0 

func (s *TooManyRequestsException) Message() string

Message returns the exception's message.

func (*TooManyRequestsException) OrigErr added in v1.28.0 

func (s *TooManyRequestsException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*TooManyRequestsException) RequestID added in v1.28.0 

func (s *TooManyRequestsException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*TooManyRequestsException) StatusCode added in v1.28.0 

func (s *TooManyRequestsException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (TooManyRequestsException) String added in v1.28.0 

func (s TooManyRequestsException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s TrackingOptions) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TrackingOptions) SetCustomRedirectDomain 

func (s *TrackingOptions) SetCustomRedirectDomain(v string) *TrackingOptions

SetCustomRedirectDomain sets the CustomRedirectDomain field's value.

func (TrackingOptions) String 

func (s TrackingOptions) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 v1.19.5 

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) GoString added in v1.19.5 

func (s UntagResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UntagResourceInput) SetResourceArn added in v1.19.5 

func (s *UntagResourceInput) SetResourceArn(v string) *UntagResourceInput

SetResourceArn sets the ResourceArn field's value.

func (*UntagResourceInput) SetTagKeys added in v1.19.5 

func (s *UntagResourceInput) SetTagKeys(v []*string) *UntagResourceInput

SetTagKeys sets the TagKeys field's value.

func (UntagResourceInput) String added in v1.19.5 

func (s UntagResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UntagResourceInput) Validate added in v1.19.5 

func (s *UntagResourceInput) Validate() error

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

type UntagResourceOutput added in v1.19.5 

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

func (UntagResourceOutput) GoString added in v1.19.5 

func (s UntagResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UntagResourceOutput) String added in v1.19.5 

func (s UntagResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s UpdateConfigurationSetEventDestinationInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateConfigurationSetEventDestinationInput) SetConfigurationSetName 

func (s *UpdateConfigurationSetEventDestinationInput) SetConfigurationSetName(v string) *UpdateConfigurationSetEventDestinationInput

SetConfigurationSetName sets the ConfigurationSetName field's value.

func (*UpdateConfigurationSetEventDestinationInput) SetEventDestination 

func (s *UpdateConfigurationSetEventDestinationInput) SetEventDestination(v *EventDestinationDefinition) *UpdateConfigurationSetEventDestinationInput

SetEventDestination sets the EventDestination field's value.

func (*UpdateConfigurationSetEventDestinationInput) SetEventDestinationName 

func (s *UpdateConfigurationSetEventDestinationInput) SetEventDestinationName(v string) *UpdateConfigurationSetEventDestinationInput

SetEventDestinationName sets the EventDestinationName field's value.

func (UpdateConfigurationSetEventDestinationInput) String 

func (s UpdateConfigurationSetEventDestinationInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s UpdateConfigurationSetEventDestinationOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UpdateConfigurationSetEventDestinationOutput) String 

func (s UpdateConfigurationSetEventDestinationOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type VolumeStatistics added in v1.16.5 

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) GoString added in v1.16.5 

func (s VolumeStatistics) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*VolumeStatistics) SetInboxRawCount added in v1.16.5 

func (s *VolumeStatistics) SetInboxRawCount(v int64) *VolumeStatistics

SetInboxRawCount sets the InboxRawCount field's value.

func (*VolumeStatistics) SetProjectedInbox added in v1.16.5 

func (s *VolumeStatistics) SetProjectedInbox(v int64) *VolumeStatistics

SetProjectedInbox sets the ProjectedInbox field's value.

func (*VolumeStatistics) SetProjectedSpam added in v1.16.5 

func (s *VolumeStatistics) SetProjectedSpam(v int64) *VolumeStatistics

SetProjectedSpam sets the ProjectedSpam field's value.

func (*VolumeStatistics) SetSpamRawCount added in v1.16.5 

func (s *VolumeStatistics) SetSpamRawCount(v int64) *VolumeStatistics

SetSpamRawCount sets the SpamRawCount field's value.

func (VolumeStatistics) String added in v1.16.5 

func (s VolumeStatistics) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.