pinpointsmsvoice – github.com/aws/aws-sdk-go-v2/service/pinpointsmsvoice Index | Files | Directories

package pinpointsmsvoice

import "github.com/aws/aws-sdk-go-v2/service/pinpointsmsvoice"

Index

Constants

const ServiceAPIVersion = "2018-09-05"
const ServiceID = "Pinpoint SMS Voice"

Functions

func AddResolveEndpointMiddleware

func AddResolveEndpointMiddleware(stack *middleware.Stack, options ResolveEndpointMiddlewareOptions)

func NewDefaultEndpointResolver

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

func RemoveResolveEndpointMiddleware

func RemoveResolveEndpointMiddleware(stack *middleware.Stack) error

Types

type Client

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

Pinpoint SMS and Voice Messaging public facing APIs

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

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

Create a new configuration set. After you create the configuration set, you can add one or more event destinations to it.

func (*Client) CreateConfigurationSetEventDestination

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

Create a new event destination in a configuration set.

func (*Client) DeleteConfigurationSet

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

Deletes an existing configuration set.

func (*Client) DeleteConfigurationSetEventDestination

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

Deletes an event destination in a configuration set.

func (*Client) GetConfigurationSetEventDestinations

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

Obtain information about an event destination, including the types of events it reports, the Amazon Resource Name (ARN) of the destination, and the name of the event destination.

func (*Client) ListConfigurationSets

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

List all of the configuration sets associated with your Amazon Pinpoint account in the current region.

func (*Client) SendVoiceMessage

func (c *Client) SendVoiceMessage(ctx context.Context, params *SendVoiceMessageInput, optFns ...func(*Options)) (*SendVoiceMessageOutput, error)

Create a new voice message and send it to a recipient's phone number.

func (*Client) UpdateConfigurationSetEventDestination

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

Update an event destination in a configuration set. An event destination is a location that you publish information about your voice calls to. For example, you can log an event to an Amazon CloudWatch destination when a call fails.

type CreateConfigurationSetEventDestinationInput

type CreateConfigurationSetEventDestinationInput struct {

	// ConfigurationSetName
	//
	// This member is required.
	ConfigurationSetName *string

	// An object that defines a single event destination.
	EventDestination *types.EventDestinationDefinition

	// A name that identifies the event destination.
	EventDestinationName *string
}

Create a new event destination in a configuration set.

type CreateConfigurationSetEventDestinationOutput

type CreateConfigurationSetEventDestinationOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

An empty object that indicates that the event destination was created successfully.

type CreateConfigurationSetInput

type CreateConfigurationSetInput struct {

	// The name that you want to give the configuration set.
	ConfigurationSetName *string
}

A request to create a new configuration set.

type CreateConfigurationSetOutput

type CreateConfigurationSetOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

An empty object that indicates that the configuration set was successfully created.

type DeleteConfigurationSetEventDestinationInput

type DeleteConfigurationSetEventDestinationInput struct {

	// ConfigurationSetName
	//
	// This member is required.
	ConfigurationSetName *string

	// EventDestinationName
	//
	// This member is required.
	EventDestinationName *string
}

type DeleteConfigurationSetEventDestinationOutput

type DeleteConfigurationSetEventDestinationOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

An empty object that indicates that the event destination was deleted successfully.

type DeleteConfigurationSetInput

type DeleteConfigurationSetInput struct {

	// ConfigurationSetName
	//
	// This member is required.
	ConfigurationSetName *string
}

type DeleteConfigurationSetOutput

type DeleteConfigurationSetOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

An empty object that indicates that the configuration set was deleted successfully.

type EndpointResolver

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

EndpointResolver interface for resolving service endpoints.

func WithEndpointResolver

func WithEndpointResolver(awsResolver aws.EndpointResolver, fallbackResolver EndpointResolver) EndpointResolver

WithEndpointResolver returns an EndpointResolver that first delegates endpoint resolution to the awsResolver. If awsResolver returns aws.EndpointNotFoundError error, the resolver will use the the provided fallbackResolver for resolution. awsResolver and fallbackResolver must not be nil

type EndpointResolverFunc

type EndpointResolverFunc func(region string, options ResolverOptions) (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 ResolverOptions) (endpoint aws.Endpoint, err error)

type GetConfigurationSetEventDestinationsInput

type GetConfigurationSetEventDestinationsInput struct {

	// ConfigurationSetName
	//
	// This member is required.
	ConfigurationSetName *string
}

type GetConfigurationSetEventDestinationsOutput

type GetConfigurationSetEventDestinationsOutput struct {

	// An array of EventDestination objects. Each EventDestination object includes ARNs
	// and other information that define an event destination.
	EventDestinations []*types.EventDestination

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

An object that contains information about an event destination.

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) error
}

type ListConfigurationSetsInput

type ListConfigurationSetsInput struct {

	// Used to specify the number of items that should be returned in the response.
	PageSize *string

	// A token returned from a previous call to the API that indicates the position in
	// the list of results.
	NextToken *string
}

type ListConfigurationSetsOutput

type ListConfigurationSetsOutput struct {

	// An object that contains a list of configuration sets for your account in the
	// current region.
	ConfigurationSets []*string

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

An object that contains information about the configuration sets for your account in the current region.

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 credentials object to use when signing requests.
	Credentials aws.CredentialsProvider

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

	// The service endpoint resolver.
	EndpointResolver EndpointResolver

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

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

	// Retryer guides how HTTP requests should be retried in case of recoverable
	// failures. When nil the API client will use a default retryer.
	Retryer retry.Retryer

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

func (Options) Copy

func (o Options) Copy() Options

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

func (Options) GetCredentials

func (o Options) GetCredentials() aws.CredentialsProvider

func (Options) GetEndpointOptions

func (o Options) GetEndpointOptions() ResolverOptions

func (Options) GetEndpointResolver

func (o Options) GetEndpointResolver() EndpointResolver

func (Options) GetHTTPSignerV4

func (o Options) GetHTTPSignerV4() HTTPSignerV4

func (Options) GetRegion

func (o Options) GetRegion() string

func (Options) GetRetryer

func (o Options) GetRetryer() retry.Retryer

type ResolveEndpoint

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  ResolverOptions
}

func (*ResolveEndpoint) HandleSerialize

func (*ResolveEndpoint) ID

func (*ResolveEndpoint) ID() string

type ResolveEndpointMiddlewareOptions

type ResolveEndpointMiddlewareOptions interface {
	GetEndpointResolver() EndpointResolver
	GetEndpointOptions() ResolverOptions
}

type ResolverOptions

type ResolverOptions = internalendpoints.Options

ResolverOptions is the service endpoint resolver options

type SendVoiceMessageInput

type SendVoiceMessageInput struct {

	// The phone number that appears on recipients' devices when they receive the
	// message.
	CallerId *string

	// An object that contains a voice message and information about the recipient that
	// you want to send it to.
	Content *types.VoiceMessageContent

	// The name of the configuration set that you want to use to send the message.
	ConfigurationSetName *string

	// The phone number that Amazon Pinpoint should use to send the voice message. This
	// isn't necessarily the phone number that appears on recipients' devices when they
	// receive the message, because you can specify a CallerId parameter in the
	// request.
	OriginationPhoneNumber *string

	// The phone number that you want to send the voice message to.
	DestinationPhoneNumber *string
}

SendVoiceMessageRequest

type SendVoiceMessageOutput

type SendVoiceMessageOutput struct {

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

An object that that contains the Message ID of a Voice message that was sent successfully.

type UpdateConfigurationSetEventDestinationInput

type UpdateConfigurationSetEventDestinationInput struct {

	// An object that defines a single event destination.
	EventDestination *types.EventDestinationDefinition

	// EventDestinationName
	//
	// This member is required.
	EventDestinationName *string

	// ConfigurationSetName
	//
	// This member is required.
	ConfigurationSetName *string
}

UpdateConfigurationSetEventDestinationRequest

type UpdateConfigurationSetEventDestinationOutput

type UpdateConfigurationSetEventDestinationOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

An empty object that indicates that the event destination was updated successfully.

Source Files

api_client.go api_op_CreateConfigurationSet.go api_op_CreateConfigurationSetEventDestination.go api_op_DeleteConfigurationSet.go api_op_DeleteConfigurationSetEventDestination.go api_op_GetConfigurationSetEventDestinations.go api_op_ListConfigurationSets.go api_op_SendVoiceMessage.go api_op_UpdateConfigurationSetEventDestination.go deserializers.go endpoints.go serializers.go validators.go

Directories

PathSynopsis
internal
types
Version
v0.26.0
Published
Oct 1, 2020
Platform
js/wasm
Imports
24 packages
Last checked
now

Tools for package owners.