pinpointsmsvoice

package
v0.6.0 Latest Latest
Warning

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

 Go to latest Published: Dec 3, 2018 License: Apache-2.0 Imports: 5 Imported by: 7

Documentation

Overview

Package pinpointsmsvoice provides the client and types for making API requests to Amazon Pinpoint SMS and Voice Service.

Pinpoint SMS and Voice Messaging public facing APIs

See https://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-2018-09-05 for more information on this service.

See pinpointsmsvoice package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/pinpointsmsvoice/

Using the Client

To Amazon Pinpoint SMS and Voice Service with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the Amazon Pinpoint SMS and Voice Service client PinpointSMSVoice for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/pinpointsmsvoice/#New

Index

Constants

View Source 
const (

	// ErrCodeAlreadyExistsException for service response error code
	// "AlreadyExistsException".
	ErrCodeAlreadyExistsException = "AlreadyExistsException"

	// ErrCodeBadRequestException for service response error code
	// "BadRequestException".
	ErrCodeBadRequestException = "BadRequestException"

	// ErrCodeInternalServiceErrorException for service response error code
	// "InternalServiceErrorException".
	//
	// The API encountered an unexpected error and couldn't complete the request.
	// You might be able to successfully issue the request again in the future.
	ErrCodeInternalServiceErrorException = "InternalServiceErrorException"

	// ErrCodeLimitExceededException for service response error code
	// "LimitExceededException".
	ErrCodeLimitExceededException = "LimitExceededException"

	// ErrCodeNotFoundException for service response error code
	// "NotFoundException".
	ErrCodeNotFoundException = "NotFoundException"

	// ErrCodeTooManyRequestsException for service response error code
	// "TooManyRequestsException".
	ErrCodeTooManyRequestsException = "TooManyRequestsException"
)
View Source 
const (
	ServiceName = "sms-voice.pinpoint" // Service endpoint prefix API calls made to.
	EndpointsID = ServiceName          // Service ID for Regions and Endpoints metadata.
)

Service information constants

Variables

This section is empty.

Functions

This section is empty.

Types

type CallInstructionsMessageType 

type CallInstructionsMessageType struct {

	// The language to use when delivering the message. For a complete list of supported
	// languages, see the Amazon Polly Developer Guide.
	Text *string `type:"string"`
	// contains filtered or unexported fields
}

An object that defines a message that contains text formatted using Amazon Pinpoint Voice Instructions markup. Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-2018-09-05/CallInstructionsMessageType

func (CallInstructionsMessageType) GoString 

func (s CallInstructionsMessageType) GoString() string

GoString returns the string representation

func (CallInstructionsMessageType) MarshalFields 

func (s CallInstructionsMessageType) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CallInstructionsMessageType) String 

func (s CallInstructionsMessageType) String() string

String returns the string representation

type CloudWatchLogsDestination 

type CloudWatchLogsDestination struct {

	// The Amazon Resource Name (ARN) of an Amazon Identity and Access Management
	// (IAM) role that is able to write event data to an Amazon CloudWatch destination.
	IamRoleArn *string `type:"string"`

	// The name of the Amazon CloudWatch Log Group that you want to record events
	// in.
	LogGroupArn *string `type:"string"`
	// contains filtered or unexported fields
}

An object that contains information about a event destination that sends data to Amazon CloudWatch Logs. Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-2018-09-05/CloudWatchLogsDestination

func (CloudWatchLogsDestination) GoString 

func (s CloudWatchLogsDestination) GoString() string

GoString returns the string representation

func (CloudWatchLogsDestination) MarshalFields 

func (s CloudWatchLogsDestination) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CloudWatchLogsDestination) String 

func (s CloudWatchLogsDestination) String() string

String returns the string representation

type CreateConfigurationSetEventDestinationInput 

type CreateConfigurationSetEventDestinationInput struct {

	// ConfigurationSetName is a required field
	ConfigurationSetName *string `location:"uri" locationName:"ConfigurationSetName" type:"string" required:"true"`

	// An object that defines a single event destination.
	EventDestination *EventDestinationDefinition `type:"structure"`

	// A name that identifies the event destination.
	EventDestinationName *string `type:"string"`
	// contains filtered or unexported fields
}

Create a new event destination in a configuration set. Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-2018-09-05/CreateConfigurationSetEventDestinationRequest

func (CreateConfigurationSetEventDestinationInput) GoString 

func (s CreateConfigurationSetEventDestinationInput) GoString() string

GoString returns the string representation

func (CreateConfigurationSetEventDestinationInput) MarshalFields 

func (s CreateConfigurationSetEventDestinationInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CreateConfigurationSetEventDestinationInput) String 

func (s CreateConfigurationSetEventDestinationInput) String() string

String returns the string representation

func (*CreateConfigurationSetEventDestinationInput) Validate 

func (s *CreateConfigurationSetEventDestinationInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateConfigurationSetEventDestinationOutput 

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

An empty object that indicates that the event destination was created successfully. Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-2018-09-05/CreateConfigurationSetEventDestinationResponse

func (CreateConfigurationSetEventDestinationOutput) GoString 

func (s CreateConfigurationSetEventDestinationOutput) GoString() string

GoString returns the string representation

func (CreateConfigurationSetEventDestinationOutput) MarshalFields 

func (s CreateConfigurationSetEventDestinationOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CreateConfigurationSetEventDestinationOutput) SDKResponseMetadata 

func (s CreateConfigurationSetEventDestinationOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (CreateConfigurationSetEventDestinationOutput) String 

func (s CreateConfigurationSetEventDestinationOutput) String() string

String returns the string representation

type CreateConfigurationSetEventDestinationRequest 

type CreateConfigurationSetEventDestinationRequest struct {
	*aws.Request
	Input *CreateConfigurationSetEventDestinationInput
	Copy  func(*CreateConfigurationSetEventDestinationInput) CreateConfigurationSetEventDestinationRequest
}

CreateConfigurationSetEventDestinationRequest is a API request type for the CreateConfigurationSetEventDestination API operation.

func (CreateConfigurationSetEventDestinationRequest) Send 

func (r CreateConfigurationSetEventDestinationRequest) Send() (*CreateConfigurationSetEventDestinationOutput, error)

Send marshals and sends the CreateConfigurationSetEventDestination API request.

type CreateConfigurationSetInput 

type CreateConfigurationSetInput struct {

	// The name that you want to give the configuration set.
	ConfigurationSetName *string `type:"string"`
	// contains filtered or unexported fields
}

A request to create a new configuration set. Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-2018-09-05/CreateConfigurationSetRequest

func (CreateConfigurationSetInput) GoString 

func (s CreateConfigurationSetInput) GoString() string

GoString returns the string representation

func (CreateConfigurationSetInput) MarshalFields 

func (s CreateConfigurationSetInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CreateConfigurationSetInput) String 

func (s CreateConfigurationSetInput) String() string

String returns the string representation

type CreateConfigurationSetOutput 

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

An empty object that indicates that the configuration set was successfully created. Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-2018-09-05/CreateConfigurationSetResponse

func (CreateConfigurationSetOutput) GoString 

func (s CreateConfigurationSetOutput) GoString() string

GoString returns the string representation

func (CreateConfigurationSetOutput) MarshalFields 

func (s CreateConfigurationSetOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CreateConfigurationSetOutput) SDKResponseMetadata 

func (s CreateConfigurationSetOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (CreateConfigurationSetOutput) String 

func (s CreateConfigurationSetOutput) String() string

String returns the string representation

type CreateConfigurationSetRequest 

type CreateConfigurationSetRequest struct {
	*aws.Request
	Input *CreateConfigurationSetInput
	Copy  func(*CreateConfigurationSetInput) CreateConfigurationSetRequest
}

CreateConfigurationSetRequest is a API request type for the CreateConfigurationSet API operation.

func (CreateConfigurationSetRequest) Send 

func (r CreateConfigurationSetRequest) Send() (*CreateConfigurationSetOutput, error)

Send marshals and sends the CreateConfigurationSet API request.

type DeleteConfigurationSetEventDestinationInput 

type DeleteConfigurationSetEventDestinationInput struct {

	// ConfigurationSetName is a required field
	ConfigurationSetName *string `location:"uri" locationName:"ConfigurationSetName" type:"string" required:"true"`

	// EventDestinationName is a required field
	EventDestinationName *string `location:"uri" locationName:"EventDestinationName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-2018-09-05/DeleteConfigurationSetEventDestinationRequest

func (DeleteConfigurationSetEventDestinationInput) GoString 

func (s DeleteConfigurationSetEventDestinationInput) GoString() string

GoString returns the string representation

func (DeleteConfigurationSetEventDestinationInput) MarshalFields 

func (s DeleteConfigurationSetEventDestinationInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeleteConfigurationSetEventDestinationInput) String 

func (s DeleteConfigurationSetEventDestinationInput) String() string

String returns the string representation

func (*DeleteConfigurationSetEventDestinationInput) Validate 

func (s *DeleteConfigurationSetEventDestinationInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteConfigurationSetEventDestinationOutput 

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

An empty object that indicates that the event destination was deleted successfully. Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-2018-09-05/DeleteConfigurationSetEventDestinationResponse

func (DeleteConfigurationSetEventDestinationOutput) GoString 

func (s DeleteConfigurationSetEventDestinationOutput) GoString() string

GoString returns the string representation

func (DeleteConfigurationSetEventDestinationOutput) MarshalFields 

func (s DeleteConfigurationSetEventDestinationOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeleteConfigurationSetEventDestinationOutput) SDKResponseMetadata 

func (s DeleteConfigurationSetEventDestinationOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (DeleteConfigurationSetEventDestinationOutput) String 

func (s DeleteConfigurationSetEventDestinationOutput) String() string

String returns the string representation

type DeleteConfigurationSetEventDestinationRequest 

type DeleteConfigurationSetEventDestinationRequest struct {
	*aws.Request
	Input *DeleteConfigurationSetEventDestinationInput
	Copy  func(*DeleteConfigurationSetEventDestinationInput) DeleteConfigurationSetEventDestinationRequest
}

DeleteConfigurationSetEventDestinationRequest is a API request type for the DeleteConfigurationSetEventDestination API operation.

func (DeleteConfigurationSetEventDestinationRequest) Send 

func (r DeleteConfigurationSetEventDestinationRequest) Send() (*DeleteConfigurationSetEventDestinationOutput, error)

Send marshals and sends the DeleteConfigurationSetEventDestination API request.

type DeleteConfigurationSetInput 

type DeleteConfigurationSetInput struct {

	// ConfigurationSetName is a required field
	ConfigurationSetName *string `location:"uri" locationName:"ConfigurationSetName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-2018-09-05/DeleteConfigurationSetRequest

func (DeleteConfigurationSetInput) GoString 

func (s DeleteConfigurationSetInput) GoString() string

GoString returns the string representation

func (DeleteConfigurationSetInput) MarshalFields 

func (s DeleteConfigurationSetInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeleteConfigurationSetInput) String 

func (s DeleteConfigurationSetInput) String() string

String returns the string representation

func (*DeleteConfigurationSetInput) Validate 

func (s *DeleteConfigurationSetInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteConfigurationSetOutput 

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

An empty object that indicates that the configuration set was deleted successfully. Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-2018-09-05/DeleteConfigurationSetResponse

func (DeleteConfigurationSetOutput) GoString 

func (s DeleteConfigurationSetOutput) GoString() string

GoString returns the string representation

func (DeleteConfigurationSetOutput) MarshalFields 

func (s DeleteConfigurationSetOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeleteConfigurationSetOutput) SDKResponseMetadata 

func (s DeleteConfigurationSetOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (DeleteConfigurationSetOutput) String 

func (s DeleteConfigurationSetOutput) String() string

String returns the string representation

type DeleteConfigurationSetRequest 

type DeleteConfigurationSetRequest struct {
	*aws.Request
	Input *DeleteConfigurationSetInput
	Copy  func(*DeleteConfigurationSetInput) DeleteConfigurationSetRequest
}

DeleteConfigurationSetRequest is a API request type for the DeleteConfigurationSet API operation.

func (DeleteConfigurationSetRequest) Send 

func (r DeleteConfigurationSetRequest) Send() (*DeleteConfigurationSetOutput, error)

Send marshals and sends the DeleteConfigurationSet API request.

type EventDestination 

type EventDestination struct {

	// An object that contains information about a event destination that sends
	// data to Amazon CloudWatch Logs.
	CloudWatchLogsDestination *CloudWatchLogsDestination `type:"structure"`

	// Indicates whether or not the event destination is enabled. If the event destination
	// is enabled, then Amazon Pinpoint sends response data to the specified event
	// destination.
	Enabled *bool `type:"boolean"`

	// An object that contains information about a event destination that sends
	// data to Amazon Kinesis Data Firehose.
	KinesisFirehoseDestination *KinesisFirehoseDestination `type:"structure"`

	// An array of EventDestination objects. Each EventDestination object includes
	// ARNs and other information that define an event destination.
	MatchingEventTypes []EventType `type:"list"`

	// A name that identifies the event destination configuration.
	Name *string `type:"string"`
	// contains filtered or unexported fields
}

An object that defines an event destination. Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-2018-09-05/EventDestination

func (EventDestination) GoString 

func (s EventDestination) GoString() string

GoString returns the string representation

func (EventDestination) MarshalFields 

func (s EventDestination) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (EventDestination) String 

func (s EventDestination) String() string

String returns the string representation

type EventDestinationDefinition 

type EventDestinationDefinition struct {

	// An object that contains information about a event destination that sends
	// data to Amazon CloudWatch Logs.
	CloudWatchLogsDestination *CloudWatchLogsDestination `type:"structure"`

	// Indicates whether or not the event destination is enabled. If the event destination
	// is enabled, then Amazon Pinpoint sends response data to the specified event
	// destination.
	Enabled *bool `type:"boolean"`

	// An object that contains information about a event destination that sends
	// data to Amazon Kinesis Data Firehose.
	KinesisFirehoseDestination *KinesisFirehoseDestination `type:"structure"`

	// An array of EventDestination objects. Each EventDestination object includes
	// ARNs and other information that define an event destination.
	MatchingEventTypes []EventType `type:"list"`
	// contains filtered or unexported fields
}

An object that defines a single event destination. Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-2018-09-05/EventDestinationDefinition

func (EventDestinationDefinition) GoString 

func (s EventDestinationDefinition) GoString() string

GoString returns the string representation

func (EventDestinationDefinition) MarshalFields 

func (s EventDestinationDefinition) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (EventDestinationDefinition) String 

func (s EventDestinationDefinition) String() string

String returns the string representation

type EventType 

type EventType string

The types of events that are sent to the event destination. 

const (
	EventTypeInitiatedCall EventType = "INITIATED_CALL"
	EventTypeRinging       EventType = "RINGING"
	EventTypeAnswered      EventType = "ANSWERED"
	EventTypeCompletedCall EventType = "COMPLETED_CALL"
	EventTypeBusy          EventType = "BUSY"
	EventTypeFailed        EventType = "FAILED"
	EventTypeNoAnswer      EventType = "NO_ANSWER"
)

Enum values for EventType

func (EventType) MarshalValue 

func (enum EventType) MarshalValue() (string, error)

func (EventType) MarshalValueBuf 

func (enum EventType) MarshalValueBuf(b []byte) ([]byte, error)

type GetConfigurationSetEventDestinationsInput 

type GetConfigurationSetEventDestinationsInput struct {

	// ConfigurationSetName is a required field
	ConfigurationSetName *string `location:"uri" locationName:"ConfigurationSetName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-2018-09-05/GetConfigurationSetEventDestinationsRequest

func (GetConfigurationSetEventDestinationsInput) GoString 

func (s GetConfigurationSetEventDestinationsInput) GoString() string

GoString returns the string representation

func (GetConfigurationSetEventDestinationsInput) MarshalFields 

func (s GetConfigurationSetEventDestinationsInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetConfigurationSetEventDestinationsInput) String 

func (s GetConfigurationSetEventDestinationsInput) String() string

String returns the string representation

func (*GetConfigurationSetEventDestinationsInput) Validate 

func (s *GetConfigurationSetEventDestinationsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetConfigurationSetEventDestinationsOutput 

type GetConfigurationSetEventDestinationsOutput struct {

	// An array of EventDestination objects. Each EventDestination object includes
	// ARNs and other information that define an event destination.
	EventDestinations []EventDestination `type:"list"`
	// contains filtered or unexported fields
}

An object that contains information about an event destination. Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-2018-09-05/GetConfigurationSetEventDestinationsResponse

func (GetConfigurationSetEventDestinationsOutput) GoString 

func (s GetConfigurationSetEventDestinationsOutput) GoString() string

GoString returns the string representation

func (GetConfigurationSetEventDestinationsOutput) MarshalFields 

func (s GetConfigurationSetEventDestinationsOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetConfigurationSetEventDestinationsOutput) SDKResponseMetadata 

func (s GetConfigurationSetEventDestinationsOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (GetConfigurationSetEventDestinationsOutput) String 

func (s GetConfigurationSetEventDestinationsOutput) String() string

String returns the string representation

type GetConfigurationSetEventDestinationsRequest 

type GetConfigurationSetEventDestinationsRequest struct {
	*aws.Request
	Input *GetConfigurationSetEventDestinationsInput
	Copy  func(*GetConfigurationSetEventDestinationsInput) GetConfigurationSetEventDestinationsRequest
}

GetConfigurationSetEventDestinationsRequest is a API request type for the GetConfigurationSetEventDestinations API operation.

func (GetConfigurationSetEventDestinationsRequest) Send 

func (r GetConfigurationSetEventDestinationsRequest) Send() (*GetConfigurationSetEventDestinationsOutput, error)

Send marshals and sends the GetConfigurationSetEventDestinations API request.

type KinesisFirehoseDestination 

type KinesisFirehoseDestination struct {

	// The Amazon Resource Name (ARN) of an IAM role that can write data to an Amazon
	// Kinesis Data Firehose stream.
	DeliveryStreamArn *string `type:"string"`

	// The Amazon Resource Name (ARN) of the Amazon Kinesis Data Firehose destination
	// that you want to use in the event destination.
	IamRoleArn *string `type:"string"`
	// contains filtered or unexported fields
}

An object that contains information about a event destination that sends data to Amazon Kinesis Data Firehose. Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-2018-09-05/KinesisFirehoseDestination

func (KinesisFirehoseDestination) GoString 

func (s KinesisFirehoseDestination) GoString() string

GoString returns the string representation

func (KinesisFirehoseDestination) MarshalFields 

func (s KinesisFirehoseDestination) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (KinesisFirehoseDestination) String 

func (s KinesisFirehoseDestination) String() string

String returns the string representation

type PinpointSMSVoice 

type PinpointSMSVoice struct {
	*aws.Client
}

PinpointSMSVoice provides the API operation methods for making requests to Amazon Pinpoint SMS and Voice Service. See this package's package overview docs for details on the service.

PinpointSMSVoice methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New 

func New(config aws.Config) *PinpointSMSVoice

New creates a new instance of the PinpointSMSVoice client with a config.

Example: 

// Create a PinpointSMSVoice client from just a config.
svc := pinpointsmsvoice.New(myConfig)

func (*PinpointSMSVoice) CreateConfigurationSetEventDestinationRequest 

func (c *PinpointSMSVoice) CreateConfigurationSetEventDestinationRequest(input *CreateConfigurationSetEventDestinationInput) CreateConfigurationSetEventDestinationRequest

CreateConfigurationSetEventDestinationRequest returns a request value for making API operation for Amazon Pinpoint SMS and Voice Service.

Create a new event destination in a configuration set. 

// Example sending a request using the CreateConfigurationSetEventDestinationRequest method.
req := client.CreateConfigurationSetEventDestinationRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-2018-09-05/CreateConfigurationSetEventDestination

func (*PinpointSMSVoice) CreateConfigurationSetRequest 

func (c *PinpointSMSVoice) CreateConfigurationSetRequest(input *CreateConfigurationSetInput) CreateConfigurationSetRequest

CreateConfigurationSetRequest returns a request value for making API operation for Amazon Pinpoint SMS and Voice Service.

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

// Example sending a request using the CreateConfigurationSetRequest method.
req := client.CreateConfigurationSetRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-2018-09-05/CreateConfigurationSet

func (*PinpointSMSVoice) DeleteConfigurationSetEventDestinationRequest 

func (c *PinpointSMSVoice) DeleteConfigurationSetEventDestinationRequest(input *DeleteConfigurationSetEventDestinationInput) DeleteConfigurationSetEventDestinationRequest

DeleteConfigurationSetEventDestinationRequest returns a request value for making API operation for Amazon Pinpoint SMS and Voice Service.

Deletes an event destination in a configuration set. 

// Example sending a request using the DeleteConfigurationSetEventDestinationRequest method.
req := client.DeleteConfigurationSetEventDestinationRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-2018-09-05/DeleteConfigurationSetEventDestination

func (*PinpointSMSVoice) DeleteConfigurationSetRequest 

func (c *PinpointSMSVoice) DeleteConfigurationSetRequest(input *DeleteConfigurationSetInput) DeleteConfigurationSetRequest

DeleteConfigurationSetRequest returns a request value for making API operation for Amazon Pinpoint SMS and Voice Service.

Deletes an existing configuration set. 

// Example sending a request using the DeleteConfigurationSetRequest method.
req := client.DeleteConfigurationSetRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-2018-09-05/DeleteConfigurationSet

func (*PinpointSMSVoice) GetConfigurationSetEventDestinationsRequest 

func (c *PinpointSMSVoice) GetConfigurationSetEventDestinationsRequest(input *GetConfigurationSetEventDestinationsInput) GetConfigurationSetEventDestinationsRequest

GetConfigurationSetEventDestinationsRequest returns a request value for making API operation for Amazon Pinpoint SMS and Voice Service.

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. 

// Example sending a request using the GetConfigurationSetEventDestinationsRequest method.
req := client.GetConfigurationSetEventDestinationsRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-2018-09-05/GetConfigurationSetEventDestinations

func (*PinpointSMSVoice) SendVoiceMessageRequest 

func (c *PinpointSMSVoice) SendVoiceMessageRequest(input *SendVoiceMessageInput) SendVoiceMessageRequest

SendVoiceMessageRequest returns a request value for making API operation for Amazon Pinpoint SMS and Voice Service.

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

// Example sending a request using the SendVoiceMessageRequest method.
req := client.SendVoiceMessageRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-2018-09-05/SendVoiceMessage

func (*PinpointSMSVoice) UpdateConfigurationSetEventDestinationRequest 

func (c *PinpointSMSVoice) UpdateConfigurationSetEventDestinationRequest(input *UpdateConfigurationSetEventDestinationInput) UpdateConfigurationSetEventDestinationRequest

UpdateConfigurationSetEventDestinationRequest returns a request value for making API operation for Amazon Pinpoint SMS and Voice Service.

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. 

// Example sending a request using the UpdateConfigurationSetEventDestinationRequest method.
req := client.UpdateConfigurationSetEventDestinationRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-2018-09-05/UpdateConfigurationSetEventDestination

type PlainTextMessageType 

type PlainTextMessageType struct {

	// The language to use when delivering the message. For a complete list of supported
	// languages, see the Amazon Polly Developer Guide.
	LanguageCode *string `type:"string"`

	// The plain (not SSML-formatted) text to deliver to the recipient.
	Text *string `type:"string"`

	VoiceId *string `type:"string"`
	// contains filtered or unexported fields
}

An object that defines a message that contains unformatted text. Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-2018-09-05/PlainTextMessageType

func (PlainTextMessageType) GoString 

func (s PlainTextMessageType) GoString() string

GoString returns the string representation

func (PlainTextMessageType) MarshalFields 

func (s PlainTextMessageType) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PlainTextMessageType) String 

func (s PlainTextMessageType) String() string

String returns the string representation

type SSMLMessageType 

type SSMLMessageType struct {

	// The language to use when delivering the message. For a complete list of supported
	// languages, see the Amazon Polly Developer Guide.
	LanguageCode *string `type:"string"`

	// The SSML-formatted text to deliver to the recipient.
	Text *string `type:"string"`

	// The name of the voice that you want to use to deliver the message. For a
	// complete list of supported voices, see the Amazon Polly Developer Guide.
	VoiceId *string `type:"string"`
	// contains filtered or unexported fields
}

An object that defines a message that contains SSML-formatted text. Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-2018-09-05/SSMLMessageType

func (SSMLMessageType) GoString 

func (s SSMLMessageType) GoString() string

GoString returns the string representation

func (SSMLMessageType) MarshalFields 

func (s SSMLMessageType) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (SSMLMessageType) String 

func (s SSMLMessageType) String() string

String returns the string representation

type SendVoiceMessageInput 

type SendVoiceMessageInput struct {

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

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

	// An object that contains a voice message and information about the recipient
	// that you want to send it to.
	Content *VoiceMessageContent `type:"structure"`

	// The phone number that you want to send the voice message to.
	DestinationPhoneNumber *string `type:"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 `type:"string"`
	// contains filtered or unexported fields
}

A request to create and send a new voice message. Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-2018-09-05/SendVoiceMessageRequest

func (SendVoiceMessageInput) GoString 

func (s SendVoiceMessageInput) GoString() string

GoString returns the string representation

func (SendVoiceMessageInput) MarshalFields 

func (s SendVoiceMessageInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (SendVoiceMessageInput) String 

func (s SendVoiceMessageInput) String() string

String returns the string representation

type SendVoiceMessageOutput 

type SendVoiceMessageOutput struct {

	// A unique identifier for the voice message.
	MessageId *string `type:"string"`
	// contains filtered or unexported fields
}

An object that that contains the Message ID of a Voice message that was sent successfully. Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-2018-09-05/SendVoiceMessageResponse

func (SendVoiceMessageOutput) GoString 

func (s SendVoiceMessageOutput) GoString() string

GoString returns the string representation

func (SendVoiceMessageOutput) MarshalFields 

func (s SendVoiceMessageOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (SendVoiceMessageOutput) SDKResponseMetadata 

func (s SendVoiceMessageOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (SendVoiceMessageOutput) String 

func (s SendVoiceMessageOutput) String() string

String returns the string representation

type SendVoiceMessageRequest 

type SendVoiceMessageRequest struct {
	*aws.Request
	Input *SendVoiceMessageInput
	Copy  func(*SendVoiceMessageInput) SendVoiceMessageRequest
}

SendVoiceMessageRequest is a API request type for the SendVoiceMessage API operation.

func (SendVoiceMessageRequest) Send 

func (r SendVoiceMessageRequest) Send() (*SendVoiceMessageOutput, error)

Send marshals and sends the SendVoiceMessage API request.

type UpdateConfigurationSetEventDestinationInput 

type UpdateConfigurationSetEventDestinationInput struct {

	// ConfigurationSetName is a required field
	ConfigurationSetName *string `location:"uri" locationName:"ConfigurationSetName" type:"string" required:"true"`

	// An object that defines a single event destination.
	EventDestination *EventDestinationDefinition `type:"structure"`

	// EventDestinationName is a required field
	EventDestinationName *string `location:"uri" locationName:"EventDestinationName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

An object that defines a request to update an existing event destination. Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-2018-09-05/UpdateConfigurationSetEventDestinationRequest

func (UpdateConfigurationSetEventDestinationInput) GoString 

func (s UpdateConfigurationSetEventDestinationInput) GoString() string

GoString returns the string representation

func (UpdateConfigurationSetEventDestinationInput) MarshalFields 

func (s UpdateConfigurationSetEventDestinationInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateConfigurationSetEventDestinationInput) String 

func (s UpdateConfigurationSetEventDestinationInput) String() string

String returns the string representation

func (*UpdateConfigurationSetEventDestinationInput) Validate 

func (s *UpdateConfigurationSetEventDestinationInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateConfigurationSetEventDestinationOutput 

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

An empty object that indicates that the event destination was updated successfully. Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-2018-09-05/UpdateConfigurationSetEventDestinationResponse

func (UpdateConfigurationSetEventDestinationOutput) GoString 

func (s UpdateConfigurationSetEventDestinationOutput) GoString() string

GoString returns the string representation

func (UpdateConfigurationSetEventDestinationOutput) MarshalFields 

func (s UpdateConfigurationSetEventDestinationOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateConfigurationSetEventDestinationOutput) SDKResponseMetadata 

func (s UpdateConfigurationSetEventDestinationOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (UpdateConfigurationSetEventDestinationOutput) String 

func (s UpdateConfigurationSetEventDestinationOutput) String() string

String returns the string representation

type UpdateConfigurationSetEventDestinationRequest 

type UpdateConfigurationSetEventDestinationRequest struct {
	*aws.Request
	Input *UpdateConfigurationSetEventDestinationInput
	Copy  func(*UpdateConfigurationSetEventDestinationInput) UpdateConfigurationSetEventDestinationRequest
}

UpdateConfigurationSetEventDestinationRequest is a API request type for the UpdateConfigurationSetEventDestination API operation.

func (UpdateConfigurationSetEventDestinationRequest) Send 

func (r UpdateConfigurationSetEventDestinationRequest) Send() (*UpdateConfigurationSetEventDestinationOutput, error)

Send marshals and sends the UpdateConfigurationSetEventDestination API request.

type VoiceMessageContent 

type VoiceMessageContent struct {

	// An object that defines a message that contains text formatted using Amazon
	// Pinpoint Voice Instructions markup.
	CallInstructionsMessage *CallInstructionsMessageType `type:"structure"`

	// An object that defines a message that contains unformatted text.
	PlainTextMessage *PlainTextMessageType `type:"structure"`

	// An object that defines a message that contains SSML-formatted text.
	SSMLMessage *SSMLMessageType `type:"structure"`
	// contains filtered or unexported fields
}

An object that contains a voice message and information about the recipient that you want to send it to. Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-2018-09-05/VoiceMessageContent

func (VoiceMessageContent) GoString 

func (s VoiceMessageContent) GoString() string

GoString returns the string representation

func (VoiceMessageContent) MarshalFields 

func (s VoiceMessageContent) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (VoiceMessageContent) String 

func (s VoiceMessageContent) String() string

String returns the string representation

Source Files

View all Source files

Directories

Path Synopsis
Package pinpointsmsvoiceiface provides an interface to enable mocking the Amazon Pinpoint SMS and Voice Service service client for testing your code.
 Package pinpointsmsvoiceiface provides an interface to enable mocking the Amazon Pinpoint SMS and Voice Service service client for testing your code.

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.