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

package pinpointsmsvoice

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

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 contact 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

Package Files

api.go doc.go errors.go service.go

Constants

const (
    // EventTypeInitiatedCall is a EventType enum value
    EventTypeInitiatedCall = "INITIATED_CALL"

    // EventTypeRinging is a EventType enum value
    EventTypeRinging = "RINGING"

    // EventTypeAnswered is a EventType enum value
    EventTypeAnswered = "ANSWERED"

    // EventTypeCompletedCall is a EventType enum value
    EventTypeCompletedCall = "COMPLETED_CALL"

    // EventTypeBusy is a EventType enum value
    EventTypeBusy = "BUSY"

    // EventTypeFailed is a EventType enum value
    EventTypeFailed = "FAILED"

    // EventTypeNoAnswer is a EventType enum value
    EventTypeNoAnswer = "NO_ANSWER"
)

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

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"
)
const (
    ServiceName = "Pinpoint SMS Voice" // Name of service.
    EndpointsID = "sms-voice.pinpoint" // ID to lookup a service endpoint with.
    ServiceID   = "Pinpoint SMS Voice" // ServiceID is a unique identifer of a specific service.
)

Service information constants

type CallInstructionsMessageType Uses

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.

func (CallInstructionsMessageType) GoString Uses

func (s CallInstructionsMessageType) GoString() string

GoString returns the string representation

func (*CallInstructionsMessageType) SetText Uses

func (s *CallInstructionsMessageType) SetText(v string) *CallInstructionsMessageType

SetText sets the Text field's value.

func (CallInstructionsMessageType) String Uses

func (s CallInstructionsMessageType) String() string

String returns the string representation

type CloudWatchLogsDestination Uses

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.

func (CloudWatchLogsDestination) GoString Uses

func (s CloudWatchLogsDestination) GoString() string

GoString returns the string representation

func (*CloudWatchLogsDestination) SetIamRoleArn Uses

func (s *CloudWatchLogsDestination) SetIamRoleArn(v string) *CloudWatchLogsDestination

SetIamRoleArn sets the IamRoleArn field's value.

func (*CloudWatchLogsDestination) SetLogGroupArn Uses

func (s *CloudWatchLogsDestination) SetLogGroupArn(v string) *CloudWatchLogsDestination

SetLogGroupArn sets the LogGroupArn field's value.

func (CloudWatchLogsDestination) String Uses

func (s CloudWatchLogsDestination) String() string

String returns the string representation

type CreateConfigurationSetEventDestinationInput Uses

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.

func (CreateConfigurationSetEventDestinationInput) GoString Uses

func (s CreateConfigurationSetEventDestinationInput) GoString() string

GoString returns the string representation

func (*CreateConfigurationSetEventDestinationInput) SetConfigurationSetName Uses

func (s *CreateConfigurationSetEventDestinationInput) SetConfigurationSetName(v string) *CreateConfigurationSetEventDestinationInput

SetConfigurationSetName sets the ConfigurationSetName field's value.

func (*CreateConfigurationSetEventDestinationInput) SetEventDestination Uses

func (s *CreateConfigurationSetEventDestinationInput) SetEventDestination(v *EventDestinationDefinition) *CreateConfigurationSetEventDestinationInput

SetEventDestination sets the EventDestination field's value.

func (*CreateConfigurationSetEventDestinationInput) SetEventDestinationName Uses

func (s *CreateConfigurationSetEventDestinationInput) SetEventDestinationName(v string) *CreateConfigurationSetEventDestinationInput

SetEventDestinationName sets the EventDestinationName field's value.

func (CreateConfigurationSetEventDestinationInput) String Uses

func (s CreateConfigurationSetEventDestinationInput) String() string

String returns the string representation

func (*CreateConfigurationSetEventDestinationInput) Validate Uses

func (s *CreateConfigurationSetEventDestinationInput) Validate() error

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

type CreateConfigurationSetEventDestinationOutput Uses

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

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

func (CreateConfigurationSetEventDestinationOutput) GoString Uses

func (s CreateConfigurationSetEventDestinationOutput) GoString() string

GoString returns the string representation

func (CreateConfigurationSetEventDestinationOutput) String Uses

func (s CreateConfigurationSetEventDestinationOutput) String() string

String returns the string representation

type CreateConfigurationSetInput Uses

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.

func (CreateConfigurationSetInput) GoString Uses

func (s CreateConfigurationSetInput) GoString() string

GoString returns the string representation

func (*CreateConfigurationSetInput) SetConfigurationSetName Uses

func (s *CreateConfigurationSetInput) SetConfigurationSetName(v string) *CreateConfigurationSetInput

SetConfigurationSetName sets the ConfigurationSetName field's value.

func (CreateConfigurationSetInput) String Uses

func (s CreateConfigurationSetInput) String() string

String returns the string representation

type CreateConfigurationSetOutput Uses

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

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

func (CreateConfigurationSetOutput) GoString Uses

func (s CreateConfigurationSetOutput) GoString() string

GoString returns the string representation

func (CreateConfigurationSetOutput) String Uses

func (s CreateConfigurationSetOutput) String() string

String returns the string representation

type DeleteConfigurationSetEventDestinationInput Uses

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
}

func (DeleteConfigurationSetEventDestinationInput) GoString Uses

func (s DeleteConfigurationSetEventDestinationInput) GoString() string

GoString returns the string representation

func (*DeleteConfigurationSetEventDestinationInput) SetConfigurationSetName Uses

func (s *DeleteConfigurationSetEventDestinationInput) SetConfigurationSetName(v string) *DeleteConfigurationSetEventDestinationInput

SetConfigurationSetName sets the ConfigurationSetName field's value.

func (*DeleteConfigurationSetEventDestinationInput) SetEventDestinationName Uses

func (s *DeleteConfigurationSetEventDestinationInput) SetEventDestinationName(v string) *DeleteConfigurationSetEventDestinationInput

SetEventDestinationName sets the EventDestinationName field's value.

func (DeleteConfigurationSetEventDestinationInput) String Uses

func (s DeleteConfigurationSetEventDestinationInput) String() string

String returns the string representation

func (*DeleteConfigurationSetEventDestinationInput) Validate Uses

func (s *DeleteConfigurationSetEventDestinationInput) Validate() error

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

type DeleteConfigurationSetEventDestinationOutput Uses

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

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

func (DeleteConfigurationSetEventDestinationOutput) GoString Uses

func (s DeleteConfigurationSetEventDestinationOutput) GoString() string

GoString returns the string representation

func (DeleteConfigurationSetEventDestinationOutput) String Uses

func (s DeleteConfigurationSetEventDestinationOutput) String() string

String returns the string representation

type DeleteConfigurationSetInput Uses

type DeleteConfigurationSetInput struct {

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

func (DeleteConfigurationSetInput) GoString Uses

func (s DeleteConfigurationSetInput) GoString() string

GoString returns the string representation

func (*DeleteConfigurationSetInput) SetConfigurationSetName Uses

func (s *DeleteConfigurationSetInput) SetConfigurationSetName(v string) *DeleteConfigurationSetInput

SetConfigurationSetName sets the ConfigurationSetName field's value.

func (DeleteConfigurationSetInput) String Uses

func (s DeleteConfigurationSetInput) String() string

String returns the string representation

func (*DeleteConfigurationSetInput) Validate Uses

func (s *DeleteConfigurationSetInput) Validate() error

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

type DeleteConfigurationSetOutput Uses

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

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

func (DeleteConfigurationSetOutput) GoString Uses

func (s DeleteConfigurationSetOutput) GoString() string

GoString returns the string representation

func (DeleteConfigurationSetOutput) String Uses

func (s DeleteConfigurationSetOutput) String() string

String returns the string representation

type EventDestination Uses

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 []*string `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.

func (EventDestination) GoString Uses

func (s EventDestination) GoString() string

GoString returns the string representation

func (*EventDestination) SetCloudWatchLogsDestination Uses

func (s *EventDestination) SetCloudWatchLogsDestination(v *CloudWatchLogsDestination) *EventDestination

SetCloudWatchLogsDestination sets the CloudWatchLogsDestination field's value.

func (*EventDestination) SetEnabled Uses

func (s *EventDestination) SetEnabled(v bool) *EventDestination

SetEnabled sets the Enabled field's value.

func (*EventDestination) SetKinesisFirehoseDestination Uses

func (s *EventDestination) SetKinesisFirehoseDestination(v *KinesisFirehoseDestination) *EventDestination

SetKinesisFirehoseDestination sets the KinesisFirehoseDestination field's value.

func (*EventDestination) SetMatchingEventTypes Uses

func (s *EventDestination) SetMatchingEventTypes(v []*string) *EventDestination

SetMatchingEventTypes sets the MatchingEventTypes field's value.

func (*EventDestination) SetName Uses

func (s *EventDestination) SetName(v string) *EventDestination

SetName sets the Name field's value.

func (*EventDestination) SetSnsDestination Uses

func (s *EventDestination) SetSnsDestination(v *SnsDestination) *EventDestination

SetSnsDestination sets the SnsDestination field's value.

func (EventDestination) String Uses

func (s EventDestination) String() string

String returns the string representation

type EventDestinationDefinition Uses

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 []*string `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.

func (EventDestinationDefinition) GoString Uses

func (s EventDestinationDefinition) GoString() string

GoString returns the string representation

func (*EventDestinationDefinition) SetCloudWatchLogsDestination Uses

func (s *EventDestinationDefinition) SetCloudWatchLogsDestination(v *CloudWatchLogsDestination) *EventDestinationDefinition

SetCloudWatchLogsDestination sets the CloudWatchLogsDestination field's value.

func (*EventDestinationDefinition) SetEnabled Uses

func (s *EventDestinationDefinition) SetEnabled(v bool) *EventDestinationDefinition

SetEnabled sets the Enabled field's value.

func (*EventDestinationDefinition) SetKinesisFirehoseDestination Uses

func (s *EventDestinationDefinition) SetKinesisFirehoseDestination(v *KinesisFirehoseDestination) *EventDestinationDefinition

SetKinesisFirehoseDestination sets the KinesisFirehoseDestination field's value.

func (*EventDestinationDefinition) SetMatchingEventTypes Uses

func (s *EventDestinationDefinition) SetMatchingEventTypes(v []*string) *EventDestinationDefinition

SetMatchingEventTypes sets the MatchingEventTypes field's value.

func (*EventDestinationDefinition) SetSnsDestination Uses

func (s *EventDestinationDefinition) SetSnsDestination(v *SnsDestination) *EventDestinationDefinition

SetSnsDestination sets the SnsDestination field's value.

func (EventDestinationDefinition) String Uses

func (s EventDestinationDefinition) String() string

String returns the string representation

type GetConfigurationSetEventDestinationsInput Uses

type GetConfigurationSetEventDestinationsInput struct {

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

func (GetConfigurationSetEventDestinationsInput) GoString Uses

func (s GetConfigurationSetEventDestinationsInput) GoString() string

GoString returns the string representation

func (*GetConfigurationSetEventDestinationsInput) SetConfigurationSetName Uses

func (s *GetConfigurationSetEventDestinationsInput) SetConfigurationSetName(v string) *GetConfigurationSetEventDestinationsInput

SetConfigurationSetName sets the ConfigurationSetName field's value.

func (GetConfigurationSetEventDestinationsInput) String Uses

func (s GetConfigurationSetEventDestinationsInput) String() string

String returns the string representation

func (*GetConfigurationSetEventDestinationsInput) Validate Uses

func (s *GetConfigurationSetEventDestinationsInput) Validate() error

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

type GetConfigurationSetEventDestinationsOutput Uses

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.

func (GetConfigurationSetEventDestinationsOutput) GoString Uses

func (s GetConfigurationSetEventDestinationsOutput) GoString() string

GoString returns the string representation

func (*GetConfigurationSetEventDestinationsOutput) SetEventDestinations Uses

func (s *GetConfigurationSetEventDestinationsOutput) SetEventDestinations(v []*EventDestination) *GetConfigurationSetEventDestinationsOutput

SetEventDestinations sets the EventDestinations field's value.

func (GetConfigurationSetEventDestinationsOutput) String Uses

func (s GetConfigurationSetEventDestinationsOutput) String() string

String returns the string representation

type KinesisFirehoseDestination Uses

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.

func (KinesisFirehoseDestination) GoString Uses

func (s KinesisFirehoseDestination) GoString() string

GoString returns the string representation

func (*KinesisFirehoseDestination) SetDeliveryStreamArn Uses

func (s *KinesisFirehoseDestination) SetDeliveryStreamArn(v string) *KinesisFirehoseDestination

SetDeliveryStreamArn sets the DeliveryStreamArn field's value.

func (*KinesisFirehoseDestination) SetIamRoleArn Uses

func (s *KinesisFirehoseDestination) SetIamRoleArn(v string) *KinesisFirehoseDestination

SetIamRoleArn sets the IamRoleArn field's value.

func (KinesisFirehoseDestination) String Uses

func (s KinesisFirehoseDestination) String() string

String returns the string representation

type ListConfigurationSetsInput Uses

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

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

func (ListConfigurationSetsInput) GoString Uses

func (s ListConfigurationSetsInput) GoString() string

GoString returns the string representation

func (*ListConfigurationSetsInput) SetNextToken Uses

func (s *ListConfigurationSetsInput) SetNextToken(v string) *ListConfigurationSetsInput

SetNextToken sets the NextToken field's value.

func (*ListConfigurationSetsInput) SetPageSize Uses

func (s *ListConfigurationSetsInput) SetPageSize(v string) *ListConfigurationSetsInput

SetPageSize sets the PageSize field's value.

func (ListConfigurationSetsInput) String Uses

func (s ListConfigurationSetsInput) String() string

String returns the string representation

type ListConfigurationSetsOutput Uses

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.

func (ListConfigurationSetsOutput) GoString Uses

func (s ListConfigurationSetsOutput) GoString() string

GoString returns the string representation

func (*ListConfigurationSetsOutput) SetConfigurationSets Uses

func (s *ListConfigurationSetsOutput) SetConfigurationSets(v []*string) *ListConfigurationSetsOutput

SetConfigurationSets sets the ConfigurationSets field's value.

func (*ListConfigurationSetsOutput) SetNextToken Uses

func (s *ListConfigurationSetsOutput) SetNextToken(v string) *ListConfigurationSetsOutput

SetNextToken sets the NextToken field's value.

func (ListConfigurationSetsOutput) String Uses

func (s ListConfigurationSetsOutput) String() string

String returns the string representation

type PinpointSMSVoice Uses

type PinpointSMSVoice struct {
    *client.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 Uses

func New(p client.ConfigProvider, cfgs ...*aws.Config) *PinpointSMSVoice

New creates a new instance of the PinpointSMSVoice client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example:

// Create a PinpointSMSVoice client from just a session.
svc := pinpointsmsvoice.New(mySession)

// Create a PinpointSMSVoice client with additional configuration
svc := pinpointsmsvoice.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*PinpointSMSVoice) CreateConfigurationSet Uses

func (c *PinpointSMSVoice) CreateConfigurationSet(input *CreateConfigurationSetInput) (*CreateConfigurationSetOutput, error)

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint SMS and Voice Service's API operation CreateConfigurationSet for usage and error information.

Returned Error Codes:

* ErrCodeTooManyRequestsException "TooManyRequestsException"
You've issued too many requests to the resource. Wait a few minutes, and
then try again.

* ErrCodeBadRequestException "BadRequestException"
The input you provided is invalid.

* ErrCodeLimitExceededException "LimitExceededException"
There are too many instances of the specified resource type.

* ErrCodeInternalServiceErrorException "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.

* ErrCodeAlreadyExistsException "AlreadyExistsException"
The resource specified in your request already exists.

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

func (*PinpointSMSVoice) CreateConfigurationSetEventDestination Uses

func (c *PinpointSMSVoice) CreateConfigurationSetEventDestination(input *CreateConfigurationSetEventDestinationInput) (*CreateConfigurationSetEventDestinationOutput, error)

CreateConfigurationSetEventDestination API operation for Amazon Pinpoint SMS and Voice Service.

Create a new event destination in a configuration set.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint SMS and Voice Service's API operation CreateConfigurationSetEventDestination for usage and error information.

Returned Error Codes:

* ErrCodeBadRequestException "BadRequestException"
The input you provided is invalid.

* ErrCodeLimitExceededException "LimitExceededException"
There are too many instances of the specified resource type.

* ErrCodeInternalServiceErrorException "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.

* ErrCodeNotFoundException "NotFoundException"
The resource you attempted to access doesn't exist.

* ErrCodeTooManyRequestsException "TooManyRequestsException"
You've issued too many requests to the resource. Wait a few minutes, and
then try again.

* ErrCodeAlreadyExistsException "AlreadyExistsException"
The resource specified in your request already exists.

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

func (*PinpointSMSVoice) CreateConfigurationSetEventDestinationRequest Uses

func (c *PinpointSMSVoice) CreateConfigurationSetEventDestinationRequest(input *CreateConfigurationSetEventDestinationInput) (req *request.Request, output *CreateConfigurationSetEventDestinationOutput)

CreateConfigurationSetEventDestinationRequest generates a "aws/request.Request" representing the client's request for the CreateConfigurationSetEventDestination operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateConfigurationSetEventDestination for more information on using the CreateConfigurationSetEventDestination API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateConfigurationSetEventDestinationRequest method.
req, resp := client.CreateConfigurationSetEventDestinationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*PinpointSMSVoice) CreateConfigurationSetEventDestinationWithContext Uses

func (c *PinpointSMSVoice) CreateConfigurationSetEventDestinationWithContext(ctx aws.Context, input *CreateConfigurationSetEventDestinationInput, opts ...request.Option) (*CreateConfigurationSetEventDestinationOutput, error)

CreateConfigurationSetEventDestinationWithContext is the same as CreateConfigurationSetEventDestination with the addition of the ability to pass a context and additional request options.

See CreateConfigurationSetEventDestination for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*PinpointSMSVoice) CreateConfigurationSetRequest Uses

func (c *PinpointSMSVoice) CreateConfigurationSetRequest(input *CreateConfigurationSetInput) (req *request.Request, output *CreateConfigurationSetOutput)

CreateConfigurationSetRequest generates a "aws/request.Request" representing the client's request for the CreateConfigurationSet operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateConfigurationSet for more information on using the CreateConfigurationSet API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateConfigurationSetRequest method.
req, resp := client.CreateConfigurationSetRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*PinpointSMSVoice) CreateConfigurationSetWithContext Uses

func (c *PinpointSMSVoice) CreateConfigurationSetWithContext(ctx aws.Context, input *CreateConfigurationSetInput, opts ...request.Option) (*CreateConfigurationSetOutput, error)

CreateConfigurationSetWithContext is the same as CreateConfigurationSet with the addition of the ability to pass a context and additional request options.

See CreateConfigurationSet for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*PinpointSMSVoice) DeleteConfigurationSet Uses

func (c *PinpointSMSVoice) DeleteConfigurationSet(input *DeleteConfigurationSetInput) (*DeleteConfigurationSetOutput, error)

DeleteConfigurationSet API operation for Amazon Pinpoint SMS and Voice Service.

Deletes an existing configuration set.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint SMS and Voice Service's API operation DeleteConfigurationSet for usage and error information.

Returned Error Codes:

* ErrCodeNotFoundException "NotFoundException"
The resource you attempted to access doesn't exist.

* ErrCodeTooManyRequestsException "TooManyRequestsException"
You've issued too many requests to the resource. Wait a few minutes, and
then try again.

* ErrCodeBadRequestException "BadRequestException"
The input you provided is invalid.

* ErrCodeInternalServiceErrorException "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.

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

func (*PinpointSMSVoice) DeleteConfigurationSetEventDestination Uses

func (c *PinpointSMSVoice) DeleteConfigurationSetEventDestination(input *DeleteConfigurationSetEventDestinationInput) (*DeleteConfigurationSetEventDestinationOutput, error)

DeleteConfigurationSetEventDestination API operation for Amazon Pinpoint SMS and Voice Service.

Deletes an event destination in a configuration set.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint SMS and Voice Service's API operation DeleteConfigurationSetEventDestination for usage and error information.

Returned Error Codes:

* ErrCodeNotFoundException "NotFoundException"
The resource you attempted to access doesn't exist.

* ErrCodeTooManyRequestsException "TooManyRequestsException"
You've issued too many requests to the resource. Wait a few minutes, and
then try again.

* ErrCodeBadRequestException "BadRequestException"
The input you provided is invalid.

* ErrCodeInternalServiceErrorException "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.

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

func (*PinpointSMSVoice) DeleteConfigurationSetEventDestinationRequest Uses

func (c *PinpointSMSVoice) DeleteConfigurationSetEventDestinationRequest(input *DeleteConfigurationSetEventDestinationInput) (req *request.Request, output *DeleteConfigurationSetEventDestinationOutput)

DeleteConfigurationSetEventDestinationRequest generates a "aws/request.Request" representing the client's request for the DeleteConfigurationSetEventDestination operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteConfigurationSetEventDestination for more information on using the DeleteConfigurationSetEventDestination API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteConfigurationSetEventDestinationRequest method.
req, resp := client.DeleteConfigurationSetEventDestinationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*PinpointSMSVoice) DeleteConfigurationSetEventDestinationWithContext Uses

func (c *PinpointSMSVoice) DeleteConfigurationSetEventDestinationWithContext(ctx aws.Context, input *DeleteConfigurationSetEventDestinationInput, opts ...request.Option) (*DeleteConfigurationSetEventDestinationOutput, error)

DeleteConfigurationSetEventDestinationWithContext is the same as DeleteConfigurationSetEventDestination with the addition of the ability to pass a context and additional request options.

See DeleteConfigurationSetEventDestination for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*PinpointSMSVoice) DeleteConfigurationSetRequest Uses

func (c *PinpointSMSVoice) DeleteConfigurationSetRequest(input *DeleteConfigurationSetInput) (req *request.Request, output *DeleteConfigurationSetOutput)

DeleteConfigurationSetRequest generates a "aws/request.Request" representing the client's request for the DeleteConfigurationSet operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteConfigurationSet for more information on using the DeleteConfigurationSet API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteConfigurationSetRequest method.
req, resp := client.DeleteConfigurationSetRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*PinpointSMSVoice) DeleteConfigurationSetWithContext Uses

func (c *PinpointSMSVoice) DeleteConfigurationSetWithContext(ctx aws.Context, input *DeleteConfigurationSetInput, opts ...request.Option) (*DeleteConfigurationSetOutput, error)

DeleteConfigurationSetWithContext is the same as DeleteConfigurationSet with the addition of the ability to pass a context and additional request options.

See DeleteConfigurationSet for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*PinpointSMSVoice) GetConfigurationSetEventDestinations Uses

func (c *PinpointSMSVoice) GetConfigurationSetEventDestinations(input *GetConfigurationSetEventDestinationsInput) (*GetConfigurationSetEventDestinationsOutput, error)

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint SMS and Voice Service's API operation GetConfigurationSetEventDestinations for usage and error information.

Returned Error Codes:

* ErrCodeNotFoundException "NotFoundException"
The resource you attempted to access doesn't exist.

* ErrCodeTooManyRequestsException "TooManyRequestsException"
You've issued too many requests to the resource. Wait a few minutes, and
then try again.

* ErrCodeBadRequestException "BadRequestException"
The input you provided is invalid.

* ErrCodeInternalServiceErrorException "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.

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

func (*PinpointSMSVoice) GetConfigurationSetEventDestinationsRequest Uses

func (c *PinpointSMSVoice) GetConfigurationSetEventDestinationsRequest(input *GetConfigurationSetEventDestinationsInput) (req *request.Request, output *GetConfigurationSetEventDestinationsOutput)

GetConfigurationSetEventDestinationsRequest generates a "aws/request.Request" representing the client's request for the GetConfigurationSetEventDestinations operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetConfigurationSetEventDestinations for more information on using the GetConfigurationSetEventDestinations API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetConfigurationSetEventDestinationsRequest method.
req, resp := client.GetConfigurationSetEventDestinationsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*PinpointSMSVoice) GetConfigurationSetEventDestinationsWithContext Uses

func (c *PinpointSMSVoice) GetConfigurationSetEventDestinationsWithContext(ctx aws.Context, input *GetConfigurationSetEventDestinationsInput, opts ...request.Option) (*GetConfigurationSetEventDestinationsOutput, error)

GetConfigurationSetEventDestinationsWithContext is the same as GetConfigurationSetEventDestinations with the addition of the ability to pass a context and additional request options.

See GetConfigurationSetEventDestinations for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*PinpointSMSVoice) ListConfigurationSets Uses

func (c *PinpointSMSVoice) ListConfigurationSets(input *ListConfigurationSetsInput) (*ListConfigurationSetsOutput, error)

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint SMS and Voice Service's API operation ListConfigurationSets for usage and error information.

Returned Error Codes:

* ErrCodeTooManyRequestsException "TooManyRequestsException"
You've issued too many requests to the resource. Wait a few minutes, and
then try again.

* ErrCodeBadRequestException "BadRequestException"
The input you provided is invalid.

* ErrCodeInternalServiceErrorException "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.

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

func (*PinpointSMSVoice) ListConfigurationSetsRequest Uses

func (c *PinpointSMSVoice) ListConfigurationSetsRequest(input *ListConfigurationSetsInput) (req *request.Request, output *ListConfigurationSetsOutput)

ListConfigurationSetsRequest generates a "aws/request.Request" representing the client's request for the ListConfigurationSets operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListConfigurationSets for more information on using the ListConfigurationSets API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListConfigurationSetsRequest method.
req, resp := client.ListConfigurationSetsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*PinpointSMSVoice) ListConfigurationSetsWithContext Uses

func (c *PinpointSMSVoice) ListConfigurationSetsWithContext(ctx aws.Context, input *ListConfigurationSetsInput, opts ...request.Option) (*ListConfigurationSetsOutput, error)

ListConfigurationSetsWithContext is the same as ListConfigurationSets with the addition of the ability to pass a context and additional request options.

See ListConfigurationSets for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*PinpointSMSVoice) SendVoiceMessage Uses

func (c *PinpointSMSVoice) SendVoiceMessage(input *SendVoiceMessageInput) (*SendVoiceMessageOutput, error)

SendVoiceMessage API operation for Amazon Pinpoint SMS and Voice Service.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint SMS and Voice Service's API operation SendVoiceMessage for usage and error information.

Returned Error Codes:

* ErrCodeTooManyRequestsException "TooManyRequestsException"
You've issued too many requests to the resource. Wait a few minutes, and
then try again.

* ErrCodeBadRequestException "BadRequestException"
The input you provided is invalid.

* ErrCodeInternalServiceErrorException "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.

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

func (*PinpointSMSVoice) SendVoiceMessageRequest Uses

func (c *PinpointSMSVoice) SendVoiceMessageRequest(input *SendVoiceMessageInput) (req *request.Request, output *SendVoiceMessageOutput)

SendVoiceMessageRequest generates a "aws/request.Request" representing the client's request for the SendVoiceMessage operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See SendVoiceMessage for more information on using the SendVoiceMessage API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the SendVoiceMessageRequest method.
req, resp := client.SendVoiceMessageRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*PinpointSMSVoice) SendVoiceMessageWithContext Uses

func (c *PinpointSMSVoice) SendVoiceMessageWithContext(ctx aws.Context, input *SendVoiceMessageInput, opts ...request.Option) (*SendVoiceMessageOutput, error)

SendVoiceMessageWithContext is the same as SendVoiceMessage with the addition of the ability to pass a context and additional request options.

See SendVoiceMessage for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*PinpointSMSVoice) UpdateConfigurationSetEventDestination Uses

func (c *PinpointSMSVoice) UpdateConfigurationSetEventDestination(input *UpdateConfigurationSetEventDestinationInput) (*UpdateConfigurationSetEventDestinationOutput, error)

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint SMS and Voice Service's API operation UpdateConfigurationSetEventDestination for usage and error information.

Returned Error Codes:

* ErrCodeNotFoundException "NotFoundException"
The resource you attempted to access doesn't exist.

* ErrCodeTooManyRequestsException "TooManyRequestsException"
You've issued too many requests to the resource. Wait a few minutes, and
then try again.

* ErrCodeBadRequestException "BadRequestException"
The input you provided is invalid.

* ErrCodeInternalServiceErrorException "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.

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

func (*PinpointSMSVoice) UpdateConfigurationSetEventDestinationRequest Uses

func (c *PinpointSMSVoice) UpdateConfigurationSetEventDestinationRequest(input *UpdateConfigurationSetEventDestinationInput) (req *request.Request, output *UpdateConfigurationSetEventDestinationOutput)

UpdateConfigurationSetEventDestinationRequest generates a "aws/request.Request" representing the client's request for the UpdateConfigurationSetEventDestination operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateConfigurationSetEventDestination for more information on using the UpdateConfigurationSetEventDestination API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateConfigurationSetEventDestinationRequest method.
req, resp := client.UpdateConfigurationSetEventDestinationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*PinpointSMSVoice) UpdateConfigurationSetEventDestinationWithContext Uses

func (c *PinpointSMSVoice) UpdateConfigurationSetEventDestinationWithContext(ctx aws.Context, input *UpdateConfigurationSetEventDestinationInput, opts ...request.Option) (*UpdateConfigurationSetEventDestinationOutput, error)

UpdateConfigurationSetEventDestinationWithContext is the same as UpdateConfigurationSetEventDestination with the addition of the ability to pass a context and additional request options.

See UpdateConfigurationSetEventDestination for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

type PlainTextMessageType Uses

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.

func (PlainTextMessageType) GoString Uses

func (s PlainTextMessageType) GoString() string

GoString returns the string representation

func (*PlainTextMessageType) SetLanguageCode Uses

func (s *PlainTextMessageType) SetLanguageCode(v string) *PlainTextMessageType

SetLanguageCode sets the LanguageCode field's value.

func (*PlainTextMessageType) SetText Uses

func (s *PlainTextMessageType) SetText(v string) *PlainTextMessageType

SetText sets the Text field's value.

func (*PlainTextMessageType) SetVoiceId Uses

func (s *PlainTextMessageType) SetVoiceId(v string) *PlainTextMessageType

SetVoiceId sets the VoiceId field's value.

func (PlainTextMessageType) String Uses

func (s PlainTextMessageType) String() string

String returns the string representation

type SSMLMessageType Uses

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.

func (SSMLMessageType) GoString Uses

func (s SSMLMessageType) GoString() string

GoString returns the string representation

func (*SSMLMessageType) SetLanguageCode Uses

func (s *SSMLMessageType) SetLanguageCode(v string) *SSMLMessageType

SetLanguageCode sets the LanguageCode field's value.

func (*SSMLMessageType) SetText Uses

func (s *SSMLMessageType) SetText(v string) *SSMLMessageType

SetText sets the Text field's value.

func (*SSMLMessageType) SetVoiceId Uses

func (s *SSMLMessageType) SetVoiceId(v string) *SSMLMessageType

SetVoiceId sets the VoiceId field's value.

func (SSMLMessageType) String Uses

func (s SSMLMessageType) String() string

String returns the string representation

type SendVoiceMessageInput Uses

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.

func (SendVoiceMessageInput) GoString Uses

func (s SendVoiceMessageInput) GoString() string

GoString returns the string representation

func (*SendVoiceMessageInput) SetCallerId Uses

func (s *SendVoiceMessageInput) SetCallerId(v string) *SendVoiceMessageInput

SetCallerId sets the CallerId field's value.

func (*SendVoiceMessageInput) SetConfigurationSetName Uses

func (s *SendVoiceMessageInput) SetConfigurationSetName(v string) *SendVoiceMessageInput

SetConfigurationSetName sets the ConfigurationSetName field's value.

func (*SendVoiceMessageInput) SetContent Uses

func (s *SendVoiceMessageInput) SetContent(v *VoiceMessageContent) *SendVoiceMessageInput

SetContent sets the Content field's value.

func (*SendVoiceMessageInput) SetDestinationPhoneNumber Uses

func (s *SendVoiceMessageInput) SetDestinationPhoneNumber(v string) *SendVoiceMessageInput

SetDestinationPhoneNumber sets the DestinationPhoneNumber field's value.

func (*SendVoiceMessageInput) SetOriginationPhoneNumber Uses

func (s *SendVoiceMessageInput) SetOriginationPhoneNumber(v string) *SendVoiceMessageInput

SetOriginationPhoneNumber sets the OriginationPhoneNumber field's value.

func (SendVoiceMessageInput) String Uses

func (s SendVoiceMessageInput) String() string

String returns the string representation

type SendVoiceMessageOutput Uses

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.

func (SendVoiceMessageOutput) GoString Uses

func (s SendVoiceMessageOutput) GoString() string

GoString returns the string representation

func (*SendVoiceMessageOutput) SetMessageId Uses

func (s *SendVoiceMessageOutput) SetMessageId(v string) *SendVoiceMessageOutput

SetMessageId sets the MessageId field's value.

func (SendVoiceMessageOutput) String Uses

func (s SendVoiceMessageOutput) String() string

String returns the string representation

type SnsDestination Uses

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.

func (SnsDestination) GoString Uses

func (s SnsDestination) GoString() string

GoString returns the string representation

func (*SnsDestination) SetTopicArn Uses

func (s *SnsDestination) SetTopicArn(v string) *SnsDestination

SetTopicArn sets the TopicArn field's value.

func (SnsDestination) String Uses

func (s SnsDestination) String() string

String returns the string representation

type UpdateConfigurationSetEventDestinationInput Uses

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.

func (UpdateConfigurationSetEventDestinationInput) GoString Uses

func (s UpdateConfigurationSetEventDestinationInput) GoString() string

GoString returns the string representation

func (*UpdateConfigurationSetEventDestinationInput) SetConfigurationSetName Uses

func (s *UpdateConfigurationSetEventDestinationInput) SetConfigurationSetName(v string) *UpdateConfigurationSetEventDestinationInput

SetConfigurationSetName sets the ConfigurationSetName field's value.

func (*UpdateConfigurationSetEventDestinationInput) SetEventDestination Uses

func (s *UpdateConfigurationSetEventDestinationInput) SetEventDestination(v *EventDestinationDefinition) *UpdateConfigurationSetEventDestinationInput

SetEventDestination sets the EventDestination field's value.

func (*UpdateConfigurationSetEventDestinationInput) SetEventDestinationName Uses

func (s *UpdateConfigurationSetEventDestinationInput) SetEventDestinationName(v string) *UpdateConfigurationSetEventDestinationInput

SetEventDestinationName sets the EventDestinationName field's value.

func (UpdateConfigurationSetEventDestinationInput) String Uses

func (s UpdateConfigurationSetEventDestinationInput) String() string

String returns the string representation

func (*UpdateConfigurationSetEventDestinationInput) Validate Uses

func (s *UpdateConfigurationSetEventDestinationInput) Validate() error

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

type UpdateConfigurationSetEventDestinationOutput Uses

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

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

func (UpdateConfigurationSetEventDestinationOutput) GoString Uses

func (s UpdateConfigurationSetEventDestinationOutput) GoString() string

GoString returns the string representation

func (UpdateConfigurationSetEventDestinationOutput) String Uses

func (s UpdateConfigurationSetEventDestinationOutput) String() string

String returns the string representation

type VoiceMessageContent Uses

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.

func (VoiceMessageContent) GoString Uses

func (s VoiceMessageContent) GoString() string

GoString returns the string representation

func (*VoiceMessageContent) SetCallInstructionsMessage Uses

func (s *VoiceMessageContent) SetCallInstructionsMessage(v *CallInstructionsMessageType) *VoiceMessageContent

SetCallInstructionsMessage sets the CallInstructionsMessage field's value.

func (*VoiceMessageContent) SetPlainTextMessage Uses

func (s *VoiceMessageContent) SetPlainTextMessage(v *PlainTextMessageType) *VoiceMessageContent

SetPlainTextMessage sets the PlainTextMessage field's value.

func (*VoiceMessageContent) SetSSMLMessage Uses

func (s *VoiceMessageContent) SetSSMLMessage(v *SSMLMessageType) *VoiceMessageContent

SetSSMLMessage sets the SSMLMessage field's value.

func (VoiceMessageContent) String Uses

func (s VoiceMessageContent) String() string

String returns the string representation

Directories

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

Package pinpointsmsvoice imports 8 packages (graph) and is imported by 11 packages. Updated 2019-10-29. Refresh now. Tools for package owners.