sesv2

package module
v1.27.3 Latest Latest
Warning

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

 Go to latest Published: Mar 29, 2024 License: Apache-2.0 Imports: 39 Imported by: 61

Documentation

Overview

Package sesv2 provides the API client, operations, and parameter types for Amazon Simple Email Service.

Amazon SES API v2 Amazon SES (http://aws.amazon.com/ses) is an Amazon Web Services service that you can use to send email messages to your customers. If you're new to Amazon SES API v2, you might find it helpful to review the Amazon Simple Email Service Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/) . The Amazon SES Developer Guide provides information and code samples that demonstrate how to use Amazon SES API v2 features programmatically.

Index

Constants

View Source 
const ServiceAPIVersion = "2019-09-27"
View Source 
const ServiceID = "SESv2"

Variables

This section is empty.

Functions

func NewDefaultEndpointResolver 

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

func WithAPIOptions added in v1.0.0 

func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)

WithAPIOptions returns a functional option for setting the Client's APIOptions option.

func WithEndpointResolver deprecated 

func WithEndpointResolver(v EndpointResolver) func(*Options)

Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for this field will likely prevent you from using any endpoint-related service features released after the introduction of EndpointResolverV2 and BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom endpoint, set the client option BaseEndpoint instead.

func WithEndpointResolverV2 added in v1.19.0 

func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)

WithEndpointResolverV2 returns a functional option for setting the Client's EndpointResolverV2 option.

func WithSigV4SigningName added in v1.23.2 

func WithSigV4SigningName(name string) func(*Options)

WithSigV4SigningName applies an override to the authentication workflow to use the given signing name for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing name from both auth scheme resolution and endpoint resolution.

func WithSigV4SigningRegion added in v1.23.2 

func WithSigV4SigningRegion(region string) func(*Options)

WithSigV4SigningRegion applies an override to the authentication workflow to use the given signing region for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing region from both auth scheme resolution and endpoint resolution.

Types

type AuthResolverParameters added in v1.23.2 

type AuthResolverParameters struct {
	// The name of the operation being invoked.
	Operation string

	// The region in which the operation is being invoked.
	Region string
}

AuthResolverParameters contains the set of inputs necessary for auth scheme resolution.

type AuthSchemeResolver added in v1.23.2 

type AuthSchemeResolver interface {
	ResolveAuthSchemes(context.Context, *AuthResolverParameters) ([]*smithyauth.Option, error)
}

AuthSchemeResolver returns a set of possible authentication options for an operation.

type BatchGetMetricDataInput added in v1.15.0 

type BatchGetMetricDataInput struct {

	// A list of queries for metrics to be retrieved.
	//
	// This member is required.
	Queries []types.BatchGetMetricDataQuery
	// contains filtered or unexported fields
}

Represents a request to retrieve a batch of metric data.

type BatchGetMetricDataOutput added in v1.15.0 

type BatchGetMetricDataOutput struct {

	// A list of MetricDataError encountered while processing your metric data batch
	// request.
	Errors []types.MetricDataError

	// A list of successfully retrieved MetricDataResult .
	Results []types.MetricDataResult

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Represents the result of processing your metric data batch request

type CancelExportJobInput added in v1.20.0 

type CancelExportJobInput struct {

	// The export job ID.
	//
	// This member is required.
	JobId *string
	// contains filtered or unexported fields
}

Represents a request to cancel an export job using the export job ID.

type CancelExportJobOutput added in v1.20.0 

type CancelExportJobOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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

type Client 

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

Client provides the API client to make operations call for Amazon Simple Email Service.

func New 

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

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

func NewFromConfig 

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

NewFromConfig returns a new client from the provided config.

func (*Client) BatchGetMetricData added in v1.15.0 

func (c *Client) BatchGetMetricData(ctx context.Context, params *BatchGetMetricDataInput, optFns ...func(*Options)) (*BatchGetMetricDataOutput, error)

Retrieves batches of metric data collected based on your sending activity. You can execute this operation no more than 16 times per second, and with at most 160 queries from the batches per second (cumulative).

func (*Client) CancelExportJob added in v1.20.0 

func (c *Client) CancelExportJob(ctx context.Context, params *CancelExportJobInput, optFns ...func(*Options)) (*CancelExportJobOutput, error)

Cancels an export job.

func (*Client) CreateConfigurationSet 

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

Create a configuration set. Configuration sets are groups of rules that you can apply to the emails that you send. You apply a configuration set to an email by specifying the name of the configuration set when you call the Amazon SES API v2. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email.

func (*Client) CreateConfigurationSetEventDestination 

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

Create an event destination. Events include message sends, deliveries, opens, clicks, bounces, and complaints. Event destinations are places that you can send information about these events to. For example, you can send event data to Amazon SNS to receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage. A single configuration set can include more than one event destination.

func (*Client) CreateContact added in v0.29.0 

func (c *Client) CreateContact(ctx context.Context, params *CreateContactInput, optFns ...func(*Options)) (*CreateContactOutput, error)

Creates a contact, which is an end-user who is receiving the email, and adds them to a contact list.

func (*Client) CreateContactList added in v0.29.0 

func (c *Client) CreateContactList(ctx context.Context, params *CreateContactListInput, optFns ...func(*Options)) (*CreateContactListOutput, error)

Creates a contact list.

func (*Client) CreateCustomVerificationEmailTemplate 

func (c *Client) CreateCustomVerificationEmailTemplate(ctx context.Context, params *CreateCustomVerificationEmailTemplateInput, optFns ...func(*Options)) (*CreateCustomVerificationEmailTemplateOutput, error)

Creates a new custom verification email template. For more information about custom verification email templates, see Using custom verification email templates (https://docs.aws.amazon.com/ses/latest/dg/creating-identities.html#send-email-verify-address-custom) in the Amazon SES Developer Guide. You can execute this operation no more than once per second.

func (*Client) CreateDedicatedIpPool 

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

Create a new pool of dedicated IP addresses. A pool can include one or more dedicated IP addresses that are associated with your Amazon Web Services account. You can associate a pool with a configuration set. When you send an email that uses that configuration set, the message is sent from one of the addresses in the associated pool.

func (*Client) CreateDeliverabilityTestReport 

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

Create a new predictive inbox placement test. Predictive inbox placement tests can help you predict how your messages will be handled by various email providers around the world. When you perform a predictive inbox placement test, you provide a sample message that contains the content that you plan to send to your customers. Amazon SES then sends that message to special email addresses spread across several major email providers. After about 24 hours, the test is complete, and you can use the GetDeliverabilityTestReport operation to view the results of the test.

func (*Client) CreateEmailIdentity 

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

Starts the process of verifying an email identity. An identity is an email address or domain that you use when you send email. Before you can use an identity to send email, you first have to verify it. By verifying an identity, you demonstrate that you're the owner of the identity, and that you've given Amazon SES API v2 permission to send email from the identity. When you verify an email address, Amazon SES 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 without specifying the DkimSigningAttributes object, this operation provides a set of DKIM tokens. You can convert these tokens into CNAME records, which you then add to the DNS configuration for your domain. Your domain is verified when Amazon SES detects these records in the DNS configuration for your domain. This verification method is known as Easy DKIM (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html) . Alternatively, you can perform the verification process by providing your own public-private key pair. This verification method is known as Bring Your Own DKIM (BYODKIM). To use BYODKIM, your call to the CreateEmailIdentity operation has to include the DkimSigningAttributes object. When you specify this object, you provide a selector (a component of the DNS record name that identifies the public key to use for DKIM authentication) and a private key. 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 SES detects these records in the DNS configuration for your domain. For some DNS providers, it can take 72 hours or more to complete the domain verification process. Additionally, you can associate an existing configuration set with the email identity that you're verifying.

func (*Client) CreateEmailIdentityPolicy 

func (c *Client) CreateEmailIdentityPolicy(ctx context.Context, params *CreateEmailIdentityPolicyInput, optFns ...func(*Options)) (*CreateEmailIdentityPolicyOutput, error)

Creates the specified sending authorization policy for the given identity (an email address or a domain). This API is for the identity owner only. If you have not verified the identity, this API will return an error. Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html) . You can execute this operation no more than once per second.

func (*Client) CreateEmailTemplate 

func (c *Client) CreateEmailTemplate(ctx context.Context, params *CreateEmailTemplateInput, optFns ...func(*Options)) (*CreateEmailTemplateOutput, error)

Creates an email template. Email templates enable you to send personalized email to one or more destinations in a single API operation. For more information, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-personalized-email-api.html) . You can execute this operation no more than once per second.

func (*Client) CreateExportJob added in v1.20.0 

func (c *Client) CreateExportJob(ctx context.Context, params *CreateExportJobInput, optFns ...func(*Options)) (*CreateExportJobOutput, error)

Creates an export job for a data source and destination. You can execute this operation no more than once per second.

func (*Client) CreateImportJob added in v0.29.0 

func (c *Client) CreateImportJob(ctx context.Context, params *CreateImportJobInput, optFns ...func(*Options)) (*CreateImportJobOutput, error)

Creates an import job for a data destination.

func (*Client) DeleteConfigurationSet 

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

Delete an existing configuration set. Configuration sets are groups of rules that you can apply to the emails you send. You apply a configuration set to an email by including a reference to the configuration set in the headers of the email. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email.

func (*Client) DeleteConfigurationSetEventDestination 

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

Delete an event destination. Events include message sends, deliveries, opens, clicks, bounces, and complaints. Event destinations are places that you can send information about these events to. For example, you can send event data to Amazon SNS to receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage.

func (*Client) DeleteContact added in v0.29.0 

func (c *Client) DeleteContact(ctx context.Context, params *DeleteContactInput, optFns ...func(*Options)) (*DeleteContactOutput, error)

Removes a contact from a contact list.

func (*Client) DeleteContactList added in v0.29.0 

func (c *Client) DeleteContactList(ctx context.Context, params *DeleteContactListInput, optFns ...func(*Options)) (*DeleteContactListOutput, error)

Deletes a contact list and all of the contacts on that list.

func (*Client) DeleteCustomVerificationEmailTemplate 

func (c *Client) DeleteCustomVerificationEmailTemplate(ctx context.Context, params *DeleteCustomVerificationEmailTemplateInput, optFns ...func(*Options)) (*DeleteCustomVerificationEmailTemplateOutput, error)

Deletes an existing custom verification email template. For more information about custom verification email templates, see Using custom verification email templates (https://docs.aws.amazon.com/ses/latest/dg/creating-identities.html#send-email-verify-address-custom) in the Amazon SES Developer Guide. You can execute this operation no more than once per second.

func (*Client) DeleteDedicatedIpPool 

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

Delete a dedicated IP pool.

func (*Client) DeleteEmailIdentity 

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

Deletes an email identity. An identity can be either an email address or a domain name.

func (*Client) DeleteEmailIdentityPolicy 

func (c *Client) DeleteEmailIdentityPolicy(ctx context.Context, params *DeleteEmailIdentityPolicyInput, optFns ...func(*Options)) (*DeleteEmailIdentityPolicyOutput, error)

Deletes the specified sending authorization policy for the given identity (an email address or a domain). This API returns successfully even if a policy with the specified name does not exist. This API is for the identity owner only. If you have not verified the identity, this API will return an error. Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html) . You can execute this operation no more than once per second.

func (*Client) DeleteEmailTemplate 

func (c *Client) DeleteEmailTemplate(ctx context.Context, params *DeleteEmailTemplateInput, optFns ...func(*Options)) (*DeleteEmailTemplateOutput, error)

Deletes an email template. You can execute this operation no more than once per second.

func (*Client) DeleteSuppressedDestination 

func (c *Client) DeleteSuppressedDestination(ctx context.Context, params *DeleteSuppressedDestinationInput, optFns ...func(*Options)) (*DeleteSuppressedDestinationOutput, error)

Removes an email address from the suppression list for your account.

func (*Client) GetAccount 

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

Obtain information about the email-sending status and capabilities of your Amazon SES account in the current Amazon Web Services Region.

func (*Client) GetBlacklistReports 

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

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

func (*Client) GetConfigurationSet 

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

Get information about an existing configuration set, including the dedicated IP pool that it's associated with, whether or not it's enabled for sending email, and more. Configuration sets are groups of rules that you can apply to the emails you send. You apply a configuration set to an email by including a reference to the configuration set in the headers of the email. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email.

func (*Client) GetConfigurationSetEventDestinations 

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

Retrieve a list of event destinations that are associated with a configuration set. Events include message sends, deliveries, opens, clicks, bounces, and complaints. Event destinations are places that you can send information about these events to. For example, you can send event data to Amazon SNS to receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage.

func (*Client) GetContact added in v0.29.0 

func (c *Client) GetContact(ctx context.Context, params *GetContactInput, optFns ...func(*Options)) (*GetContactOutput, error)

Returns a contact from a contact list.

func (*Client) GetContactList added in v0.29.0 

func (c *Client) GetContactList(ctx context.Context, params *GetContactListInput, optFns ...func(*Options)) (*GetContactListOutput, error)

Returns contact list metadata. It does not return any information about the contacts present in the list.

func (*Client) GetCustomVerificationEmailTemplate 

func (c *Client) GetCustomVerificationEmailTemplate(ctx context.Context, params *GetCustomVerificationEmailTemplateInput, optFns ...func(*Options)) (*GetCustomVerificationEmailTemplateOutput, error)

Returns the custom email verification template for the template name you specify. For more information about custom verification email templates, see Using custom verification email templates (https://docs.aws.amazon.com/ses/latest/dg/creating-identities.html#send-email-verify-address-custom) in the Amazon SES Developer Guide. You can execute this operation no more than once per second.

func (*Client) GetDedicatedIp 

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

Get information about a dedicated IP address, including the name of the dedicated IP pool that it's associated with, as well information about the automatic warm-up process for the address.

func (*Client) GetDedicatedIpPool added in v1.14.0 

func (c *Client) GetDedicatedIpPool(ctx context.Context, params *GetDedicatedIpPoolInput, optFns ...func(*Options)) (*GetDedicatedIpPoolOutput, error)

Retrieve information about the dedicated pool.

func (*Client) GetDedicatedIps 

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

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

func (*Client) GetDeliverabilityDashboardOptions 

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

Retrieve information about the status of the Deliverability dashboard for your account. When the Deliverability dashboard is enabled, you gain access to reputation, deliverability, and other metrics for the domains that you use to send email. You also gain the ability to perform predictive inbox placement tests. When you use the Deliverability dashboard, you pay a monthly subscription charge, in addition to any other fees that you accrue by using Amazon SES and other Amazon Web Services services. For more information about the features and cost of a Deliverability dashboard subscription, see Amazon SES Pricing (http://aws.amazon.com/ses/pricing/) .

func (*Client) GetDeliverabilityTestReport 

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

Retrieve the results of a predictive inbox placement test.

func (*Client) GetDomainDeliverabilityCampaign 

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

Retrieve all the deliverability data for a specific campaign. This data is available for a campaign only if the campaign sent email by using a domain that the Deliverability dashboard is enabled for.

func (*Client) GetDomainStatisticsReport 

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

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

func (*Client) GetEmailIdentity 

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

Provides information about a specific identity, including the identity's verification status, sending authorization policies, its DKIM authentication status, and its custom Mail-From settings.

func (*Client) GetEmailIdentityPolicies 

func (c *Client) GetEmailIdentityPolicies(ctx context.Context, params *GetEmailIdentityPoliciesInput, optFns ...func(*Options)) (*GetEmailIdentityPoliciesOutput, error)

Returns the requested sending authorization policies for the given identity (an email address or a domain). The policies are returned as a map of policy names to policy contents. You can retrieve a maximum of 20 policies at a time. This API is for the identity owner only. If you have not verified the identity, this API will return an error. Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html) . You can execute this operation no more than once per second.

func (*Client) GetEmailTemplate 

func (c *Client) GetEmailTemplate(ctx context.Context, params *GetEmailTemplateInput, optFns ...func(*Options)) (*GetEmailTemplateOutput, error)

Displays the template object (which includes the subject line, HTML part and text part) for the template you specify. You can execute this operation no more than once per second.

func (*Client) GetExportJob added in v1.20.0 

func (c *Client) GetExportJob(ctx context.Context, params *GetExportJobInput, optFns ...func(*Options)) (*GetExportJobOutput, error)

Provides information about an export job.

func (*Client) GetImportJob added in v0.29.0 

func (c *Client) GetImportJob(ctx context.Context, params *GetImportJobInput, optFns ...func(*Options)) (*GetImportJobOutput, error)

Provides information about an import job.

func (*Client) GetMessageInsights added in v1.20.0 

func (c *Client) GetMessageInsights(ctx context.Context, params *GetMessageInsightsInput, optFns ...func(*Options)) (*GetMessageInsightsOutput, error)

Provides information about a specific message, including the from address, the subject, the recipient address, email tags, as well as events associated with the message. You can execute this operation no more than once per second.

func (*Client) GetSuppressedDestination 

func (c *Client) GetSuppressedDestination(ctx context.Context, params *GetSuppressedDestinationInput, optFns ...func(*Options)) (*GetSuppressedDestinationOutput, error)

Retrieves information about a specific email address that's on the suppression list for your account.

func (*Client) ListConfigurationSets 

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

List all of the configuration sets associated with your account in the current region. Configuration sets are groups of rules that you can apply to the emails you send. You apply a configuration set to an email by including a reference to the configuration set in the headers of the email. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email.

func (*Client) ListContactLists added in v0.29.0 

func (c *Client) ListContactLists(ctx context.Context, params *ListContactListsInput, optFns ...func(*Options)) (*ListContactListsOutput, error)

Lists all of the contact lists available.

func (*Client) ListContacts added in v0.29.0 

func (c *Client) ListContacts(ctx context.Context, params *ListContactsInput, optFns ...func(*Options)) (*ListContactsOutput, error)

Lists the contacts present in a specific contact list.

func (*Client) ListCustomVerificationEmailTemplates 

func (c *Client) ListCustomVerificationEmailTemplates(ctx context.Context, params *ListCustomVerificationEmailTemplatesInput, optFns ...func(*Options)) (*ListCustomVerificationEmailTemplatesOutput, error)

Lists the existing custom verification email templates for your account in the current Amazon Web Services Region. For more information about custom verification email templates, see Using custom verification email templates (https://docs.aws.amazon.com/ses/latest/dg/creating-identities.html#send-email-verify-address-custom) in the Amazon SES Developer Guide. You can execute this operation no more than once per second.

func (*Client) ListDedicatedIpPools 

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

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

func (*Client) ListDeliverabilityTestReports 

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

Show a list of the predictive inbox placement tests that you've performed, regardless of their statuses. For predictive inbox placement tests that are complete, you can use the GetDeliverabilityTestReport operation to view the results.

func (*Client) ListDomainDeliverabilityCampaigns 

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

Retrieve deliverability data for all the campaigns that used a specific domain to send email during a specified time range. This data is available for a domain only if you enabled the Deliverability dashboard for the domain.

func (*Client) ListEmailIdentities 

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

Returns a list of all of the email identities that are associated with your Amazon Web Services 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. This operation returns identities that are associated with Amazon SES and Amazon Pinpoint.

func (*Client) ListEmailTemplates 

func (c *Client) ListEmailTemplates(ctx context.Context, params *ListEmailTemplatesInput, optFns ...func(*Options)) (*ListEmailTemplatesOutput, error)

Lists the email templates present in your Amazon SES account in the current Amazon Web Services Region. You can execute this operation no more than once per second.

func (*Client) ListExportJobs added in v1.20.0 

func (c *Client) ListExportJobs(ctx context.Context, params *ListExportJobsInput, optFns ...func(*Options)) (*ListExportJobsOutput, error)

Lists all of the export jobs.

func (*Client) ListImportJobs added in v0.29.0 

func (c *Client) ListImportJobs(ctx context.Context, params *ListImportJobsInput, optFns ...func(*Options)) (*ListImportJobsOutput, error)

Lists all of the import jobs.

func (*Client) ListRecommendations added in v1.15.0 

func (c *Client) ListRecommendations(ctx context.Context, params *ListRecommendationsInput, optFns ...func(*Options)) (*ListRecommendationsOutput, error)

Lists the recommendations present in your Amazon SES account in the current Amazon Web Services Region. You can execute this operation no more than once per second.

func (*Client) ListSuppressedDestinations 

func (c *Client) ListSuppressedDestinations(ctx context.Context, params *ListSuppressedDestinationsInput, optFns ...func(*Options)) (*ListSuppressedDestinationsOutput, error)

Retrieves a list of email addresses that are on the suppression list for your account.

func (*Client) ListTagsForResource 

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

Retrieve a list of the tags (keys and values) that are associated with a specified resource. A tag is a label that you optionally define and associate with a resource. Each tag consists of a required tag key and an optional associated tag value. A tag key is a general label that acts as a category for more specific tag values. A tag value acts as a descriptor within a tag key.

func (*Client) Options added in v1.24.0 

func (c *Client) Options() Options

Options returns a copy of the client configuration.

Callers SHOULD NOT perform mutations on any inner structures within client config. Config overrides should instead be made on a per-operation basis through functional options.

func (*Client) PutAccountDedicatedIpWarmupAttributes 

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

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

func (*Client) PutAccountDetails 

func (c *Client) PutAccountDetails(ctx context.Context, params *PutAccountDetailsInput, optFns ...func(*Options)) (*PutAccountDetailsOutput, error)

Update your Amazon SES account details.

func (*Client) PutAccountSendingAttributes 

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

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

func (*Client) PutAccountSuppressionAttributes 

func (c *Client) PutAccountSuppressionAttributes(ctx context.Context, params *PutAccountSuppressionAttributesInput, optFns ...func(*Options)) (*PutAccountSuppressionAttributesOutput, error)

Change the settings for the account-level suppression list.

func (*Client) PutAccountVdmAttributes added in v1.15.0 

func (c *Client) PutAccountVdmAttributes(ctx context.Context, params *PutAccountVdmAttributesInput, optFns ...func(*Options)) (*PutAccountVdmAttributesOutput, error)

Update your Amazon SES account VDM attributes. You can execute this operation no more than once per second.

func (*Client) PutConfigurationSetDeliveryOptions 

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

Associate a configuration set with a dedicated IP pool. You can use dedicated IP pools to create groups of dedicated IP addresses for sending specific types of email.

func (*Client) PutConfigurationSetReputationOptions 

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

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

func (*Client) PutConfigurationSetSendingOptions 

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

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

func (*Client) PutConfigurationSetSuppressionOptions 

func (c *Client) PutConfigurationSetSuppressionOptions(ctx context.Context, params *PutConfigurationSetSuppressionOptionsInput, optFns ...func(*Options)) (*PutConfigurationSetSuppressionOptionsOutput, error)

Specify the account suppression list preferences for a configuration set.

func (*Client) PutConfigurationSetTrackingOptions 

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

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

func (*Client) PutConfigurationSetVdmOptions added in v1.15.0 

func (c *Client) PutConfigurationSetVdmOptions(ctx context.Context, params *PutConfigurationSetVdmOptionsInput, optFns ...func(*Options)) (*PutConfigurationSetVdmOptionsOutput, error)

Specify VDM preferences for email that you send using the configuration set. You can execute this operation no more than once per second.

func (*Client) PutDedicatedIpInPool 

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

Move a dedicated IP address to an existing dedicated IP pool. The dedicated IP address that you specify must already exist, and must be associated with your Amazon Web Services account. The dedicated IP pool you specify must already exist. You can create a new pool by using the CreateDedicatedIpPool operation.

func (*Client) PutDedicatedIpPoolScalingAttributes added in v1.18.0 

func (c *Client) PutDedicatedIpPoolScalingAttributes(ctx context.Context, params *PutDedicatedIpPoolScalingAttributesInput, optFns ...func(*Options)) (*PutDedicatedIpPoolScalingAttributesOutput, error)

Used to convert a dedicated IP pool to a different scaling mode. MANAGED pools cannot be converted to STANDARD scaling mode.

func (*Client) PutDedicatedIpWarmupAttributes 

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

func (*Client) PutDeliverabilityDashboardOption 

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

Enable or disable the Deliverability dashboard. When you enable the Deliverability dashboard, you gain access to reputation, deliverability, and other metrics for the domains that you use to send email. You also gain the ability to perform predictive inbox placement tests. When you use the Deliverability dashboard, you pay a monthly subscription charge, in addition to any other fees that you accrue by using Amazon SES and other Amazon Web Services services. For more information about the features and cost of a Deliverability dashboard subscription, see Amazon SES Pricing (http://aws.amazon.com/ses/pricing/) .

func (*Client) PutEmailIdentityConfigurationSetAttributes added in v1.2.0 

func (c *Client) PutEmailIdentityConfigurationSetAttributes(ctx context.Context, params *PutEmailIdentityConfigurationSetAttributesInput, optFns ...func(*Options)) (*PutEmailIdentityConfigurationSetAttributesOutput, error)

Used to associate a configuration set with an email identity.

func (*Client) PutEmailIdentityDkimAttributes 

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

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

func (*Client) PutEmailIdentityDkimSigningAttributes 

func (c *Client) PutEmailIdentityDkimSigningAttributes(ctx context.Context, params *PutEmailIdentityDkimSigningAttributesInput, optFns ...func(*Options)) (*PutEmailIdentityDkimSigningAttributesOutput, error)

Used to configure or change the DKIM authentication settings for an email domain identity. You can use this operation to do any of the following:

  • Update the signing attributes for an identity that uses Bring Your Own DKIM (BYODKIM).
  • Update the key length that should be used for Easy DKIM.
  • Change from using no DKIM authentication to using Easy DKIM.
  • Change from using no DKIM authentication to using BYODKIM.
  • Change from using Easy DKIM to using BYODKIM.
  • Change from using BYODKIM to using Easy DKIM.

func (*Client) PutEmailIdentityFeedbackAttributes 

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

Used to enable or disable feedback forwarding for an identity. This setting determines what happens when an identity is used to send an email that results in a bounce or complaint event. If the value is true , you receive email notifications when bounce or complaint events occur. These notifications are sent to the address that you specified in the Return-Path header of the original email. 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 (for example, by setting up an event destination), you receive an email notification when these events occur (even if this setting is disabled).

func (*Client) PutEmailIdentityMailFromAttributes 

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

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

func (*Client) PutSuppressedDestination 

func (c *Client) PutSuppressedDestination(ctx context.Context, params *PutSuppressedDestinationInput, optFns ...func(*Options)) (*PutSuppressedDestinationOutput, error)

Adds an email address to the suppression list for your account.

func (*Client) SendBulkEmail 

func (c *Client) SendBulkEmail(ctx context.Context, params *SendBulkEmailInput, optFns ...func(*Options)) (*SendBulkEmailOutput, error)

Composes an email message to multiple destinations.

func (*Client) SendCustomVerificationEmail 

func (c *Client) SendCustomVerificationEmail(ctx context.Context, params *SendCustomVerificationEmailInput, optFns ...func(*Options)) (*SendCustomVerificationEmailOutput, error)

Adds an email address to the list of identities for your Amazon SES account in the current Amazon Web Services Region and attempts to verify it. As a result of executing this operation, a customized verification email is sent to the specified address. To use this operation, you must first create a custom verification email template. For more information about creating and using custom verification email templates, see Using custom verification email templates (https://docs.aws.amazon.com/ses/latest/dg/creating-identities.html#send-email-verify-address-custom) in the Amazon SES Developer Guide. You can execute this operation no more than once per second.

func (*Client) SendEmail 

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

Sends an email message. You can use the Amazon SES API v2 to send the following 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 SES 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.
  • Templated – A message that contains personalization tags. When you send this type of email, Amazon SES API v2 automatically replaces the tags with values that you specify.

func (*Client) TagResource 

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

Add one or more tags (keys and values) to a specified resource. A tag is a label that you optionally define and associate with a resource. Tags can help you categorize and manage resources in different ways, such as by purpose, owner, environment, or other criteria. A resource can have as many as 50 tags. Each tag consists of a required tag key and an associated tag value, both of which you define. A tag key is a general label that acts as a category for more specific tag values. A tag value acts as a descriptor within a tag key.

func (*Client) TestRenderEmailTemplate 

func (c *Client) TestRenderEmailTemplate(ctx context.Context, params *TestRenderEmailTemplateInput, optFns ...func(*Options)) (*TestRenderEmailTemplateOutput, error)

Creates a preview of the MIME content of an email when provided with a template and a set of replacement data. You can execute this operation no more than once per second.

func (*Client) UntagResource 

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

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

func (*Client) UpdateConfigurationSetEventDestination 

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

Update the configuration of an event destination for a configuration set. Events include message sends, deliveries, opens, clicks, bounces, and complaints. Event destinations are places that you can send information about these events to. For example, you can send event data to Amazon SNS to receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage.

func (*Client) UpdateContact added in v0.29.0 

func (c *Client) UpdateContact(ctx context.Context, params *UpdateContactInput, optFns ...func(*Options)) (*UpdateContactOutput, error)

Updates a contact's preferences for a list. You must specify all existing topic preferences in the TopicPreferences object, not just the ones that need updating; otherwise, all your existing preferences will be removed.

func (*Client) UpdateContactList added in v0.29.0 

func (c *Client) UpdateContactList(ctx context.Context, params *UpdateContactListInput, optFns ...func(*Options)) (*UpdateContactListOutput, error)

Updates contact list metadata. This operation does a complete replacement.

func (*Client) UpdateCustomVerificationEmailTemplate 

func (c *Client) UpdateCustomVerificationEmailTemplate(ctx context.Context, params *UpdateCustomVerificationEmailTemplateInput, optFns ...func(*Options)) (*UpdateCustomVerificationEmailTemplateOutput, error)

Updates an existing custom verification email template. For more information about custom verification email templates, see Using custom verification email templates (https://docs.aws.amazon.com/ses/latest/dg/creating-identities.html#send-email-verify-address-custom) in the Amazon SES Developer Guide. You can execute this operation no more than once per second.

func (*Client) UpdateEmailIdentityPolicy 

func (c *Client) UpdateEmailIdentityPolicy(ctx context.Context, params *UpdateEmailIdentityPolicyInput, optFns ...func(*Options)) (*UpdateEmailIdentityPolicyOutput, error)

Updates the specified sending authorization policy for the given identity (an email address or a domain). This API returns successfully even if a policy with the specified name does not exist. This API is for the identity owner only. If you have not verified the identity, this API will return an error. Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html) . You can execute this operation no more than once per second.

func (*Client) UpdateEmailTemplate 

func (c *Client) UpdateEmailTemplate(ctx context.Context, params *UpdateEmailTemplateInput, optFns ...func(*Options)) (*UpdateEmailTemplateOutput, error)

Updates an email template. Email templates enable you to send personalized email to one or more destinations in a single API operation. For more information, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-personalized-email-api.html) . You can execute this operation no more than once per second.

type CreateConfigurationSetEventDestinationInput 

type CreateConfigurationSetEventDestinationInput struct {

	// The name of the configuration set .
	//
	// This member is required.
	ConfigurationSetName *string

	// An object that defines the event destination.
	//
	// This member is required.
	EventDestination *types.EventDestinationDefinition

	// A name that identifies the event destination within the configuration set.
	//
	// This member is required.
	EventDestinationName *string
	// contains filtered or unexported fields
}

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

type CreateConfigurationSetEventDestinationOutput 

type CreateConfigurationSetEventDestinationOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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

type CreateConfigurationSetInput 

type CreateConfigurationSetInput struct {

	// The name of the configuration set. The name can contain up to 64 alphanumeric
	// characters, including letters, numbers, hyphens (-) and underscores (_) only.
	//
	// This member is required.
	ConfigurationSetName *string

	// An object that defines the dedicated IP pool that is used to send emails that
	// you send using the configuration set.
	DeliveryOptions *types.DeliveryOptions

	// An object that defines whether or not Amazon SES collects reputation metrics
	// for the emails that you send that use the configuration set.
	ReputationOptions *types.ReputationOptions

	// An object that defines whether or not Amazon SES can send email that you send
	// using the configuration set.
	SendingOptions *types.SendingOptions

	// An object that contains information about the suppression list preferences for
	// your account.
	SuppressionOptions *types.SuppressionOptions

	// An array of objects that define the tags (keys and values) to associate with
	// the configuration set.
	Tags []types.Tag

	// An object that defines the open and click tracking options for emails that you
	// send using the configuration set.
	TrackingOptions *types.TrackingOptions

	// An object that defines the VDM options for emails that you send using the
	// configuration set.
	VdmOptions *types.VdmOptions
	// contains filtered or unexported fields
}

A request to create a configuration set.

type CreateConfigurationSetOutput 

type CreateConfigurationSetOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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

type CreateContactInput added in v0.29.0 

type CreateContactInput struct {

	// The name of the contact list to which the contact should be added.
	//
	// This member is required.
	ContactListName *string

	// The contact's email address.
	//
	// This member is required.
	EmailAddress *string

	// The attribute data attached to a contact.
	AttributesData *string

	// The contact's preferences for being opted-in to or opted-out of topics.
	TopicPreferences []types.TopicPreference

	// A boolean value status noting if the contact is unsubscribed from all contact
	// list topics.
	UnsubscribeAll bool
	// contains filtered or unexported fields
}

type CreateContactListInput added in v0.29.0 

type CreateContactListInput struct {

	// The name of the contact list.
	//
	// This member is required.
	ContactListName *string

	// A description of what the contact list is about.
	Description *string

	// The tags associated with a contact list.
	Tags []types.Tag

	// An interest group, theme, or label within a list. A contact list can have
	// multiple topics.
	Topics []types.Topic
	// contains filtered or unexported fields
}

type CreateContactListOutput added in v0.29.0 

type CreateContactListOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateContactOutput added in v0.29.0 

type CreateContactOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateCustomVerificationEmailTemplateInput 

type CreateCustomVerificationEmailTemplateInput struct {

	// The URL that the recipient of the verification email is sent to if his or her
	// address is not successfully verified.
	//
	// This member is required.
	FailureRedirectionURL *string

	// The email address that the custom verification email is sent from.
	//
	// This member is required.
	FromEmailAddress *string

	// The URL that the recipient of the verification email is sent to if his or her
	// address is successfully verified.
	//
	// This member is required.
	SuccessRedirectionURL *string

	// The content of the custom verification email. The total size of the email must
	// be less than 10 MB. The message body may contain HTML, with some limitations.
	// For more information, see Custom verification email frequently asked questions (https://docs.aws.amazon.com/ses/latest/dg/creating-identities.html#send-email-verify-address-custom-faq)
	// in the Amazon SES Developer Guide.
	//
	// This member is required.
	TemplateContent *string

	// The name of the custom verification email template.
	//
	// This member is required.
	TemplateName *string

	// The subject line of the custom verification email.
	//
	// This member is required.
	TemplateSubject *string
	// contains filtered or unexported fields
}

Represents a request to create a custom verification email template.

type CreateCustomVerificationEmailTemplateOutput 

type CreateCustomVerificationEmailTemplateOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

type CreateDedicatedIpPoolInput 

type CreateDedicatedIpPoolInput struct {

	// The name of the dedicated IP pool.
	//
	// This member is required.
	PoolName *string

	// The type of scaling mode.
	ScalingMode types.ScalingMode

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

A request to create a new dedicated IP pool.

type CreateDedicatedIpPoolOutput 

type CreateDedicatedIpPoolOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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

type CreateDeliverabilityTestReportInput 

type CreateDeliverabilityTestReportInput struct {

	// The HTML body of the message that you sent when you performed the predictive
	// inbox placement test.
	//
	// This member is required.
	Content *types.EmailContent

	// The email address that the predictive inbox placement test email was sent from.
	//
	// This member is required.
	FromEmailAddress *string

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

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

A request to perform a predictive inbox placement test. Predictive inbox placement tests can help you predict how your messages will be handled by various email providers around the world. When you perform a predictive inbox placement test, you provide a sample message that contains the content that you plan to send to your customers. We send that message to special email addresses spread across several major email providers around the world. The test takes about 24 hours to complete. When the test is complete, you can use the GetDeliverabilityTestReport operation to view the results of the test.

type CreateDeliverabilityTestReportOutput 

type CreateDeliverabilityTestReportOutput struct {

	// The status of the predictive inbox placement test. If the status is IN_PROGRESS
	// , then the predictive inbox placement test is currently running. Predictive
	// inbox placement tests are usually complete within 24 hours of creating the test.
	// If the status is COMPLETE , then the test is finished, and you can use the
	// GetDeliverabilityTestReport to view the results of the test.
	//
	// This member is required.
	DeliverabilityTestStatus types.DeliverabilityTestStatus

	// A unique string that identifies the predictive inbox placement test.
	//
	// This member is required.
	ReportId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Information about the predictive inbox placement test that you created.

type CreateEmailIdentityInput 

type CreateEmailIdentityInput struct {

	// The email address or domain to verify.
	//
	// This member is required.
	EmailIdentity *string

	// The configuration set to use by default when sending from this identity. Note
	// that any configuration set defined in the email sending request takes
	// precedence.
	ConfigurationSetName *string

	// If your request includes this object, Amazon SES configures the identity to use
	// Bring Your Own DKIM (BYODKIM) for DKIM authentication purposes, or, configures
	// the key length to be used for Easy DKIM (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html)
	// . You can only specify this object if the email identity is a domain, as opposed
	// to an address.
	DkimSigningAttributes *types.DkimSigningAttributes

	// An array of objects that define the tags (keys and values) to associate with
	// the email identity.
	Tags []types.Tag
	// contains filtered or unexported fields
}

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

type CreateEmailIdentityOutput 

type CreateEmailIdentityOutput struct {

	// An object that contains information about the DKIM attributes for the identity.
	DkimAttributes *types.DkimAttributes

	// The email identity type. Note: the MANAGED_DOMAIN identity type is not
	// supported.
	IdentityType types.IdentityType

	// Specifies whether or not the identity is verified. You can only send email from
	// verified email addresses or domains. For more information about verifying
	// identities, see the Amazon Pinpoint User Guide (https://docs.aws.amazon.com/pinpoint/latest/userguide/channels-email-manage-verify.html)
	// .
	VerifiedForSendingStatus bool

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

If the email identity is a domain, this object contains information about the DKIM verification status for the domain. If the email identity is an email address, this object is empty.

type CreateEmailIdentityPolicyInput 

type CreateEmailIdentityPolicyInput struct {

	// The email identity.
	//
	// This member is required.
	EmailIdentity *string

	// The text of the policy in JSON format. The policy cannot exceed 4 KB. For
	// information about the syntax of sending authorization policies, see the Amazon
	// SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization-policies.html)
	// .
	//
	// This member is required.
	Policy *string

	// The name of the policy. The policy name cannot exceed 64 characters and can
	// only include alphanumeric characters, dashes, and underscores.
	//
	// This member is required.
	PolicyName *string
	// contains filtered or unexported fields
}

Represents a request to create a sending authorization policy for an identity. Sending authorization is an Amazon SES feature that enables you to authorize other senders to use your identities. For information, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization-identity-owner-tasks-management.html) .

type CreateEmailIdentityPolicyOutput 

type CreateEmailIdentityPolicyOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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

type CreateEmailTemplateInput 

type CreateEmailTemplateInput struct {

	// The content of the email template, composed of a subject line, an HTML part,
	// and a text-only part.
	//
	// This member is required.
	TemplateContent *types.EmailTemplateContent

	// The name of the template.
	//
	// This member is required.
	TemplateName *string
	// contains filtered or unexported fields
}

Represents a request to create an email template. For more information, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-personalized-email-api.html) .

type CreateEmailTemplateOutput 

type CreateEmailTemplateOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

type CreateExportJobInput added in v1.20.0 

type CreateExportJobInput struct {

	// The data source for the export job.
	//
	// This member is required.
	ExportDataSource *types.ExportDataSource

	// The destination for the export job.
	//
	// This member is required.
	ExportDestination *types.ExportDestination
	// contains filtered or unexported fields
}

Represents a request to create an export job from a data source to a data destination.

type CreateExportJobOutput added in v1.20.0 

type CreateExportJobOutput struct {

	// A string that represents the export job ID.
	JobId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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

type CreateImportJobInput added in v0.29.0 

type CreateImportJobInput struct {

	// The data source for the import job.
	//
	// This member is required.
	ImportDataSource *types.ImportDataSource

	// The destination for the import job.
	//
	// This member is required.
	ImportDestination *types.ImportDestination
	// contains filtered or unexported fields
}

Represents a request to create an import job from a data source for a data destination.

type CreateImportJobOutput added in v0.29.0 

type CreateImportJobOutput struct {

	// A string that represents the import job ID.
	JobId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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

type DeleteConfigurationSetEventDestinationInput 

type DeleteConfigurationSetEventDestinationInput struct {

	// The name of the configuration set that contains the event destination to delete.
	//
	// This member is required.
	ConfigurationSetName *string

	// The name of the event destination to delete.
	//
	// This member is required.
	EventDestinationName *string
	// contains filtered or unexported fields
}

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

type DeleteConfigurationSetEventDestinationOutput 

type DeleteConfigurationSetEventDestinationOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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

type DeleteConfigurationSetInput 

type DeleteConfigurationSetInput struct {

	// The name of the configuration set.
	//
	// This member is required.
	ConfigurationSetName *string
	// contains filtered or unexported fields
}

A request to delete a configuration set.

type DeleteConfigurationSetOutput 

type DeleteConfigurationSetOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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

type DeleteContactInput added in v0.29.0 

type DeleteContactInput struct {

	// The name of the contact list from which the contact should be removed.
	//
	// This member is required.
	ContactListName *string

	// The contact's email address.
	//
	// This member is required.
	EmailAddress *string
	// contains filtered or unexported fields
}

type DeleteContactListInput added in v0.29.0 

type DeleteContactListInput struct {

	// The name of the contact list.
	//
	// This member is required.
	ContactListName *string
	// contains filtered or unexported fields
}

type DeleteContactListOutput added in v0.29.0 

type DeleteContactListOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteContactOutput added in v0.29.0 

type DeleteContactOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteCustomVerificationEmailTemplateInput 

type DeleteCustomVerificationEmailTemplateInput struct {

	// The name of the custom verification email template that you want to delete.
	//
	// This member is required.
	TemplateName *string
	// contains filtered or unexported fields
}

Represents a request to delete an existing custom verification email template.

type DeleteCustomVerificationEmailTemplateOutput 

type DeleteCustomVerificationEmailTemplateOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

type DeleteDedicatedIpPoolInput 

type DeleteDedicatedIpPoolInput struct {

	// The name of the dedicated IP pool that you want to delete.
	//
	// This member is required.
	PoolName *string
	// contains filtered or unexported fields
}

A request to delete a dedicated IP pool.

type DeleteDedicatedIpPoolOutput 

type DeleteDedicatedIpPoolOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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

type DeleteEmailIdentityInput 

type DeleteEmailIdentityInput struct {

	// The identity (that is, the email address or domain) to delete.
	//
	// This member is required.
	EmailIdentity *string
	// contains filtered or unexported fields
}

A request to delete an existing email identity. When you delete an identity, you lose the ability to send email from that identity. You can restore your ability to send email by completing the verification process for the identity again.

type DeleteEmailIdentityOutput 

type DeleteEmailIdentityOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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

type DeleteEmailIdentityPolicyInput 

type DeleteEmailIdentityPolicyInput struct {

	// The email identity.
	//
	// This member is required.
	EmailIdentity *string

	// The name of the policy. The policy name cannot exceed 64 characters and can
	// only include alphanumeric characters, dashes, and underscores.
	//
	// This member is required.
	PolicyName *string
	// contains filtered or unexported fields
}

Represents a request to delete a sending authorization policy for an identity. Sending authorization is an Amazon SES feature that enables you to authorize other senders to use your identities. For information, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization-identity-owner-tasks-management.html) .

type DeleteEmailIdentityPolicyOutput 

type DeleteEmailIdentityPolicyOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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

type DeleteEmailTemplateInput 

type DeleteEmailTemplateInput struct {

	// The name of the template to be deleted.
	//
	// This member is required.
	TemplateName *string
	// contains filtered or unexported fields
}

Represents a request to delete an email template. For more information, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-personalized-email-api.html) .

type DeleteEmailTemplateOutput 

type DeleteEmailTemplateOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

type DeleteSuppressedDestinationInput 

type DeleteSuppressedDestinationInput struct {

	// The suppressed email destination to remove from the account suppression list.
	//
	// This member is required.
	EmailAddress *string
	// contains filtered or unexported fields
}

A request to remove an email address from the suppression list for your account.

type DeleteSuppressedDestinationOutput 

type DeleteSuppressedDestinationOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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

type EndpointParameters added in v1.19.0 

type EndpointParameters struct {
	// The AWS region used to dispatch the request.
	//
	// Parameter is
	// required.
	//
	// AWS::Region
	Region *string

	// When true, use the dual-stack endpoint. If the configured endpoint does not
	// support dual-stack, dispatching the request MAY return an error.
	//
	// Defaults to
	// false if no value is provided.
	//
	// AWS::UseDualStack
	UseDualStack *bool

	// When true, send this request to the FIPS-compliant regional endpoint. If the
	// configured endpoint does not have a FIPS compliant endpoint, dispatching the
	// request will return an error.
	//
	// Defaults to false if no value is
	// provided.
	//
	// AWS::UseFIPS
	UseFIPS *bool

	// Override the endpoint used to send this request
	//
	// Parameter is
	// required.
	//
	// SDK::Endpoint
	Endpoint *string
}

EndpointParameters provides the parameters that influence how endpoints are resolved.

func (EndpointParameters) ValidateRequired added in v1.19.0 

func (p EndpointParameters) ValidateRequired() error

ValidateRequired validates required parameters are set.

func (EndpointParameters) WithDefaults added in v1.19.0 

func (p EndpointParameters) WithDefaults() EndpointParameters

WithDefaults returns a shallow copy of EndpointParameterswith default values applied to members where applicable.

type EndpointResolver 

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

EndpointResolver interface for resolving service endpoints.

func EndpointResolverFromURL added in v1.1.0 

func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver

EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.

type EndpointResolverFunc 

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

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

func (EndpointResolverFunc) ResolveEndpoint 

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

type EndpointResolverOptions added in v0.29.0 

type EndpointResolverOptions = internalendpoints.Options

EndpointResolverOptions is the service endpoint resolver options

type EndpointResolverV2 added in v1.19.0 

type EndpointResolverV2 interface {
	// ResolveEndpoint attempts to resolve the endpoint with the provided options,
	// returning the endpoint if found. Otherwise an error is returned.
	ResolveEndpoint(ctx context.Context, params EndpointParameters) (
		smithyendpoints.Endpoint, error,
	)
}

EndpointResolverV2 provides the interface for resolving service endpoints.

func NewDefaultEndpointResolverV2 added in v1.19.0 

func NewDefaultEndpointResolverV2() EndpointResolverV2

type GetAccountInput 

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

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

type GetAccountOutput 

type GetAccountOutput struct {

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

	// An object that defines your account details.
	Details *types.AccountDetails

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

	// Indicates whether or not your account has production access in the current
	// Amazon Web Services Region. If the value is false , then your account is in the
	// sandbox. When your account is in the sandbox, you can only send email to
	// verified identities. If the value is true , then your account has production
	// access. When your account has production access, you can send email to any
	// address. The sending quota and maximum sending rate for your account vary based
	// on your specific use case.
	ProductionAccessEnabled bool

	// An object that contains information about the per-day and per-second sending
	// limits for your Amazon SES account in the current Amazon Web Services Region.
	SendQuota *types.SendQuota

	// Indicates whether or not email sending is enabled for your Amazon SES account
	// in the current Amazon Web Services Region.
	SendingEnabled bool

	// An object that contains information about the email address suppression
	// preferences for your account in the current Amazon Web Services Region.
	SuppressionAttributes *types.SuppressionAttributes

	// The VDM attributes that apply to your Amazon SES account.
	VdmAttributes *types.VdmAttributes

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

A list of details about the email-sending capabilities of your Amazon SES account in the current Amazon Web Services Region.

type GetBlacklistReportsInput 

type GetBlacklistReportsInput struct {

	// A list of IP addresses that you want to retrieve blacklist information about.
	// You can only specify the dedicated IP addresses that you use to send email using
	// Amazon SES or Amazon Pinpoint.
	//
	// This member is required.
	BlacklistItemNames []string
	// contains filtered or unexported fields
}

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

type GetBlacklistReportsOutput 

type GetBlacklistReportsOutput struct {

	// An object that contains information about a blacklist that one of your
	// dedicated IP addresses appears on.
	//
	// This member is required.
	BlacklistReport map[string][]types.BlacklistEntry

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

An object that contains information about blacklist events.

type GetConfigurationSetEventDestinationsInput 

type GetConfigurationSetEventDestinationsInput struct {

	// The name of the configuration set that contains the event destination.
	//
	// This member is required.
	ConfigurationSetName *string
	// contains filtered or unexported fields
}

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

type GetConfigurationSetEventDestinationsOutput 

type GetConfigurationSetEventDestinationsOutput struct {

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Information about an event destination for a configuration set.

type GetConfigurationSetInput 

type GetConfigurationSetInput struct {

	// The name of the configuration set.
	//
	// This member is required.
	ConfigurationSetName *string
	// contains filtered or unexported fields
}

A request to obtain information about a configuration set.

type GetConfigurationSetOutput 

type GetConfigurationSetOutput struct {

	// The name of the configuration set.
	ConfigurationSetName *string

	// An object that defines the dedicated IP pool that is used to send emails that
	// you send using the configuration set.
	DeliveryOptions *types.DeliveryOptions

	// An object that defines whether or not Amazon SES collects reputation metrics
	// for the emails that you send that use the configuration set.
	ReputationOptions *types.ReputationOptions

	// An object that defines whether or not Amazon SES can send email that you send
	// using the configuration set.
	SendingOptions *types.SendingOptions

	// An object that contains information about the suppression list preferences for
	// your account.
	SuppressionOptions *types.SuppressionOptions

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

	// An object that defines the open and click tracking options for emails that you
	// send using the configuration set.
	TrackingOptions *types.TrackingOptions

	// An object that contains information about the VDM preferences for your
	// configuration set.
	VdmOptions *types.VdmOptions

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Information about a configuration set.

type GetContactInput added in v0.29.0 

type GetContactInput struct {

	// The name of the contact list to which the contact belongs.
	//
	// This member is required.
	ContactListName *string

	// The contact's email address.
	//
	// This member is required.
	EmailAddress *string
	// contains filtered or unexported fields
}

type GetContactListInput added in v0.29.0 

type GetContactListInput struct {

	// The name of the contact list.
	//
	// This member is required.
	ContactListName *string
	// contains filtered or unexported fields
}

type GetContactListOutput added in v0.29.0 

type GetContactListOutput struct {

	// The name of the contact list.
	ContactListName *string

	// A timestamp noting when the contact list was created.
	CreatedTimestamp *time.Time

	// A description of what the contact list is about.
	Description *string

	// A timestamp noting the last time the contact list was updated.
	LastUpdatedTimestamp *time.Time

	// The tags associated with a contact list.
	Tags []types.Tag

	// An interest group, theme, or label within a list. A contact list can have
	// multiple topics.
	Topics []types.Topic

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetContactOutput added in v0.29.0 

type GetContactOutput struct {

	// The attribute data attached to a contact.
	AttributesData *string

	// The name of the contact list to which the contact belongs.
	ContactListName *string

	// A timestamp noting when the contact was created.
	CreatedTimestamp *time.Time

	// The contact's email address.
	EmailAddress *string

	// A timestamp noting the last time the contact's information was updated.
	LastUpdatedTimestamp *time.Time

	// The default topic preferences applied to the contact.
	TopicDefaultPreferences []types.TopicPreference

	// The contact's preference for being opted-in to or opted-out of a topic.>
	TopicPreferences []types.TopicPreference

	// A boolean value status noting if the contact is unsubscribed from all contact
	// list topics.
	UnsubscribeAll bool

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetCustomVerificationEmailTemplateInput 

type GetCustomVerificationEmailTemplateInput struct {

	// The name of the custom verification email template that you want to retrieve.
	//
	// This member is required.
	TemplateName *string
	// contains filtered or unexported fields
}

Represents a request to retrieve an existing custom verification email template.

type GetCustomVerificationEmailTemplateOutput 

type GetCustomVerificationEmailTemplateOutput struct {

	// The URL that the recipient of the verification email is sent to if his or her
	// address is not successfully verified.
	FailureRedirectionURL *string

	// The email address that the custom verification email is sent from.
	FromEmailAddress *string

	// The URL that the recipient of the verification email is sent to if his or her
	// address is successfully verified.
	SuccessRedirectionURL *string

	// The content of the custom verification email.
	TemplateContent *string

	// The name of the custom verification email template.
	TemplateName *string

	// The subject line of the custom verification email.
	TemplateSubject *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

The following elements are returned by the service.

type GetDedicatedIpInput 

type GetDedicatedIpInput struct {

	// The IP address that you want to obtain more information about. The value you
	// specify has to be a dedicated IP address that's assocaited with your Amazon Web
	// Services account.
	//
	// This member is required.
	Ip *string
	// contains filtered or unexported fields
}

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

type GetDedicatedIpOutput 

type GetDedicatedIpOutput struct {

	// An object that contains information about a dedicated IP address.
	DedicatedIp *types.DedicatedIp

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Information about a dedicated IP address.

type GetDedicatedIpPoolInput added in v1.14.0 

type GetDedicatedIpPoolInput struct {

	// The name of the dedicated IP pool to retrieve.
	//
	// This member is required.
	PoolName *string
	// contains filtered or unexported fields
}

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

type GetDedicatedIpPoolOutput added in v1.14.0 

type GetDedicatedIpPoolOutput struct {

	// An object that contains information about a dedicated IP pool.
	DedicatedIpPool *types.DedicatedIpPool

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

The following element is returned by the service.

type GetDedicatedIpsAPIClient added in v0.30.0 

type GetDedicatedIpsAPIClient interface {
	GetDedicatedIps(context.Context, *GetDedicatedIpsInput, ...func(*Options)) (*GetDedicatedIpsOutput, error)
}

GetDedicatedIpsAPIClient is a client that implements the GetDedicatedIps operation.

type GetDedicatedIpsInput 

type GetDedicatedIpsInput struct {

	// A token returned from a previous call to GetDedicatedIps to indicate the
	// position of the dedicated IP pool in the list of IP pools.
	NextToken *string

	// The number of results to show in a single call to GetDedicatedIpsRequest . If
	// the number of results is larger than the number you specified in this parameter,
	// then the response includes a NextToken element, which you can use to obtain
	// additional results.
	PageSize *int32

	// The name of the IP pool that the dedicated IP address is associated with.
	PoolName *string
	// contains filtered or unexported fields
}

A request to obtain more information about dedicated IP pools.

type GetDedicatedIpsOutput 

type GetDedicatedIpsOutput struct {

	// A list of dedicated IP addresses that are associated with your Amazon Web
	// Services account.
	DedicatedIps []types.DedicatedIp

	// A token that indicates that there are additional dedicated IP addresses to
	// list. To view additional addresses, issue another request to GetDedicatedIps ,
	// passing this token in the NextToken parameter.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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

type GetDedicatedIpsPaginator added in v0.30.0 

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

GetDedicatedIpsPaginator is a paginator for GetDedicatedIps

func NewGetDedicatedIpsPaginator added in v0.30.0 

func NewGetDedicatedIpsPaginator(client GetDedicatedIpsAPIClient, params *GetDedicatedIpsInput, optFns ...func(*GetDedicatedIpsPaginatorOptions)) *GetDedicatedIpsPaginator

NewGetDedicatedIpsPaginator returns a new GetDedicatedIpsPaginator

func (*GetDedicatedIpsPaginator) HasMorePages added in v0.30.0 

func (p *GetDedicatedIpsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*GetDedicatedIpsPaginator) NextPage added in v0.30.0 

func (p *GetDedicatedIpsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*GetDedicatedIpsOutput, error)

NextPage retrieves the next GetDedicatedIps page.

type GetDedicatedIpsPaginatorOptions added in v0.30.0 

type GetDedicatedIpsPaginatorOptions struct {
	// The number of results to show in a single call to GetDedicatedIpsRequest . If
	// the number of results is larger than the number you specified in this parameter,
	// then the response includes a NextToken element, which you can use to obtain
	// additional results.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

GetDedicatedIpsPaginatorOptions is the paginator options for GetDedicatedIps

type GetDeliverabilityDashboardOptionsInput 

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

Retrieve information about the status of the Deliverability dashboard for your Amazon Web Services account. When the Deliverability dashboard is enabled, you gain access to reputation, deliverability, and other metrics for your domains. You also gain the ability to perform predictive inbox placement tests. When you use the Deliverability dashboard, you pay a monthly subscription charge, in addition to any other fees that you accrue by using Amazon SES and other Amazon Web Services services. For more information about the features and cost of a Deliverability dashboard subscription, see Amazon Pinpoint Pricing (http://aws.amazon.com/pinpoint/pricing/) .

type GetDeliverabilityDashboardOptionsOutput 

type GetDeliverabilityDashboardOptionsOutput struct {

	// Specifies whether the Deliverability dashboard is enabled. If this value is true
	// , the dashboard is enabled.
	//
	// This member is required.
	DashboardEnabled bool

	// The current status of your Deliverability dashboard subscription. If this value
	// is PENDING_EXPIRATION , your subscription is scheduled to expire at the end of
	// the current calendar month.
	AccountStatus types.DeliverabilityDashboardAccountStatus

	// An array of objects, one for each verified domain that you use to send email
	// and currently has an active Deliverability dashboard subscription that isn’t
	// scheduled to expire at the end of the current calendar month.
	ActiveSubscribedDomains []types.DomainDeliverabilityTrackingOption

	// An array of objects, one for each verified domain that you use to send email
	// and currently has an active Deliverability dashboard subscription that's
	// scheduled to expire at the end of the current calendar month.
	PendingExpirationSubscribedDomains []types.DomainDeliverabilityTrackingOption

	// The date when your current subscription to the Deliverability dashboard is
	// scheduled to expire, if your subscription is scheduled to expire at the end of
	// the current calendar month. This value is null if you have an active
	// subscription that isn’t due to expire at the end of the month.
	SubscriptionExpiryDate *time.Time

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

An object that shows the status of the Deliverability dashboard.

type GetDeliverabilityTestReportInput 

type GetDeliverabilityTestReportInput struct {

	// A unique string that identifies the predictive inbox placement test.
	//
	// This member is required.
	ReportId *string
	// contains filtered or unexported fields
}

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

type GetDeliverabilityTestReportOutput 

type GetDeliverabilityTestReportOutput struct {

	// An object that contains the results of the predictive inbox placement test.
	//
	// This member is required.
	DeliverabilityTestReport *types.DeliverabilityTestReport

	// An object that describes how the test email was handled by several email
	// providers, including Gmail, Hotmail, Yahoo, AOL, and others.
	//
	// This member is required.
	IspPlacements []types.IspPlacement

	// An object that specifies how many test messages that were sent during the
	// predictive inbox placement test were delivered to recipients' inboxes, how many
	// were sent to recipients' spam folders, and how many weren't delivered.
	//
	// This member is required.
	OverallPlacement *types.PlacementStatistics

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

	// An array of objects that define the tags (keys and values) that are associated
	// with the predictive inbox placement test.
	Tags []types.Tag

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

The results of the predictive inbox placement test.

type GetDomainDeliverabilityCampaignInput 

type GetDomainDeliverabilityCampaignInput struct {

	// The unique identifier for the campaign. The Deliverability dashboard
	// automatically generates and assigns this identifier to a campaign.
	//
	// This member is required.
	CampaignId *string
	// contains filtered or unexported fields
}

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

type GetDomainDeliverabilityCampaignOutput 

type GetDomainDeliverabilityCampaignOutput struct {

	// An object that contains the deliverability data for the campaign.
	//
	// This member is required.
	DomainDeliverabilityCampaign *types.DomainDeliverabilityCampaign

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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

type GetDomainStatisticsReportInput 

type GetDomainStatisticsReportInput struct {

	// The domain that you want to obtain deliverability metrics for.
	//
	// This member is required.
	Domain *string

	// The last day (in Unix time) that you want to obtain domain deliverability
	// metrics for. The EndDate that you specify has to be less than or equal to 30
	// days after the StartDate .
	//
	// This member is required.
	EndDate *time.Time

	// The first day (in Unix time) that you want to obtain domain deliverability
	// metrics for.
	//
	// This member is required.
	StartDate *time.Time
	// contains filtered or unexported fields
}

A request to obtain deliverability metrics for a domain.

type GetDomainStatisticsReportOutput 

type GetDomainStatisticsReportOutput struct {

	// An object that contains deliverability metrics for the domain that you
	// specified. This object contains data for each day, starting on the StartDate
	// and ending on the EndDate .
	//
	// This member is required.
	DailyVolumes []types.DailyVolume

	// An object that contains deliverability metrics for the domain that you
	// specified. The data in this object is a summary of all of the data that was
	// collected from the StartDate to the EndDate .
	//
	// This member is required.
	OverallVolume *types.OverallVolume

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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

type GetEmailIdentityInput 

type GetEmailIdentityInput struct {

	// The email identity.
	//
	// This member is required.
	EmailIdentity *string
	// contains filtered or unexported fields
}

A request to return details about an email identity.

type GetEmailIdentityOutput 

type GetEmailIdentityOutput struct {

	// The configuration set used by default when sending from this identity.
	ConfigurationSetName *string

	// An object that contains information about the DKIM attributes for the identity.
	DkimAttributes *types.DkimAttributes

	// The feedback forwarding configuration for the identity. If the value is true ,
	// you receive email notifications when bounce or complaint events occur. These
	// notifications are sent to the address that you specified in the Return-Path
	// header of the original email. 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 (for example, by setting up an event
	// destination), you receive an email notification when these events occur (even if
	// this setting is disabled).
	FeedbackForwardingStatus bool

	// The email identity type. Note: the MANAGED_DOMAIN identity type is not
	// supported.
	IdentityType types.IdentityType

	// An object that contains information about the Mail-From attributes for the
	// email identity.
	MailFromAttributes *types.MailFromAttributes

	// A map of policy names to policies.
	Policies map[string]string

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

	// An object that contains additional information about the verification status
	// for the identity.
	VerificationInfo *types.VerificationInfo

	// The verification status of the identity. The status can be one of the
	// following:
	//   - PENDING – The verification process was initiated, but Amazon SES hasn't yet
	//   been able to verify the identity.
	//   - SUCCESS – The verification process completed successfully.
	//   - FAILED – The verification process failed.
	//   - TEMPORARY_FAILURE – A temporary issue is preventing Amazon SES from
	//   determining the verification status of the identity.
	//   - NOT_STARTED – The verification process hasn't been initiated for the
	//   identity.
	VerificationStatus types.VerificationStatus

	// Specifies whether or not the identity is verified. You can only send email from
	// verified email addresses or domains. For more information about verifying
	// identities, see the Amazon Pinpoint User Guide (https://docs.aws.amazon.com/pinpoint/latest/userguide/channels-email-manage-verify.html)
	// .
	VerifiedForSendingStatus bool

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Details about an email identity.

type GetEmailIdentityPoliciesInput 

type GetEmailIdentityPoliciesInput struct {

	// The email identity.
	//
	// This member is required.
	EmailIdentity *string
	// contains filtered or unexported fields
}

A request to return the policies of an email identity.

type GetEmailIdentityPoliciesOutput 

type GetEmailIdentityPoliciesOutput struct {

	// A map of policy names to policies.
	Policies map[string]string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Identity policies associated with email identity.

type GetEmailTemplateInput 

type GetEmailTemplateInput struct {

	// The name of the template.
	//
	// This member is required.
	TemplateName *string
	// contains filtered or unexported fields
}

Represents a request to display the template object (which includes the subject line, HTML part and text part) for the template you specify.

type GetEmailTemplateOutput 

type GetEmailTemplateOutput struct {

	// The content of the email template, composed of a subject line, an HTML part,
	// and a text-only part.
	//
	// This member is required.
	TemplateContent *types.EmailTemplateContent

	// The name of the template.
	//
	// This member is required.
	TemplateName *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

The following element is returned by the service.

type GetExportJobInput added in v1.20.0 

type GetExportJobInput struct {

	// The export job ID.
	//
	// This member is required.
	JobId *string
	// contains filtered or unexported fields
}

Represents a request to retrieve information about an export job using the export job ID.

type GetExportJobOutput added in v1.20.0 

type GetExportJobOutput struct {

	// The timestamp of when the export job was completed.
	CompletedTimestamp *time.Time

	// The timestamp of when the export job was created.
	CreatedTimestamp *time.Time

	// The data source of the export job.
	ExportDataSource *types.ExportDataSource

	// The destination of the export job.
	ExportDestination *types.ExportDestination

	// The type of source of the export job.
	ExportSourceType types.ExportSourceType

	// The failure details about an export job.
	FailureInfo *types.FailureInfo

	// The export job ID.
	JobId *string

	// The status of the export job.
	JobStatus types.JobStatus

	// The statistics about the export job.
	Statistics *types.ExportStatistics

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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

type GetImportJobInput added in v0.29.0 

type GetImportJobInput struct {

	// The ID of the import job.
	//
	// This member is required.
	JobId *string
	// contains filtered or unexported fields
}

Represents a request for information about an import job using the import job ID.

type GetImportJobOutput added in v0.29.0 

type GetImportJobOutput struct {

	// The time stamp of when the import job was completed.
	CompletedTimestamp *time.Time

	// The time stamp of when the import job was created.
	CreatedTimestamp *time.Time

	// The number of records that failed processing because of invalid input or other
	// reasons.
	FailedRecordsCount *int32

	// The failure details about an import job.
	FailureInfo *types.FailureInfo

	// The data source of the import job.
	ImportDataSource *types.ImportDataSource

	// The destination of the import job.
	ImportDestination *types.ImportDestination

	// A string that represents the import job ID.
	JobId *string

	// The status of the import job.
	JobStatus types.JobStatus

	// The current number of records processed.
	ProcessedRecordsCount *int32

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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

type GetMessageInsightsInput added in v1.20.0 

type GetMessageInsightsInput struct {

	// A MessageId is a unique identifier for a message, and is returned when sending
	// emails through Amazon SES.
	//
	// This member is required.
	MessageId *string
	// contains filtered or unexported fields
}

A request to return information about a message.

type GetMessageInsightsOutput added in v1.20.0 

type GetMessageInsightsOutput struct {

	// A list of tags, in the form of name/value pairs, that were applied to the email
	// you sent, along with Amazon SES Auto-Tags (https://docs.aws.amazon.com/ses/latest/dg/monitor-using-event-publishing.html)
	// .
	EmailTags []types.MessageTag

	// The from address used to send the message.
	FromEmailAddress *string

	// A set of insights associated with the message.
	Insights []types.EmailInsights

	// A unique identifier for the message.
	MessageId *string

	// The subject line of the message.
	Subject *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Information about a message.

type GetSuppressedDestinationInput 

type GetSuppressedDestinationInput struct {

	// The email address that's on the account suppression list.
	//
	// This member is required.
	EmailAddress *string
	// contains filtered or unexported fields
}

A request to retrieve information about an email address that's on the suppression list for your account.

type GetSuppressedDestinationOutput 

type GetSuppressedDestinationOutput struct {

	// An object containing information about the suppressed email address.
	//
	// This member is required.
	SuppressedDestination *types.SuppressedDestination

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Information about the suppressed email address.

type HTTPClient 

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

type HTTPSignerV4 

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

type ListConfigurationSetsAPIClient added in v0.30.0 

type ListConfigurationSetsAPIClient interface {
	ListConfigurationSets(context.Context, *ListConfigurationSetsInput, ...func(*Options)) (*ListConfigurationSetsOutput, error)
}

ListConfigurationSetsAPIClient is a client that implements the ListConfigurationSets operation.

type ListConfigurationSetsInput 

type ListConfigurationSetsInput struct {

	// A token returned from a previous call to ListConfigurationSets to indicate the
	// position in the list of configuration sets.
	NextToken *string

	// The number of results to show in a single call to ListConfigurationSets . If the
	// number of results is larger than the number you specified in this parameter,
	// then the response includes a NextToken element, which you can use to obtain
	// additional results.
	PageSize *int32
	// contains filtered or unexported fields
}

A request to obtain a list of configuration sets for your Amazon SES account in the current Amazon Web Services Region.

type ListConfigurationSetsOutput 

type ListConfigurationSetsOutput struct {

	// An array that contains all of the configuration sets in your Amazon SES account
	// in the current Amazon Web Services Region.
	ConfigurationSets []string

	// A token that indicates that there are additional configuration sets to list. To
	// view additional configuration sets, issue another request to
	// ListConfigurationSets , and pass this token in the NextToken parameter.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

A list of configuration sets in your Amazon SES account in the current Amazon Web Services Region.

type ListConfigurationSetsPaginator added in v0.30.0 

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

ListConfigurationSetsPaginator is a paginator for ListConfigurationSets

func NewListConfigurationSetsPaginator added in v0.30.0 

func NewListConfigurationSetsPaginator(client ListConfigurationSetsAPIClient, params *ListConfigurationSetsInput, optFns ...func(*ListConfigurationSetsPaginatorOptions)) *ListConfigurationSetsPaginator

NewListConfigurationSetsPaginator returns a new ListConfigurationSetsPaginator

func (*ListConfigurationSetsPaginator) HasMorePages added in v0.30.0 

func (p *ListConfigurationSetsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListConfigurationSetsPaginator) NextPage added in v0.30.0 

func (p *ListConfigurationSetsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListConfigurationSetsOutput, error)

NextPage retrieves the next ListConfigurationSets page.

type ListConfigurationSetsPaginatorOptions added in v0.30.0 

type ListConfigurationSetsPaginatorOptions struct {
	// The number of results to show in a single call to ListConfigurationSets . If the
	// number of results is larger than the number you specified in this parameter,
	// then the response includes a NextToken element, which you can use to obtain
	// additional results.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListConfigurationSetsPaginatorOptions is the paginator options for ListConfigurationSets

type ListContactListsAPIClient added in v0.30.0 

type ListContactListsAPIClient interface {
	ListContactLists(context.Context, *ListContactListsInput, ...func(*Options)) (*ListContactListsOutput, error)
}

ListContactListsAPIClient is a client that implements the ListContactLists operation.

type ListContactListsInput added in v0.29.0 

type ListContactListsInput struct {

	// A string token indicating that there might be additional contact lists
	// available to be listed. Use the token provided in the Response to use in the
	// subsequent call to ListContactLists with the same parameters to retrieve the
	// next page of contact lists.
	NextToken *string

	// Maximum number of contact lists to return at once. Use this parameter to
	// paginate results. If additional contact lists exist beyond the specified limit,
	// the NextToken element is sent in the response. Use the NextToken value in
	// subsequent requests to retrieve additional lists.
	PageSize *int32
	// contains filtered or unexported fields
}

type ListContactListsOutput added in v0.29.0 

type ListContactListsOutput struct {

	// The available contact lists.
	ContactLists []types.ContactList

	// A string token indicating that there might be additional contact lists
	// available to be listed. Copy this token to a subsequent call to ListContactLists
	// with the same parameters to retrieve the next page of contact lists.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListContactListsPaginator added in v0.30.0 

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

ListContactListsPaginator is a paginator for ListContactLists

func NewListContactListsPaginator added in v0.30.0 

func NewListContactListsPaginator(client ListContactListsAPIClient, params *ListContactListsInput, optFns ...func(*ListContactListsPaginatorOptions)) *ListContactListsPaginator

NewListContactListsPaginator returns a new ListContactListsPaginator

func (*ListContactListsPaginator) HasMorePages added in v0.30.0 

func (p *ListContactListsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListContactListsPaginator) NextPage added in v0.30.0 

func (p *ListContactListsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListContactListsOutput, error)

NextPage retrieves the next ListContactLists page.

type ListContactListsPaginatorOptions added in v0.30.0 

type ListContactListsPaginatorOptions struct {
	// Maximum number of contact lists to return at once. Use this parameter to
	// paginate results. If additional contact lists exist beyond the specified limit,
	// the NextToken element is sent in the response. Use the NextToken value in
	// subsequent requests to retrieve additional lists.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListContactListsPaginatorOptions is the paginator options for ListContactLists

type ListContactsAPIClient added in v0.30.0 

type ListContactsAPIClient interface {
	ListContacts(context.Context, *ListContactsInput, ...func(*Options)) (*ListContactsOutput, error)
}

ListContactsAPIClient is a client that implements the ListContacts operation.

type ListContactsInput added in v0.29.0 

type ListContactsInput struct {

	// The name of the contact list.
	//
	// This member is required.
	ContactListName *string

	// A filter that can be applied to a list of contacts.
	Filter *types.ListContactsFilter

	// A string token indicating that there might be additional contacts available to
	// be listed. Use the token provided in the Response to use in the subsequent call
	// to ListContacts with the same parameters to retrieve the next page of contacts.
	NextToken *string

	// The number of contacts that may be returned at once, which is dependent on if
	// there are more or less contacts than the value of the PageSize. Use this
	// parameter to paginate results. If additional contacts exist beyond the specified
	// limit, the NextToken element is sent in the response. Use the NextToken value
	// in subsequent requests to retrieve additional contacts.
	PageSize *int32
	// contains filtered or unexported fields
}

type ListContactsOutput added in v0.29.0 

type ListContactsOutput struct {

	// The contacts present in a specific contact list.
	Contacts []types.Contact

	// A string token indicating that there might be additional contacts available to
	// be listed. Copy this token to a subsequent call to ListContacts with the same
	// parameters to retrieve the next page of contacts.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListContactsPaginator added in v0.30.0 

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

ListContactsPaginator is a paginator for ListContacts

func NewListContactsPaginator added in v0.30.0 

func NewListContactsPaginator(client ListContactsAPIClient, params *ListContactsInput, optFns ...func(*ListContactsPaginatorOptions)) *ListContactsPaginator

NewListContactsPaginator returns a new ListContactsPaginator

func (*ListContactsPaginator) HasMorePages added in v0.30.0 

func (p *ListContactsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListContactsPaginator) NextPage added in v0.30.0 

func (p *ListContactsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListContactsOutput, error)

NextPage retrieves the next ListContacts page.

type ListContactsPaginatorOptions added in v0.30.0 

type ListContactsPaginatorOptions struct {
	// The number of contacts that may be returned at once, which is dependent on if
	// there are more or less contacts than the value of the PageSize. Use this
	// parameter to paginate results. If additional contacts exist beyond the specified
	// limit, the NextToken element is sent in the response. Use the NextToken value
	// in subsequent requests to retrieve additional contacts.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListContactsPaginatorOptions is the paginator options for ListContacts

type ListCustomVerificationEmailTemplatesAPIClient added in v0.30.0 

type ListCustomVerificationEmailTemplatesAPIClient interface {
	ListCustomVerificationEmailTemplates(context.Context, *ListCustomVerificationEmailTemplatesInput, ...func(*Options)) (*ListCustomVerificationEmailTemplatesOutput, error)
}

ListCustomVerificationEmailTemplatesAPIClient is a client that implements the ListCustomVerificationEmailTemplates operation.

type ListCustomVerificationEmailTemplatesInput 

type ListCustomVerificationEmailTemplatesInput struct {

	// A token returned from a previous call to ListCustomVerificationEmailTemplates
	// to indicate the position in the list of custom verification email templates.
	NextToken *string

	// The number of results to show in a single call to
	// ListCustomVerificationEmailTemplates . If the number of results is larger than
	// the number you specified in this parameter, then the response includes a
	// NextToken element, which you can use to obtain additional results. The value you
	// specify has to be at least 1, and can be no more than 50.
	PageSize *int32
	// contains filtered or unexported fields
}

Represents a request to list the existing custom verification email templates for your account.

type ListCustomVerificationEmailTemplatesOutput 

type ListCustomVerificationEmailTemplatesOutput struct {

	// A list of the custom verification email templates that exist in your account.
	CustomVerificationEmailTemplates []types.CustomVerificationEmailTemplateMetadata

	// A token indicating that there are additional custom verification email
	// templates available to be listed. Pass this token to a subsequent call to
	// ListCustomVerificationEmailTemplates to retrieve the next 50 custom verification
	// email templates.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

The following elements are returned by the service.

type ListCustomVerificationEmailTemplatesPaginator added in v0.30.0 

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

ListCustomVerificationEmailTemplatesPaginator is a paginator for ListCustomVerificationEmailTemplates

func NewListCustomVerificationEmailTemplatesPaginator added in v0.30.0 

func NewListCustomVerificationEmailTemplatesPaginator(client ListCustomVerificationEmailTemplatesAPIClient, params *ListCustomVerificationEmailTemplatesInput, optFns ...func(*ListCustomVerificationEmailTemplatesPaginatorOptions)) *ListCustomVerificationEmailTemplatesPaginator

NewListCustomVerificationEmailTemplatesPaginator returns a new ListCustomVerificationEmailTemplatesPaginator

func (*ListCustomVerificationEmailTemplatesPaginator) HasMorePages added in v0.30.0 

func (p *ListCustomVerificationEmailTemplatesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListCustomVerificationEmailTemplatesPaginator) NextPage added in v0.30.0 

func (p *ListCustomVerificationEmailTemplatesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListCustomVerificationEmailTemplatesOutput, error)

NextPage retrieves the next ListCustomVerificationEmailTemplates page.

type ListCustomVerificationEmailTemplatesPaginatorOptions added in v0.30.0 

type ListCustomVerificationEmailTemplatesPaginatorOptions struct {
	// The number of results to show in a single call to
	// ListCustomVerificationEmailTemplates . If the number of results is larger than
	// the number you specified in this parameter, then the response includes a
	// NextToken element, which you can use to obtain additional results. The value you
	// specify has to be at least 1, and can be no more than 50.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListCustomVerificationEmailTemplatesPaginatorOptions is the paginator options for ListCustomVerificationEmailTemplates

type ListDedicatedIpPoolsAPIClient added in v0.30.0 

type ListDedicatedIpPoolsAPIClient interface {
	ListDedicatedIpPools(context.Context, *ListDedicatedIpPoolsInput, ...func(*Options)) (*ListDedicatedIpPoolsOutput, error)
}

ListDedicatedIpPoolsAPIClient is a client that implements the ListDedicatedIpPools operation.

type ListDedicatedIpPoolsInput 

type ListDedicatedIpPoolsInput struct {

	// A token returned from a previous call to ListDedicatedIpPools to indicate the
	// position in the list of dedicated IP pools.
	NextToken *string

	// The number of results to show in a single call to ListDedicatedIpPools . If the
	// number of results is larger than the number you specified in this parameter,
	// then the response includes a NextToken element, which you can use to obtain
	// additional results.
	PageSize *int32
	// contains filtered or unexported fields
}

A request to obtain a list of dedicated IP pools.

type ListDedicatedIpPoolsOutput 

type ListDedicatedIpPoolsOutput struct {

	// A list of all of the dedicated IP pools that are associated with your Amazon
	// Web Services account in the current Region.
	DedicatedIpPools []string

	// A token that indicates that there are additional IP pools to list. To view
	// additional IP pools, issue another request to ListDedicatedIpPools , passing
	// this token in the NextToken parameter.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

A list of dedicated IP pools.

type ListDedicatedIpPoolsPaginator added in v0.30.0 

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

ListDedicatedIpPoolsPaginator is a paginator for ListDedicatedIpPools

func NewListDedicatedIpPoolsPaginator added in v0.30.0 

func NewListDedicatedIpPoolsPaginator(client ListDedicatedIpPoolsAPIClient, params *ListDedicatedIpPoolsInput, optFns ...func(*ListDedicatedIpPoolsPaginatorOptions)) *ListDedicatedIpPoolsPaginator

NewListDedicatedIpPoolsPaginator returns a new ListDedicatedIpPoolsPaginator

func (*ListDedicatedIpPoolsPaginator) HasMorePages added in v0.30.0 

func (p *ListDedicatedIpPoolsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListDedicatedIpPoolsPaginator) NextPage added in v0.30.0 

func (p *ListDedicatedIpPoolsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListDedicatedIpPoolsOutput, error)

NextPage retrieves the next ListDedicatedIpPools page.

type ListDedicatedIpPoolsPaginatorOptions added in v0.30.0 

type ListDedicatedIpPoolsPaginatorOptions struct {
	// The number of results to show in a single call to ListDedicatedIpPools . If the
	// number of results is larger than the number you specified in this parameter,
	// then the response includes a NextToken element, which you can use to obtain
	// additional results.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListDedicatedIpPoolsPaginatorOptions is the paginator options for ListDedicatedIpPools

type ListDeliverabilityTestReportsAPIClient added in v0.30.0 

type ListDeliverabilityTestReportsAPIClient interface {
	ListDeliverabilityTestReports(context.Context, *ListDeliverabilityTestReportsInput, ...func(*Options)) (*ListDeliverabilityTestReportsOutput, error)
}

ListDeliverabilityTestReportsAPIClient is a client that implements the ListDeliverabilityTestReports operation.

type ListDeliverabilityTestReportsInput 

type ListDeliverabilityTestReportsInput struct {

	// A token returned from a previous call to ListDeliverabilityTestReports to
	// indicate the position in the list of predictive inbox placement tests.
	NextToken *string

	// The number of results to show in a single call to ListDeliverabilityTestReports
	// . If the number of results is larger than the number you specified in this
	// parameter, then the response includes a NextToken element, which you can use to
	// obtain additional results. The value you specify has to be at least 0, and can
	// be no more than 1000.
	PageSize *int32
	// contains filtered or unexported fields
}

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

type ListDeliverabilityTestReportsOutput 

type ListDeliverabilityTestReportsOutput struct {

	// An object that contains a lists of predictive inbox placement tests that you've
	// performed.
	//
	// This member is required.
	DeliverabilityTestReports []types.DeliverabilityTestReport

	// A token that indicates that there are additional predictive inbox placement
	// tests to list. To view additional predictive inbox placement tests, issue
	// another request to ListDeliverabilityTestReports , and pass this token in the
	// NextToken parameter.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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

type ListDeliverabilityTestReportsPaginator added in v0.30.0 

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

ListDeliverabilityTestReportsPaginator is a paginator for ListDeliverabilityTestReports

func NewListDeliverabilityTestReportsPaginator added in v0.30.0 

func NewListDeliverabilityTestReportsPaginator(client ListDeliverabilityTestReportsAPIClient, params *ListDeliverabilityTestReportsInput, optFns ...func(*ListDeliverabilityTestReportsPaginatorOptions)) *ListDeliverabilityTestReportsPaginator

NewListDeliverabilityTestReportsPaginator returns a new ListDeliverabilityTestReportsPaginator

func (*ListDeliverabilityTestReportsPaginator) HasMorePages added in v0.30.0 

func (p *ListDeliverabilityTestReportsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListDeliverabilityTestReportsPaginator) NextPage added in v0.30.0 

func (p *ListDeliverabilityTestReportsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListDeliverabilityTestReportsOutput, error)

NextPage retrieves the next ListDeliverabilityTestReports page.

type ListDeliverabilityTestReportsPaginatorOptions added in v0.30.0 

type ListDeliverabilityTestReportsPaginatorOptions struct {
	// The number of results to show in a single call to ListDeliverabilityTestReports
	// . If the number of results is larger than the number you specified in this
	// parameter, then the response includes a NextToken element, which you can use to
	// obtain additional results. The value you specify has to be at least 0, and can
	// be no more than 1000.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListDeliverabilityTestReportsPaginatorOptions is the paginator options for ListDeliverabilityTestReports

type ListDomainDeliverabilityCampaignsAPIClient added in v0.30.0 

type ListDomainDeliverabilityCampaignsAPIClient interface {
	ListDomainDeliverabilityCampaigns(context.Context, *ListDomainDeliverabilityCampaignsInput, ...func(*Options)) (*ListDomainDeliverabilityCampaignsOutput, error)
}

ListDomainDeliverabilityCampaignsAPIClient is a client that implements the ListDomainDeliverabilityCampaigns operation.

type ListDomainDeliverabilityCampaignsInput 

type ListDomainDeliverabilityCampaignsInput struct {

	// The last day that you want to obtain deliverability data for. This value has to
	// be less than or equal to 30 days after the value of the StartDate parameter.
	//
	// This member is required.
	EndDate *time.Time

	// The first day that you want to obtain deliverability data for.
	//
	// This member is required.
	StartDate *time.Time

	// The domain to obtain deliverability data for.
	//
	// This member is required.
	SubscribedDomain *string

	// A token that’s returned from a previous call to the
	// ListDomainDeliverabilityCampaigns operation. This token indicates the position
	// of a campaign in the list of campaigns.
	NextToken *string

	// The maximum number of results to include in response to a single call to the
	// ListDomainDeliverabilityCampaigns operation. If the number of results is larger
	// than the number that you specify in this parameter, the response includes a
	// NextToken element, which you can use to obtain additional results.
	PageSize *int32
	// contains filtered or unexported fields
}

Retrieve deliverability data for all the campaigns that used a specific domain to send email during a specified time range. This data is available for a domain only if you enabled the Deliverability dashboard.

type ListDomainDeliverabilityCampaignsOutput 

type ListDomainDeliverabilityCampaignsOutput struct {

	// An array of responses, one for each campaign that used the domain to send email
	// during the specified time range.
	//
	// This member is required.
	DomainDeliverabilityCampaigns []types.DomainDeliverabilityCampaign

	// A token that’s returned from a previous call to the
	// ListDomainDeliverabilityCampaigns operation. This token indicates the position
	// of the campaign in the list of campaigns.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

An array of objects that provide deliverability data for all the campaigns that used a specific domain to send email during a specified time range. This data is available for a domain only if you enabled the Deliverability dashboard for the domain.

type ListDomainDeliverabilityCampaignsPaginator added in v0.30.0 

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

ListDomainDeliverabilityCampaignsPaginator is a paginator for ListDomainDeliverabilityCampaigns

func NewListDomainDeliverabilityCampaignsPaginator added in v0.30.0 

func NewListDomainDeliverabilityCampaignsPaginator(client ListDomainDeliverabilityCampaignsAPIClient, params *ListDomainDeliverabilityCampaignsInput, optFns ...func(*ListDomainDeliverabilityCampaignsPaginatorOptions)) *ListDomainDeliverabilityCampaignsPaginator

NewListDomainDeliverabilityCampaignsPaginator returns a new ListDomainDeliverabilityCampaignsPaginator

func (*ListDomainDeliverabilityCampaignsPaginator) HasMorePages added in v0.30.0 

func (p *ListDomainDeliverabilityCampaignsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListDomainDeliverabilityCampaignsPaginator) NextPage added in v0.30.0 

func (p *ListDomainDeliverabilityCampaignsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListDomainDeliverabilityCampaignsOutput, error)

NextPage retrieves the next ListDomainDeliverabilityCampaigns page.

type ListDomainDeliverabilityCampaignsPaginatorOptions added in v0.30.0 

type ListDomainDeliverabilityCampaignsPaginatorOptions struct {
	// The maximum number of results to include in response to a single call to the
	// ListDomainDeliverabilityCampaigns operation. If the number of results is larger
	// than the number that you specify in this parameter, the response includes a
	// NextToken element, which you can use to obtain additional results.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListDomainDeliverabilityCampaignsPaginatorOptions is the paginator options for ListDomainDeliverabilityCampaigns

type ListEmailIdentitiesAPIClient added in v0.30.0 

type ListEmailIdentitiesAPIClient interface {
	ListEmailIdentities(context.Context, *ListEmailIdentitiesInput, ...func(*Options)) (*ListEmailIdentitiesOutput, error)
}

ListEmailIdentitiesAPIClient is a client that implements the ListEmailIdentities operation.

type ListEmailIdentitiesInput 

type ListEmailIdentitiesInput struct {

	// A token returned from a previous call to ListEmailIdentities to indicate the
	// position in the list of identities.
	NextToken *string

	// The number of results to show in a single call to ListEmailIdentities . If the
	// number of results is larger than the number you specified in this parameter,
	// then the response includes a NextToken element, which you can use to obtain
	// additional results. The value you specify has to be at least 0, and can be no
	// more than 1000.
	PageSize *int32
	// contains filtered or unexported fields
}

A request to list all of the email identities associated with your Amazon Web Services account. This list includes identities that you've already verified, identities that are unverified, and identities that were verified in the past, but are no longer verified.

type ListEmailIdentitiesOutput 

type ListEmailIdentitiesOutput struct {

	// An array that includes all of the email identities associated with your Amazon
	// Web Services account.
	EmailIdentities []types.IdentityInfo

	// A token that indicates that there are additional configuration sets to list. To
	// view additional configuration sets, issue another request to ListEmailIdentities
	// , and pass this token in the NextToken parameter.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

A list of all of the identities that you've attempted to verify, regardless of whether or not those identities were successfully verified.

type ListEmailIdentitiesPaginator added in v0.30.0 

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

ListEmailIdentitiesPaginator is a paginator for ListEmailIdentities

func NewListEmailIdentitiesPaginator added in v0.30.0 

func NewListEmailIdentitiesPaginator(client ListEmailIdentitiesAPIClient, params *ListEmailIdentitiesInput, optFns ...func(*ListEmailIdentitiesPaginatorOptions)) *ListEmailIdentitiesPaginator

NewListEmailIdentitiesPaginator returns a new ListEmailIdentitiesPaginator

func (*ListEmailIdentitiesPaginator) HasMorePages added in v0.30.0 

func (p *ListEmailIdentitiesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListEmailIdentitiesPaginator) NextPage added in v0.30.0 

func (p *ListEmailIdentitiesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListEmailIdentitiesOutput, error)

NextPage retrieves the next ListEmailIdentities page.

type ListEmailIdentitiesPaginatorOptions added in v0.30.0 

type ListEmailIdentitiesPaginatorOptions struct {
	// The number of results to show in a single call to ListEmailIdentities . If the
	// number of results is larger than the number you specified in this parameter,
	// then the response includes a NextToken element, which you can use to obtain
	// additional results. The value you specify has to be at least 0, and can be no
	// more than 1000.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListEmailIdentitiesPaginatorOptions is the paginator options for ListEmailIdentities

type ListEmailTemplatesAPIClient added in v0.30.0 

type ListEmailTemplatesAPIClient interface {
	ListEmailTemplates(context.Context, *ListEmailTemplatesInput, ...func(*Options)) (*ListEmailTemplatesOutput, error)
}

ListEmailTemplatesAPIClient is a client that implements the ListEmailTemplates operation.

type ListEmailTemplatesInput 

type ListEmailTemplatesInput struct {

	// A token returned from a previous call to ListEmailTemplates to indicate the
	// position in the list of email templates.
	NextToken *string

	// The number of results to show in a single call to ListEmailTemplates . If the
	// number of results is larger than the number you specified in this parameter,
	// then the response includes a NextToken element, which you can use to obtain
	// additional results. The value you specify has to be at least 1, and can be no
	// more than 100.
	PageSize *int32
	// contains filtered or unexported fields
}

Represents a request to list the email templates present in your Amazon SES account in the current Amazon Web Services Region. For more information, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-personalized-email-api.html) .

type ListEmailTemplatesOutput 

type ListEmailTemplatesOutput struct {

	// A token indicating that there are additional email templates available to be
	// listed. Pass this token to a subsequent ListEmailTemplates call to retrieve the
	// next 10 email templates.
	NextToken *string

	// An array the contains the name and creation time stamp for each template in
	// your Amazon SES account.
	TemplatesMetadata []types.EmailTemplateMetadata

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

The following elements are returned by the service.

type ListEmailTemplatesPaginator added in v0.30.0 

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

ListEmailTemplatesPaginator is a paginator for ListEmailTemplates

func NewListEmailTemplatesPaginator added in v0.30.0 

func NewListEmailTemplatesPaginator(client ListEmailTemplatesAPIClient, params *ListEmailTemplatesInput, optFns ...func(*ListEmailTemplatesPaginatorOptions)) *ListEmailTemplatesPaginator

NewListEmailTemplatesPaginator returns a new ListEmailTemplatesPaginator

func (*ListEmailTemplatesPaginator) HasMorePages added in v0.30.0 

func (p *ListEmailTemplatesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListEmailTemplatesPaginator) NextPage added in v0.30.0 

func (p *ListEmailTemplatesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListEmailTemplatesOutput, error)

NextPage retrieves the next ListEmailTemplates page.

type ListEmailTemplatesPaginatorOptions added in v0.30.0 

type ListEmailTemplatesPaginatorOptions struct {
	// The number of results to show in a single call to ListEmailTemplates . If the
	// number of results is larger than the number you specified in this parameter,
	// then the response includes a NextToken element, which you can use to obtain
	// additional results. The value you specify has to be at least 1, and can be no
	// more than 100.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListEmailTemplatesPaginatorOptions is the paginator options for ListEmailTemplates

type ListExportJobsAPIClient added in v1.20.0 

type ListExportJobsAPIClient interface {
	ListExportJobs(context.Context, *ListExportJobsInput, ...func(*Options)) (*ListExportJobsOutput, error)
}

ListExportJobsAPIClient is a client that implements the ListExportJobs operation.

type ListExportJobsInput added in v1.20.0 

type ListExportJobsInput struct {

	// A value used to list export jobs that have a certain ExportSourceType .
	ExportSourceType types.ExportSourceType

	// A value used to list export jobs that have a certain JobStatus .
	JobStatus types.JobStatus

	// The pagination token returned from a previous call to ListExportJobs to
	// indicate the position in the list of export jobs.
	NextToken *string

	// Maximum number of export jobs to return at once. Use this parameter to paginate
	// results. If additional export jobs exist beyond the specified limit, the
	// NextToken element is sent in the response. Use the NextToken value in
	// subsequent calls to ListExportJobs to retrieve additional export jobs.
	PageSize *int32
	// contains filtered or unexported fields
}

Represents a request to list all export jobs with filters.

type ListExportJobsOutput added in v1.20.0 

type ListExportJobsOutput struct {

	// A list of the export job summaries.
	ExportJobs []types.ExportJobSummary

	// A string token indicating that there might be additional export jobs available
	// to be listed. Use this token to a subsequent call to ListExportJobs with the
	// same parameters to retrieve the next page of export jobs.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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

type ListExportJobsPaginator added in v1.20.0 

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

ListExportJobsPaginator is a paginator for ListExportJobs

func NewListExportJobsPaginator added in v1.20.0 

func NewListExportJobsPaginator(client ListExportJobsAPIClient, params *ListExportJobsInput, optFns ...func(*ListExportJobsPaginatorOptions)) *ListExportJobsPaginator

NewListExportJobsPaginator returns a new ListExportJobsPaginator

func (*ListExportJobsPaginator) HasMorePages added in v1.20.0 

func (p *ListExportJobsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListExportJobsPaginator) NextPage added in v1.20.0 

func (p *ListExportJobsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListExportJobsOutput, error)

NextPage retrieves the next ListExportJobs page.

type ListExportJobsPaginatorOptions added in v1.20.0 

type ListExportJobsPaginatorOptions struct {
	// Maximum number of export jobs to return at once. Use this parameter to paginate
	// results. If additional export jobs exist beyond the specified limit, the
	// NextToken element is sent in the response. Use the NextToken value in
	// subsequent calls to ListExportJobs to retrieve additional export jobs.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListExportJobsPaginatorOptions is the paginator options for ListExportJobs

type ListImportJobsAPIClient added in v0.30.0 

type ListImportJobsAPIClient interface {
	ListImportJobs(context.Context, *ListImportJobsInput, ...func(*Options)) (*ListImportJobsOutput, error)
}

ListImportJobsAPIClient is a client that implements the ListImportJobs operation.

type ListImportJobsInput added in v0.29.0 

type ListImportJobsInput struct {

	// The destination of the import job, which can be used to list import jobs that
	// have a certain ImportDestinationType .
	ImportDestinationType types.ImportDestinationType

	// A string token indicating that there might be additional import jobs available
	// to be listed. Copy this token to a subsequent call to ListImportJobs with the
	// same parameters to retrieve the next page of import jobs.
	NextToken *string

	// Maximum number of import jobs to return at once. Use this parameter to paginate
	// results. If additional import jobs exist beyond the specified limit, the
	// NextToken element is sent in the response. Use the NextToken value in
	// subsequent requests to retrieve additional addresses.
	PageSize *int32
	// contains filtered or unexported fields
}

Represents a request to list all of the import jobs for a data destination within the specified maximum number of import jobs.

type ListImportJobsOutput added in v0.29.0 

type ListImportJobsOutput struct {

	// A list of the import job summaries.
	ImportJobs []types.ImportJobSummary

	// A string token indicating that there might be additional import jobs available
	// to be listed. Copy this token to a subsequent call to ListImportJobs with the
	// same parameters to retrieve the next page of import jobs.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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

type ListImportJobsPaginator added in v0.30.0 

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

ListImportJobsPaginator is a paginator for ListImportJobs

func NewListImportJobsPaginator added in v0.30.0 

func NewListImportJobsPaginator(client ListImportJobsAPIClient, params *ListImportJobsInput, optFns ...func(*ListImportJobsPaginatorOptions)) *ListImportJobsPaginator

NewListImportJobsPaginator returns a new ListImportJobsPaginator

func (*ListImportJobsPaginator) HasMorePages added in v0.30.0 

func (p *ListImportJobsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListImportJobsPaginator) NextPage added in v0.30.0 

func (p *ListImportJobsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListImportJobsOutput, error)

NextPage retrieves the next ListImportJobs page.

type ListImportJobsPaginatorOptions added in v0.30.0 

type ListImportJobsPaginatorOptions struct {
	// Maximum number of import jobs to return at once. Use this parameter to paginate
	// results. If additional import jobs exist beyond the specified limit, the
	// NextToken element is sent in the response. Use the NextToken value in
	// subsequent requests to retrieve additional addresses.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListImportJobsPaginatorOptions is the paginator options for ListImportJobs

type ListRecommendationsAPIClient added in v1.15.0 

type ListRecommendationsAPIClient interface {
	ListRecommendations(context.Context, *ListRecommendationsInput, ...func(*Options)) (*ListRecommendationsOutput, error)
}

ListRecommendationsAPIClient is a client that implements the ListRecommendations operation.

type ListRecommendationsInput added in v1.15.0 

type ListRecommendationsInput struct {

	// Filters applied when retrieving recommendations. Can eiter be an individual
	// filter, or combinations of STATUS and IMPACT or STATUS and TYPE
	Filter map[string]string

	// A token returned from a previous call to ListRecommendations to indicate the
	// position in the list of recommendations.
	NextToken *string

	// The number of results to show in a single call to ListRecommendations . If the
	// number of results is larger than the number you specified in this parameter,
	// then the response includes a NextToken element, which you can use to obtain
	// additional results. The value you specify has to be at least 1, and can be no
	// more than 100.
	PageSize *int32
	// contains filtered or unexported fields
}

Represents a request to list the existing recommendations for your account.

type ListRecommendationsOutput added in v1.15.0 

type ListRecommendationsOutput struct {

	// A string token indicating that there might be additional recommendations
	// available to be listed. Use the token provided in the
	// ListRecommendationsResponse to use in the subsequent call to ListRecommendations
	// with the same parameters to retrieve the next page of recommendations.
	NextToken *string

	// The recommendations applicable to your account.
	Recommendations []types.Recommendation

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Contains the response to your request to retrieve the list of recommendations for your account.

type ListRecommendationsPaginator added in v1.15.0 

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

ListRecommendationsPaginator is a paginator for ListRecommendations

func NewListRecommendationsPaginator added in v1.15.0 

func NewListRecommendationsPaginator(client ListRecommendationsAPIClient, params *ListRecommendationsInput, optFns ...func(*ListRecommendationsPaginatorOptions)) *ListRecommendationsPaginator

NewListRecommendationsPaginator returns a new ListRecommendationsPaginator

func (*ListRecommendationsPaginator) HasMorePages added in v1.15.0 

func (p *ListRecommendationsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListRecommendationsPaginator) NextPage added in v1.15.0 

func (p *ListRecommendationsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListRecommendationsOutput, error)

NextPage retrieves the next ListRecommendations page.

type ListRecommendationsPaginatorOptions added in v1.15.0 

type ListRecommendationsPaginatorOptions struct {
	// The number of results to show in a single call to ListRecommendations . If the
	// number of results is larger than the number you specified in this parameter,
	// then the response includes a NextToken element, which you can use to obtain
	// additional results. The value you specify has to be at least 1, and can be no
	// more than 100.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListRecommendationsPaginatorOptions is the paginator options for ListRecommendations

type ListSuppressedDestinationsAPIClient added in v0.30.0 

type ListSuppressedDestinationsAPIClient interface {
	ListSuppressedDestinations(context.Context, *ListSuppressedDestinationsInput, ...func(*Options)) (*ListSuppressedDestinationsOutput, error)
}

ListSuppressedDestinationsAPIClient is a client that implements the ListSuppressedDestinations operation.

type ListSuppressedDestinationsInput 

type ListSuppressedDestinationsInput struct {

	// Used to filter the list of suppressed email destinations so that it only
	// includes addresses that were added to the list before a specific date.
	EndDate *time.Time

	// A token returned from a previous call to ListSuppressedDestinations to indicate
	// the position in the list of suppressed email addresses.
	NextToken *string

	// The number of results to show in a single call to ListSuppressedDestinations .
	// If the number of results is larger than the number you specified in this
	// parameter, then the response includes a NextToken element, which you can use to
	// obtain additional results.
	PageSize *int32

	// The factors that caused the email address to be added to .
	Reasons []types.SuppressionListReason

	// Used to filter the list of suppressed email destinations so that it only
	// includes addresses that were added to the list after a specific date.
	StartDate *time.Time
	// contains filtered or unexported fields
}

A request to obtain a list of email destinations that are on the suppression list for your account.

type ListSuppressedDestinationsOutput 

type ListSuppressedDestinationsOutput struct {

	// A token that indicates that there are additional email addresses on the
	// suppression list for your account. To view additional suppressed addresses,
	// issue another request to ListSuppressedDestinations , and pass this token in the
	// NextToken parameter.
	NextToken *string

	// A list of summaries, each containing a summary for a suppressed email
	// destination.
	SuppressedDestinationSummaries []types.SuppressedDestinationSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

A list of suppressed email addresses.

type ListSuppressedDestinationsPaginator added in v0.30.0 

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

ListSuppressedDestinationsPaginator is a paginator for ListSuppressedDestinations

func NewListSuppressedDestinationsPaginator added in v0.30.0 

func NewListSuppressedDestinationsPaginator(client ListSuppressedDestinationsAPIClient, params *ListSuppressedDestinationsInput, optFns ...func(*ListSuppressedDestinationsPaginatorOptions)) *ListSuppressedDestinationsPaginator

NewListSuppressedDestinationsPaginator returns a new ListSuppressedDestinationsPaginator

func (*ListSuppressedDestinationsPaginator) HasMorePages added in v0.30.0 

func (p *ListSuppressedDestinationsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListSuppressedDestinationsPaginator) NextPage added in v0.30.0 

func (p *ListSuppressedDestinationsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListSuppressedDestinationsOutput, error)

NextPage retrieves the next ListSuppressedDestinations page.

type ListSuppressedDestinationsPaginatorOptions added in v0.30.0 

type ListSuppressedDestinationsPaginatorOptions struct {
	// The number of results to show in a single call to ListSuppressedDestinations .
	// If the number of results is larger than the number you specified in this
	// parameter, then the response includes a NextToken element, which you can use to
	// obtain additional results.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListSuppressedDestinationsPaginatorOptions is the paginator options for ListSuppressedDestinations

type ListTagsForResourceInput 

type ListTagsForResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource that you want to retrieve tag
	// information for.
	//
	// This member is required.
	ResourceArn *string
	// contains filtered or unexported fields
}

type ListTagsForResourceOutput 

type ListTagsForResourceOutput struct {

	// An array that lists all the tags that are associated with the resource. Each
	// tag consists of a required tag key ( Key ) and an associated tag value ( Value )
	//
	// This member is required.
	Tags []types.Tag

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type Options 

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

	// The optional application specific identifier appended to the User-Agent header.
	AppID string

	// This endpoint will be given as input to an EndpointResolverV2. It is used for
	// providing a custom base endpoint that is subject to modifications by the
	// processing EndpointResolverV2.
	BaseEndpoint *string

	// Configures the events that will be sent to the configured logger.
	ClientLogMode aws.ClientLogMode

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

	// The configuration DefaultsMode that the SDK should use when constructing the
	// clients initial default settings.
	DefaultsMode aws.DefaultsMode

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

	// The service endpoint resolver.
	//
	// Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a
	// value for this field will likely prevent you from using any endpoint-related
	// service features released after the introduction of EndpointResolverV2 and
	// BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom
	// endpoint, set the client option BaseEndpoint instead.
	EndpointResolver EndpointResolver

	// Resolves the endpoint used for a particular service operation. This should be
	// used over the deprecated EndpointResolver.
	EndpointResolverV2 EndpointResolverV2

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

	// The logger writer interface to write logging messages to.
	Logger logging.Logger

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

	// RetryMaxAttempts specifies the maximum number attempts an API client will call
	// an operation that fails with a retryable error. A value of 0 is ignored, and
	// will not be used to configure the API client created default retryer, or modify
	// per operation call's retry max attempts. If specified in an operation call's
	// functional options with a value that is different than the constructed client's
	// Options, the Client's Retryer will be wrapped to use the operation's specific
	// RetryMaxAttempts value.
	RetryMaxAttempts int

	// RetryMode specifies the retry mode the API client will be created with, if
	// Retryer option is not also specified. When creating a new API Clients this
	// member will only be used if the Retryer Options member is nil. This value will
	// be ignored if Retryer is not nil. Currently does not support per operation call
	// overrides, may in the future.
	RetryMode aws.RetryMode

	// Retryer guides how HTTP requests should be retried in case of recoverable
	// failures. When nil the API client will use a default retryer. The kind of
	// default retry created by the API client can be changed with the RetryMode
	// option.
	Retryer aws.Retryer

	// The RuntimeEnvironment configuration, only populated if the DefaultsMode is set
	// to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You
	// should not populate this structure programmatically, or rely on the values here
	// within your applications.
	RuntimeEnvironment aws.RuntimeEnvironment

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

	// The auth scheme resolver which determines how to authenticate for each
	// operation.
	AuthSchemeResolver AuthSchemeResolver

	// The list of auth schemes supported by the client.
	AuthSchemes []smithyhttp.AuthScheme
	// contains filtered or unexported fields
}

func (Options) Copy 

func (o Options) Copy() Options

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

func (Options) GetIdentityResolver added in v1.23.2 

func (o Options) GetIdentityResolver(schemeID string) smithyauth.IdentityResolver

type PutAccountDedicatedIpWarmupAttributesInput 

type PutAccountDedicatedIpWarmupAttributesInput struct {

	// Enables or disables the automatic warm-up feature for dedicated IP addresses
	// that are associated with your Amazon SES account in the current Amazon Web
	// Services Region. Set to true to enable the automatic warm-up feature, or set to
	// false to disable it.
	AutoWarmupEnabled bool
	// contains filtered or unexported fields
}

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

type PutAccountDedicatedIpWarmupAttributesOutput 

type PutAccountDedicatedIpWarmupAttributesOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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

type PutAccountDetailsInput 

type PutAccountDetailsInput struct {

	// The type of email your account will send.
	//
	// This member is required.
	MailType types.MailType

	// A description of the types of email that you plan to send.
	//
	// This member is required.
	UseCaseDescription *string

	// The URL of your website. This information helps us better understand the type
	// of content that you plan to send.
	//
	// This member is required.
	WebsiteURL *string

	// Additional email addresses that you would like to be notified regarding Amazon
	// SES matters.
	AdditionalContactEmailAddresses []string

	// The language you would prefer to be contacted with.
	ContactLanguage types.ContactLanguage

	// Indicates whether or not your account should have production access in the
	// current Amazon Web Services Region. If the value is false , then your account is
	// in the sandbox. When your account is in the sandbox, you can only send email to
	// verified identities. If the value is true , then your account has production
	// access. When your account has production access, you can send email to any
	// address. The sending quota and maximum sending rate for your account vary based
	// on your specific use case.
	ProductionAccessEnabled *bool
	// contains filtered or unexported fields
}

A request to submit new account details.

type PutAccountDetailsOutput 

type PutAccountDetailsOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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

type PutAccountSendingAttributesInput 

type PutAccountSendingAttributesInput struct {

	// Enables or disables your account's ability to send email. Set to true to enable
	// email sending, or set to false to disable email sending. If Amazon Web Services
	// paused your account's ability to send email, you can't use this operation to
	// resume your account's ability to send email.
	SendingEnabled bool
	// contains filtered or unexported fields
}

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

type PutAccountSendingAttributesOutput 

type PutAccountSendingAttributesOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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

type PutAccountSuppressionAttributesInput 

type PutAccountSuppressionAttributesInput struct {

	// A list that contains the reasons that email addresses will be automatically
	// added to the suppression list for your account. This list can contain any or all
	// of the following:
	//   - COMPLAINT – Amazon SES adds an email address to the suppression list for
	//   your account when a message sent to that address results in a complaint.
	//   - BOUNCE – Amazon SES adds an email address to the suppression list for your
	//   account when a message sent to that address results in a hard bounce.
	SuppressedReasons []types.SuppressionListReason
	// contains filtered or unexported fields
}

A request to change your account's suppression preferences.

type PutAccountSuppressionAttributesOutput 

type PutAccountSuppressionAttributesOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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

type PutAccountVdmAttributesInput added in v1.15.0 

type PutAccountVdmAttributesInput struct {

	// The VDM attributes that you wish to apply to your Amazon SES account.
	//
	// This member is required.
	VdmAttributes *types.VdmAttributes
	// contains filtered or unexported fields
}

A request to submit new account VDM attributes.

type PutAccountVdmAttributesOutput added in v1.15.0 

type PutAccountVdmAttributesOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type PutConfigurationSetDeliveryOptionsInput 

type PutConfigurationSetDeliveryOptionsInput struct {

	// The name of the configuration set to associate with a dedicated IP pool.
	//
	// This member is required.
	ConfigurationSetName *string

	// The name of the dedicated IP pool to associate with the configuration set.
	SendingPoolName *string

	// Specifies whether messages that use the configuration set are required to use
	// Transport Layer Security (TLS). If the value is Require , messages are only
	// delivered if a TLS connection can be established. If the value is Optional ,
	// messages can be delivered in plain text if a TLS connection can't be
	// established.
	TlsPolicy types.TlsPolicy
	// contains filtered or unexported fields
}

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

type PutConfigurationSetDeliveryOptionsOutput 

type PutConfigurationSetDeliveryOptionsOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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

type PutConfigurationSetReputationOptionsInput 

type PutConfigurationSetReputationOptionsInput struct {

	// The name of the configuration set.
	//
	// This member is required.
	ConfigurationSetName *string

	// If true , tracking of reputation metrics is enabled for the configuration set.
	// If false , tracking of reputation metrics is disabled for the configuration set.
	ReputationMetricsEnabled bool
	// contains filtered or unexported fields
}

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

type PutConfigurationSetReputationOptionsOutput 

type PutConfigurationSetReputationOptionsOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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

type PutConfigurationSetSendingOptionsInput 

type PutConfigurationSetSendingOptionsInput struct {

	// The name of the configuration set to enable or disable email sending for.
	//
	// This member is required.
	ConfigurationSetName *string

	// If true , email sending is enabled for the configuration set. If false , email
	// sending is disabled for the configuration set.
	SendingEnabled bool
	// contains filtered or unexported fields
}

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

type PutConfigurationSetSendingOptionsOutput 

type PutConfigurationSetSendingOptionsOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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

type PutConfigurationSetSuppressionOptionsInput 

type PutConfigurationSetSuppressionOptionsInput struct {

	// The name of the configuration set to change the suppression list preferences
	// for.
	//
	// This member is required.
	ConfigurationSetName *string

	// A list that contains the reasons that email addresses are automatically added
	// to the suppression list for your account. This list can contain any or all of
	// the following:
	//   - COMPLAINT – Amazon SES adds an email address to the suppression list for
	//   your account when a message sent to that address results in a complaint.
	//   - BOUNCE – Amazon SES adds an email address to the suppression list for your
	//   account when a message sent to that address results in a hard bounce.
	SuppressedReasons []types.SuppressionListReason
	// contains filtered or unexported fields
}

A request to change the account suppression list preferences for a specific configuration set.

type PutConfigurationSetSuppressionOptionsOutput 

type PutConfigurationSetSuppressionOptionsOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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

type PutConfigurationSetTrackingOptionsInput 

type PutConfigurationSetTrackingOptionsInput struct {

	// The name of the configuration set.
	//
	// This member is required.
	ConfigurationSetName *string

	// The domain to use to track open and click events.
	CustomRedirectDomain *string
	// contains filtered or unexported fields
}

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

type PutConfigurationSetTrackingOptionsOutput 

type PutConfigurationSetTrackingOptionsOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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

type PutConfigurationSetVdmOptionsInput added in v1.15.0 

type PutConfigurationSetVdmOptionsInput struct {

	// The name of the configuration set.
	//
	// This member is required.
	ConfigurationSetName *string

	// The VDM options to apply to the configuration set.
	VdmOptions *types.VdmOptions
	// contains filtered or unexported fields
}

A request to add specific VDM settings to a configuration set.

type PutConfigurationSetVdmOptionsOutput added in v1.15.0 

type PutConfigurationSetVdmOptionsOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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

type PutDedicatedIpInPoolInput 

type PutDedicatedIpInPoolInput struct {

	// The name of the IP pool that you want to add the dedicated IP address to. You
	// have to specify an IP pool that already exists.
	//
	// This member is required.
	DestinationPoolName *string

	// The IP address that you want to move to the dedicated IP pool. The value you
	// specify has to be a dedicated IP address that's associated with your Amazon Web
	// Services account.
	//
	// This member is required.
	Ip *string
	// contains filtered or unexported fields
}

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

type PutDedicatedIpInPoolOutput 

type PutDedicatedIpInPoolOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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

type PutDedicatedIpPoolScalingAttributesInput added in v1.18.0 

type PutDedicatedIpPoolScalingAttributesInput struct {

	// The name of the dedicated IP pool.
	//
	// This member is required.
	PoolName *string

	// The scaling mode to apply to the dedicated IP pool. Changing the scaling mode
	// from MANAGED to STANDARD is not supported.
	//
	// This member is required.
	ScalingMode types.ScalingMode
	// contains filtered or unexported fields
}

A request to convert a dedicated IP pool to a different scaling mode.

type PutDedicatedIpPoolScalingAttributesOutput added in v1.18.0 

type PutDedicatedIpPoolScalingAttributesOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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

type PutDedicatedIpWarmupAttributesInput 

type PutDedicatedIpWarmupAttributesInput struct {

	// The dedicated IP address that you want to update the warm-up attributes for.
	//
	// This member is required.
	Ip *string

	// The warm-up percentage that you want to associate with the dedicated IP address.
	//
	// This member is required.
	WarmupPercentage *int32
	// contains filtered or unexported fields
}

A request to change the warm-up attributes for a dedicated IP address. This operation is useful when you want to resume the warm-up process for an existing IP address.

type PutDedicatedIpWarmupAttributesOutput 

type PutDedicatedIpWarmupAttributesOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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

type PutDeliverabilityDashboardOptionInput 

type PutDeliverabilityDashboardOptionInput struct {

	// Specifies whether to enable the Deliverability dashboard. To enable the
	// dashboard, set this value to true .
	//
	// This member is required.
	DashboardEnabled bool

	// An array of objects, one for each verified domain that you use to send email
	// and enabled the Deliverability dashboard for.
	SubscribedDomains []types.DomainDeliverabilityTrackingOption
	// contains filtered or unexported fields
}

Enable or disable the Deliverability dashboard. When you enable the Deliverability dashboard, you gain access to reputation, deliverability, and other metrics for the domains that you use to send email using Amazon SES API v2. You also gain the ability to perform predictive inbox placement tests. When you use the Deliverability dashboard, you pay a monthly subscription charge, in addition to any other fees that you accrue by using Amazon SES and other Amazon Web Services services. For more information about the features and cost of a Deliverability dashboard subscription, see Amazon Pinpoint Pricing (http://aws.amazon.com/pinpoint/pricing/) .

type PutDeliverabilityDashboardOptionOutput 

type PutDeliverabilityDashboardOptionOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

A response that indicates whether the Deliverability dashboard is enabled.

type PutEmailIdentityConfigurationSetAttributesInput added in v1.2.0 

type PutEmailIdentityConfigurationSetAttributesInput struct {

	// The email address or domain to associate with a configuration set.
	//
	// This member is required.
	EmailIdentity *string

	// The configuration set to associate with an email identity.
	ConfigurationSetName *string
	// contains filtered or unexported fields
}

A request to associate a configuration set with an email identity.

type PutEmailIdentityConfigurationSetAttributesOutput added in v1.2.0 

type PutEmailIdentityConfigurationSetAttributesOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

type PutEmailIdentityDkimAttributesInput 

type PutEmailIdentityDkimAttributesInput struct {

	// The email identity.
	//
	// This member is required.
	EmailIdentity *string

	// Sets the DKIM signing configuration for the identity. When you set this value
	// true , then the messages that are sent from the identity are signed using DKIM.
	// If you set this value to false , your messages are sent without DKIM signing.
	SigningEnabled bool
	// contains filtered or unexported fields
}

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

type PutEmailIdentityDkimAttributesOutput 

type PutEmailIdentityDkimAttributesOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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

type PutEmailIdentityDkimSigningAttributesInput 

type PutEmailIdentityDkimSigningAttributesInput struct {

	// The email identity.
	//
	// This member is required.
	EmailIdentity *string

	// The method to use to configure DKIM for the identity. There are the following
	// possible values:
	//   - AWS_SES – Configure DKIM for the identity by using Easy DKIM (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html)
	//   .
	//   - EXTERNAL – Configure DKIM for the identity by using Bring Your Own DKIM
	//   (BYODKIM).
	//
	// This member is required.
	SigningAttributesOrigin types.DkimSigningAttributesOrigin

	// An object that contains information about the private key and selector that you
	// want to use to configure DKIM for the identity for Bring Your Own DKIM (BYODKIM)
	// for the identity, or, configures the key length to be used for Easy DKIM (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html)
	// .
	SigningAttributes *types.DkimSigningAttributes
	// contains filtered or unexported fields
}

A request to change the DKIM attributes for an email identity.

type PutEmailIdentityDkimSigningAttributesOutput 

type PutEmailIdentityDkimSigningAttributesOutput struct {

	// The DKIM authentication status of the identity. Amazon SES determines the
	// authentication status by searching for specific records in the DNS configuration
	// for your domain. If you used Easy DKIM (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html)
	// to set up DKIM authentication, Amazon SES tries to find three unique CNAME
	// records in the DNS configuration for your domain. If you provided a public key
	// to perform DKIM authentication, Amazon SES tries to find a TXT record that uses
	// the selector that you specified. The value of the TXT record must be a public
	// key that's paired with the private key that you specified in the process of
	// creating the identity. The status can be one of the following:
	//   - PENDING – The verification process was initiated, but Amazon SES hasn't yet
	//   detected the DKIM records in the DNS configuration for the domain.
	//   - SUCCESS – The verification process completed successfully.
	//   - FAILED – The verification process failed. This typically occurs when Amazon
	//   SES fails to find the DKIM records in the DNS configuration of the domain.
	//   - TEMPORARY_FAILURE – A temporary issue is preventing Amazon SES from
	//   determining the DKIM authentication status of the domain.
	//   - NOT_STARTED – The DKIM verification process hasn't been initiated for the
	//   domain.
	DkimStatus types.DkimStatus

	// If you used Easy DKIM (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html)
	// to configure DKIM authentication for the domain, then this object contains a set
	// of unique strings that you use to create a set of CNAME records that you add to
	// the DNS configuration for your domain. When Amazon SES detects these records in
	// the DNS configuration for your domain, the DKIM authentication process is
	// complete. If you configured DKIM authentication for the domain by providing your
	// own public-private key pair, then this object contains the selector that's
	// associated with your public key. Regardless of the DKIM authentication method
	// you use, Amazon SES searches for the appropriate records in the DNS
	// configuration of the domain for up to 72 hours.
	DkimTokens []string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service.

type PutEmailIdentityFeedbackAttributesInput 

type PutEmailIdentityFeedbackAttributesInput struct {

	// The email identity.
	//
	// This member is required.
	EmailIdentity *string

	// Sets the feedback forwarding configuration for the identity. If the value is
	// true , you receive email notifications when bounce or complaint events occur.
	// These notifications are sent to the address that you specified in the
	// Return-Path header of the original email. 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 (for example, by setting up an event
	// destination), you receive an email notification when these events occur (even if
	// this setting is disabled).
	EmailForwardingEnabled bool
	// contains filtered or unexported fields
}

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

type PutEmailIdentityFeedbackAttributesOutput 

type PutEmailIdentityFeedbackAttributesOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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

type PutEmailIdentityMailFromAttributesInput 

type PutEmailIdentityMailFromAttributesInput struct {

	// The verified email identity.
	//
	// This member is required.
	EmailIdentity *string

	// The action to take if the required MX record isn't found when you send an
	// email. When you set this value to UseDefaultValue , the mail is sent using
	// amazonses.com as the MAIL FROM domain. When you set this value to RejectMessage
	// , the Amazon SES API v2 returns a MailFromDomainNotVerified error, and doesn't
	// attempt to deliver the email. These behaviors are taken when the custom MAIL
	// FROM domain configuration is in the Pending , Failed , and TemporaryFailure
	// states.
	BehaviorOnMxFailure types.BehaviorOnMxFailure

	// The custom MAIL FROM domain that you want the verified identity to use. The
	// MAIL FROM domain must meet the following criteria:
	//   - It has to be a subdomain of the verified identity.
	//   - It can't be used to receive email.
	//   - It can't be used in a "From" address if the MAIL FROM domain is a
	//   destination for feedback forwarding emails.
	MailFromDomain *string
	// contains filtered or unexported fields
}

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

type PutEmailIdentityMailFromAttributesOutput 

type PutEmailIdentityMailFromAttributesOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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

type PutSuppressedDestinationInput 

type PutSuppressedDestinationInput struct {

	// The email address that should be added to the suppression list for your account.
	//
	// This member is required.
	EmailAddress *string

	// The factors that should cause the email address to be added to the suppression
	// list for your account.
	//
	// This member is required.
	Reason types.SuppressionListReason
	// contains filtered or unexported fields
}

A request to add an email destination to the suppression list for your account.

type PutSuppressedDestinationOutput 

type PutSuppressedDestinationOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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

type ResolveEndpoint 

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  EndpointResolverOptions
}

func (*ResolveEndpoint) HandleSerialize 

func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) (
	out middleware.SerializeOutput, metadata middleware.Metadata, err error,
)

func (*ResolveEndpoint) ID 

func (*ResolveEndpoint) ID() string

type SendBulkEmailInput 

type SendBulkEmailInput struct {

	// The list of bulk email entry objects.
	//
	// This member is required.
	BulkEmailEntries []types.BulkEmailEntry

	// An object that contains the body of the message. You can specify a template
	// message.
	//
	// This member is required.
	DefaultContent *types.BulkEmailContent

	// The name of the configuration set to use when sending the email.
	ConfigurationSetName *string

	// A list of tags, in the form of name/value pairs, to apply to an email that you
	// send using the SendEmail operation. Tags correspond to characteristics of the
	// email that you define, so that you can publish email sending events.
	DefaultEmailTags []types.MessageTag

	// The address that you want bounce and complaint notifications to be sent to.
	FeedbackForwardingEmailAddress *string

	// This parameter is used only for sending authorization. It is the ARN of the
	// identity that is associated with the sending authorization policy that permits
	// you to use the email address specified in the FeedbackForwardingEmailAddress
	// parameter. For example, if the owner of example.com (which has ARN
	// arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it
	// that authorizes you to use feedback@example.com, then you would specify the
	// FeedbackForwardingEmailAddressIdentityArn to be
	// arn:aws:ses:us-east-1:123456789012:identity/example.com, and the
	// FeedbackForwardingEmailAddress to be feedback@example.com. For more information
	// about sending authorization, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html)
	// .
	FeedbackForwardingEmailAddressIdentityArn *string

	// The email address to use as the "From" address for the email. The address that
	// you specify has to be verified.
	FromEmailAddress *string

	// This parameter is used only for sending authorization. It is the ARN of the
	// identity that is associated with the sending authorization policy that permits
	// you to use the email address specified in the FromEmailAddress parameter. For
	// example, if the owner of example.com (which has ARN
	// arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it
	// that authorizes you to use sender@example.com, then you would specify the
	// FromEmailAddressIdentityArn to be
	// arn:aws:ses:us-east-1:123456789012:identity/example.com, and the
	// FromEmailAddress to be sender@example.com. For more information about sending
	// authorization, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html)
	// .
	FromEmailAddressIdentityArn *string

	// The "Reply-to" email addresses for the message. When the recipient replies to
	// the message, each Reply-to address receives the reply.
	ReplyToAddresses []string
	// contains filtered or unexported fields
}

Represents a request to send email messages to multiple destinations using Amazon SES. For more information, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-personalized-email-api.html) .

type SendBulkEmailOutput 

type SendBulkEmailOutput struct {

	// One object per intended recipient. Check each response object and retry any
	// messages with a failure status.
	//
	// This member is required.
	BulkEmailEntryResults []types.BulkEmailEntryResult

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

The following data is returned in JSON format by the service.

type SendCustomVerificationEmailInput 

type SendCustomVerificationEmailInput struct {

	// The email address to verify.
	//
	// This member is required.
	EmailAddress *string

	// The name of the custom verification email template to use when sending the
	// verification email.
	//
	// This member is required.
	TemplateName *string

	// Name of a configuration set to use when sending the verification email.
	ConfigurationSetName *string
	// contains filtered or unexported fields
}

Represents a request to send a custom verification email to a specified recipient.

type SendCustomVerificationEmailOutput 

type SendCustomVerificationEmailOutput struct {

	// The unique message identifier returned from the SendCustomVerificationEmail
	// operation.
	MessageId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

The following element is returned by the service.

type SendEmailInput 

type SendEmailInput struct {

	// An object that contains the body of the message. You can send either a Simple
	// message, Raw message, or a Templated message.
	//
	// This member is required.
	Content *types.EmailContent

	// The name of the configuration set to use when sending the email.
	ConfigurationSetName *string

	// An object that contains the recipients of the email message.
	Destination *types.Destination

	// A list of tags, in the form of name/value pairs, to apply to an email that you
	// send using the SendEmail operation. Tags correspond to characteristics of the
	// email that you define, so that you can publish email sending events.
	EmailTags []types.MessageTag

	// The address that you want bounce and complaint notifications to be sent to.
	FeedbackForwardingEmailAddress *string

	// This parameter is used only for sending authorization. It is the ARN of the
	// identity that is associated with the sending authorization policy that permits
	// you to use the email address specified in the FeedbackForwardingEmailAddress
	// parameter. For example, if the owner of example.com (which has ARN
	// arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it
	// that authorizes you to use feedback@example.com, then you would specify the
	// FeedbackForwardingEmailAddressIdentityArn to be
	// arn:aws:ses:us-east-1:123456789012:identity/example.com, and the
	// FeedbackForwardingEmailAddress to be feedback@example.com. For more information
	// about sending authorization, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html)
	// .
	FeedbackForwardingEmailAddressIdentityArn *string

	// The email address to use as the "From" address for the email. The address that
	// you specify has to be verified.
	FromEmailAddress *string

	// This parameter is used only for sending authorization. It is the ARN of the
	// identity that is associated with the sending authorization policy that permits
	// you to use the email address specified in the FromEmailAddress parameter. For
	// example, if the owner of example.com (which has ARN
	// arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it
	// that authorizes you to use sender@example.com, then you would specify the
	// FromEmailAddressIdentityArn to be
	// arn:aws:ses:us-east-1:123456789012:identity/example.com, and the
	// FromEmailAddress to be sender@example.com. For more information about sending
	// authorization, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html)
	// . For Raw emails, the FromEmailAddressIdentityArn value overrides the
	// X-SES-SOURCE-ARN and X-SES-FROM-ARN headers specified in raw email message
	// content.
	FromEmailAddressIdentityArn *string

	// An object used to specify a list or topic to which an email belongs, which will
	// be used when a contact chooses to unsubscribe.
	ListManagementOptions *types.ListManagementOptions

	// The "Reply-to" email addresses for the message. When the recipient replies to
	// the message, each Reply-to address receives the reply.
	ReplyToAddresses []string
	// contains filtered or unexported fields
}

Represents a request to send a single formatted email using Amazon SES. For more information, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-email-formatted.html) .

type SendEmailOutput 

type SendEmailOutput struct {

	// A unique identifier for the message that is generated when the message is
	// accepted. It's possible for Amazon SES to accept a message without sending it.
	// For example, this can happen when the message that you're trying to send has an
	// attachment that contains a virus, or when you send a templated email that
	// contains invalid personalization content.
	MessageId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

A unique message ID that you receive when an email is accepted for sending.

type TagResourceInput 

type TagResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource that you want to add one or more
	// tags to.
	//
	// This member is required.
	ResourceArn *string

	// A list of the tags that you want to add to the resource. A tag consists of a
	// required tag key ( Key ) and an associated tag value ( Value ). The maximum
	// length of a tag key is 128 characters. The maximum length of a tag value is 256
	// characters.
	//
	// This member is required.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type TagResourceOutput 

type TagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type TestRenderEmailTemplateInput 

type TestRenderEmailTemplateInput struct {

	// A list of replacement values to apply to the template. This parameter is a JSON
	// object, typically consisting of key-value pairs in which the keys correspond to
	// replacement tags in the email template.
	//
	// This member is required.
	TemplateData *string

	// The name of the template.
	//
	// This member is required.
	TemplateName *string
	// contains filtered or unexported fields
}

>Represents a request to create a preview of the MIME content of an email when provided with a template and a set of replacement data.

type TestRenderEmailTemplateOutput 

type TestRenderEmailTemplateOutput struct {

	// The complete MIME message rendered by applying the data in the TemplateData
	// parameter to the template specified in the TemplateName parameter.
	//
	// This member is required.
	RenderedTemplate *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

The following element is returned by the service.

type UntagResourceInput 

type UntagResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource that you want to remove one or
	// more tags from.
	//
	// This member is required.
	ResourceArn *string

	// The tags (tag keys) that you want to remove from the resource. When you specify
	// a tag key, the action removes both that key and its associated tag value. To
	// remove more than one tag from the resource, append the TagKeys parameter and
	// argument for each additional tag to remove, separated by an ampersand. For
	// example: /v2/email/tags?ResourceArn=ResourceArn&TagKeys=Key1&TagKeys=Key2
	//
	// This member is required.
	TagKeys []string
	// contains filtered or unexported fields
}

type UntagResourceOutput 

type UntagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateConfigurationSetEventDestinationInput 

type UpdateConfigurationSetEventDestinationInput struct {

	// The name of the configuration set that contains the event destination to modify.
	//
	// This member is required.
	ConfigurationSetName *string

	// An object that defines the event destination.
	//
	// This member is required.
	EventDestination *types.EventDestinationDefinition

	// The name of the event destination.
	//
	// This member is required.
	EventDestinationName *string
	// contains filtered or unexported fields
}

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

type UpdateConfigurationSetEventDestinationOutput 

type UpdateConfigurationSetEventDestinationOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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

type UpdateContactInput added in v0.29.0 

type UpdateContactInput struct {

	// The name of the contact list.
	//
	// This member is required.
	ContactListName *string

	// The contact's email address.
	//
	// This member is required.
	EmailAddress *string

	// The attribute data attached to a contact.
	AttributesData *string

	// The contact's preference for being opted-in to or opted-out of a topic.
	TopicPreferences []types.TopicPreference

	// A boolean value status noting if the contact is unsubscribed from all contact
	// list topics.
	UnsubscribeAll bool
	// contains filtered or unexported fields
}

type UpdateContactListInput added in v0.29.0 

type UpdateContactListInput struct {

	// The name of the contact list.
	//
	// This member is required.
	ContactListName *string

	// A description of what the contact list is about.
	Description *string

	// An interest group, theme, or label within a list. A contact list can have
	// multiple topics.
	Topics []types.Topic
	// contains filtered or unexported fields
}

type UpdateContactListOutput added in v0.29.0 

type UpdateContactListOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateContactOutput added in v0.29.0 

type UpdateContactOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateCustomVerificationEmailTemplateInput 

type UpdateCustomVerificationEmailTemplateInput struct {

	// The URL that the recipient of the verification email is sent to if his or her
	// address is not successfully verified.
	//
	// This member is required.
	FailureRedirectionURL *string

	// The email address that the custom verification email is sent from.
	//
	// This member is required.
	FromEmailAddress *string

	// The URL that the recipient of the verification email is sent to if his or her
	// address is successfully verified.
	//
	// This member is required.
	SuccessRedirectionURL *string

	// The content of the custom verification email. The total size of the email must
	// be less than 10 MB. The message body may contain HTML, with some limitations.
	// For more information, see Custom verification email frequently asked questions (https://docs.aws.amazon.com/ses/latest/dg/creating-identities.html#send-email-verify-address-custom-faq)
	// in the Amazon SES Developer Guide.
	//
	// This member is required.
	TemplateContent *string

	// The name of the custom verification email template that you want to update.
	//
	// This member is required.
	TemplateName *string

	// The subject line of the custom verification email.
	//
	// This member is required.
	TemplateSubject *string
	// contains filtered or unexported fields
}

Represents a request to update an existing custom verification email template.

type UpdateCustomVerificationEmailTemplateOutput 

type UpdateCustomVerificationEmailTemplateOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

type UpdateEmailIdentityPolicyInput 

type UpdateEmailIdentityPolicyInput struct {

	// The email identity.
	//
	// This member is required.
	EmailIdentity *string

	// The text of the policy in JSON format. The policy cannot exceed 4 KB. For
	// information about the syntax of sending authorization policies, see the Amazon
	// SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization-policies.html)
	// .
	//
	// This member is required.
	Policy *string

	// The name of the policy. The policy name cannot exceed 64 characters and can
	// only include alphanumeric characters, dashes, and underscores.
	//
	// This member is required.
	PolicyName *string
	// contains filtered or unexported fields
}

Represents a request to update a sending authorization policy for an identity. Sending authorization is an Amazon SES feature that enables you to authorize other senders to use your identities. For information, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization-identity-owner-tasks-management.html) .

type UpdateEmailIdentityPolicyOutput 

type UpdateEmailIdentityPolicyOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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

type UpdateEmailTemplateInput 

type UpdateEmailTemplateInput struct {

	// The content of the email template, composed of a subject line, an HTML part,
	// and a text-only part.
	//
	// This member is required.
	TemplateContent *types.EmailTemplateContent

	// The name of the template.
	//
	// This member is required.
	TemplateName *string
	// contains filtered or unexported fields
}

Represents a request to update an email template. For more information, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-personalized-email-api.html) .

type UpdateEmailTemplateOutput 

type UpdateEmailTemplateOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Source Files

View all Source files

Directories

Path Synopsis
internal
endpoints

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.