package pinpointsmsvoice
import "github.com/aws/aws-sdk-go-v2/service/pinpointsmsvoice"
Package pinpointsmsvoice provides the API client, operations, and parameter types for Amazon Pinpoint SMS and Voice Service.
Pinpoint SMS and Voice Messaging public facing APIs
Index ¶
- Constants
- func NewDefaultEndpointResolver() *internalendpoints.Resolver
- func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)
- func WithEndpointResolver(v EndpointResolver) func(*Options)
- type Client
- func New(options Options, optFns ...func(*Options)) *Client
- func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client
- func (c *Client) CreateConfigurationSet(ctx context.Context, params *CreateConfigurationSetInput, optFns ...func(*Options)) (*CreateConfigurationSetOutput, error)
- func (c *Client) CreateConfigurationSetEventDestination(ctx context.Context, params *CreateConfigurationSetEventDestinationInput, optFns ...func(*Options)) (*CreateConfigurationSetEventDestinationOutput, error)
- func (c *Client) DeleteConfigurationSet(ctx context.Context, params *DeleteConfigurationSetInput, optFns ...func(*Options)) (*DeleteConfigurationSetOutput, error)
- func (c *Client) DeleteConfigurationSetEventDestination(ctx context.Context, params *DeleteConfigurationSetEventDestinationInput, optFns ...func(*Options)) (*DeleteConfigurationSetEventDestinationOutput, error)
- func (c *Client) GetConfigurationSetEventDestinations(ctx context.Context, params *GetConfigurationSetEventDestinationsInput, optFns ...func(*Options)) (*GetConfigurationSetEventDestinationsOutput, error)
- func (c *Client) ListConfigurationSets(ctx context.Context, params *ListConfigurationSetsInput, optFns ...func(*Options)) (*ListConfigurationSetsOutput, error)
- func (c *Client) SendVoiceMessage(ctx context.Context, params *SendVoiceMessageInput, optFns ...func(*Options)) (*SendVoiceMessageOutput, error)
- func (c *Client) UpdateConfigurationSetEventDestination(ctx context.Context, params *UpdateConfigurationSetEventDestinationInput, optFns ...func(*Options)) (*UpdateConfigurationSetEventDestinationOutput, error)
- type CreateConfigurationSetEventDestinationInput
- type CreateConfigurationSetEventDestinationOutput
- type CreateConfigurationSetInput
- type CreateConfigurationSetOutput
- type DeleteConfigurationSetEventDestinationInput
- type DeleteConfigurationSetEventDestinationOutput
- type DeleteConfigurationSetInput
- type DeleteConfigurationSetOutput
- type EndpointResolver
- type EndpointResolverFunc
- type EndpointResolverOptions
- type GetConfigurationSetEventDestinationsInput
- type GetConfigurationSetEventDestinationsOutput
- type HTTPClient
- type HTTPSignerV4
- type ListConfigurationSetsInput
- type ListConfigurationSetsOutput
- type Options
- type ResolveEndpoint
- func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) ( out middleware.SerializeOutput, metadata middleware.Metadata, err error, )
- func (*ResolveEndpoint) ID() string
- type SendVoiceMessageInput
- type SendVoiceMessageOutput
- type UpdateConfigurationSetEventDestinationInput
- type UpdateConfigurationSetEventDestinationOutput
Constants ¶
const ServiceAPIVersion = "2018-09-05"
const ServiceID = "Pinpoint SMS Voice"
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 ¶
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 Amazon Pinpoint SMS and Voice Service.
func New ¶
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 ¶
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 // contains filtered or unexported fields }
Create a new event destination in a configuration set.
type CreateConfigurationSetEventDestinationOutput ¶
type CreateConfigurationSetEventDestinationOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
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 // contains filtered or unexported fields }
A request to create a new configuration set.
type CreateConfigurationSetOutput ¶
type CreateConfigurationSetOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
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 // contains filtered or unexported fields }
type DeleteConfigurationSetEventDestinationOutput ¶
type DeleteConfigurationSetEventDestinationOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
An empty object that indicates that the event destination was deleted successfully.
type DeleteConfigurationSetInput ¶
type DeleteConfigurationSetInput struct { // ConfigurationSetName // // This member is required. ConfigurationSetName *string // contains filtered or unexported fields }
type DeleteConfigurationSetOutput ¶
type DeleteConfigurationSetOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
An empty object that indicates that the configuration set was deleted successfully.
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 GetConfigurationSetEventDestinationsInput ¶
type GetConfigurationSetEventDestinationsInput struct { // ConfigurationSetName // // This member is required. ConfigurationSetName *string // contains filtered or unexported fields }
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 // contains filtered or unexported fields }
An object that contains information about an event destination.
type HTTPClient ¶
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 ListConfigurationSetsInput ¶
type ListConfigurationSetsInput struct { // A token returned from a previous call to the API that indicates the position in // the list of results. NextToken *string // Used to specify the number of items that should be returned in the response. PageSize *string // contains filtered or unexported fields }
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 // contains filtered or unexported fields }
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 // 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 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 // Retryer guides how HTTP requests should be retried in case of recoverable // failures. When nil the API client will use a default retryer. Retryer aws.Retryer // The HTTP client to invoke API calls with. Defaults to client's default HTTP // implementation if nil. HTTPClient HTTPClient }
func (Options) Copy ¶
Copy creates a clone where the APIOptions list is deep copied.
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 SendVoiceMessageInput ¶
type SendVoiceMessageInput struct { // The phone number that appears on recipients' devices when they receive the // message. CallerId *string // The name of the configuration set that you want to use to send the message. ConfigurationSetName *string // An object that contains a voice message and information about the recipient that // you want to send it to. Content *types.VoiceMessageContent // The phone number that you want to send the voice message to. DestinationPhoneNumber *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 // contains filtered or unexported fields }
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 // contains filtered or unexported fields }
An object that that contains the Message ID of a Voice message that was sent successfully.
type UpdateConfigurationSetEventDestinationInput ¶
type UpdateConfigurationSetEventDestinationInput struct { // ConfigurationSetName // // This member is required. ConfigurationSetName *string // EventDestinationName // // This member is required. EventDestinationName *string // An object that defines a single event destination. EventDestination *types.EventDestinationDefinition // contains filtered or unexported fields }
UpdateConfigurationSetEventDestinationRequest
type UpdateConfigurationSetEventDestinationOutput ¶
type UpdateConfigurationSetEventDestinationOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
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 doc.go endpoints.go go_module_metadata.go serializers.go validators.go
Directories ¶
Path | Synopsis |
---|---|
internal | |
types |
- Version
- v1.4.2
- Published
- Oct 11, 2021
- Platform
- js/wasm
- Imports
- 27 packages
- Last checked
- now –
Tools for package owners.