ess

package
v1.28.0 Latest Latest
Warning

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

 Go to latest Published: Aug 30, 2024 License: Apache-2.0 Imports: 39 Imported by: 4

Documentation

Overview

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

Index

Constants

View Source 
const ServiceAPIVersion = "2010-12-01N2014-05-28"
View Source 
const ServiceID = "ess"

Variables

This section is empty.

Functions

func NewDefaultEndpointResolver added in v1.14.0 

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

func WithAPIOptions added in v1.14.0 

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

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

func WithEndpointResolver added in v1.14.0 

func WithEndpointResolver(v EndpointResolver) func(*Options)

WithEndpointResolver returns a functional option for setting the Client's EndpointResolver option.

Types

type Client 

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

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

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

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

NewFromConfig returns a new client from the provided config.

func (*Client) DeleteIdentity added in v1.14.0 

func (c *Client) DeleteIdentity(ctx context.Context, params *DeleteIdentityInput, optFns ...func(*Options)) (*DeleteIdentityOutput, error)

func (*Client) GetDeliveryLog added in v1.14.0 

func (c *Client) GetDeliveryLog(ctx context.Context, params *GetDeliveryLogInput, optFns ...func(*Options)) (*GetDeliveryLogOutput, error)

func (*Client) GetIdentityDkimAttributes added in v1.14.0 

func (c *Client) GetIdentityDkimAttributes(ctx context.Context, params *GetIdentityDkimAttributesInput, optFns ...func(*Options)) (*GetIdentityDkimAttributesOutput, error)

func (*Client) GetIdentityVerificationAttributes added in v1.14.0 

func (c *Client) GetIdentityVerificationAttributes(ctx context.Context, params *GetIdentityVerificationAttributesInput, optFns ...func(*Options)) (*GetIdentityVerificationAttributesOutput, error)

func (*Client) GetSendQuota added in v1.14.0 

func (c *Client) GetSendQuota(ctx context.Context, params *GetSendQuotaInput, optFns ...func(*Options)) (*GetSendQuotaOutput, error)

func (*Client) GetSendStatistics added in v1.14.0 

func (c *Client) GetSendStatistics(ctx context.Context, params *GetSendStatisticsInput, optFns ...func(*Options)) (*GetSendStatisticsOutput, error)

func (*Client) ListIdentities added in v1.14.0 

func (c *Client) ListIdentities(ctx context.Context, params *ListIdentitiesInput, optFns ...func(*Options)) (*ListIdentitiesOutput, error)

func (*Client) SendEmail added in v1.14.0 

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

func (*Client) SendRawEmail added in v1.14.0 

func (c *Client) SendRawEmail(ctx context.Context, params *SendRawEmailInput, optFns ...func(*Options)) (*SendRawEmailOutput, error)

func (*Client) SetIdentityDkimEnabled added in v1.14.0 

func (c *Client) SetIdentityDkimEnabled(ctx context.Context, params *SetIdentityDkimEnabledInput, optFns ...func(*Options)) (*SetIdentityDkimEnabledOutput, error)

func (*Client) VerifyDomainDkim added in v1.14.0 

func (c *Client) VerifyDomainDkim(ctx context.Context, params *VerifyDomainDkimInput, optFns ...func(*Options)) (*VerifyDomainDkimOutput, error)

func (*Client) VerifyDomainIdentity added in v1.14.0 

func (c *Client) VerifyDomainIdentity(ctx context.Context, params *VerifyDomainIdentityInput, optFns ...func(*Options)) (*VerifyDomainIdentityOutput, error)

func (*Client) VerifyEmailIdentity added in v1.14.0 

func (c *Client) VerifyEmailIdentity(ctx context.Context, params *VerifyEmailIdentityInput, optFns ...func(*Options)) (*VerifyEmailIdentityOutput, error)

type DeleteIdentityInput 

type DeleteIdentityInput struct {

	// This member is required.
	Identity *string
	// contains filtered or unexported fields
}

type DeleteIdentityOutput 

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

type EndpointParameters added in v1.22.1 

type EndpointParameters struct {
}

EndpointParameters provides the parameters that influence how endpoints are resolved.

type EndpointResolver added in v1.14.0 

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

EndpointResolver interface for resolving service endpoints.

func EndpointResolverFromURL added in v1.14.0 

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

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

type EndpointResolverFunc added in v1.14.0 

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

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

type EndpointResolverOptions added in v1.14.0 

type EndpointResolverOptions = internalendpoints.Options

EndpointResolverOptions is the service endpoint resolver options

type EndpointResolverV2 added in v1.22.1 

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

EndpointResolverV2 provides the interface for resolving service endpoints.

func NewDefaultEndpointResolverV2 added in v1.22.1 

func NewDefaultEndpointResolverV2() EndpointResolverV2

type GetDeliveryLogInput 

type GetDeliveryLogInput struct {

	// This member is required.
	EndDate *time.Time

	// This member is required.
	StartDate *time.Time

	MaxItems *int32

	NextToken *string

	Status *int32
	// contains filtered or unexported fields
}

type GetDeliveryLogOutput 

type GetDeliveryLogOutput struct {
	Log *string

	LogCount *string

	NextToken *string

	ResponseMetadata *types.ResponseMetadata

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

type GetIdentityDkimAttributesInput 

type GetIdentityDkimAttributesInput struct {

	// This member is required.
	Identities []string
	// contains filtered or unexported fields
}

type GetIdentityDkimAttributesOutput 

type GetIdentityDkimAttributesOutput struct {
	DkimAttributes []types.DkimAttributes

	ResponseMetadata *types.ResponseMetadata

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

type GetIdentityVerificationAttributesInput 

type GetIdentityVerificationAttributesInput struct {

	// This member is required.
	Identities []string
	// contains filtered or unexported fields
}

type GetIdentityVerificationAttributesOutput 

type GetIdentityVerificationAttributesOutput struct {
	ResponseMetadata *types.ResponseMetadata

	VerificationAttributes []types.VerificationAttributes

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

type GetSendQuotaInput 

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

type GetSendQuotaOutput 

type GetSendQuotaOutput struct {
	Max24HourSend *float64

	MaxSendRate *float64

	ResponseMetadata *types.ResponseMetadata

	SentLast24Hours *float64

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

type GetSendStatisticsInput 

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

type GetSendStatisticsOutput 

type GetSendStatisticsOutput struct {
	ResponseMetadata *types.ResponseMetadata

	SendDataPoints []types.SendDataPoints

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

type HTTPClient added in v1.14.0 

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

type HTTPSignerV4 added in v1.14.0 

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 ListIdentitiesInput 

type ListIdentitiesInput struct {
	IdentityType types.IdentityTypeOfListIdentitiesRequest

	MaxItems *int32

	NextToken *string
	// contains filtered or unexported fields
}

type ListIdentitiesOutput 

type ListIdentitiesOutput struct {
	Identities []string

	NextToken *string

	ResponseMetadata *types.ResponseMetadata

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

type Options added in v1.14.0 

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

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

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

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

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

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

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

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

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

	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
	// implementation if nil.
	HTTPClient HTTPClient
	// contains filtered or unexported fields
}

func (Options) Copy added in v1.14.0 

func (o Options) Copy() Options

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

type ResolveEndpoint added in v1.14.0 

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  EndpointResolverOptions
}

func (*ResolveEndpoint) HandleSerialize added in v1.14.0 

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

func (*ResolveEndpoint) ID added in v1.14.0 

func (*ResolveEndpoint) ID() string

type SendEmailInput 

type SendEmailInput struct {

	// This member is required.
	Source *string

	Destination *types.RequestDestination

	Message *types.RequestMessage

	ReplyToAddresses []string

	ReturnPath *string
	// contains filtered or unexported fields
}

type SendEmailOutput 

type SendEmailOutput struct {
	MessageId *string

	ResponseMetadata *types.ResponseMetadata

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

type SendRawEmailInput 

type SendRawEmailInput struct {

	// This member is required.
	RawMessage *types.RequestRawMessage

	Destinations []string

	Source *string
	// contains filtered or unexported fields
}

type SendRawEmailOutput 

type SendRawEmailOutput struct {
	MessageId *string

	ResponseMetadata *types.ResponseMetadata

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

type SetIdentityDkimEnabledInput 

type SetIdentityDkimEnabledInput struct {

	// This member is required.
	DkimEnabled types.DkimEnabledOfSetIdentityDkimEnabledRequest

	// This member is required.
	Identity *string
	// contains filtered or unexported fields
}

type SetIdentityDkimEnabledOutput 

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

type VerifyDomainDkimInput 

type VerifyDomainDkimInput struct {

	// This member is required.
	Domain *string
	// contains filtered or unexported fields
}

type VerifyDomainDkimOutput 

type VerifyDomainDkimOutput struct {
	DkimTokens []string

	ResponseMetadata *types.ResponseMetadata

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

type VerifyDomainIdentityInput 

type VerifyDomainIdentityInput struct {

	// This member is required.
	Domain *string
	// contains filtered or unexported fields
}

type VerifyDomainIdentityOutput 

type VerifyDomainIdentityOutput struct {
	ResponseMetadata *types.ResponseMetadata

	VerificationToken *string

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

type VerifyEmailIdentityInput 

type VerifyEmailIdentityInput struct {

	// This member is required.
	EmailAddress *string
	// contains filtered or unexported fields
}

type VerifyEmailIdentityOutput 

type VerifyEmailIdentityOutput struct {
	ResponseMetadata *types.ResponseMetadata

	VerifyEmailIdentityResult *string

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