AWS SDK for Go (PILOT)
API Reference

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see https://docs.aws.amazon.com/sdk-for-go/api/.

We welcome your feedback on this new version of the documentation. Send your comments to aws-sdkdocs-feedback@amazon.com.

PinpointEmail

import "github.com/aws/aws-sdk-go/service/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.

Client

Type: *client.Client

Method

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 Codes:

  • ErrCodeAlreadyExistsException "AlreadyExistsException" The resource specified in your request already exists.

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

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

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

  • ErrCodeBadRequestException "BadRequestException" The input you provided is invalid.

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

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 Codes:

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

  • ErrCodeAlreadyExistsException "AlreadyExistsException" The resource specified in your request already exists.

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

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

  • ErrCodeBadRequestException "BadRequestException" The input you provided is invalid.

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

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

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.

See Also

For more information about using this API, see AWS API Documentation.

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

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.

See Also

For more information about using this API, see AWS API Documentation.

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 Codes:

  • ErrCodeAlreadyExistsException "AlreadyExistsException" The resource specified in your request already exists.

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

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

  • ErrCodeBadRequestException "BadRequestException" The input you provided is invalid.

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

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

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.

See Also

For more information about using this API, see AWS API Documentation.

CreateDeliverabilityTestReport

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 Codes:

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

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

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

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

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

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

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

  • ErrCodeBadRequestException "BadRequestException" The input you provided is invalid.

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

CreateDeliverabilityTestReportRequest

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

CreateDeliverabilityTestReportWithContext

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.

See Also

For more information about using this API, see AWS API Documentation.

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 Codes:

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

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

  • ErrCodeBadRequestException "BadRequestException" The input you provided is invalid.

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

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

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.

See Also

For more information about using this API, see AWS API Documentation.

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 Codes:

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

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

  • ErrCodeBadRequestException "BadRequestException" The input you provided is invalid.

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

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 Codes:

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

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

  • ErrCodeBadRequestException "BadRequestException" The input you provided is invalid.

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

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

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.

See Also

For more information about using this API, see AWS API Documentation.

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

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.

See Also

For more information about using this API, see AWS API Documentation.

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 Codes:

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

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

  • ErrCodeBadRequestException "BadRequestException" The input you provided is invalid.

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

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

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.

See Also

For more information about using this API, see AWS API Documentation.

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 Codes:

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

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

  • ErrCodeBadRequestException "BadRequestException" The input you provided is invalid.

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

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

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.

See Also

For more information about using this API, see AWS API Documentation.

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 Codes:

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

  • ErrCodeBadRequestException "BadRequestException" The input you provided is invalid.

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

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

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.

See Also

For more information about using this API, see AWS API Documentation.

GetBlacklistReports

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 Codes:

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

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

  • ErrCodeBadRequestException "BadRequestException" The input you provided is invalid.

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

GetBlacklistReportsRequest

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

GetBlacklistReportsWithContext

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.

See Also

For more information about using this API, see AWS API Documentation.

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 Codes:

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

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

  • ErrCodeBadRequestException "BadRequestException" The input you provided is invalid.

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

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 Codes:

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

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

  • ErrCodeBadRequestException "BadRequestException" The input you provided is invalid.

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

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

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.

See Also

For more information about using this API, see AWS API Documentation.

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

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.

See Also

For more information about using this API, see AWS API Documentation.

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 Codes:

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

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

  • ErrCodeBadRequestException "BadRequestException" The input you provided is invalid.

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

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

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.

See Also

For more information about using this API, see AWS API Documentation.

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 Codes:

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

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

  • ErrCodeBadRequestException "BadRequestException" The input you provided is invalid.

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

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 *GetDedicatedIpsOutput, lastPage bool) bool { pageNum++ fmt.Println(page) return pageNum <= 3 })

See Also

For more information about using this API, see AWS API Documentation.

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.

See Also

For more information about using this API, see AWS API Documentation.

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

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.

See Also

For more information about using this API, see AWS API Documentation.

GetDeliverabilityDashboardOptions

func (c *PinpointEmail) GetDeliverabilityDashboardOptions(input *GetDeliverabilityDashboardOptionsInput) (*GetDeliverabilityDashboardOptionsOutput, error)

GetDeliverabilityDashboardOptions API operation for Amazon Pinpoint Email Service.

Show the status of the Deliverability dashboard. When the Deliverability dashboard is enabled, you gain access to reputation 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 charge of USD$1,250.00, in addition to any other fees that you accrue by using Amazon Pinpoint. If you enable the Deliverability dashboard after the first day of a calendar month, AWS prorates the monthly charge based on how many days have elapsed in the current calendar month.

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 Codes:

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

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

  • ErrCodeBadRequestException "BadRequestException" The input you provided is invalid.

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

GetDeliverabilityDashboardOptionsRequest

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

GetDeliverabilityDashboardOptionsWithContext

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.

See Also

For more information about using this API, see AWS API Documentation.

GetDeliverabilityTestReport

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 Codes:

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

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

  • ErrCodeBadRequestException "BadRequestException" The input you provided is invalid.

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

GetDeliverabilityTestReportRequest

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

GetDeliverabilityTestReportWithContext

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.

See Also

For more information about using this API, see AWS API Documentation.

GetDomainStatisticsReport

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 Codes:

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

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

  • ErrCodeBadRequestException "BadRequestException" The input you provided is invalid.

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

GetDomainStatisticsReportRequest

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

GetDomainStatisticsReportWithContext

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.

See Also

For more information about using this API, see AWS API Documentation.

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 Codes:

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

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

  • ErrCodeBadRequestException "BadRequestException" The input you provided is invalid.

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

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

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.

See Also

For more information about using this API, see AWS API Documentation.

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 Codes:

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

  • ErrCodeBadRequestException "BadRequestException" The input you provided is invalid.

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

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 *ListConfigurationSetsOutput, lastPage bool) bool { pageNum++ fmt.Println(page) return pageNum <= 3 })

See Also

For more information about using this API, see AWS API Documentation.

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.

See Also

For more information about using this API, see AWS API Documentation.

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

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.

See Also

For more information about using this API, see AWS API Documentation.

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 Codes:

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

  • ErrCodeBadRequestException "BadRequestException" The input you provided is invalid.

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

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 *ListDedicatedIpPoolsOutput, lastPage bool) bool { pageNum++ fmt.Println(page) return pageNum <= 3 })

See Also

For more information about using this API, see AWS API Documentation.

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.

See Also

For more information about using this API, see AWS API Documentation.

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

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.

See Also

For more information about using this API, see AWS API Documentation.

ListDeliverabilityTestReports

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 Codes:

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

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

  • ErrCodeBadRequestException "BadRequestException" The input you provided is invalid.

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

ListDeliverabilityTestReportsPages

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 *ListDeliverabilityTestReportsOutput, lastPage bool) bool { pageNum++ fmt.Println(page) return pageNum <= 3 })

See Also

For more information about using this API, see AWS API Documentation.

ListDeliverabilityTestReportsPagesWithContext

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.

See Also

For more information about using this API, see AWS API Documentation.

ListDeliverabilityTestReportsRequest

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

ListDeliverabilityTestReportsWithContext

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.

See Also

For more information about using this API, see AWS API Documentation.

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 Codes:

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

  • ErrCodeBadRequestException "BadRequestException" The input you provided is invalid.

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

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 *ListEmailIdentitiesOutput, lastPage bool) bool { pageNum++ fmt.Println(page) return pageNum <= 3 })

See Also

For more information about using this API, see AWS API Documentation.

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.

See Also

For more information about using this API, see AWS API Documentation.

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

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.

See Also

For more information about using this API, see AWS API Documentation.

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 Codes:

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

  • ErrCodeBadRequestException "BadRequestException" The input you provided is invalid.

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

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

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.

See Also

For more information about using this API, see AWS API Documentation.

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 Codes:

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

  • ErrCodeBadRequestException "BadRequestException" The input you provided is invalid.

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

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

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.

See Also

For more information about using this API, see AWS API Documentation.

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 Codes:

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

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

  • ErrCodeBadRequestException "BadRequestException" The input you provided is invalid.

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

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

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.

See Also

For more information about using this API, see AWS API Documentation.

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 Codes:

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

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

  • ErrCodeBadRequestException "BadRequestException" The input you provided is invalid.

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

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

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.

See Also

For more information about using this API, see AWS API Documentation.

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 Codes:

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

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

  • ErrCodeBadRequestException "BadRequestException" The input you provided is invalid.

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

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

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.

See Also

For more information about using this API, see AWS API Documentation.

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 Codes:

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

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

  • ErrCodeBadRequestException "BadRequestException" The input you provided is invalid.

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

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

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.

See Also

For more information about using this API, see AWS API Documentation.

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 Codes:

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

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

  • ErrCodeBadRequestException "BadRequestException" The input you provided is invalid.

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

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

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.

See Also

For more information about using this API, see AWS API Documentation.

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 Codes:

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

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

  • ErrCodeBadRequestException "BadRequestException" The input you provided is invalid.

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

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

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.

See Also

For more information about using this API, see AWS API Documentation.

PutDeliverabilityDashboardOption

func (c *PinpointEmail) PutDeliverabilityDashboardOption(input *PutDeliverabilityDashboardOptionInput) (*PutDeliverabilityDashboardOptionOutput, error)

PutDeliverabilityDashboardOption API operation for Amazon Pinpoint Email Service.

Enable or disable the Deliverability dashboard. When you enable the Deliverability dashboard, you gain access to reputation 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 charge of USD$1,250.00, in addition to any other fees that you accrue by using Amazon Pinpoint. If you enable the Deliverability dashboard after the first day of a calendar month, we prorate the monthly charge based on how many days have elapsed in the current calendar month.

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 Codes:

  • ErrCodeAlreadyExistsException "AlreadyExistsException" The resource specified in your request already exists.

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

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

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

  • ErrCodeBadRequestException "BadRequestException" The input you provided is invalid.

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

PutDeliverabilityDashboardOptionRequest

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

PutDeliverabilityDashboardOptionWithContext

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.

See Also

For more information about using this API, see AWS API Documentation.

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 Codes:

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

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

  • ErrCodeBadRequestException "BadRequestException" The input you provided is invalid.

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

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

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.

See Also

For more information about using this API, see AWS API Documentation.

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 Codes:

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

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

  • ErrCodeBadRequestException "BadRequestException" The input you provided is invalid.

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

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

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.

See Also

For more information about using this API, see AWS API Documentation.

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 Codes:

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

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

  • ErrCodeBadRequestException "BadRequestException" The input you provided is invalid.

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

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

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.

See Also

For more information about using this API, see AWS API Documentation.

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 Codes:

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

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

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

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

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

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

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

  • ErrCodeBadRequestException "BadRequestException" The input you provided is invalid.

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

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

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.

See Also

For more information about using this API, see AWS API Documentation.

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 Codes:

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

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

  • ErrCodeBadRequestException "BadRequestException" The input you provided is invalid.

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

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

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.

See Also

For more information about using this API, see AWS API Documentation.

On this page: