pinpointsmsvoice

package
v0.11.0 Latest Latest
Warning

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

 Go to latest Published: Aug 23, 2019 License: Apache-2.0 Imports: 6 Imported by: 7

Documentation

Overview

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

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 use Pinpoint SMS Voice 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 Pinpoint SMS Voice client 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 (
	ServiceName = "Pinpoint SMS Voice" // Service's name
	ServiceID   = "PinpointSMSVoice"   // Service's identifier
	EndpointsID = "sms-voice.pinpoint" // Service's Endpoint identifier
)
View Source 
const (

	// ErrCodeAlreadyExistsException for service response error code
	// "AlreadyExistsException".
	//
	// The resource specified in your request already exists.
	ErrCodeAlreadyExistsException = "AlreadyExistsException"

	// ErrCodeBadRequestException for service response error code
	// "BadRequestException".
	//
	// The input you provided is invalid.
	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".
	//
	// There are too many instances of the specified resource type.
	ErrCodeLimitExceededException = "LimitExceededException"

	// ErrCodeNotFoundException for service response error code
	// "NotFoundException".
	//
	// The resource you attempted to access doesn't exist.
	ErrCodeNotFoundException = "NotFoundException"

	// ErrCodeTooManyRequestsException for service response error code
	// "TooManyRequestsException".
	//
	// You've issued too many requests to the resource. Wait a few minutes, and
	// then try again.
	ErrCodeTooManyRequestsException = "TooManyRequestsException"
)

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) 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 Client added in v0.9.0 

type Client struct {
	*aws.Client
}

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

The client's 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) *Client

New creates a new instance of the client from the provided Config.

Example: 

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

func (*Client) CreateConfigurationSetEventDestinationRequest added in v0.9.0 

func (c *Client) 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 CreateConfigurationSetEventDestinationRequest.
req := client.CreateConfigurationSetEventDestinationRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) CreateConfigurationSetRequest added in v0.9.0 

func (c *Client) 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 CreateConfigurationSetRequest.
req := client.CreateConfigurationSetRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) DeleteConfigurationSetEventDestinationRequest added in v0.9.0 

func (c *Client) 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 DeleteConfigurationSetEventDestinationRequest.
req := client.DeleteConfigurationSetEventDestinationRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) DeleteConfigurationSetRequest added in v0.9.0 

func (c *Client) 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 DeleteConfigurationSetRequest.
req := client.DeleteConfigurationSetRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) GetConfigurationSetEventDestinationsRequest added in v0.9.0 

func (c *Client) 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 GetConfigurationSetEventDestinationsRequest.
req := client.GetConfigurationSetEventDestinationsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) ListConfigurationSetsRequest added in v0.9.0 

func (c *Client) ListConfigurationSetsRequest(input *ListConfigurationSetsInput) ListConfigurationSetsRequest

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

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

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

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

func (*Client) SendVoiceMessageRequest added in v0.9.0 

func (c *Client) 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 SendVoiceMessageRequest.
req := client.SendVoiceMessageRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) UpdateConfigurationSetEventDestinationRequest added in v0.9.0 

func (c *Client) 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 UpdateConfigurationSetEventDestinationRequest.
req := client.UpdateConfigurationSetEventDestinationRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

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 an 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) 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) 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) MarshalFields 

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

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

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 the request type for the CreateConfigurationSetEventDestination API operation.

func (CreateConfigurationSetEventDestinationRequest) Send 

func (r CreateConfigurationSetEventDestinationRequest) Send(ctx context.Context) (*CreateConfigurationSetEventDestinationResponse, error)

Send marshals and sends the CreateConfigurationSetEventDestination API request.

type CreateConfigurationSetEventDestinationResponse added in v0.9.0 

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

CreateConfigurationSetEventDestinationResponse is the response type for the CreateConfigurationSetEventDestination API operation.

func (*CreateConfigurationSetEventDestinationResponse) SDKResponseMetdata added in v0.9.0 

func (r *CreateConfigurationSetEventDestinationResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CreateConfigurationSetEventDestination 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) 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) MarshalFields 

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

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

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 the request type for the CreateConfigurationSet API operation.

func (CreateConfigurationSetRequest) Send 

func (r CreateConfigurationSetRequest) Send(ctx context.Context) (*CreateConfigurationSetResponse, error)

Send marshals and sends the CreateConfigurationSet API request.

type CreateConfigurationSetResponse added in v0.9.0 

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

CreateConfigurationSetResponse is the response type for the CreateConfigurationSet API operation.

func (*CreateConfigurationSetResponse) SDKResponseMetdata added in v0.9.0 

func (r *CreateConfigurationSetResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CreateConfigurationSet 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) 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) MarshalFields 

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

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

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 the request type for the DeleteConfigurationSetEventDestination API operation.

func (DeleteConfigurationSetEventDestinationRequest) Send 

func (r DeleteConfigurationSetEventDestinationRequest) Send(ctx context.Context) (*DeleteConfigurationSetEventDestinationResponse, error)

Send marshals and sends the DeleteConfigurationSetEventDestination API request.

type DeleteConfigurationSetEventDestinationResponse added in v0.9.0 

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

DeleteConfigurationSetEventDestinationResponse is the response type for the DeleteConfigurationSetEventDestination API operation.

func (*DeleteConfigurationSetEventDestinationResponse) SDKResponseMetdata added in v0.9.0 

func (r *DeleteConfigurationSetEventDestinationResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteConfigurationSetEventDestination 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) 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) MarshalFields 

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

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

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 the request type for the DeleteConfigurationSet API operation.

func (DeleteConfigurationSetRequest) Send 

func (r DeleteConfigurationSetRequest) Send(ctx context.Context) (*DeleteConfigurationSetResponse, error)

Send marshals and sends the DeleteConfigurationSet API request.

type DeleteConfigurationSetResponse added in v0.9.0 

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

DeleteConfigurationSetResponse is the response type for the DeleteConfigurationSet API operation.

func (*DeleteConfigurationSetResponse) SDKResponseMetdata added in v0.9.0 

func (r *DeleteConfigurationSetResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteConfigurationSet request.

type EventDestination 

type EventDestination struct {

	// An object that contains information about an 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 an 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"`

	// An object that contains information about an event destination that sends
	// data to Amazon SNS.
	SnsDestination *SnsDestination `type:"structure"`
	// 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) 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 an 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 an 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"`

	// An object that contains information about an event destination that sends
	// data to Amazon SNS.
	SnsDestination *SnsDestination `type:"structure"`
	// 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) 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) 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) MarshalFields 

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

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

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 the request type for the GetConfigurationSetEventDestinations API operation.

func (GetConfigurationSetEventDestinationsRequest) Send 

func (r GetConfigurationSetEventDestinationsRequest) Send(ctx context.Context) (*GetConfigurationSetEventDestinationsResponse, error)

Send marshals and sends the GetConfigurationSetEventDestinations API request.

type GetConfigurationSetEventDestinationsResponse added in v0.9.0 

type GetConfigurationSetEventDestinationsResponse struct {
	*GetConfigurationSetEventDestinationsOutput
	// contains filtered or unexported fields
}

GetConfigurationSetEventDestinationsResponse is the response type for the GetConfigurationSetEventDestinations API operation.

func (*GetConfigurationSetEventDestinationsResponse) SDKResponseMetdata added in v0.9.0 

func (r *GetConfigurationSetEventDestinationsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetConfigurationSetEventDestinations 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 an 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) 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 ListConfigurationSetsInput added in v0.8.0 

type ListConfigurationSetsInput struct {
	NextToken *string `location:"querystring" locationName:"NextToken" type:"string"`

	PageSize *string `location:"querystring" locationName:"PageSize" type:"string"`
	// contains filtered or unexported fields
}

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

func (ListConfigurationSetsInput) MarshalFields added in v0.8.0 

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

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

func (ListConfigurationSetsInput) String added in v0.8.0 

func (s ListConfigurationSetsInput) String() string

String returns the string representation

type ListConfigurationSetsOutput added in v0.8.0 

type ListConfigurationSetsOutput struct {

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

	// A token returned from a previous call to ListConfigurationSets to indicate
	// the position in the list of configuration sets.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

An object that contains information about the configuration sets for your account in the current region. Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-2018-09-05/ListConfigurationSetsResponse

func (ListConfigurationSetsOutput) MarshalFields added in v0.8.0 

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

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

func (ListConfigurationSetsOutput) String added in v0.8.0 

func (s ListConfigurationSetsOutput) String() string

String returns the string representation

type ListConfigurationSetsRequest added in v0.8.0 

type ListConfigurationSetsRequest struct {
	*aws.Request
	Input *ListConfigurationSetsInput
	Copy  func(*ListConfigurationSetsInput) ListConfigurationSetsRequest
}

ListConfigurationSetsRequest is the request type for the ListConfigurationSets API operation.

func (ListConfigurationSetsRequest) Send added in v0.8.0 

func (r ListConfigurationSetsRequest) Send(ctx context.Context) (*ListConfigurationSetsResponse, error)

Send marshals and sends the ListConfigurationSets API request.

type ListConfigurationSetsResponse added in v0.9.0 

type ListConfigurationSetsResponse struct {
	*ListConfigurationSetsOutput
	// contains filtered or unexported fields
}

ListConfigurationSetsResponse is the response type for the ListConfigurationSets API operation.

func (*ListConfigurationSetsResponse) SDKResponseMetdata added in v0.9.0 

func (r *ListConfigurationSetsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListConfigurationSets request.

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"`

	// 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 unformatted text. Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-2018-09-05/PlainTextMessageType

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

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

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

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 the request type for the SendVoiceMessage API operation.

func (SendVoiceMessageRequest) Send 

func (r SendVoiceMessageRequest) Send(ctx context.Context) (*SendVoiceMessageResponse, error)

Send marshals and sends the SendVoiceMessage API request.

type SendVoiceMessageResponse added in v0.9.0 

type SendVoiceMessageResponse struct {
	*SendVoiceMessageOutput
	// contains filtered or unexported fields
}

SendVoiceMessageResponse is the response type for the SendVoiceMessage API operation.

func (*SendVoiceMessageResponse) SDKResponseMetdata added in v0.9.0 

func (r *SendVoiceMessageResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the SendVoiceMessage request.

type SnsDestination added in v0.7.0 

type SnsDestination struct {

	// The Amazon Resource Name (ARN) of the Amazon SNS topic that you want to publish
	// events to.
	TopicArn *string `type:"string"`
	// contains filtered or unexported fields
}

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

func (SnsDestination) MarshalFields added in v0.7.0 

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

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

func (SnsDestination) String added in v0.7.0 

func (s SnsDestination) String() string

String returns the string representation

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

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

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

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 the request type for the UpdateConfigurationSetEventDestination API operation.

func (UpdateConfigurationSetEventDestinationRequest) Send 

func (r UpdateConfigurationSetEventDestinationRequest) Send(ctx context.Context) (*UpdateConfigurationSetEventDestinationResponse, error)

Send marshals and sends the UpdateConfigurationSetEventDestination API request.

type UpdateConfigurationSetEventDestinationResponse added in v0.9.0 

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

UpdateConfigurationSetEventDestinationResponse is the response type for the UpdateConfigurationSetEventDestination API operation.

func (*UpdateConfigurationSetEventDestinationResponse) SDKResponseMetdata added in v0.9.0 

func (r *UpdateConfigurationSetEventDestinationResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UpdateConfigurationSetEventDestination 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) 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.