mailmanager

package module
v1.8.3 Latest Latest
Warning

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

 Go to latest Published: Feb 5, 2025 License: Apache-2.0 Imports: 46 Imported by: 3

Documentation

Overview

Package mailmanager provides the API client, operations, and parameter types for MailManager.

Amazon SES Mail Manager API

The Amazon SES Mail Manager API contains operations and data types that comprise the Mail Manager feature of Amazon Simple Email Service (SES).

Mail Manager is a set of Amazon SES email gateway features designed to help you strengthen your organization's email infrastructure, simplify email workflow management, and streamline email compliance control. To learn more, see the Mail Manager chapterin the Amazon SES Developer Guide.

Index

Constants

View Source 
const ServiceAPIVersion = "2023-10-17"
View Source 
const ServiceID = "MailManager"

Variables

This section is empty.

Functions

func NewDefaultEndpointResolver 

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

func WithAPIOptions 

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 

func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)

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

func WithSigV4SigningName 

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 

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 

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 

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

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

type Client 

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

Client provides the API client to make operations call for MailManager.

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

func (c *Client) CreateAddonInstance(ctx context.Context, params *CreateAddonInstanceInput, optFns ...func(*Options)) (*CreateAddonInstanceOutput, error)

Creates an Add On instance for the subscription indicated in the request. The resulting Amazon Resource Name (ARN) can be used in a conditional statement for a rule set or traffic policy.

func (*Client) CreateAddonSubscription 

func (c *Client) CreateAddonSubscription(ctx context.Context, params *CreateAddonSubscriptionInput, optFns ...func(*Options)) (*CreateAddonSubscriptionOutput, error)

Creates a subscription for an Add On representing the acceptance of its terms of use and additional pricing. The subscription can then be used to create an instance for use in rule sets or traffic policies.

func (*Client) CreateAddressList added in v1.8.0 

func (c *Client) CreateAddressList(ctx context.Context, params *CreateAddressListInput, optFns ...func(*Options)) (*CreateAddressListOutput, error)

Creates a new address list.

func (*Client) CreateAddressListImportJob added in v1.8.0 

func (c *Client) CreateAddressListImportJob(ctx context.Context, params *CreateAddressListImportJobInput, optFns ...func(*Options)) (*CreateAddressListImportJobOutput, error)

Creates an import job for an address list.

func (*Client) CreateArchive 

func (c *Client) CreateArchive(ctx context.Context, params *CreateArchiveInput, optFns ...func(*Options)) (*CreateArchiveOutput, error)

Creates a new email archive resource for storing and retaining emails.

func (*Client) CreateIngressPoint 

func (c *Client) CreateIngressPoint(ctx context.Context, params *CreateIngressPointInput, optFns ...func(*Options)) (*CreateIngressPointOutput, error)

Provision a new ingress endpoint resource.

func (*Client) CreateRelay 

func (c *Client) CreateRelay(ctx context.Context, params *CreateRelayInput, optFns ...func(*Options)) (*CreateRelayOutput, error)

Creates a relay resource which can be used in rules to relay incoming emails to defined relay destinations.

func (*Client) CreateRuleSet 

func (c *Client) CreateRuleSet(ctx context.Context, params *CreateRuleSetInput, optFns ...func(*Options)) (*CreateRuleSetOutput, error)

Provision a new rule set.

func (*Client) CreateTrafficPolicy 

func (c *Client) CreateTrafficPolicy(ctx context.Context, params *CreateTrafficPolicyInput, optFns ...func(*Options)) (*CreateTrafficPolicyOutput, error)

Provision a new traffic policy resource.

func (*Client) DeleteAddonInstance 

func (c *Client) DeleteAddonInstance(ctx context.Context, params *DeleteAddonInstanceInput, optFns ...func(*Options)) (*DeleteAddonInstanceOutput, error)

Deletes an Add On instance.

func (*Client) DeleteAddonSubscription 

func (c *Client) DeleteAddonSubscription(ctx context.Context, params *DeleteAddonSubscriptionInput, optFns ...func(*Options)) (*DeleteAddonSubscriptionOutput, error)

Deletes an Add On subscription.

func (*Client) DeleteAddressList added in v1.8.0 

func (c *Client) DeleteAddressList(ctx context.Context, params *DeleteAddressListInput, optFns ...func(*Options)) (*DeleteAddressListOutput, error)

Deletes an address list.

func (*Client) DeleteArchive 

func (c *Client) DeleteArchive(ctx context.Context, params *DeleteArchiveInput, optFns ...func(*Options)) (*DeleteArchiveOutput, error)

Initiates deletion of an email archive. This changes the archive state to pending deletion. In this state, no new emails can be added, and existing archived emails become inaccessible (search, export, download). The archive and all of its contents will be permanently deleted 30 days after entering the pending deletion state, regardless of the configured retention period.

func (*Client) DeleteIngressPoint 

func (c *Client) DeleteIngressPoint(ctx context.Context, params *DeleteIngressPointInput, optFns ...func(*Options)) (*DeleteIngressPointOutput, error)

Delete an ingress endpoint resource.

func (*Client) DeleteRelay 

func (c *Client) DeleteRelay(ctx context.Context, params *DeleteRelayInput, optFns ...func(*Options)) (*DeleteRelayOutput, error)

Deletes an existing relay resource.

func (*Client) DeleteRuleSet 

func (c *Client) DeleteRuleSet(ctx context.Context, params *DeleteRuleSetInput, optFns ...func(*Options)) (*DeleteRuleSetOutput, error)

Delete a rule set.

func (*Client) DeleteTrafficPolicy 

func (c *Client) DeleteTrafficPolicy(ctx context.Context, params *DeleteTrafficPolicyInput, optFns ...func(*Options)) (*DeleteTrafficPolicyOutput, error)

Delete a traffic policy resource.

func (*Client) DeregisterMemberFromAddressList added in v1.8.0 

func (c *Client) DeregisterMemberFromAddressList(ctx context.Context, params *DeregisterMemberFromAddressListInput, optFns ...func(*Options)) (*DeregisterMemberFromAddressListOutput, error)

Removes a member from an address list.

func (*Client) GetAddonInstance 

func (c *Client) GetAddonInstance(ctx context.Context, params *GetAddonInstanceInput, optFns ...func(*Options)) (*GetAddonInstanceOutput, error)

Gets detailed information about an Add On instance.

func (*Client) GetAddonSubscription 

func (c *Client) GetAddonSubscription(ctx context.Context, params *GetAddonSubscriptionInput, optFns ...func(*Options)) (*GetAddonSubscriptionOutput, error)

Gets detailed information about an Add On subscription.

func (*Client) GetAddressList added in v1.8.0 

func (c *Client) GetAddressList(ctx context.Context, params *GetAddressListInput, optFns ...func(*Options)) (*GetAddressListOutput, error)

Fetch attributes of an address list.

func (*Client) GetAddressListImportJob added in v1.8.0 

func (c *Client) GetAddressListImportJob(ctx context.Context, params *GetAddressListImportJobInput, optFns ...func(*Options)) (*GetAddressListImportJobOutput, error)

Fetch attributes of an import job.

func (*Client) GetArchive 

func (c *Client) GetArchive(ctx context.Context, params *GetArchiveInput, optFns ...func(*Options)) (*GetArchiveOutput, error)

Retrieves the full details and current state of a specified email archive.

func (*Client) GetArchiveExport 

func (c *Client) GetArchiveExport(ctx context.Context, params *GetArchiveExportInput, optFns ...func(*Options)) (*GetArchiveExportOutput, error)

Retrieves the details and current status of a specific email archive export job.

func (*Client) GetArchiveMessage 

func (c *Client) GetArchiveMessage(ctx context.Context, params *GetArchiveMessageInput, optFns ...func(*Options)) (*GetArchiveMessageOutput, error)

Returns a pre-signed URL that provides temporary download access to the specific email message stored in the archive.

func (*Client) GetArchiveMessageContent 

func (c *Client) GetArchiveMessageContent(ctx context.Context, params *GetArchiveMessageContentInput, optFns ...func(*Options)) (*GetArchiveMessageContentOutput, error)

Returns the textual content of a specific email message stored in the archive. Attachments are not included.

func (*Client) GetArchiveSearch 

func (c *Client) GetArchiveSearch(ctx context.Context, params *GetArchiveSearchInput, optFns ...func(*Options)) (*GetArchiveSearchOutput, error)

Retrieves the details and current status of a specific email archive search job.

func (*Client) GetArchiveSearchResults 

func (c *Client) GetArchiveSearchResults(ctx context.Context, params *GetArchiveSearchResultsInput, optFns ...func(*Options)) (*GetArchiveSearchResultsOutput, error)

Returns the results of a completed email archive search job.

func (*Client) GetIngressPoint 

func (c *Client) GetIngressPoint(ctx context.Context, params *GetIngressPointInput, optFns ...func(*Options)) (*GetIngressPointOutput, error)

Fetch ingress endpoint resource attributes.

func (*Client) GetMemberOfAddressList added in v1.8.0 

func (c *Client) GetMemberOfAddressList(ctx context.Context, params *GetMemberOfAddressListInput, optFns ...func(*Options)) (*GetMemberOfAddressListOutput, error)

Fetch attributes of a member in an address list.

func (*Client) GetRelay 

func (c *Client) GetRelay(ctx context.Context, params *GetRelayInput, optFns ...func(*Options)) (*GetRelayOutput, error)

Fetch the relay resource and it's attributes.

func (*Client) GetRuleSet 

func (c *Client) GetRuleSet(ctx context.Context, params *GetRuleSetInput, optFns ...func(*Options)) (*GetRuleSetOutput, error)

Fetch attributes of a rule set.

func (*Client) GetTrafficPolicy 

func (c *Client) GetTrafficPolicy(ctx context.Context, params *GetTrafficPolicyInput, optFns ...func(*Options)) (*GetTrafficPolicyOutput, error)

Fetch attributes of a traffic policy resource.

func (*Client) ListAddonInstances 

func (c *Client) ListAddonInstances(ctx context.Context, params *ListAddonInstancesInput, optFns ...func(*Options)) (*ListAddonInstancesOutput, error)

Lists all Add On instances in your account.

func (*Client) ListAddonSubscriptions 

func (c *Client) ListAddonSubscriptions(ctx context.Context, params *ListAddonSubscriptionsInput, optFns ...func(*Options)) (*ListAddonSubscriptionsOutput, error)

Lists all Add On subscriptions in your account.

func (*Client) ListAddressListImportJobs added in v1.8.0 

func (c *Client) ListAddressListImportJobs(ctx context.Context, params *ListAddressListImportJobsInput, optFns ...func(*Options)) (*ListAddressListImportJobsOutput, error)

Lists jobs for an address list.

func (*Client) ListAddressLists added in v1.8.0 

func (c *Client) ListAddressLists(ctx context.Context, params *ListAddressListsInput, optFns ...func(*Options)) (*ListAddressListsOutput, error)

Lists address lists for this account.

func (*Client) ListArchiveExports 

func (c *Client) ListArchiveExports(ctx context.Context, params *ListArchiveExportsInput, optFns ...func(*Options)) (*ListArchiveExportsOutput, error)

Returns a list of email archive export jobs.

func (*Client) ListArchiveSearches 

func (c *Client) ListArchiveSearches(ctx context.Context, params *ListArchiveSearchesInput, optFns ...func(*Options)) (*ListArchiveSearchesOutput, error)

Returns a list of email archive search jobs.

func (*Client) ListArchives 

func (c *Client) ListArchives(ctx context.Context, params *ListArchivesInput, optFns ...func(*Options)) (*ListArchivesOutput, error)

Returns a list of all email archives in your account.

func (*Client) ListIngressPoints 

func (c *Client) ListIngressPoints(ctx context.Context, params *ListIngressPointsInput, optFns ...func(*Options)) (*ListIngressPointsOutput, error)

List all ingress endpoint resources.

func (*Client) ListMembersOfAddressList added in v1.8.0 

func (c *Client) ListMembersOfAddressList(ctx context.Context, params *ListMembersOfAddressListInput, optFns ...func(*Options)) (*ListMembersOfAddressListOutput, error)

Lists members of an address list.

func (*Client) ListRelays 

func (c *Client) ListRelays(ctx context.Context, params *ListRelaysInput, optFns ...func(*Options)) (*ListRelaysOutput, error)

Lists all the existing relay resources.

func (*Client) ListRuleSets 

func (c *Client) ListRuleSets(ctx context.Context, params *ListRuleSetsInput, optFns ...func(*Options)) (*ListRuleSetsOutput, error)

List rule sets for this account.

func (*Client) ListTagsForResource 

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

Retrieves the list of tags (keys and values) assigned to the resource.

func (*Client) ListTrafficPolicies 

func (c *Client) ListTrafficPolicies(ctx context.Context, params *ListTrafficPoliciesInput, optFns ...func(*Options)) (*ListTrafficPoliciesOutput, error)

List traffic policy resources.

func (*Client) Options 

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) RegisterMemberToAddressList added in v1.8.0 

func (c *Client) RegisterMemberToAddressList(ctx context.Context, params *RegisterMemberToAddressListInput, optFns ...func(*Options)) (*RegisterMemberToAddressListOutput, error)

Adds a member to an address list.

func (*Client) StartAddressListImportJob added in v1.8.0 

func (c *Client) StartAddressListImportJob(ctx context.Context, params *StartAddressListImportJobInput, optFns ...func(*Options)) (*StartAddressListImportJobOutput, error)

Starts an import job for an address list.

func (*Client) StartArchiveExport 

func (c *Client) StartArchiveExport(ctx context.Context, params *StartArchiveExportInput, optFns ...func(*Options)) (*StartArchiveExportOutput, error)

Initiates an export of emails from the specified archive.

func (*Client) StartArchiveSearch 

func (c *Client) StartArchiveSearch(ctx context.Context, params *StartArchiveSearchInput, optFns ...func(*Options)) (*StartArchiveSearchOutput, error)

Initiates a search across emails in the specified archive.

func (*Client) StopAddressListImportJob added in v1.8.0 

func (c *Client) StopAddressListImportJob(ctx context.Context, params *StopAddressListImportJobInput, optFns ...func(*Options)) (*StopAddressListImportJobOutput, error)

Stops an ongoing import job for an address list.

func (*Client) StopArchiveExport 

func (c *Client) StopArchiveExport(ctx context.Context, params *StopArchiveExportInput, optFns ...func(*Options)) (*StopArchiveExportOutput, error)

Stops an in-progress export of emails from an archive.

func (*Client) StopArchiveSearch 

func (c *Client) StopArchiveSearch(ctx context.Context, params *StopArchiveSearchInput, optFns ...func(*Options)) (*StopArchiveSearchOutput, error)

Stops an in-progress archive search job.

func (*Client) TagResource 

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

Adds one or more tags (keys and values) to a specified resource.

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

func (c *Client) UpdateArchive(ctx context.Context, params *UpdateArchiveInput, optFns ...func(*Options)) (*UpdateArchiveOutput, error)

Updates the attributes of an existing email archive.

func (*Client) UpdateIngressPoint 

func (c *Client) UpdateIngressPoint(ctx context.Context, params *UpdateIngressPointInput, optFns ...func(*Options)) (*UpdateIngressPointOutput, error)

Update attributes of a provisioned ingress endpoint resource.

func (*Client) UpdateRelay 

func (c *Client) UpdateRelay(ctx context.Context, params *UpdateRelayInput, optFns ...func(*Options)) (*UpdateRelayOutput, error)

Updates the attributes of an existing relay resource.

func (*Client) UpdateRuleSet 

func (c *Client) UpdateRuleSet(ctx context.Context, params *UpdateRuleSetInput, optFns ...func(*Options)) (*UpdateRuleSetOutput, error)

Update attributes of an already provisioned rule set.

func (*Client) UpdateTrafficPolicy 

func (c *Client) UpdateTrafficPolicy(ctx context.Context, params *UpdateTrafficPolicyInput, optFns ...func(*Options)) (*UpdateTrafficPolicyOutput, error)

Update attributes of an already provisioned traffic policy resource.

type CreateAddonInstanceInput 

type CreateAddonInstanceInput struct {

	// The unique ID of a previously created subscription that an Add On instance is
	// created for. You can only have one instance per subscription.
	//
	// This member is required.
	AddonSubscriptionId *string

	// A unique token that Amazon SES uses to recognize subsequent retries of the same
	// request.
	ClientToken *string

	// The tags used to organize, track, or control access for the resource. For
	// example, { "tags": {"key1":"value1", "key2":"value2"} }.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateAddonInstanceOutput 

type CreateAddonInstanceOutput struct {

	// The unique ID of the Add On instance created by this API.
	//
	// This member is required.
	AddonInstanceId *string

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

type CreateAddonSubscriptionInput 

type CreateAddonSubscriptionInput struct {

	// The name of the Add On to subscribe to. You can only have one subscription for
	// each Add On name.
	//
	// This member is required.
	AddonName *string

	// A unique token that Amazon SES uses to recognize subsequent retries of the same
	// request.
	ClientToken *string

	// The tags used to organize, track, or control access for the resource. For
	// example, { "tags": {"key1":"value1", "key2":"value2"} }.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateAddonSubscriptionOutput 

type CreateAddonSubscriptionOutput struct {

	// The unique ID of the Add On subscription created by this API.
	//
	// This member is required.
	AddonSubscriptionId *string

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

type CreateAddressListImportJobInput added in v1.8.0 

type CreateAddressListImportJobInput struct {

	// The unique identifier of the address list for importing addresses to.
	//
	// This member is required.
	AddressListId *string

	// The format of the input for an import job.
	//
	// This member is required.
	ImportDataFormat *types.ImportDataFormat

	// A user-friendly name for the import job.
	//
	// This member is required.
	Name *string

	// A unique token that Amazon SES uses to recognize subsequent retries of the same
	// request.
	ClientToken *string
	// contains filtered or unexported fields
}

type CreateAddressListImportJobOutput added in v1.8.0 

type CreateAddressListImportJobOutput struct {

	// The identifier of the created import job.
	//
	// This member is required.
	JobId *string

	// The pre-signed URL target for uploading the input file.
	//
	// This member is required.
	PreSignedUrl *string

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

type CreateAddressListInput added in v1.8.0 

type CreateAddressListInput struct {

	// A user-friendly name for the address list.
	//
	// This member is required.
	AddressListName *string

	// A unique token that Amazon SES uses to recognize subsequent retries of the same
	// request.
	ClientToken *string

	// The tags used to organize, track, or control access for the resource. For
	// example, { "tags": {"key1":"value1", "key2":"value2"} }.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateAddressListOutput added in v1.8.0 

type CreateAddressListOutput struct {

	// The identifier of the created address list.
	//
	// This member is required.
	AddressListId *string

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

type CreateArchiveInput 

type CreateArchiveInput struct {

	// A unique name for the new archive.
	//
	// This member is required.
	ArchiveName *string

	// A unique token Amazon SES uses to recognize retries of this request.
	ClientToken *string

	// The Amazon Resource Name (ARN) of the KMS key for encrypting emails in the
	// archive.
	KmsKeyArn *string

	// The period for retaining emails in the archive before automatic deletion.
	Retention types.ArchiveRetention

	// The tags used to organize, track, or control access for the resource. For
	// example, { "tags": {"key1":"value1", "key2":"value2"} }.
	Tags []types.Tag
	// contains filtered or unexported fields
}

The request to create a new email archive.

type CreateArchiveOutput 

type CreateArchiveOutput struct {

	// The unique identifier for the newly created archive.
	//
	// This member is required.
	ArchiveId *string

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

The response from creating a new email archive.

type CreateIngressPointInput 

type CreateIngressPointInput struct {

	// A user friendly name for an ingress endpoint resource.
	//
	// This member is required.
	IngressPointName *string

	// The identifier of an existing rule set that you attach to an ingress endpoint
	// resource.
	//
	// This member is required.
	RuleSetId *string

	// The identifier of an existing traffic policy that you attach to an ingress
	// endpoint resource.
	//
	// This member is required.
	TrafficPolicyId *string

	// The type of the ingress endpoint to create.
	//
	// This member is required.
	Type types.IngressPointType

	// A unique token that Amazon SES uses to recognize subsequent retries of the same
	// request.
	ClientToken *string

	// If you choose an Authenticated ingress endpoint, you must configure either an
	// SMTP password or a secret ARN.
	IngressPointConfiguration types.IngressPointConfiguration

	// The tags used to organize, track, or control access for the resource. For
	// example, { "tags": {"key1":"value1", "key2":"value2"} }.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateIngressPointOutput 

type CreateIngressPointOutput struct {

	// The unique identifier for a previously created ingress endpoint.
	//
	// This member is required.
	IngressPointId *string

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

type CreateRelayInput 

type CreateRelayInput struct {

	// Authentication for the relay destination server—specify the secretARN where the
	// SMTP credentials are stored.
	//
	// This member is required.
	Authentication types.RelayAuthentication

	// The unique name of the relay resource.
	//
	// This member is required.
	RelayName *string

	// The destination relay server address.
	//
	// This member is required.
	ServerName *string

	// The destination relay server port.
	//
	// This member is required.
	ServerPort *int32

	// A unique token that Amazon SES uses to recognize subsequent retries of the same
	// request.
	ClientToken *string

	// The tags used to organize, track, or control access for the resource. For
	// example, { "tags": {"key1":"value1", "key2":"value2"} }.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateRelayOutput 

type CreateRelayOutput struct {

	// A unique identifier of the created relay resource.
	//
	// This member is required.
	RelayId *string

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

type CreateRuleSetInput 

type CreateRuleSetInput struct {

	// A user-friendly name for the rule set.
	//
	// This member is required.
	RuleSetName *string

	// Conditional rules that are evaluated for determining actions on email.
	//
	// This member is required.
	Rules []types.Rule

	// A unique token that Amazon SES uses to recognize subsequent retries of the same
	// request.
	ClientToken *string

	// The tags used to organize, track, or control access for the resource. For
	// example, { "tags": {"key1":"value1", "key2":"value2"} }.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateRuleSetOutput 

type CreateRuleSetOutput struct {

	// The identifier of the created rule set.
	//
	// This member is required.
	RuleSetId *string

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

type CreateTrafficPolicyInput 

type CreateTrafficPolicyInput struct {

	// Default action instructs the traffic policy to either Allow or Deny (block)
	// messages that fall outside of (or not addressed by) the conditions of your
	// policy statements
	//
	// This member is required.
	DefaultAction types.AcceptAction

	// Conditional statements for filtering email traffic.
	//
	// This member is required.
	PolicyStatements []types.PolicyStatement

	// A user-friendly name for the traffic policy resource.
	//
	// This member is required.
	TrafficPolicyName *string

	// A unique token that Amazon SES uses to recognize subsequent retries of the same
	// request.
	ClientToken *string

	// The maximum message size in bytes of email which is allowed in by this traffic
	// policy—anything larger will be blocked.
	MaxMessageSizeBytes *int32

	// The tags used to organize, track, or control access for the resource. For
	// example, { "tags": {"key1":"value1", "key2":"value2"} }.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateTrafficPolicyOutput 

type CreateTrafficPolicyOutput struct {

	// The identifier of the traffic policy resource.
	//
	// This member is required.
	TrafficPolicyId *string

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

type DeleteAddonInstanceInput 

type DeleteAddonInstanceInput struct {

	// The Add On instance ID to delete.
	//
	// This member is required.
	AddonInstanceId *string
	// contains filtered or unexported fields
}

type DeleteAddonInstanceOutput 

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

type DeleteAddonSubscriptionInput 

type DeleteAddonSubscriptionInput struct {

	// The Add On subscription ID to delete.
	//
	// This member is required.
	AddonSubscriptionId *string
	// contains filtered or unexported fields
}

type DeleteAddonSubscriptionOutput 

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

type DeleteAddressListInput added in v1.8.0 

type DeleteAddressListInput struct {

	// The identifier of an existing address list resource to delete.
	//
	// This member is required.
	AddressListId *string
	// contains filtered or unexported fields
}

type DeleteAddressListOutput added in v1.8.0 

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

type DeleteArchiveInput 

type DeleteArchiveInput struct {

	// The identifier of the archive to delete.
	//
	// This member is required.
	ArchiveId *string
	// contains filtered or unexported fields
}

The request to initiate deletion of an email archive.

type DeleteArchiveOutput 

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

The response indicating if the archive deletion was successfully initiated.

On success, returns an HTTP 200 status code. On failure, returns an error message.

type DeleteIngressPointInput 

type DeleteIngressPointInput struct {

	// The identifier of the ingress endpoint resource that you want to delete.
	//
	// This member is required.
	IngressPointId *string
	// contains filtered or unexported fields
}

type DeleteIngressPointOutput 

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

type DeleteRelayInput 

type DeleteRelayInput struct {

	// The unique relay identifier.
	//
	// This member is required.
	RelayId *string
	// contains filtered or unexported fields
}

type DeleteRelayOutput 

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

type DeleteRuleSetInput 

type DeleteRuleSetInput struct {

	// The identifier of an existing rule set resource to delete.
	//
	// This member is required.
	RuleSetId *string
	// contains filtered or unexported fields
}

type DeleteRuleSetOutput 

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

type DeleteTrafficPolicyInput 

type DeleteTrafficPolicyInput struct {

	// The identifier of the traffic policy that you want to delete.
	//
	// This member is required.
	TrafficPolicyId *string
	// contains filtered or unexported fields
}

type DeleteTrafficPolicyOutput 

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

type DeregisterMemberFromAddressListInput added in v1.8.0 

type DeregisterMemberFromAddressListInput struct {

	// The address to be removed from the address list.
	//
	// This member is required.
	Address *string

	// The unique identifier of the address list to remove the address from.
	//
	// This member is required.
	AddressListId *string
	// contains filtered or unexported fields
}

type DeregisterMemberFromAddressListOutput added in v1.8.0 

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

type EndpointParameters 

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 

func (p EndpointParameters) ValidateRequired() error

ValidateRequired validates required parameters are set.

func (EndpointParameters) WithDefaults 

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 

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 

type EndpointResolverOptions = internalendpoints.Options

EndpointResolverOptions is the service endpoint resolver options

type EndpointResolverV2 

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 

func NewDefaultEndpointResolverV2() EndpointResolverV2

type GetAddonInstanceInput 

type GetAddonInstanceInput struct {

	// The Add On instance ID to retrieve information for.
	//
	// This member is required.
	AddonInstanceId *string
	// contains filtered or unexported fields
}

type GetAddonInstanceOutput 

type GetAddonInstanceOutput struct {

	// The Amazon Resource Name (ARN) of the Add On instance.
	AddonInstanceArn *string

	// The name of the Add On provider associated to the subscription of the instance.
	AddonName *string

	// The subscription ID associated to the instance.
	AddonSubscriptionId *string

	// The timestamp of when the Add On instance was created.
	CreatedTimestamp *time.Time

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

type GetAddonSubscriptionInput 

type GetAddonSubscriptionInput struct {

	// The Add On subscription ID to retrieve information for.
	//
	// This member is required.
	AddonSubscriptionId *string
	// contains filtered or unexported fields
}

type GetAddonSubscriptionOutput 

type GetAddonSubscriptionOutput struct {

	// The name of the Add On for the subscription.
	AddonName *string

	// Amazon Resource Name (ARN) for the subscription.
	AddonSubscriptionArn *string

	// The timestamp of when the Add On subscription was created.
	CreatedTimestamp *time.Time

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

type GetAddressListImportJobInput added in v1.8.0 

type GetAddressListImportJobInput struct {

	// The identifier of the import job that needs to be retrieved.
	//
	// This member is required.
	JobId *string
	// contains filtered or unexported fields
}

type GetAddressListImportJobOutput added in v1.8.0 

type GetAddressListImportJobOutput struct {

	// The unique identifier of the address list the import job was created for.
	//
	// This member is required.
	AddressListId *string

	// The timestamp of when the import job was created.
	//
	// This member is required.
	CreatedTimestamp *time.Time

	// The format of the input for an import job.
	//
	// This member is required.
	ImportDataFormat *types.ImportDataFormat

	// The identifier of the import job.
	//
	// This member is required.
	JobId *string

	// A user-friendly name for the import job.
	//
	// This member is required.
	Name *string

	// The pre-signed URL target for uploading the input file.
	//
	// This member is required.
	PreSignedUrl *string

	// The status of the import job.
	//
	// This member is required.
	Status types.ImportJobStatus

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

	// The reason for failure of an import job.
	Error *string

	// The number of input addresses that failed to be imported into the address list.
	FailedItemsCount *int32

	// The number of input addresses successfully imported into the address list.
	ImportedItemsCount *int32

	// The timestamp of when the import job was started.
	StartTimestamp *time.Time

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

type GetAddressListInput added in v1.8.0 

type GetAddressListInput struct {

	// The identifier of an existing address list resource to be retrieved.
	//
	// This member is required.
	AddressListId *string
	// contains filtered or unexported fields
}

type GetAddressListOutput added in v1.8.0 

type GetAddressListOutput struct {

	// The Amazon Resource Name (ARN) of the address list resource.
	//
	// This member is required.
	AddressListArn *string

	// The identifier of the address list resource.
	//
	// This member is required.
	AddressListId *string

	// A user-friendly name for the address list resource.
	//
	// This member is required.
	AddressListName *string

	// The date of when then address list was created.
	//
	// This member is required.
	CreatedTimestamp *time.Time

	// The date of when the address list was last updated.
	//
	// This member is required.
	LastUpdatedTimestamp *time.Time

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

type GetArchiveExportInput 

type GetArchiveExportInput struct {

	// The identifier of the export job to get details for.
	//
	// This member is required.
	ExportId *string
	// contains filtered or unexported fields
}

The request to retrieve details of a specific archive export job.

type GetArchiveExportOutput 

type GetArchiveExportOutput struct {

	// The identifier of the archive the email export was performed from.
	ArchiveId *string

	// Where the exported emails are being delivered.
	ExportDestinationConfiguration types.ExportDestinationConfiguration

	// The criteria used to filter emails included in the export.
	Filters *types.ArchiveFilters

	// The start of the timestamp range the exported emails cover.
	FromTimestamp *time.Time

	// The maximum number of email items included in the export.
	MaxResults *int32

	// The current status of the export job.
	Status *types.ExportStatus

	// The end of the date range the exported emails cover.
	ToTimestamp *time.Time

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

The response containing details of the specified archive export job.

type GetArchiveInput 

type GetArchiveInput struct {

	// The identifier of the archive to retrieve.
	//
	// This member is required.
	ArchiveId *string
	// contains filtered or unexported fields
}

The request to retrieve details of an email archive.

type GetArchiveMessageContentInput 

type GetArchiveMessageContentInput struct {

	// The unique identifier of the archived email message.
	//
	// This member is required.
	ArchivedMessageId *string
	// contains filtered or unexported fields
}

The request to get the textual content of a specific email message stored in an archive.

type GetArchiveMessageContentOutput 

type GetArchiveMessageContentOutput struct {

	// The textual body content of the email message.
	Body *types.MessageBody

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

The response containing the textual content of the requested archived email message.

type GetArchiveMessageInput 

type GetArchiveMessageInput struct {

	// The unique identifier of the archived email message.
	//
	// This member is required.
	ArchivedMessageId *string
	// contains filtered or unexported fields
}

The request to get details of a specific email message stored in an archive.

type GetArchiveMessageOutput 

type GetArchiveMessageOutput struct {

	// The SMTP envelope information of the email.
	Envelope *types.Envelope

	// A pre-signed URL to temporarily download the full message content.
	MessageDownloadLink *string

	// The metadata about the email.
	Metadata *types.Metadata

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

The response containing details about the requested archived email message.

type GetArchiveOutput 

type GetArchiveOutput struct {

	// The Amazon Resource Name (ARN) of the archive.
	//
	// This member is required.
	ArchiveArn *string

	// The unique identifier of the archive.
	//
	// This member is required.
	ArchiveId *string

	// The unique name assigned to the archive.
	//
	// This member is required.
	ArchiveName *string

	// The current state of the archive:
	//
	//   - ACTIVE – The archive is ready and available for use.
	//
	//   - PENDING_DELETION – The archive has been marked for deletion and will be
	//   permanently deleted in 30 days. No further modifications can be made in this
	//   state.
	//
	// This member is required.
	ArchiveState types.ArchiveState

	// The retention period for emails in this archive.
	//
	// This member is required.
	Retention types.ArchiveRetention

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

	// The Amazon Resource Name (ARN) of the KMS key used to encrypt the archive.
	KmsKeyArn *string

	// The timestamp of when the archive was modified.
	LastUpdatedTimestamp *time.Time

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

The response containing details of the requested archive.

type GetArchiveSearchInput 

type GetArchiveSearchInput struct {

	// The identifier of the search job to get details for.
	//
	// This member is required.
	SearchId *string
	// contains filtered or unexported fields
}

The request to retrieve details of a specific archive search job.

type GetArchiveSearchOutput 

type GetArchiveSearchOutput struct {

	// The identifier of the archive the email search was performed in.
	ArchiveId *string

	// The criteria used to filter emails included in the search.
	Filters *types.ArchiveFilters

	// The start timestamp of the range the searched emails cover.
	FromTimestamp *time.Time

	// The maximum number of search results to return.
	MaxResults *int32

	// The current status of the search job.
	Status *types.SearchStatus

	// The end timestamp of the range the searched emails cover.
	ToTimestamp *time.Time

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

The response containing details of the specified archive search job.

type GetArchiveSearchResultsInput 

type GetArchiveSearchResultsInput struct {

	// The identifier of the completed search job.
	//
	// This member is required.
	SearchId *string
	// contains filtered or unexported fields
}

The request to retrieve results from a completed archive search job.

type GetArchiveSearchResultsOutput 

type GetArchiveSearchResultsOutput struct {

	// The list of email result objects matching the search criteria.
	Rows []types.Row

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

The response containing search results from a completed archive search.

type GetIngressPointInput 

type GetIngressPointInput struct {

	// The identifier of an ingress endpoint.
	//
	// This member is required.
	IngressPointId *string
	// contains filtered or unexported fields
}

type GetIngressPointOutput 

type GetIngressPointOutput struct {

	// The identifier of an ingress endpoint resource.
	//
	// This member is required.
	IngressPointId *string

	// A user friendly name for the ingress endpoint.
	//
	// This member is required.
	IngressPointName *string

	//  The DNS A Record that identifies your ingress endpoint. Configure your DNS
	// Mail Exchange (MX) record with this value to route emails to Mail Manager.
	ARecord *string

	// The timestamp of when the ingress endpoint was created.
	CreatedTimestamp *time.Time

	// The Amazon Resource Name (ARN) of the ingress endpoint resource.
	IngressPointArn *string

	// The authentication configuration of the ingress endpoint resource.
	IngressPointAuthConfiguration *types.IngressPointAuthConfiguration

	// The timestamp of when the ingress endpoint was last updated.
	LastUpdatedTimestamp *time.Time

	// The identifier of a rule set resource associated with the ingress endpoint.
	RuleSetId *string

	// The status of the ingress endpoint resource.
	Status types.IngressPointStatus

	// The identifier of the traffic policy resource associated with the ingress
	// endpoint.
	TrafficPolicyId *string

	// The type of ingress endpoint.
	Type types.IngressPointType

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

type GetMemberOfAddressListInput added in v1.8.0 

type GetMemberOfAddressListInput struct {

	// The address to be retrieved from the address list.
	//
	// This member is required.
	Address *string

	// The unique identifier of the address list to retrieve the address from.
	//
	// This member is required.
	AddressListId *string
	// contains filtered or unexported fields
}

type GetMemberOfAddressListOutput added in v1.8.0 

type GetMemberOfAddressListOutput struct {

	// The address retrieved from the address list.
	//
	// This member is required.
	Address *string

	// The timestamp of when the address was created.
	//
	// This member is required.
	CreatedTimestamp *time.Time

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

type GetRelayInput 

type GetRelayInput struct {

	// A unique relay identifier.
	//
	// This member is required.
	RelayId *string
	// contains filtered or unexported fields
}

type GetRelayOutput 

type GetRelayOutput struct {

	// The unique relay identifier.
	//
	// This member is required.
	RelayId *string

	// The authentication attribute—contains the secret ARN where the customer relay
	// server credentials are stored.
	Authentication types.RelayAuthentication

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

	// The timestamp of when relay was last updated.
	LastModifiedTimestamp *time.Time

	// The Amazon Resource Name (ARN) of the relay.
	RelayArn *string

	// The unique name of the relay.
	RelayName *string

	// The destination relay server address.
	ServerName *string

	// The destination relay server port.
	ServerPort *int32

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

type GetRuleSetInput 

type GetRuleSetInput struct {

	// The identifier of an existing rule set to be retrieved.
	//
	// This member is required.
	RuleSetId *string
	// contains filtered or unexported fields
}

type GetRuleSetOutput 

type GetRuleSetOutput struct {

	// The date of when then rule set was created.
	//
	// This member is required.
	CreatedDate *time.Time

	// The date of when the rule set was last modified.
	//
	// This member is required.
	LastModificationDate *time.Time

	// The Amazon Resource Name (ARN) of the rule set resource.
	//
	// This member is required.
	RuleSetArn *string

	// The identifier of the rule set resource.
	//
	// This member is required.
	RuleSetId *string

	// A user-friendly name for the rule set resource.
	//
	// This member is required.
	RuleSetName *string

	// The rules contained in the rule set.
	//
	// This member is required.
	Rules []types.Rule

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

type GetTrafficPolicyInput 

type GetTrafficPolicyInput struct {

	// The identifier of the traffic policy resource.
	//
	// This member is required.
	TrafficPolicyId *string
	// contains filtered or unexported fields
}

type GetTrafficPolicyOutput 

type GetTrafficPolicyOutput struct {

	// The identifier of the traffic policy resource.
	//
	// This member is required.
	TrafficPolicyId *string

	// A user-friendly name for the traffic policy resource.
	//
	// This member is required.
	TrafficPolicyName *string

	// The timestamp of when the traffic policy was created.
	CreatedTimestamp *time.Time

	// The default action of the traffic policy.
	DefaultAction types.AcceptAction

	// The timestamp of when the traffic policy was last updated.
	LastUpdatedTimestamp *time.Time

	// The maximum message size in bytes of email which is allowed in by this traffic
	// policy—anything larger will be blocked.
	MaxMessageSizeBytes *int32

	// The list of conditions which are in the traffic policy resource.
	PolicyStatements []types.PolicyStatement

	// The Amazon Resource Name (ARN) of the traffic policy resource.
	TrafficPolicyArn *string

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

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 IdempotencyTokenProvider 

type IdempotencyTokenProvider interface {
	GetIdempotencyToken() (string, error)
}

IdempotencyTokenProvider interface for providing idempotency token

type ListAddonInstancesAPIClient 

type ListAddonInstancesAPIClient interface {
	ListAddonInstances(context.Context, *ListAddonInstancesInput, ...func(*Options)) (*ListAddonInstancesOutput, error)
}

ListAddonInstancesAPIClient is a client that implements the ListAddonInstances operation.

type ListAddonInstancesInput 

type ListAddonInstancesInput struct {

	// If you received a pagination token from a previous call to this API, you can
	// provide it here to continue paginating through the next page of results.
	NextToken *string

	// The maximum number of ingress endpoint resources that are returned per call.
	// You can use NextToken to obtain further ingress endpoints.
	PageSize *int32
	// contains filtered or unexported fields
}

type ListAddonInstancesOutput 

type ListAddonInstancesOutput struct {

	// The list of ingress endpoints.
	AddonInstances []types.AddonInstance

	// If NextToken is returned, there are more results available. The value of
	// NextToken is a unique pagination token for each page. Make the call again using
	// the returned token to retrieve the next page.
	NextToken *string

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

type ListAddonInstancesPaginator 

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

ListAddonInstancesPaginator is a paginator for ListAddonInstances

func NewListAddonInstancesPaginator 

func NewListAddonInstancesPaginator(client ListAddonInstancesAPIClient, params *ListAddonInstancesInput, optFns ...func(*ListAddonInstancesPaginatorOptions)) *ListAddonInstancesPaginator

NewListAddonInstancesPaginator returns a new ListAddonInstancesPaginator

func (*ListAddonInstancesPaginator) HasMorePages 

func (p *ListAddonInstancesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListAddonInstancesPaginator) NextPage 

func (p *ListAddonInstancesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListAddonInstancesOutput, error)

NextPage retrieves the next ListAddonInstances page.

type ListAddonInstancesPaginatorOptions 

type ListAddonInstancesPaginatorOptions struct {
	// The maximum number of ingress endpoint resources that are returned per call.
	// You can use NextToken to obtain further ingress endpoints.
	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
}

ListAddonInstancesPaginatorOptions is the paginator options for ListAddonInstances

type ListAddonSubscriptionsAPIClient 

type ListAddonSubscriptionsAPIClient interface {
	ListAddonSubscriptions(context.Context, *ListAddonSubscriptionsInput, ...func(*Options)) (*ListAddonSubscriptionsOutput, error)
}

ListAddonSubscriptionsAPIClient is a client that implements the ListAddonSubscriptions operation.

type ListAddonSubscriptionsInput 

type ListAddonSubscriptionsInput struct {

	// If you received a pagination token from a previous call to this API, you can
	// provide it here to continue paginating through the next page of results.
	NextToken *string

	// The maximum number of ingress endpoint resources that are returned per call.
	// You can use NextToken to obtain further ingress endpoints.
	PageSize *int32
	// contains filtered or unexported fields
}

type ListAddonSubscriptionsOutput 

type ListAddonSubscriptionsOutput struct {

	// The list of ingress endpoints.
	AddonSubscriptions []types.AddonSubscription

	// If NextToken is returned, there are more results available. The value of
	// NextToken is a unique pagination token for each page. Make the call again using
	// the returned token to retrieve the next page.
	NextToken *string

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

type ListAddonSubscriptionsPaginator 

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

ListAddonSubscriptionsPaginator is a paginator for ListAddonSubscriptions

func NewListAddonSubscriptionsPaginator 

func NewListAddonSubscriptionsPaginator(client ListAddonSubscriptionsAPIClient, params *ListAddonSubscriptionsInput, optFns ...func(*ListAddonSubscriptionsPaginatorOptions)) *ListAddonSubscriptionsPaginator

NewListAddonSubscriptionsPaginator returns a new ListAddonSubscriptionsPaginator

func (*ListAddonSubscriptionsPaginator) HasMorePages 

func (p *ListAddonSubscriptionsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListAddonSubscriptionsPaginator) NextPage 

func (p *ListAddonSubscriptionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListAddonSubscriptionsOutput, error)

NextPage retrieves the next ListAddonSubscriptions page.

type ListAddonSubscriptionsPaginatorOptions 

type ListAddonSubscriptionsPaginatorOptions struct {
	// The maximum number of ingress endpoint resources that are returned per call.
	// You can use NextToken to obtain further ingress endpoints.
	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
}

ListAddonSubscriptionsPaginatorOptions is the paginator options for ListAddonSubscriptions

type ListAddressListImportJobsAPIClient added in v1.8.0 

type ListAddressListImportJobsAPIClient interface {
	ListAddressListImportJobs(context.Context, *ListAddressListImportJobsInput, ...func(*Options)) (*ListAddressListImportJobsOutput, error)
}

ListAddressListImportJobsAPIClient is a client that implements the ListAddressListImportJobs operation.

type ListAddressListImportJobsInput added in v1.8.0 

type ListAddressListImportJobsInput struct {

	// The unique identifier of the address list for listing import jobs.
	//
	// This member is required.
	AddressListId *string

	// If you received a pagination token from a previous call to this API, you can
	// provide it here to continue paginating through the next page of results.
	NextToken *string

	// The maximum number of import jobs that are returned per call. You can use
	// NextToken to retrieve the next page of jobs.
	PageSize *int32
	// contains filtered or unexported fields
}

type ListAddressListImportJobsOutput added in v1.8.0 

type ListAddressListImportJobsOutput struct {

	// The list of import jobs.
	//
	// This member is required.
	ImportJobs []types.ImportJob

	// If NextToken is returned, there are more results available. The value of
	// NextToken is a unique pagination token for each page. Make the call again using
	// the returned token to retrieve the next page.
	NextToken *string

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

type ListAddressListImportJobsPaginator added in v1.8.0 

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

ListAddressListImportJobsPaginator is a paginator for ListAddressListImportJobs

func NewListAddressListImportJobsPaginator added in v1.8.0 

func NewListAddressListImportJobsPaginator(client ListAddressListImportJobsAPIClient, params *ListAddressListImportJobsInput, optFns ...func(*ListAddressListImportJobsPaginatorOptions)) *ListAddressListImportJobsPaginator

NewListAddressListImportJobsPaginator returns a new ListAddressListImportJobsPaginator

func (*ListAddressListImportJobsPaginator) HasMorePages added in v1.8.0 

func (p *ListAddressListImportJobsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListAddressListImportJobsPaginator) NextPage added in v1.8.0 

func (p *ListAddressListImportJobsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListAddressListImportJobsOutput, error)

NextPage retrieves the next ListAddressListImportJobs page.

type ListAddressListImportJobsPaginatorOptions added in v1.8.0 

type ListAddressListImportJobsPaginatorOptions struct {
	// The maximum number of import jobs that are returned per call. You can use
	// NextToken to retrieve the next page of 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
}

ListAddressListImportJobsPaginatorOptions is the paginator options for ListAddressListImportJobs

type ListAddressListsAPIClient added in v1.8.0 

type ListAddressListsAPIClient interface {
	ListAddressLists(context.Context, *ListAddressListsInput, ...func(*Options)) (*ListAddressListsOutput, error)
}

ListAddressListsAPIClient is a client that implements the ListAddressLists operation.

type ListAddressListsInput added in v1.8.0 

type ListAddressListsInput struct {

	// If you received a pagination token from a previous call to this API, you can
	// provide it here to continue paginating through the next page of results.
	NextToken *string

	// The maximum number of address list resources that are returned per call. You
	// can use NextToken to retrieve the next page of address lists.
	PageSize *int32
	// contains filtered or unexported fields
}

type ListAddressListsOutput added in v1.8.0 

type ListAddressListsOutput struct {

	// The list of address lists.
	//
	// This member is required.
	AddressLists []types.AddressList

	// If NextToken is returned, there are more results available. The value of
	// NextToken is a unique pagination token for each page. Make the call again using
	// the returned token to retrieve the next page.
	NextToken *string

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

type ListAddressListsPaginator added in v1.8.0 

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

ListAddressListsPaginator is a paginator for ListAddressLists

func NewListAddressListsPaginator added in v1.8.0 

func NewListAddressListsPaginator(client ListAddressListsAPIClient, params *ListAddressListsInput, optFns ...func(*ListAddressListsPaginatorOptions)) *ListAddressListsPaginator

NewListAddressListsPaginator returns a new ListAddressListsPaginator

func (*ListAddressListsPaginator) HasMorePages added in v1.8.0 

func (p *ListAddressListsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListAddressListsPaginator) NextPage added in v1.8.0 

func (p *ListAddressListsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListAddressListsOutput, error)

NextPage retrieves the next ListAddressLists page.

type ListAddressListsPaginatorOptions added in v1.8.0 

type ListAddressListsPaginatorOptions struct {
	// The maximum number of address list resources that are returned per call. You
	// can use NextToken to retrieve the next page of address 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
}

ListAddressListsPaginatorOptions is the paginator options for ListAddressLists

type ListArchiveExportsAPIClient 

type ListArchiveExportsAPIClient interface {
	ListArchiveExports(context.Context, *ListArchiveExportsInput, ...func(*Options)) (*ListArchiveExportsOutput, error)
}

ListArchiveExportsAPIClient is a client that implements the ListArchiveExports operation.

type ListArchiveExportsInput 

type ListArchiveExportsInput struct {

	// The identifier of the archive.
	//
	// This member is required.
	ArchiveId *string

	// If NextToken is returned, there are more results available. The value of
	// NextToken is a unique pagination token for each page. Make the call again using
	// the returned token to retrieve the next page.
	NextToken *string

	// The maximum number of archive export jobs that are returned per call. You can
	// use NextToken to obtain further pages of archives.
	PageSize *int32
	// contains filtered or unexported fields
}

The request to list archive export jobs in your account.

type ListArchiveExportsOutput 

type ListArchiveExportsOutput struct {

	// The list of export job identifiers and statuses.
	Exports []types.ExportSummary

	// If present, use to retrieve the next page of results.
	NextToken *string

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

The response containing a list of archive export jobs and their statuses.

type ListArchiveExportsPaginator 

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

ListArchiveExportsPaginator is a paginator for ListArchiveExports

func NewListArchiveExportsPaginator 

func NewListArchiveExportsPaginator(client ListArchiveExportsAPIClient, params *ListArchiveExportsInput, optFns ...func(*ListArchiveExportsPaginatorOptions)) *ListArchiveExportsPaginator

NewListArchiveExportsPaginator returns a new ListArchiveExportsPaginator

func (*ListArchiveExportsPaginator) HasMorePages 

func (p *ListArchiveExportsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListArchiveExportsPaginator) NextPage 

func (p *ListArchiveExportsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListArchiveExportsOutput, error)

NextPage retrieves the next ListArchiveExports page.

type ListArchiveExportsPaginatorOptions 

type ListArchiveExportsPaginatorOptions struct {
	// The maximum number of archive export jobs that are returned per call. You can
	// use NextToken to obtain further pages of archives.
	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
}

ListArchiveExportsPaginatorOptions is the paginator options for ListArchiveExports

type ListArchiveSearchesAPIClient 

type ListArchiveSearchesAPIClient interface {
	ListArchiveSearches(context.Context, *ListArchiveSearchesInput, ...func(*Options)) (*ListArchiveSearchesOutput, error)
}

ListArchiveSearchesAPIClient is a client that implements the ListArchiveSearches operation.

type ListArchiveSearchesInput 

type ListArchiveSearchesInput struct {

	// The identifier of the archive.
	//
	// This member is required.
	ArchiveId *string

	// If NextToken is returned, there are more results available. The value of
	// NextToken is a unique pagination token for each page. Make the call again using
	// the returned token to retrieve the next page.
	NextToken *string

	// The maximum number of archive search jobs that are returned per call. You can
	// use NextToken to obtain further pages of archives.
	PageSize *int32
	// contains filtered or unexported fields
}

The request to list archive search jobs in your account.

type ListArchiveSearchesOutput 

type ListArchiveSearchesOutput struct {

	// If present, use to retrieve the next page of results.
	NextToken *string

	// The list of search job identifiers and statuses.
	Searches []types.SearchSummary

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

The response containing a list of archive search jobs and their statuses.

type ListArchiveSearchesPaginator 

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

ListArchiveSearchesPaginator is a paginator for ListArchiveSearches

func NewListArchiveSearchesPaginator 

func NewListArchiveSearchesPaginator(client ListArchiveSearchesAPIClient, params *ListArchiveSearchesInput, optFns ...func(*ListArchiveSearchesPaginatorOptions)) *ListArchiveSearchesPaginator

NewListArchiveSearchesPaginator returns a new ListArchiveSearchesPaginator

func (*ListArchiveSearchesPaginator) HasMorePages 

func (p *ListArchiveSearchesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListArchiveSearchesPaginator) NextPage 

func (p *ListArchiveSearchesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListArchiveSearchesOutput, error)

NextPage retrieves the next ListArchiveSearches page.

type ListArchiveSearchesPaginatorOptions 

type ListArchiveSearchesPaginatorOptions struct {
	// The maximum number of archive search jobs that are returned per call. You can
	// use NextToken to obtain further pages of archives.
	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
}

ListArchiveSearchesPaginatorOptions is the paginator options for ListArchiveSearches

type ListArchivesAPIClient 

type ListArchivesAPIClient interface {
	ListArchives(context.Context, *ListArchivesInput, ...func(*Options)) (*ListArchivesOutput, error)
}

ListArchivesAPIClient is a client that implements the ListArchives operation.

type ListArchivesInput 

type ListArchivesInput struct {

	// If NextToken is returned, there are more results available. The value of
	// NextToken is a unique pagination token for each page. Make the call again using
	// the returned token to retrieve the next page.
	NextToken *string

	// The maximum number of archives that are returned per call. You can use
	// NextToken to obtain further pages of archives.
	PageSize *int32
	// contains filtered or unexported fields
}

The request to list email archives in your account.

type ListArchivesOutput 

type ListArchivesOutput struct {

	// The list of archive details.
	//
	// This member is required.
	Archives []types.Archive

	// If present, use to retrieve the next page of results.
	NextToken *string

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

The response containing a list of your email archives.

type ListArchivesPaginator 

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

ListArchivesPaginator is a paginator for ListArchives

func NewListArchivesPaginator 

func NewListArchivesPaginator(client ListArchivesAPIClient, params *ListArchivesInput, optFns ...func(*ListArchivesPaginatorOptions)) *ListArchivesPaginator

NewListArchivesPaginator returns a new ListArchivesPaginator

func (*ListArchivesPaginator) HasMorePages 

func (p *ListArchivesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListArchivesPaginator) NextPage 

func (p *ListArchivesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListArchivesOutput, error)

NextPage retrieves the next ListArchives page.

type ListArchivesPaginatorOptions 

type ListArchivesPaginatorOptions struct {
	// The maximum number of archives that are returned per call. You can use
	// NextToken to obtain further pages of archives.
	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
}

ListArchivesPaginatorOptions is the paginator options for ListArchives

type ListIngressPointsAPIClient 

type ListIngressPointsAPIClient interface {
	ListIngressPoints(context.Context, *ListIngressPointsInput, ...func(*Options)) (*ListIngressPointsOutput, error)
}

ListIngressPointsAPIClient is a client that implements the ListIngressPoints operation.

type ListIngressPointsInput 

type ListIngressPointsInput struct {

	// If you received a pagination token from a previous call to this API, you can
	// provide it here to continue paginating through the next page of results.
	NextToken *string

	// The maximum number of ingress endpoint resources that are returned per call.
	// You can use NextToken to obtain further ingress endpoints.
	PageSize *int32
	// contains filtered or unexported fields
}

type ListIngressPointsOutput 

type ListIngressPointsOutput struct {

	// The list of ingress endpoints.
	IngressPoints []types.IngressPoint

	// If NextToken is returned, there are more results available. The value of
	// NextToken is a unique pagination token for each page. Make the call again using
	// the returned token to retrieve the next page.
	NextToken *string

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

type ListIngressPointsPaginator 

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

ListIngressPointsPaginator is a paginator for ListIngressPoints

func NewListIngressPointsPaginator 

func NewListIngressPointsPaginator(client ListIngressPointsAPIClient, params *ListIngressPointsInput, optFns ...func(*ListIngressPointsPaginatorOptions)) *ListIngressPointsPaginator

NewListIngressPointsPaginator returns a new ListIngressPointsPaginator

func (*ListIngressPointsPaginator) HasMorePages 

func (p *ListIngressPointsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListIngressPointsPaginator) NextPage 

func (p *ListIngressPointsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListIngressPointsOutput, error)

NextPage retrieves the next ListIngressPoints page.

type ListIngressPointsPaginatorOptions 

type ListIngressPointsPaginatorOptions struct {
	// The maximum number of ingress endpoint resources that are returned per call.
	// You can use NextToken to obtain further ingress endpoints.
	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
}

ListIngressPointsPaginatorOptions is the paginator options for ListIngressPoints

type ListMembersOfAddressListAPIClient added in v1.8.0 

type ListMembersOfAddressListAPIClient interface {
	ListMembersOfAddressList(context.Context, *ListMembersOfAddressListInput, ...func(*Options)) (*ListMembersOfAddressListOutput, error)
}

ListMembersOfAddressListAPIClient is a client that implements the ListMembersOfAddressList operation.

type ListMembersOfAddressListInput added in v1.8.0 

type ListMembersOfAddressListInput struct {

	// The unique identifier of the address list to list the addresses from.
	//
	// This member is required.
	AddressListId *string

	// Filter to be used to limit the results.
	Filter *types.AddressFilter

	// If you received a pagination token from a previous call to this API, you can
	// provide it here to continue paginating through the next page of results.
	NextToken *string

	// The maximum number of address list members that are returned per call. You can
	// use NextToken to retrieve the next page of members.
	PageSize *int32
	// contains filtered or unexported fields
}

type ListMembersOfAddressListOutput added in v1.8.0 

type ListMembersOfAddressListOutput struct {

	// The list of addresses.
	//
	// This member is required.
	Addresses []types.SavedAddress

	// If NextToken is returned, there are more results available. The value of
	// NextToken is a unique pagination token for each page. Make the call again using
	// the returned token to retrieve the next page.
	NextToken *string

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

type ListMembersOfAddressListPaginator added in v1.8.0 

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

ListMembersOfAddressListPaginator is a paginator for ListMembersOfAddressList

func NewListMembersOfAddressListPaginator added in v1.8.0 

func NewListMembersOfAddressListPaginator(client ListMembersOfAddressListAPIClient, params *ListMembersOfAddressListInput, optFns ...func(*ListMembersOfAddressListPaginatorOptions)) *ListMembersOfAddressListPaginator

NewListMembersOfAddressListPaginator returns a new ListMembersOfAddressListPaginator

func (*ListMembersOfAddressListPaginator) HasMorePages added in v1.8.0 

func (p *ListMembersOfAddressListPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListMembersOfAddressListPaginator) NextPage added in v1.8.0 

func (p *ListMembersOfAddressListPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListMembersOfAddressListOutput, error)

NextPage retrieves the next ListMembersOfAddressList page.

type ListMembersOfAddressListPaginatorOptions added in v1.8.0 

type ListMembersOfAddressListPaginatorOptions struct {
	// The maximum number of address list members that are returned per call. You can
	// use NextToken to retrieve the next page of members.
	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
}

ListMembersOfAddressListPaginatorOptions is the paginator options for ListMembersOfAddressList

type ListRelaysAPIClient 

type ListRelaysAPIClient interface {
	ListRelays(context.Context, *ListRelaysInput, ...func(*Options)) (*ListRelaysOutput, error)
}

ListRelaysAPIClient is a client that implements the ListRelays operation.

type ListRelaysInput 

type ListRelaysInput struct {

	// If you received a pagination token from a previous call to this API, you can
	// provide it here to continue paginating through the next page of results.
	NextToken *string

	// The number of relays to be returned in one request.
	PageSize *int32
	// contains filtered or unexported fields
}

type ListRelaysOutput 

type ListRelaysOutput struct {

	// The list of returned relays.
	//
	// This member is required.
	Relays []types.Relay

	// If NextToken is returned, there are more results available. The value of
	// NextToken is a unique pagination token for each page. Make the call again using
	// the returned token to retrieve the next page.
	NextToken *string

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

type ListRelaysPaginator 

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

ListRelaysPaginator is a paginator for ListRelays

func NewListRelaysPaginator 

func NewListRelaysPaginator(client ListRelaysAPIClient, params *ListRelaysInput, optFns ...func(*ListRelaysPaginatorOptions)) *ListRelaysPaginator

NewListRelaysPaginator returns a new ListRelaysPaginator

func (*ListRelaysPaginator) HasMorePages 

func (p *ListRelaysPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListRelaysPaginator) NextPage 

func (p *ListRelaysPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListRelaysOutput, error)

NextPage retrieves the next ListRelays page.

type ListRelaysPaginatorOptions 

type ListRelaysPaginatorOptions struct {
	// The number of relays to be returned in one request.
	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
}

ListRelaysPaginatorOptions is the paginator options for ListRelays

type ListRuleSetsAPIClient 

type ListRuleSetsAPIClient interface {
	ListRuleSets(context.Context, *ListRuleSetsInput, ...func(*Options)) (*ListRuleSetsOutput, error)
}

ListRuleSetsAPIClient is a client that implements the ListRuleSets operation.

type ListRuleSetsInput 

type ListRuleSetsInput struct {

	// If you received a pagination token from a previous call to this API, you can
	// provide it here to continue paginating through the next page of results.
	NextToken *string

	// The maximum number of rule set resources that are returned per call. You can
	// use NextToken to obtain further rule sets.
	PageSize *int32
	// contains filtered or unexported fields
}

type ListRuleSetsOutput 

type ListRuleSetsOutput struct {

	// The list of rule sets.
	//
	// This member is required.
	RuleSets []types.RuleSet

	// If NextToken is returned, there are more results available. The value of
	// NextToken is a unique pagination token for each page. Make the call again using
	// the returned token to retrieve the next page.
	NextToken *string

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

type ListRuleSetsPaginator 

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

ListRuleSetsPaginator is a paginator for ListRuleSets

func NewListRuleSetsPaginator 

func NewListRuleSetsPaginator(client ListRuleSetsAPIClient, params *ListRuleSetsInput, optFns ...func(*ListRuleSetsPaginatorOptions)) *ListRuleSetsPaginator

NewListRuleSetsPaginator returns a new ListRuleSetsPaginator

func (*ListRuleSetsPaginator) HasMorePages 

func (p *ListRuleSetsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListRuleSetsPaginator) NextPage 

func (p *ListRuleSetsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListRuleSetsOutput, error)

NextPage retrieves the next ListRuleSets page.

type ListRuleSetsPaginatorOptions 

type ListRuleSetsPaginatorOptions struct {
	// The maximum number of rule set resources that are returned per call. You can
	// use NextToken to obtain further rule sets.
	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
}

ListRuleSetsPaginatorOptions is the paginator options for ListRuleSets

type ListTagsForResourceInput 

type ListTagsForResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource to retrieve tags from.
	//
	// This member is required.
	ResourceArn *string
	// contains filtered or unexported fields
}

type ListTagsForResourceOutput 

type ListTagsForResourceOutput struct {

	// The tags used to organize, track, or control access for the resource. For
	// example, { "tags": {"key1":"value1", "key2":"value2"} }.
	//
	// This member is required.
	Tags []types.Tag

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

type ListTrafficPoliciesAPIClient 

type ListTrafficPoliciesAPIClient interface {
	ListTrafficPolicies(context.Context, *ListTrafficPoliciesInput, ...func(*Options)) (*ListTrafficPoliciesOutput, error)
}

ListTrafficPoliciesAPIClient is a client that implements the ListTrafficPolicies operation.

type ListTrafficPoliciesInput 

type ListTrafficPoliciesInput struct {

	// If you received a pagination token from a previous call to this API, you can
	// provide it here to continue paginating through the next page of results.
	NextToken *string

	// The maximum number of traffic policy resources that are returned per call. You
	// can use NextToken to obtain further traffic policies.
	PageSize *int32
	// contains filtered or unexported fields
}

type ListTrafficPoliciesOutput 

type ListTrafficPoliciesOutput struct {

	// If NextToken is returned, there are more results available. The value of
	// NextToken is a unique pagination token for each page. Make the call again using
	// the returned token to retrieve the next page.
	NextToken *string

	// The list of traffic policies.
	TrafficPolicies []types.TrafficPolicy

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

type ListTrafficPoliciesPaginator 

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

ListTrafficPoliciesPaginator is a paginator for ListTrafficPolicies

func NewListTrafficPoliciesPaginator 

func NewListTrafficPoliciesPaginator(client ListTrafficPoliciesAPIClient, params *ListTrafficPoliciesInput, optFns ...func(*ListTrafficPoliciesPaginatorOptions)) *ListTrafficPoliciesPaginator

NewListTrafficPoliciesPaginator returns a new ListTrafficPoliciesPaginator

func (*ListTrafficPoliciesPaginator) HasMorePages 

func (p *ListTrafficPoliciesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListTrafficPoliciesPaginator) NextPage 

func (p *ListTrafficPoliciesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListTrafficPoliciesOutput, error)

NextPage retrieves the next ListTrafficPolicies page.

type ListTrafficPoliciesPaginatorOptions 

type ListTrafficPoliciesPaginatorOptions struct {
	// The maximum number of traffic policy resources that are returned per call. You
	// can use NextToken to obtain further traffic policies.
	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
}

ListTrafficPoliciesPaginatorOptions is the paginator options for ListTrafficPolicies

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

	// Provides idempotency tokens values that will be automatically populated into
	// idempotent API operations.
	IdempotencyTokenProvider IdempotencyTokenProvider

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

	// The client meter provider.
	MeterProvider metrics.MeterProvider

	// 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 client tracer provider.
	TracerProvider tracing.TracerProvider

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

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

type RegisterMemberToAddressListInput added in v1.8.0 

type RegisterMemberToAddressListInput struct {

	// The address to be added to the address list.
	//
	// This member is required.
	Address *string

	// The unique identifier of the address list where the address should be added.
	//
	// This member is required.
	AddressListId *string
	// contains filtered or unexported fields
}

type RegisterMemberToAddressListOutput added in v1.8.0 

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

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 StartAddressListImportJobInput added in v1.8.0 

type StartAddressListImportJobInput struct {

	// The identifier of the import job that needs to be started.
	//
	// This member is required.
	JobId *string
	// contains filtered or unexported fields
}

type StartAddressListImportJobOutput added in v1.8.0 

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

type StartArchiveExportInput 

type StartArchiveExportInput struct {

	// The identifier of the archive to export emails from.
	//
	// This member is required.
	ArchiveId *string

	// Details on where to deliver the exported email data.
	//
	// This member is required.
	ExportDestinationConfiguration types.ExportDestinationConfiguration

	// The start of the timestamp range to include emails from.
	//
	// This member is required.
	FromTimestamp *time.Time

	// The end of the timestamp range to include emails from.
	//
	// This member is required.
	ToTimestamp *time.Time

	// Criteria to filter which emails are included in the export.
	Filters *types.ArchiveFilters

	// Whether to include message metadata as JSON files in the export.
	IncludeMetadata *bool

	// The maximum number of email items to include in the export.
	MaxResults *int32
	// contains filtered or unexported fields
}

The request to initiate an export of emails from an archive.

type StartArchiveExportOutput 

type StartArchiveExportOutput struct {

	// The unique identifier for the initiated export job.
	ExportId *string

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

The response from initiating an archive export.

type StartArchiveSearchInput 

type StartArchiveSearchInput struct {

	// The identifier of the archive to search emails in.
	//
	// This member is required.
	ArchiveId *string

	// The start timestamp of the range to search emails from.
	//
	// This member is required.
	FromTimestamp *time.Time

	// The maximum number of search results to return.
	//
	// This member is required.
	MaxResults *int32

	// The end timestamp of the range to search emails from.
	//
	// This member is required.
	ToTimestamp *time.Time

	// Criteria to filter which emails are included in the search results.
	Filters *types.ArchiveFilters
	// contains filtered or unexported fields
}

The request to initiate a search across emails in an archive.

type StartArchiveSearchOutput 

type StartArchiveSearchOutput struct {

	// The unique identifier for the initiated search job.
	SearchId *string

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

The response from initiating an archive search.

type StopAddressListImportJobInput added in v1.8.0 

type StopAddressListImportJobInput struct {

	// The identifier of the import job that needs to be stopped.
	//
	// This member is required.
	JobId *string
	// contains filtered or unexported fields
}

type StopAddressListImportJobOutput added in v1.8.0 

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

type StopArchiveExportInput 

type StopArchiveExportInput struct {

	// The identifier of the export job to stop.
	//
	// This member is required.
	ExportId *string
	// contains filtered or unexported fields
}

The request to stop an in-progress archive export job.

type StopArchiveExportOutput 

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

The response indicating if the request to stop the export job succeeded.

On success, returns an HTTP 200 status code. On failure, returns an error message.

type StopArchiveSearchInput 

type StopArchiveSearchInput struct {

	// The identifier of the search job to stop.
	//
	// This member is required.
	SearchId *string
	// contains filtered or unexported fields
}

The request to stop an in-progress archive search job.

type StopArchiveSearchOutput 

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

The response indicating if the request to stop the search job succeeded.

On success, returns an HTTP 200 status code. On failure, returns an error message.

type TagResourceInput 

type TagResourceInput struct {

	//  The Amazon Resource Name (ARN) of the resource that you want to tag.
	//
	// This member is required.
	ResourceArn *string

	//  The tags used to organize, track, or control access for the resource. For
	// example, { "tags": {"key1":"value1", "key2":"value2"} }.
	//
	// 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 UntagResourceInput 

type UntagResourceInput struct {

	//  The Amazon Resource Name (ARN) of the resource that you want to untag.
	//
	// This member is required.
	ResourceArn *string

	//  The keys of the key-value pairs for the tag or tags you want to remove from
	// the specified resource.
	//
	// 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 UpdateArchiveInput 

type UpdateArchiveInput struct {

	// The identifier of the archive to update.
	//
	// This member is required.
	ArchiveId *string

	// A new, unique name for the archive.
	ArchiveName *string

	// A new retention period for emails in the archive.
	Retention types.ArchiveRetention
	// contains filtered or unexported fields
}

The request to update properties of an existing email archive.

type UpdateArchiveOutput 

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

The response indicating if the archive update succeeded or failed.

On success, returns an HTTP 200 status code. On failure, returns an error message.

type UpdateIngressPointInput 

type UpdateIngressPointInput struct {

	// The identifier for the ingress endpoint you want to update.
	//
	// This member is required.
	IngressPointId *string

	// If you choose an Authenticated ingress endpoint, you must configure either an
	// SMTP password or a secret ARN.
	IngressPointConfiguration types.IngressPointConfiguration

	// A user friendly name for the ingress endpoint resource.
	IngressPointName *string

	// The identifier of an existing rule set that you attach to an ingress endpoint
	// resource.
	RuleSetId *string

	// The update status of an ingress endpoint.
	StatusToUpdate types.IngressPointStatusToUpdate

	// The identifier of an existing traffic policy that you attach to an ingress
	// endpoint resource.
	TrafficPolicyId *string
	// contains filtered or unexported fields
}

type UpdateIngressPointOutput 

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

type UpdateRelayInput 

type UpdateRelayInput struct {

	// The unique relay identifier.
	//
	// This member is required.
	RelayId *string

	// Authentication for the relay destination server—specify the secretARN where the
	// SMTP credentials are stored.
	Authentication types.RelayAuthentication

	// The name of the relay resource.
	RelayName *string

	// The destination relay server address.
	ServerName *string

	// The destination relay server port.
	ServerPort *int32
	// contains filtered or unexported fields
}

type UpdateRelayOutput 

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

type UpdateRuleSetInput 

type UpdateRuleSetInput struct {

	// The identifier of a rule set you want to update.
	//
	// This member is required.
	RuleSetId *string

	// A user-friendly name for the rule set resource.
	RuleSetName *string

	// A new set of rules to replace the current rules of the rule set—these rules
	// will override all the rules of the rule set.
	Rules []types.Rule
	// contains filtered or unexported fields
}

type UpdateRuleSetOutput 

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

type UpdateTrafficPolicyInput 

type UpdateTrafficPolicyInput struct {

	// The identifier of the traffic policy that you want to update.
	//
	// This member is required.
	TrafficPolicyId *string

	// Default action instructs the traffic policy to either Allow or Deny (block)
	// messages that fall outside of (or not addressed by) the conditions of your
	// policy statements
	DefaultAction types.AcceptAction

	// The maximum message size in bytes of email which is allowed in by this traffic
	// policy—anything larger will be blocked.
	MaxMessageSizeBytes *int32

	// The list of conditions to be updated for filtering email traffic.
	PolicyStatements []types.PolicyStatement

	// A user-friendly name for the traffic policy resource.
	TrafficPolicyName *string
	// contains filtered or unexported fields
}

type UpdateTrafficPolicyOutput 

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

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.