Documentation ¶
Overview ¶
Package pinpointsmsvoice provides the client and types for making API requests to Amazon Pinpoint SMS and Voice Service.
Pinpoint SMS and Voice Messaging public facing APIs ¶
See https://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-2018-09-05 for more information on this service.
See pinpointsmsvoice package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/pinpointsmsvoice/
Using the Client ¶
To 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 ¶
- Constants
- func EventType_Values() []string
- type AlreadyExistsException
- func (s *AlreadyExistsException) Code() string
- func (s *AlreadyExistsException) Error() string
- func (s AlreadyExistsException) GoString() string
- func (s *AlreadyExistsException) Message() string
- func (s *AlreadyExistsException) OrigErr() error
- func (s *AlreadyExistsException) RequestID() string
- func (s *AlreadyExistsException) StatusCode() int
- func (s AlreadyExistsException) String() string
- type BadRequestException
- func (s *BadRequestException) Code() string
- func (s *BadRequestException) Error() string
- func (s BadRequestException) GoString() string
- func (s *BadRequestException) Message() string
- func (s *BadRequestException) OrigErr() error
- func (s *BadRequestException) RequestID() string
- func (s *BadRequestException) StatusCode() int
- func (s BadRequestException) String() string
- type CallInstructionsMessageType
- type CloudWatchLogsDestination
- type CreateConfigurationSetEventDestinationInput
- func (s CreateConfigurationSetEventDestinationInput) GoString() string
- func (s *CreateConfigurationSetEventDestinationInput) SetConfigurationSetName(v string) *CreateConfigurationSetEventDestinationInput
- func (s *CreateConfigurationSetEventDestinationInput) SetEventDestination(v *EventDestinationDefinition) *CreateConfigurationSetEventDestinationInput
- func (s *CreateConfigurationSetEventDestinationInput) SetEventDestinationName(v string) *CreateConfigurationSetEventDestinationInput
- func (s CreateConfigurationSetEventDestinationInput) String() string
- func (s *CreateConfigurationSetEventDestinationInput) Validate() error
- type CreateConfigurationSetEventDestinationOutput
- type CreateConfigurationSetInput
- type CreateConfigurationSetOutput
- type DeleteConfigurationSetEventDestinationInput
- func (s DeleteConfigurationSetEventDestinationInput) GoString() string
- func (s *DeleteConfigurationSetEventDestinationInput) SetConfigurationSetName(v string) *DeleteConfigurationSetEventDestinationInput
- func (s *DeleteConfigurationSetEventDestinationInput) SetEventDestinationName(v string) *DeleteConfigurationSetEventDestinationInput
- func (s DeleteConfigurationSetEventDestinationInput) String() string
- func (s *DeleteConfigurationSetEventDestinationInput) Validate() error
- type DeleteConfigurationSetEventDestinationOutput
- type DeleteConfigurationSetInput
- type DeleteConfigurationSetOutput
- type EventDestination
- func (s EventDestination) GoString() string
- func (s *EventDestination) SetCloudWatchLogsDestination(v *CloudWatchLogsDestination) *EventDestination
- func (s *EventDestination) SetEnabled(v bool) *EventDestination
- func (s *EventDestination) SetKinesisFirehoseDestination(v *KinesisFirehoseDestination) *EventDestination
- func (s *EventDestination) SetMatchingEventTypes(v []*string) *EventDestination
- func (s *EventDestination) SetName(v string) *EventDestination
- func (s *EventDestination) SetSnsDestination(v *SnsDestination) *EventDestination
- func (s EventDestination) String() string
- type EventDestinationDefinition
- func (s EventDestinationDefinition) GoString() string
- func (s *EventDestinationDefinition) SetCloudWatchLogsDestination(v *CloudWatchLogsDestination) *EventDestinationDefinition
- func (s *EventDestinationDefinition) SetEnabled(v bool) *EventDestinationDefinition
- func (s *EventDestinationDefinition) SetKinesisFirehoseDestination(v *KinesisFirehoseDestination) *EventDestinationDefinition
- func (s *EventDestinationDefinition) SetMatchingEventTypes(v []*string) *EventDestinationDefinition
- func (s *EventDestinationDefinition) SetSnsDestination(v *SnsDestination) *EventDestinationDefinition
- func (s EventDestinationDefinition) String() string
- type GetConfigurationSetEventDestinationsInput
- func (s GetConfigurationSetEventDestinationsInput) GoString() string
- func (s *GetConfigurationSetEventDestinationsInput) SetConfigurationSetName(v string) *GetConfigurationSetEventDestinationsInput
- func (s GetConfigurationSetEventDestinationsInput) String() string
- func (s *GetConfigurationSetEventDestinationsInput) Validate() error
- type GetConfigurationSetEventDestinationsOutput
- type InternalServiceErrorException
- func (s *InternalServiceErrorException) Code() string
- func (s *InternalServiceErrorException) Error() string
- func (s InternalServiceErrorException) GoString() string
- func (s *InternalServiceErrorException) Message() string
- func (s *InternalServiceErrorException) OrigErr() error
- func (s *InternalServiceErrorException) RequestID() string
- func (s *InternalServiceErrorException) StatusCode() int
- func (s InternalServiceErrorException) String() string
- type KinesisFirehoseDestination
- type LimitExceededException
- func (s *LimitExceededException) Code() string
- func (s *LimitExceededException) Error() string
- func (s LimitExceededException) GoString() string
- func (s *LimitExceededException) Message() string
- func (s *LimitExceededException) OrigErr() error
- func (s *LimitExceededException) RequestID() string
- func (s *LimitExceededException) StatusCode() int
- func (s LimitExceededException) String() string
- type ListConfigurationSetsInput
- type ListConfigurationSetsOutput
- type NotFoundException
- func (s *NotFoundException) Code() string
- func (s *NotFoundException) Error() string
- func (s NotFoundException) GoString() string
- func (s *NotFoundException) Message() string
- func (s *NotFoundException) OrigErr() error
- func (s *NotFoundException) RequestID() string
- func (s *NotFoundException) StatusCode() int
- func (s NotFoundException) String() string
- type PinpointSMSVoice
- func (c *PinpointSMSVoice) CreateConfigurationSet(input *CreateConfigurationSetInput) (*CreateConfigurationSetOutput, error)
- func (c *PinpointSMSVoice) CreateConfigurationSetEventDestination(input *CreateConfigurationSetEventDestinationInput) (*CreateConfigurationSetEventDestinationOutput, error)
- func (c *PinpointSMSVoice) CreateConfigurationSetEventDestinationRequest(input *CreateConfigurationSetEventDestinationInput) (req *request.Request, output *CreateConfigurationSetEventDestinationOutput)
- func (c *PinpointSMSVoice) CreateConfigurationSetEventDestinationWithContext(ctx aws.Context, input *CreateConfigurationSetEventDestinationInput, ...) (*CreateConfigurationSetEventDestinationOutput, error)
- func (c *PinpointSMSVoice) CreateConfigurationSetRequest(input *CreateConfigurationSetInput) (req *request.Request, output *CreateConfigurationSetOutput)
- func (c *PinpointSMSVoice) CreateConfigurationSetWithContext(ctx aws.Context, input *CreateConfigurationSetInput, opts ...request.Option) (*CreateConfigurationSetOutput, error)
- func (c *PinpointSMSVoice) DeleteConfigurationSet(input *DeleteConfigurationSetInput) (*DeleteConfigurationSetOutput, error)
- func (c *PinpointSMSVoice) DeleteConfigurationSetEventDestination(input *DeleteConfigurationSetEventDestinationInput) (*DeleteConfigurationSetEventDestinationOutput, error)
- func (c *PinpointSMSVoice) DeleteConfigurationSetEventDestinationRequest(input *DeleteConfigurationSetEventDestinationInput) (req *request.Request, output *DeleteConfigurationSetEventDestinationOutput)
- func (c *PinpointSMSVoice) DeleteConfigurationSetEventDestinationWithContext(ctx aws.Context, input *DeleteConfigurationSetEventDestinationInput, ...) (*DeleteConfigurationSetEventDestinationOutput, error)
- func (c *PinpointSMSVoice) DeleteConfigurationSetRequest(input *DeleteConfigurationSetInput) (req *request.Request, output *DeleteConfigurationSetOutput)
- func (c *PinpointSMSVoice) DeleteConfigurationSetWithContext(ctx aws.Context, input *DeleteConfigurationSetInput, opts ...request.Option) (*DeleteConfigurationSetOutput, error)
- func (c *PinpointSMSVoice) GetConfigurationSetEventDestinations(input *GetConfigurationSetEventDestinationsInput) (*GetConfigurationSetEventDestinationsOutput, error)
- func (c *PinpointSMSVoice) GetConfigurationSetEventDestinationsRequest(input *GetConfigurationSetEventDestinationsInput) (req *request.Request, output *GetConfigurationSetEventDestinationsOutput)
- func (c *PinpointSMSVoice) GetConfigurationSetEventDestinationsWithContext(ctx aws.Context, input *GetConfigurationSetEventDestinationsInput, ...) (*GetConfigurationSetEventDestinationsOutput, error)
- func (c *PinpointSMSVoice) ListConfigurationSets(input *ListConfigurationSetsInput) (*ListConfigurationSetsOutput, error)
- func (c *PinpointSMSVoice) ListConfigurationSetsRequest(input *ListConfigurationSetsInput) (req *request.Request, output *ListConfigurationSetsOutput)
- func (c *PinpointSMSVoice) ListConfigurationSetsWithContext(ctx aws.Context, input *ListConfigurationSetsInput, opts ...request.Option) (*ListConfigurationSetsOutput, error)
- func (c *PinpointSMSVoice) SendVoiceMessage(input *SendVoiceMessageInput) (*SendVoiceMessageOutput, error)
- func (c *PinpointSMSVoice) SendVoiceMessageRequest(input *SendVoiceMessageInput) (req *request.Request, output *SendVoiceMessageOutput)
- func (c *PinpointSMSVoice) SendVoiceMessageWithContext(ctx aws.Context, input *SendVoiceMessageInput, opts ...request.Option) (*SendVoiceMessageOutput, error)
- func (c *PinpointSMSVoice) UpdateConfigurationSetEventDestination(input *UpdateConfigurationSetEventDestinationInput) (*UpdateConfigurationSetEventDestinationOutput, error)
- func (c *PinpointSMSVoice) UpdateConfigurationSetEventDestinationRequest(input *UpdateConfigurationSetEventDestinationInput) (req *request.Request, output *UpdateConfigurationSetEventDestinationOutput)
- func (c *PinpointSMSVoice) UpdateConfigurationSetEventDestinationWithContext(ctx aws.Context, input *UpdateConfigurationSetEventDestinationInput, ...) (*UpdateConfigurationSetEventDestinationOutput, error)
- type PlainTextMessageType
- func (s PlainTextMessageType) GoString() string
- func (s *PlainTextMessageType) SetLanguageCode(v string) *PlainTextMessageType
- func (s *PlainTextMessageType) SetText(v string) *PlainTextMessageType
- func (s *PlainTextMessageType) SetVoiceId(v string) *PlainTextMessageType
- func (s PlainTextMessageType) String() string
- type SSMLMessageType
- type SendVoiceMessageInput
- func (s SendVoiceMessageInput) GoString() string
- func (s *SendVoiceMessageInput) SetCallerId(v string) *SendVoiceMessageInput
- func (s *SendVoiceMessageInput) SetConfigurationSetName(v string) *SendVoiceMessageInput
- func (s *SendVoiceMessageInput) SetContent(v *VoiceMessageContent) *SendVoiceMessageInput
- func (s *SendVoiceMessageInput) SetDestinationPhoneNumber(v string) *SendVoiceMessageInput
- func (s *SendVoiceMessageInput) SetOriginationPhoneNumber(v string) *SendVoiceMessageInput
- func (s SendVoiceMessageInput) String() string
- type SendVoiceMessageOutput
- type SnsDestination
- type TooManyRequestsException
- func (s *TooManyRequestsException) Code() string
- func (s *TooManyRequestsException) Error() string
- func (s TooManyRequestsException) GoString() string
- func (s *TooManyRequestsException) Message() string
- func (s *TooManyRequestsException) OrigErr() error
- func (s *TooManyRequestsException) RequestID() string
- func (s *TooManyRequestsException) StatusCode() int
- func (s TooManyRequestsException) String() string
- type UpdateConfigurationSetEventDestinationInput
- func (s UpdateConfigurationSetEventDestinationInput) GoString() string
- func (s *UpdateConfigurationSetEventDestinationInput) SetConfigurationSetName(v string) *UpdateConfigurationSetEventDestinationInput
- func (s *UpdateConfigurationSetEventDestinationInput) SetEventDestination(v *EventDestinationDefinition) *UpdateConfigurationSetEventDestinationInput
- func (s *UpdateConfigurationSetEventDestinationInput) SetEventDestinationName(v string) *UpdateConfigurationSetEventDestinationInput
- func (s UpdateConfigurationSetEventDestinationInput) String() string
- func (s *UpdateConfigurationSetEventDestinationInput) Validate() error
- type UpdateConfigurationSetEventDestinationOutput
- type VoiceMessageContent
- func (s VoiceMessageContent) GoString() string
- func (s *VoiceMessageContent) SetCallInstructionsMessage(v *CallInstructionsMessageType) *VoiceMessageContent
- func (s *VoiceMessageContent) SetPlainTextMessage(v *PlainTextMessageType) *VoiceMessageContent
- func (s *VoiceMessageContent) SetSSMLMessage(v *SSMLMessageType) *VoiceMessageContent
- func (s VoiceMessageContent) String() string
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 identifier of a specific service. )
Service information constants
Variables ¶
This section is empty.
Functions ¶
func EventType_Values ¶ added in v1.34.3
func EventType_Values() []string
EventType_Values returns all elements of the EventType enum
Types ¶
type AlreadyExistsException ¶ added in v1.28.0
type AlreadyExistsException struct { RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` Message_ *string `locationName:"Message" type:"string"` // contains filtered or unexported fields }
The resource specified in your request already exists.
func (*AlreadyExistsException) Code ¶ added in v1.28.0
func (s *AlreadyExistsException) Code() string
Code returns the exception type name.
func (*AlreadyExistsException) Error ¶ added in v1.28.0
func (s *AlreadyExistsException) Error() string
func (AlreadyExistsException) GoString ¶ added in v1.28.0
func (s AlreadyExistsException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*AlreadyExistsException) Message ¶ added in v1.28.0
func (s *AlreadyExistsException) Message() string
Message returns the exception's message.
func (*AlreadyExistsException) OrigErr ¶ added in v1.28.0
func (s *AlreadyExistsException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (*AlreadyExistsException) RequestID ¶ added in v1.28.0
func (s *AlreadyExistsException) RequestID() string
RequestID returns the service's response RequestID for request.
func (*AlreadyExistsException) StatusCode ¶ added in v1.28.0
func (s *AlreadyExistsException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (AlreadyExistsException) String ¶ added in v1.28.0
func (s AlreadyExistsException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type BadRequestException ¶ added in v1.28.0
type BadRequestException struct { RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` Message_ *string `locationName:"Message" type:"string"` // contains filtered or unexported fields }
The input you provided is invalid.
func (*BadRequestException) Code ¶ added in v1.28.0
func (s *BadRequestException) Code() string
Code returns the exception type name.
func (*BadRequestException) Error ¶ added in v1.28.0
func (s *BadRequestException) Error() string
func (BadRequestException) GoString ¶ added in v1.28.0
func (s BadRequestException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*BadRequestException) Message ¶ added in v1.28.0
func (s *BadRequestException) Message() string
Message returns the exception's message.
func (*BadRequestException) OrigErr ¶ added in v1.28.0
func (s *BadRequestException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (*BadRequestException) RequestID ¶ added in v1.28.0
func (s *BadRequestException) RequestID() string
RequestID returns the service's response RequestID for request.
func (*BadRequestException) StatusCode ¶ added in v1.28.0
func (s *BadRequestException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (BadRequestException) String ¶ added in v1.28.0
func (s BadRequestException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
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.
func (CallInstructionsMessageType) GoString ¶
func (s CallInstructionsMessageType) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*CallInstructionsMessageType) SetText ¶
func (s *CallInstructionsMessageType) SetText(v string) *CallInstructionsMessageType
SetText sets the Text field's value.
func (CallInstructionsMessageType) String ¶
func (s CallInstructionsMessageType) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
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.
func (CloudWatchLogsDestination) GoString ¶
func (s CloudWatchLogsDestination) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*CloudWatchLogsDestination) SetIamRoleArn ¶
func (s *CloudWatchLogsDestination) SetIamRoleArn(v string) *CloudWatchLogsDestination
SetIamRoleArn sets the IamRoleArn field's value.
func (*CloudWatchLogsDestination) SetLogGroupArn ¶
func (s *CloudWatchLogsDestination) SetLogGroupArn(v string) *CloudWatchLogsDestination
SetLogGroupArn sets the LogGroupArn field's value.
func (CloudWatchLogsDestination) String ¶
func (s CloudWatchLogsDestination) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
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.
func (CreateConfigurationSetEventDestinationInput) GoString ¶
func (s CreateConfigurationSetEventDestinationInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*CreateConfigurationSetEventDestinationInput) SetConfigurationSetName ¶
func (s *CreateConfigurationSetEventDestinationInput) SetConfigurationSetName(v string) *CreateConfigurationSetEventDestinationInput
SetConfigurationSetName sets the ConfigurationSetName field's value.
func (*CreateConfigurationSetEventDestinationInput) SetEventDestination ¶
func (s *CreateConfigurationSetEventDestinationInput) SetEventDestination(v *EventDestinationDefinition) *CreateConfigurationSetEventDestinationInput
SetEventDestination sets the EventDestination field's value.
func (*CreateConfigurationSetEventDestinationInput) SetEventDestinationName ¶
func (s *CreateConfigurationSetEventDestinationInput) SetEventDestinationName(v string) *CreateConfigurationSetEventDestinationInput
SetEventDestinationName sets the EventDestinationName field's value.
func (CreateConfigurationSetEventDestinationInput) String ¶
func (s CreateConfigurationSetEventDestinationInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
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.
func (CreateConfigurationSetEventDestinationOutput) GoString ¶
func (s CreateConfigurationSetEventDestinationOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (CreateConfigurationSetEventDestinationOutput) String ¶
func (s CreateConfigurationSetEventDestinationOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
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.
func (CreateConfigurationSetInput) GoString ¶
func (s CreateConfigurationSetInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*CreateConfigurationSetInput) SetConfigurationSetName ¶
func (s *CreateConfigurationSetInput) SetConfigurationSetName(v string) *CreateConfigurationSetInput
SetConfigurationSetName sets the ConfigurationSetName field's value.
func (CreateConfigurationSetInput) String ¶
func (s CreateConfigurationSetInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type CreateConfigurationSetOutput ¶
type CreateConfigurationSetOutput struct {
// contains filtered or unexported fields
}
An empty object that indicates that the configuration set was successfully created.
func (CreateConfigurationSetOutput) GoString ¶
func (s CreateConfigurationSetOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (CreateConfigurationSetOutput) String ¶
func (s CreateConfigurationSetOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
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 }
func (DeleteConfigurationSetEventDestinationInput) GoString ¶
func (s DeleteConfigurationSetEventDestinationInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*DeleteConfigurationSetEventDestinationInput) SetConfigurationSetName ¶
func (s *DeleteConfigurationSetEventDestinationInput) SetConfigurationSetName(v string) *DeleteConfigurationSetEventDestinationInput
SetConfigurationSetName sets the ConfigurationSetName field's value.
func (*DeleteConfigurationSetEventDestinationInput) SetEventDestinationName ¶
func (s *DeleteConfigurationSetEventDestinationInput) SetEventDestinationName(v string) *DeleteConfigurationSetEventDestinationInput
SetEventDestinationName sets the EventDestinationName field's value.
func (DeleteConfigurationSetEventDestinationInput) String ¶
func (s DeleteConfigurationSetEventDestinationInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
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.
func (DeleteConfigurationSetEventDestinationOutput) GoString ¶
func (s DeleteConfigurationSetEventDestinationOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (DeleteConfigurationSetEventDestinationOutput) String ¶
func (s DeleteConfigurationSetEventDestinationOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
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 }
func (DeleteConfigurationSetInput) GoString ¶
func (s DeleteConfigurationSetInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*DeleteConfigurationSetInput) SetConfigurationSetName ¶
func (s *DeleteConfigurationSetInput) SetConfigurationSetName(v string) *DeleteConfigurationSetInput
SetConfigurationSetName sets the ConfigurationSetName field's value.
func (DeleteConfigurationSetInput) String ¶
func (s DeleteConfigurationSetInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
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.
func (DeleteConfigurationSetOutput) GoString ¶
func (s DeleteConfigurationSetOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (DeleteConfigurationSetOutput) String ¶
func (s DeleteConfigurationSetOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
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 []*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 ¶
func (s EventDestination) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*EventDestination) SetCloudWatchLogsDestination ¶
func (s *EventDestination) SetCloudWatchLogsDestination(v *CloudWatchLogsDestination) *EventDestination
SetCloudWatchLogsDestination sets the CloudWatchLogsDestination field's value.
func (*EventDestination) SetEnabled ¶
func (s *EventDestination) SetEnabled(v bool) *EventDestination
SetEnabled sets the Enabled field's value.
func (*EventDestination) SetKinesisFirehoseDestination ¶
func (s *EventDestination) SetKinesisFirehoseDestination(v *KinesisFirehoseDestination) *EventDestination
SetKinesisFirehoseDestination sets the KinesisFirehoseDestination field's value.
func (*EventDestination) SetMatchingEventTypes ¶
func (s *EventDestination) SetMatchingEventTypes(v []*string) *EventDestination
SetMatchingEventTypes sets the MatchingEventTypes field's value.
func (*EventDestination) SetName ¶
func (s *EventDestination) SetName(v string) *EventDestination
SetName sets the Name field's value.
func (*EventDestination) SetSnsDestination ¶ added in v1.16.11
func (s *EventDestination) SetSnsDestination(v *SnsDestination) *EventDestination
SetSnsDestination sets the SnsDestination field's value.
func (EventDestination) String ¶
func (s EventDestination) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
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 []*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 ¶
func (s EventDestinationDefinition) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*EventDestinationDefinition) SetCloudWatchLogsDestination ¶
func (s *EventDestinationDefinition) SetCloudWatchLogsDestination(v *CloudWatchLogsDestination) *EventDestinationDefinition
SetCloudWatchLogsDestination sets the CloudWatchLogsDestination field's value.
func (*EventDestinationDefinition) SetEnabled ¶
func (s *EventDestinationDefinition) SetEnabled(v bool) *EventDestinationDefinition
SetEnabled sets the Enabled field's value.
func (*EventDestinationDefinition) SetKinesisFirehoseDestination ¶
func (s *EventDestinationDefinition) SetKinesisFirehoseDestination(v *KinesisFirehoseDestination) *EventDestinationDefinition
SetKinesisFirehoseDestination sets the KinesisFirehoseDestination field's value.
func (*EventDestinationDefinition) SetMatchingEventTypes ¶
func (s *EventDestinationDefinition) SetMatchingEventTypes(v []*string) *EventDestinationDefinition
SetMatchingEventTypes sets the MatchingEventTypes field's value.
func (*EventDestinationDefinition) SetSnsDestination ¶ added in v1.16.11
func (s *EventDestinationDefinition) SetSnsDestination(v *SnsDestination) *EventDestinationDefinition
SetSnsDestination sets the SnsDestination field's value.
func (EventDestinationDefinition) String ¶
func (s EventDestinationDefinition) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
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 }
func (GetConfigurationSetEventDestinationsInput) GoString ¶
func (s GetConfigurationSetEventDestinationsInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*GetConfigurationSetEventDestinationsInput) SetConfigurationSetName ¶
func (s *GetConfigurationSetEventDestinationsInput) SetConfigurationSetName(v string) *GetConfigurationSetEventDestinationsInput
SetConfigurationSetName sets the ConfigurationSetName field's value.
func (GetConfigurationSetEventDestinationsInput) String ¶
func (s GetConfigurationSetEventDestinationsInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
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.
func (GetConfigurationSetEventDestinationsOutput) GoString ¶
func (s GetConfigurationSetEventDestinationsOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*GetConfigurationSetEventDestinationsOutput) SetEventDestinations ¶
func (s *GetConfigurationSetEventDestinationsOutput) SetEventDestinations(v []*EventDestination) *GetConfigurationSetEventDestinationsOutput
SetEventDestinations sets the EventDestinations field's value.
func (GetConfigurationSetEventDestinationsOutput) String ¶
func (s GetConfigurationSetEventDestinationsOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type InternalServiceErrorException ¶ added in v1.28.0
type InternalServiceErrorException struct { RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` Message_ *string `locationName:"Message" type:"string"` // contains filtered or unexported fields }
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.
func (*InternalServiceErrorException) Code ¶ added in v1.28.0
func (s *InternalServiceErrorException) Code() string
Code returns the exception type name.
func (*InternalServiceErrorException) Error ¶ added in v1.28.0
func (s *InternalServiceErrorException) Error() string
func (InternalServiceErrorException) GoString ¶ added in v1.28.0
func (s InternalServiceErrorException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*InternalServiceErrorException) Message ¶ added in v1.28.0
func (s *InternalServiceErrorException) Message() string
Message returns the exception's message.
func (*InternalServiceErrorException) OrigErr ¶ added in v1.28.0
func (s *InternalServiceErrorException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (*InternalServiceErrorException) RequestID ¶ added in v1.28.0
func (s *InternalServiceErrorException) RequestID() string
RequestID returns the service's response RequestID for request.
func (*InternalServiceErrorException) StatusCode ¶ added in v1.28.0
func (s *InternalServiceErrorException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (InternalServiceErrorException) String ¶ added in v1.28.0
func (s InternalServiceErrorException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
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.
func (KinesisFirehoseDestination) GoString ¶
func (s KinesisFirehoseDestination) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*KinesisFirehoseDestination) SetDeliveryStreamArn ¶
func (s *KinesisFirehoseDestination) SetDeliveryStreamArn(v string) *KinesisFirehoseDestination
SetDeliveryStreamArn sets the DeliveryStreamArn field's value.
func (*KinesisFirehoseDestination) SetIamRoleArn ¶
func (s *KinesisFirehoseDestination) SetIamRoleArn(v string) *KinesisFirehoseDestination
SetIamRoleArn sets the IamRoleArn field's value.
func (KinesisFirehoseDestination) String ¶
func (s KinesisFirehoseDestination) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type LimitExceededException ¶ added in v1.28.0
type LimitExceededException struct { RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` Message_ *string `locationName:"Message" type:"string"` // contains filtered or unexported fields }
There are too many instances of the specified resource type.
func (*LimitExceededException) Code ¶ added in v1.28.0
func (s *LimitExceededException) Code() string
Code returns the exception type name.
func (*LimitExceededException) Error ¶ added in v1.28.0
func (s *LimitExceededException) Error() string
func (LimitExceededException) GoString ¶ added in v1.28.0
func (s LimitExceededException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*LimitExceededException) Message ¶ added in v1.28.0
func (s *LimitExceededException) Message() string
Message returns the exception's message.
func (*LimitExceededException) OrigErr ¶ added in v1.28.0
func (s *LimitExceededException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (*LimitExceededException) RequestID ¶ added in v1.28.0
func (s *LimitExceededException) RequestID() string
RequestID returns the service's response RequestID for request.
func (*LimitExceededException) StatusCode ¶ added in v1.28.0
func (s *LimitExceededException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (LimitExceededException) String ¶ added in v1.28.0
func (s LimitExceededException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ListConfigurationSetsInput ¶ added in v1.16.25
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 ¶ added in v1.16.25
func (s ListConfigurationSetsInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*ListConfigurationSetsInput) SetNextToken ¶ added in v1.16.25
func (s *ListConfigurationSetsInput) SetNextToken(v string) *ListConfigurationSetsInput
SetNextToken sets the NextToken field's value.
func (*ListConfigurationSetsInput) SetPageSize ¶ added in v1.16.25
func (s *ListConfigurationSetsInput) SetPageSize(v string) *ListConfigurationSetsInput
SetPageSize sets the PageSize field's value.
func (ListConfigurationSetsInput) String ¶ added in v1.16.25
func (s ListConfigurationSetsInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ListConfigurationSetsOutput ¶ added in v1.16.25
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 ¶ added in v1.16.25
func (s ListConfigurationSetsOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*ListConfigurationSetsOutput) SetConfigurationSets ¶ added in v1.16.25
func (s *ListConfigurationSetsOutput) SetConfigurationSets(v []*string) *ListConfigurationSetsOutput
SetConfigurationSets sets the ConfigurationSets field's value.
func (*ListConfigurationSetsOutput) SetNextToken ¶ added in v1.16.25
func (s *ListConfigurationSetsOutput) SetNextToken(v string) *ListConfigurationSetsOutput
SetNextToken sets the NextToken field's value.
func (ListConfigurationSetsOutput) String ¶ added in v1.16.25
func (s ListConfigurationSetsOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type NotFoundException ¶ added in v1.28.0
type NotFoundException struct { RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` Message_ *string `locationName:"Message" type:"string"` // contains filtered or unexported fields }
The resource you attempted to access doesn't exist.
func (*NotFoundException) Code ¶ added in v1.28.0
func (s *NotFoundException) Code() string
Code returns the exception type name.
func (*NotFoundException) Error ¶ added in v1.28.0
func (s *NotFoundException) Error() string
func (NotFoundException) GoString ¶ added in v1.28.0
func (s NotFoundException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*NotFoundException) Message ¶ added in v1.28.0
func (s *NotFoundException) Message() string
Message returns the exception's message.
func (*NotFoundException) OrigErr ¶ added in v1.28.0
func (s *NotFoundException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (*NotFoundException) RequestID ¶ added in v1.28.0
func (s *NotFoundException) RequestID() string
RequestID returns the service's response RequestID for request.
func (*NotFoundException) StatusCode ¶ added in v1.28.0
func (s *NotFoundException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (NotFoundException) String ¶ added in v1.28.0
func (s NotFoundException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type PinpointSMSVoice ¶
PinpointSMSVoice provides the API operation methods for making requests to Amazon Pinpoint SMS and Voice Service. See this package's package overview docs for details on the service.
PinpointSMSVoice methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.
func New ¶
func New(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:
mySession := session.Must(session.NewSession()) // 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 ¶
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 Types:
TooManyRequestsException You've issued too many requests to the resource. Wait a few minutes, and then try again.
BadRequestException The input you provided is invalid.
LimitExceededException There are too many instances of the specified resource type.
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.
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 ¶
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 Types:
BadRequestException The input you provided is invalid.
LimitExceededException There are too many instances of the specified resource type.
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.
NotFoundException The resource you attempted to access doesn't exist.
TooManyRequestsException You've issued too many requests to the resource. Wait a few minutes, and then try again.
AlreadyExistsException The resource specified in your request already exists.
func (*PinpointSMSVoice) CreateConfigurationSetEventDestinationRequest ¶
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) }
func (*PinpointSMSVoice) CreateConfigurationSetEventDestinationWithContext ¶
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 ¶
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 ¶
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 ¶
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 Types:
NotFoundException The resource you attempted to access doesn't exist.
TooManyRequestsException You've issued too many requests to the resource. Wait a few minutes, and then try again.
BadRequestException The input you provided is invalid.
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 ¶
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 Types:
NotFoundException The resource you attempted to access doesn't exist.
TooManyRequestsException You've issued too many requests to the resource. Wait a few minutes, and then try again.
BadRequestException The input you provided is invalid.
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.
func (*PinpointSMSVoice) DeleteConfigurationSetEventDestinationRequest ¶
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) }
func (*PinpointSMSVoice) DeleteConfigurationSetEventDestinationWithContext ¶
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 ¶
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 ¶
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 ¶
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 Types:
NotFoundException The resource you attempted to access doesn't exist.
TooManyRequestsException You've issued too many requests to the resource. Wait a few minutes, and then try again.
BadRequestException The input you provided is invalid.
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.
func (*PinpointSMSVoice) GetConfigurationSetEventDestinationsRequest ¶
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) }
func (*PinpointSMSVoice) GetConfigurationSetEventDestinationsWithContext ¶
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 ¶ added in v1.16.25
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 Types:
TooManyRequestsException You've issued too many requests to the resource. Wait a few minutes, and then try again.
BadRequestException The input you provided is invalid.
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 ¶ added in v1.16.25
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 ¶ added in v1.16.25
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 ¶
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 Types:
TooManyRequestsException You've issued too many requests to the resource. Wait a few minutes, and then try again.
BadRequestException The input you provided is invalid.
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 ¶
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 ¶
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 ¶
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 Types:
NotFoundException The resource you attempted to access doesn't exist.
TooManyRequestsException You've issued too many requests to the resource. Wait a few minutes, and then try again.
BadRequestException The input you provided is invalid.
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.
func (*PinpointSMSVoice) UpdateConfigurationSetEventDestinationRequest ¶
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) }
func (*PinpointSMSVoice) UpdateConfigurationSetEventDestinationWithContext ¶
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 ¶
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 ¶
func (s PlainTextMessageType) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*PlainTextMessageType) SetLanguageCode ¶
func (s *PlainTextMessageType) SetLanguageCode(v string) *PlainTextMessageType
SetLanguageCode sets the LanguageCode field's value.
func (*PlainTextMessageType) SetText ¶
func (s *PlainTextMessageType) SetText(v string) *PlainTextMessageType
SetText sets the Text field's value.
func (*PlainTextMessageType) SetVoiceId ¶
func (s *PlainTextMessageType) SetVoiceId(v string) *PlainTextMessageType
SetVoiceId sets the VoiceId field's value.
func (PlainTextMessageType) String ¶
func (s PlainTextMessageType) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
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.
func (SSMLMessageType) GoString ¶
func (s SSMLMessageType) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*SSMLMessageType) SetLanguageCode ¶
func (s *SSMLMessageType) SetLanguageCode(v string) *SSMLMessageType
SetLanguageCode sets the LanguageCode field's value.
func (*SSMLMessageType) SetText ¶
func (s *SSMLMessageType) SetText(v string) *SSMLMessageType
SetText sets the Text field's value.
func (*SSMLMessageType) SetVoiceId ¶
func (s *SSMLMessageType) SetVoiceId(v string) *SSMLMessageType
SetVoiceId sets the VoiceId field's value.
func (SSMLMessageType) String ¶
func (s SSMLMessageType) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
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.
func (SendVoiceMessageInput) GoString ¶
func (s SendVoiceMessageInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*SendVoiceMessageInput) SetCallerId ¶
func (s *SendVoiceMessageInput) SetCallerId(v string) *SendVoiceMessageInput
SetCallerId sets the CallerId field's value.
func (*SendVoiceMessageInput) SetConfigurationSetName ¶
func (s *SendVoiceMessageInput) SetConfigurationSetName(v string) *SendVoiceMessageInput
SetConfigurationSetName sets the ConfigurationSetName field's value.
func (*SendVoiceMessageInput) SetContent ¶
func (s *SendVoiceMessageInput) SetContent(v *VoiceMessageContent) *SendVoiceMessageInput
SetContent sets the Content field's value.
func (*SendVoiceMessageInput) SetDestinationPhoneNumber ¶
func (s *SendVoiceMessageInput) SetDestinationPhoneNumber(v string) *SendVoiceMessageInput
SetDestinationPhoneNumber sets the DestinationPhoneNumber field's value.
func (*SendVoiceMessageInput) SetOriginationPhoneNumber ¶
func (s *SendVoiceMessageInput) SetOriginationPhoneNumber(v string) *SendVoiceMessageInput
SetOriginationPhoneNumber sets the OriginationPhoneNumber field's value.
func (SendVoiceMessageInput) String ¶
func (s SendVoiceMessageInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
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.
func (SendVoiceMessageOutput) GoString ¶
func (s SendVoiceMessageOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*SendVoiceMessageOutput) SetMessageId ¶
func (s *SendVoiceMessageOutput) SetMessageId(v string) *SendVoiceMessageOutput
SetMessageId sets the MessageId field's value.
func (SendVoiceMessageOutput) String ¶
func (s SendVoiceMessageOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type SnsDestination ¶ added in v1.16.11
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 ¶ added in v1.16.11
func (s SnsDestination) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*SnsDestination) SetTopicArn ¶ added in v1.16.11
func (s *SnsDestination) SetTopicArn(v string) *SnsDestination
SetTopicArn sets the TopicArn field's value.
func (SnsDestination) String ¶ added in v1.16.11
func (s SnsDestination) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type TooManyRequestsException ¶ added in v1.28.0
type TooManyRequestsException struct { RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` Message_ *string `locationName:"Message" type:"string"` // contains filtered or unexported fields }
You've issued too many requests to the resource. Wait a few minutes, and then try again.
func (*TooManyRequestsException) Code ¶ added in v1.28.0
func (s *TooManyRequestsException) Code() string
Code returns the exception type name.
func (*TooManyRequestsException) Error ¶ added in v1.28.0
func (s *TooManyRequestsException) Error() string
func (TooManyRequestsException) GoString ¶ added in v1.28.0
func (s TooManyRequestsException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*TooManyRequestsException) Message ¶ added in v1.28.0
func (s *TooManyRequestsException) Message() string
Message returns the exception's message.
func (*TooManyRequestsException) OrigErr ¶ added in v1.28.0
func (s *TooManyRequestsException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (*TooManyRequestsException) RequestID ¶ added in v1.28.0
func (s *TooManyRequestsException) RequestID() string
RequestID returns the service's response RequestID for request.
func (*TooManyRequestsException) StatusCode ¶ added in v1.28.0
func (s *TooManyRequestsException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (TooManyRequestsException) String ¶ added in v1.28.0
func (s TooManyRequestsException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
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.
func (UpdateConfigurationSetEventDestinationInput) GoString ¶
func (s UpdateConfigurationSetEventDestinationInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*UpdateConfigurationSetEventDestinationInput) SetConfigurationSetName ¶
func (s *UpdateConfigurationSetEventDestinationInput) SetConfigurationSetName(v string) *UpdateConfigurationSetEventDestinationInput
SetConfigurationSetName sets the ConfigurationSetName field's value.
func (*UpdateConfigurationSetEventDestinationInput) SetEventDestination ¶
func (s *UpdateConfigurationSetEventDestinationInput) SetEventDestination(v *EventDestinationDefinition) *UpdateConfigurationSetEventDestinationInput
SetEventDestination sets the EventDestination field's value.
func (*UpdateConfigurationSetEventDestinationInput) SetEventDestinationName ¶
func (s *UpdateConfigurationSetEventDestinationInput) SetEventDestinationName(v string) *UpdateConfigurationSetEventDestinationInput
SetEventDestinationName sets the EventDestinationName field's value.
func (UpdateConfigurationSetEventDestinationInput) String ¶
func (s UpdateConfigurationSetEventDestinationInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
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.
func (UpdateConfigurationSetEventDestinationOutput) GoString ¶
func (s UpdateConfigurationSetEventDestinationOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (UpdateConfigurationSetEventDestinationOutput) String ¶
func (s UpdateConfigurationSetEventDestinationOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
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.
func (VoiceMessageContent) GoString ¶
func (s VoiceMessageContent) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*VoiceMessageContent) SetCallInstructionsMessage ¶
func (s *VoiceMessageContent) SetCallInstructionsMessage(v *CallInstructionsMessageType) *VoiceMessageContent
SetCallInstructionsMessage sets the CallInstructionsMessage field's value.
func (*VoiceMessageContent) SetPlainTextMessage ¶
func (s *VoiceMessageContent) SetPlainTextMessage(v *PlainTextMessageType) *VoiceMessageContent
SetPlainTextMessage sets the PlainTextMessage field's value.
func (*VoiceMessageContent) SetSSMLMessage ¶
func (s *VoiceMessageContent) SetSSMLMessage(v *SSMLMessageType) *VoiceMessageContent
SetSSMLMessage sets the SSMLMessage field's value.
func (VoiceMessageContent) String ¶
func (s VoiceMessageContent) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
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. |