type ADMChannelRequest struct {
// The Client ID that you obtained from the Amazon App Distribution Portal.
ClientId *string `type:"string"`
// The Client Secret that you obtained from the Amazon App Distribution Portal.
ClientSecret *string `type:"string"`
// Indicates whether or not the channel is enabled for sending messages.
Enabled *bool `type:"boolean"`
// contains filtered or unexported fields
}
Amazon Device Messaging channel definition.
func (s ADMChannelRequest) GoString() string
GoString returns the string representation
func (s *ADMChannelRequest) SetClientId(v string) *ADMChannelRequest
SetClientId sets the ClientId field's value.
func (s *ADMChannelRequest) SetClientSecret(v string) *ADMChannelRequest
SetClientSecret sets the ClientSecret field's value.
func (s *ADMChannelRequest) SetEnabled(v bool) *ADMChannelRequest
SetEnabled sets the Enabled field's value.
func (s ADMChannelRequest) String() string
String returns the string representation
type ADMChannelResponse struct {
// The ID of the application to which the channel applies.
ApplicationId *string `type:"string"`
// The date and time when this channel was created.
CreationDate *string `type:"string"`
// Indicates whether or not the channel is enabled for sending messages.
Enabled *bool `type:"boolean"`
// Not used. Retained for backwards compatibility.
HasCredential *bool `type:"boolean"`
// (Deprecated) An identifier for the channel. Retained for backwards compatibility.
Id *string `type:"string"`
// Indicates whether or not the channel is archived.
IsArchived *bool `type:"boolean"`
// The user who last updated this channel.
LastModifiedBy *string `type:"string"`
// The date and time when this channel was last modified.
LastModifiedDate *string `type:"string"`
// The platform type. For this channel, the value is always "ADM."
Platform *string `type:"string"`
// The channel version.
Version *int64 `type:"integer"`
// contains filtered or unexported fields
}
Amazon Device Messaging channel definition.
func (s ADMChannelResponse) GoString() string
GoString returns the string representation
func (s *ADMChannelResponse) SetApplicationId(v string) *ADMChannelResponse
SetApplicationId sets the ApplicationId field's value.
func (s *ADMChannelResponse) SetCreationDate(v string) *ADMChannelResponse
SetCreationDate sets the CreationDate field's value.
func (s *ADMChannelResponse) SetEnabled(v bool) *ADMChannelResponse
SetEnabled sets the Enabled field's value.
func (s *ADMChannelResponse) SetHasCredential(v bool) *ADMChannelResponse
SetHasCredential sets the HasCredential field's value.
func (s *ADMChannelResponse) SetId(v string) *ADMChannelResponse
SetId sets the Id field's value.
func (s *ADMChannelResponse) SetIsArchived(v bool) *ADMChannelResponse
SetIsArchived sets the IsArchived field's value.
func (s *ADMChannelResponse) SetLastModifiedBy(v string) *ADMChannelResponse
SetLastModifiedBy sets the LastModifiedBy field's value.
func (s *ADMChannelResponse) SetLastModifiedDate(v string) *ADMChannelResponse
SetLastModifiedDate sets the LastModifiedDate field's value.
func (s *ADMChannelResponse) SetPlatform(v string) *ADMChannelResponse
SetPlatform sets the Platform field's value.
func (s *ADMChannelResponse) SetVersion(v int64) *ADMChannelResponse
SetVersion sets the Version field's value.
func (s ADMChannelResponse) String() string
String returns the string representation
type ADMMessage struct {
// The action that occurs if the user taps a push notification delivered by
// the campaign: OPEN_APP - Your app launches, or it becomes the foreground
// app if it has been sent to the background. This is the default action. DEEP_LINK
// - Uses deep linking features in iOS and Android to open your app and display
// a designated user interface within the app. URL - The default mobile browser
// on the user's device launches and opens a web page at the URL you specify.
// Possible values include: OPEN_APP | DEEP_LINK | URL
Action *string `type:"string" enum:"Action"`
// The message body of the notification.
Body *string `type:"string"`
// Optional. Arbitrary string used to indicate multiple messages are logically
// the same and that ADM is allowed to drop previously enqueued messages in
// favor of this one.
ConsolidationKey *string `type:"string"`
// The data payload used for a silent push. This payload is added to the notifications'
// data.pinpoint.jsonBody' object
Data map[string]*string `type:"map"`
// Optional. Number of seconds ADM should retain the message if the device is
// offline
ExpiresAfter *string `type:"string"`
// The icon image name of the asset saved in your application.
IconReference *string `type:"string"`
// The URL that points to an image used as the large icon to the notification
// content view.
ImageIconUrl *string `type:"string"`
// The URL that points to an image used in the push notification.
ImageUrl *string `type:"string"`
// Optional. Base-64-encoded MD5 checksum of the data parameter. Used to verify
// data integrity
MD5 *string `type:"string"`
// The Raw JSON formatted string to be used as the payload. This value overrides
// the message.
RawContent *string `type:"string"`
// Indicates if the message should display on the users device. Silent pushes
// can be used for Remote Configuration and Phone Home use cases.
SilentPush *bool `type:"boolean"`
// The URL that points to an image used as the small icon for the notification
// which will be used to represent the notification in the status bar and content
// view
SmallImageIconUrl *string `type:"string"`
// Indicates a sound to play when the device receives the notification. Supports
// default, or the filename of a sound resource bundled in the app. Android
// sound files must reside in /res/raw/
Sound *string `type:"string"`
// Default message substitutions. Can be overridden by individual address substitutions.
Substitutions map[string][]*string `type:"map"`
// The message title that displays above the message on the user's device.
Title *string `type:"string"`
// The URL to open in the user's mobile browser. Used if the value for Action
// is URL.
Url *string `type:"string"`
// contains filtered or unexported fields
}
ADM Message.
func (s ADMMessage) GoString() string
GoString returns the string representation
func (s *ADMMessage) SetAction(v string) *ADMMessage
SetAction sets the Action field's value.
func (s *ADMMessage) SetBody(v string) *ADMMessage
SetBody sets the Body field's value.
func (s *ADMMessage) SetConsolidationKey(v string) *ADMMessage
SetConsolidationKey sets the ConsolidationKey field's value.
func (s *ADMMessage) SetData(v map[string]*string) *ADMMessage
SetData sets the Data field's value.
func (s *ADMMessage) SetExpiresAfter(v string) *ADMMessage
SetExpiresAfter sets the ExpiresAfter field's value.
func (s *ADMMessage) SetIconReference(v string) *ADMMessage
SetIconReference sets the IconReference field's value.
func (s *ADMMessage) SetImageIconUrl(v string) *ADMMessage
SetImageIconUrl sets the ImageIconUrl field's value.
func (s *ADMMessage) SetImageUrl(v string) *ADMMessage
SetImageUrl sets the ImageUrl field's value.
func (s *ADMMessage) SetMD5(v string) *ADMMessage
SetMD5 sets the MD5 field's value.
func (s *ADMMessage) SetRawContent(v string) *ADMMessage
SetRawContent sets the RawContent field's value.
func (s *ADMMessage) SetSilentPush(v bool) *ADMMessage
SetSilentPush sets the SilentPush field's value.
func (s *ADMMessage) SetSmallImageIconUrl(v string) *ADMMessage
SetSmallImageIconUrl sets the SmallImageIconUrl field's value.
func (s *ADMMessage) SetSound(v string) *ADMMessage
SetSound sets the Sound field's value.
func (s *ADMMessage) SetSubstitutions(v map[string][]*string) *ADMMessage
SetSubstitutions sets the Substitutions field's value.
func (s *ADMMessage) SetTitle(v string) *ADMMessage
SetTitle sets the Title field's value.
func (s *ADMMessage) SetUrl(v string) *ADMMessage
SetUrl sets the Url field's value.
func (s ADMMessage) String() string
String returns the string representation
type APNSChannelRequest struct {
// The bundle id used for APNs Tokens.
BundleId *string `type:"string"`
// The distribution certificate from Apple.
Certificate *string `type:"string"`
// The default authentication method used for APNs.
DefaultAuthenticationMethod *string `type:"string"`
// If the channel is enabled for sending messages.
Enabled *bool `type:"boolean"`
// The certificate private key.
PrivateKey *string `type:"string"`
// The team id used for APNs Tokens.
TeamId *string `type:"string"`
// The token key used for APNs Tokens.
TokenKey *string `type:"string"`
// The token key used for APNs Tokens.
TokenKeyId *string `type:"string"`
// contains filtered or unexported fields
}
Apple Push Notification Service channel definition.
func (s APNSChannelRequest) GoString() string
GoString returns the string representation
func (s *APNSChannelRequest) SetBundleId(v string) *APNSChannelRequest
SetBundleId sets the BundleId field's value.
func (s *APNSChannelRequest) SetCertificate(v string) *APNSChannelRequest
SetCertificate sets the Certificate field's value.
func (s *APNSChannelRequest) SetDefaultAuthenticationMethod(v string) *APNSChannelRequest
SetDefaultAuthenticationMethod sets the DefaultAuthenticationMethod field's value.
func (s *APNSChannelRequest) SetEnabled(v bool) *APNSChannelRequest
SetEnabled sets the Enabled field's value.
func (s *APNSChannelRequest) SetPrivateKey(v string) *APNSChannelRequest
SetPrivateKey sets the PrivateKey field's value.
func (s *APNSChannelRequest) SetTeamId(v string) *APNSChannelRequest
SetTeamId sets the TeamId field's value.
func (s *APNSChannelRequest) SetTokenKey(v string) *APNSChannelRequest
SetTokenKey sets the TokenKey field's value.
func (s *APNSChannelRequest) SetTokenKeyId(v string) *APNSChannelRequest
SetTokenKeyId sets the TokenKeyId field's value.
func (s APNSChannelRequest) String() string
String returns the string representation
type APNSChannelResponse struct {
// The ID of the application that the channel applies to.
ApplicationId *string `type:"string"`
// The date and time when this channel was created.
CreationDate *string `type:"string"`
// The default authentication method used for APNs.
DefaultAuthenticationMethod *string `type:"string"`
// If the channel is enabled for sending messages.
Enabled *bool `type:"boolean"`
// Not used. Retained for backwards compatibility.
HasCredential *bool `type:"boolean"`
// Indicates whether the channel is configured with a key for APNs token authentication.
// Provide a token key by setting the TokenKey attribute.
HasTokenKey *bool `type:"boolean"`
// (Deprecated) An identifier for the channel. Retained for backwards compatibility.
Id *string `type:"string"`
// Indicates whether or not the channel is archived.
IsArchived *bool `type:"boolean"`
// The user who last updated this channel.
LastModifiedBy *string `type:"string"`
// The date and time when this channel was last modified.
LastModifiedDate *string `type:"string"`
// The platform type. For this channel, the value is always "ADM."
Platform *string `type:"string"`
// The channel version.
Version *int64 `type:"integer"`
// contains filtered or unexported fields
}
Apple Distribution Push Notification Service channel definition.
func (s APNSChannelResponse) GoString() string
GoString returns the string representation
func (s *APNSChannelResponse) SetApplicationId(v string) *APNSChannelResponse
SetApplicationId sets the ApplicationId field's value.
func (s *APNSChannelResponse) SetCreationDate(v string) *APNSChannelResponse
SetCreationDate sets the CreationDate field's value.
func (s *APNSChannelResponse) SetDefaultAuthenticationMethod(v string) *APNSChannelResponse
SetDefaultAuthenticationMethod sets the DefaultAuthenticationMethod field's value.
func (s *APNSChannelResponse) SetEnabled(v bool) *APNSChannelResponse
SetEnabled sets the Enabled field's value.
func (s *APNSChannelResponse) SetHasCredential(v bool) *APNSChannelResponse
SetHasCredential sets the HasCredential field's value.
func (s *APNSChannelResponse) SetHasTokenKey(v bool) *APNSChannelResponse
SetHasTokenKey sets the HasTokenKey field's value.
func (s *APNSChannelResponse) SetId(v string) *APNSChannelResponse
SetId sets the Id field's value.
func (s *APNSChannelResponse) SetIsArchived(v bool) *APNSChannelResponse
SetIsArchived sets the IsArchived field's value.
func (s *APNSChannelResponse) SetLastModifiedBy(v string) *APNSChannelResponse
SetLastModifiedBy sets the LastModifiedBy field's value.
func (s *APNSChannelResponse) SetLastModifiedDate(v string) *APNSChannelResponse
SetLastModifiedDate sets the LastModifiedDate field's value.
func (s *APNSChannelResponse) SetPlatform(v string) *APNSChannelResponse
SetPlatform sets the Platform field's value.
func (s *APNSChannelResponse) SetVersion(v int64) *APNSChannelResponse
SetVersion sets the Version field's value.
func (s APNSChannelResponse) String() string
String returns the string representation
type APNSMessage struct {
// The action that occurs if the user taps a push notification delivered by
// the campaign: OPEN_APP - Your app launches, or it becomes the foreground
// app if it has been sent to the background. This is the default action. DEEP_LINK
// - Uses deep linking features in iOS and Android to open your app and display
// a designated user interface within the app. URL - The default mobile browser
// on the user's device launches and opens a web page at the URL you specify.
// Possible values include: OPEN_APP | DEEP_LINK | URL
Action *string `type:"string" enum:"Action"`
// Include this key when you want the system to modify the badge of your app
// icon. If this key is not included in the dictionary, the badge is not changed.
// To remove the badge, set the value of this key to 0.
Badge *int64 `type:"integer"`
// The message body of the notification.
Body *string `type:"string"`
// Provide this key with a string value that represents the notification's type.
// This value corresponds to the value in the identifier property of one of
// your app's registered categories.
Category *string `type:"string"`
// An ID that, if assigned to multiple messages, causes APNs to coalesce the
// messages into a single push notification instead of delivering each message
// individually. The value must not exceed 64 bytes. Amazon Pinpoint uses this
// value to set the apns-collapse-id request header when it sends the message
// to APNs.
CollapseId *string `type:"string"`
// The data payload used for a silent push. This payload is added to the notifications'
// data.pinpoint.jsonBody' object
Data map[string]*string `type:"map"`
// A URL that refers to the location of an image or video that you want to display
// in the push notification.
MediaUrl *string `type:"string"`
// The preferred authentication method, either "CERTIFICATE" or "TOKEN"
PreferredAuthenticationMethod *string `type:"string"`
// The message priority. Amazon Pinpoint uses this value to set the apns-priority
// request header when it sends the message to APNs. Accepts the following values:"5"
// - Low priority. Messages might be delayed, delivered in groups, and throttled."10"
// - High priority. Messages are sent immediately. High priority messages must
// cause an alert, sound, or badge on the receiving device.The default value
// is "10".The equivalent values for FCM or GCM messages are "normal" and "high".
// Amazon Pinpoint accepts these values for APNs messages and converts them.For
// more information about the apns-priority parameter, see Communicating with
// APNs in the APNs Local and Remote Notification Programming Guide.
Priority *string `type:"string"`
// The Raw JSON formatted string to be used as the payload. This value overrides
// the message.
RawContent *string `type:"string"`
// Indicates if the message should display on the users device. Silent pushes
// can be used for Remote Configuration and Phone Home use cases.
SilentPush *bool `type:"boolean"`
// Include this key when you want the system to play a sound. The value of this
// key is the name of a sound file in your app's main bundle or in the Library/Sounds
// folder of your app's data container. If the sound file cannot be found, or
// if you specify defaultfor the value, the system plays the default alert sound.
Sound *string `type:"string"`
// Default message substitutions. Can be overridden by individual address substitutions.
Substitutions map[string][]*string `type:"map"`
// Provide this key with a string value that represents the app-specific identifier
// for grouping notifications. If you provide a Notification Content app extension,
// you can use this value to group your notifications together.
ThreadId *string `type:"string"`
// The length of time (in seconds) that APNs stores and attempts to deliver
// the message. If the value is 0, APNs does not store the message or attempt
// to deliver it more than once. Amazon Pinpoint uses this value to set the
// apns-expiration request header when it sends the message to APNs.
TimeToLive *int64 `type:"integer"`
// The message title that displays above the message on the user's device.
Title *string `type:"string"`
// The URL to open in the user's mobile browser. Used if the value for Action
// is URL.
Url *string `type:"string"`
// contains filtered or unexported fields
}
APNS Message.
func (s APNSMessage) GoString() string
GoString returns the string representation
func (s *APNSMessage) SetAction(v string) *APNSMessage
SetAction sets the Action field's value.
func (s *APNSMessage) SetBadge(v int64) *APNSMessage
SetBadge sets the Badge field's value.
func (s *APNSMessage) SetBody(v string) *APNSMessage
SetBody sets the Body field's value.
func (s *APNSMessage) SetCategory(v string) *APNSMessage
SetCategory sets the Category field's value.
func (s *APNSMessage) SetCollapseId(v string) *APNSMessage
SetCollapseId sets the CollapseId field's value.
func (s *APNSMessage) SetData(v map[string]*string) *APNSMessage
SetData sets the Data field's value.
func (s *APNSMessage) SetMediaUrl(v string) *APNSMessage
SetMediaUrl sets the MediaUrl field's value.
func (s *APNSMessage) SetPreferredAuthenticationMethod(v string) *APNSMessage
SetPreferredAuthenticationMethod sets the PreferredAuthenticationMethod field's value.
func (s *APNSMessage) SetPriority(v string) *APNSMessage
SetPriority sets the Priority field's value.
func (s *APNSMessage) SetRawContent(v string) *APNSMessage
SetRawContent sets the RawContent field's value.
func (s *APNSMessage) SetSilentPush(v bool) *APNSMessage
SetSilentPush sets the SilentPush field's value.
func (s *APNSMessage) SetSound(v string) *APNSMessage
SetSound sets the Sound field's value.
func (s *APNSMessage) SetSubstitutions(v map[string][]*string) *APNSMessage
SetSubstitutions sets the Substitutions field's value.
func (s *APNSMessage) SetThreadId(v string) *APNSMessage
SetThreadId sets the ThreadId field's value.
func (s *APNSMessage) SetTimeToLive(v int64) *APNSMessage
SetTimeToLive sets the TimeToLive field's value.
func (s *APNSMessage) SetTitle(v string) *APNSMessage
SetTitle sets the Title field's value.
func (s *APNSMessage) SetUrl(v string) *APNSMessage
SetUrl sets the Url field's value.
func (s APNSMessage) String() string
String returns the string representation
type APNSSandboxChannelRequest struct {
// The bundle id used for APNs Tokens.
BundleId *string `type:"string"`
// The distribution certificate from Apple.
Certificate *string `type:"string"`
// The default authentication method used for APNs.
DefaultAuthenticationMethod *string `type:"string"`
// If the channel is enabled for sending messages.
Enabled *bool `type:"boolean"`
// The certificate private key.
PrivateKey *string `type:"string"`
// The team id used for APNs Tokens.
TeamId *string `type:"string"`
// The token key used for APNs Tokens.
TokenKey *string `type:"string"`
// The token key used for APNs Tokens.
TokenKeyId *string `type:"string"`
// contains filtered or unexported fields
}
Apple Development Push Notification Service channel definition.
func (s APNSSandboxChannelRequest) GoString() string
GoString returns the string representation
func (s *APNSSandboxChannelRequest) SetBundleId(v string) *APNSSandboxChannelRequest
SetBundleId sets the BundleId field's value.
func (s *APNSSandboxChannelRequest) SetCertificate(v string) *APNSSandboxChannelRequest
SetCertificate sets the Certificate field's value.
func (s *APNSSandboxChannelRequest) SetDefaultAuthenticationMethod(v string) *APNSSandboxChannelRequest
SetDefaultAuthenticationMethod sets the DefaultAuthenticationMethod field's value.
func (s *APNSSandboxChannelRequest) SetEnabled(v bool) *APNSSandboxChannelRequest
SetEnabled sets the Enabled field's value.
func (s *APNSSandboxChannelRequest) SetPrivateKey(v string) *APNSSandboxChannelRequest
SetPrivateKey sets the PrivateKey field's value.
func (s *APNSSandboxChannelRequest) SetTeamId(v string) *APNSSandboxChannelRequest
SetTeamId sets the TeamId field's value.
func (s *APNSSandboxChannelRequest) SetTokenKey(v string) *APNSSandboxChannelRequest
SetTokenKey sets the TokenKey field's value.
func (s *APNSSandboxChannelRequest) SetTokenKeyId(v string) *APNSSandboxChannelRequest
SetTokenKeyId sets the TokenKeyId field's value.
func (s APNSSandboxChannelRequest) String() string
String returns the string representation
type APNSSandboxChannelResponse struct {
// The ID of the application to which the channel applies.
ApplicationId *string `type:"string"`
// When was this segment created
CreationDate *string `type:"string"`
// The default authentication method used for APNs.
DefaultAuthenticationMethod *string `type:"string"`
// If the channel is enabled for sending messages.
Enabled *bool `type:"boolean"`
// Not used. Retained for backwards compatibility.
HasCredential *bool `type:"boolean"`
// Indicates whether the channel is configured with a key for APNs token authentication.
// Provide a token key by setting the TokenKey attribute.
HasTokenKey *bool `type:"boolean"`
// Channel ID. Not used, only for backwards compatibility.
Id *string `type:"string"`
// Is this channel archived
IsArchived *bool `type:"boolean"`
// Who last updated this entry
LastModifiedBy *string `type:"string"`
// Last date this was updated
LastModifiedDate *string `type:"string"`
// The platform type. Will be APNS_SANDBOX.
Platform *string `type:"string"`
// Version of channel
Version *int64 `type:"integer"`
// contains filtered or unexported fields
}
Apple Development Push Notification Service channel definition.
func (s APNSSandboxChannelResponse) GoString() string
GoString returns the string representation
func (s *APNSSandboxChannelResponse) SetApplicationId(v string) *APNSSandboxChannelResponse
SetApplicationId sets the ApplicationId field's value.
func (s *APNSSandboxChannelResponse) SetCreationDate(v string) *APNSSandboxChannelResponse
SetCreationDate sets the CreationDate field's value.
func (s *APNSSandboxChannelResponse) SetDefaultAuthenticationMethod(v string) *APNSSandboxChannelResponse
SetDefaultAuthenticationMethod sets the DefaultAuthenticationMethod field's value.
func (s *APNSSandboxChannelResponse) SetEnabled(v bool) *APNSSandboxChannelResponse
SetEnabled sets the Enabled field's value.
func (s *APNSSandboxChannelResponse) SetHasCredential(v bool) *APNSSandboxChannelResponse
SetHasCredential sets the HasCredential field's value.
func (s *APNSSandboxChannelResponse) SetHasTokenKey(v bool) *APNSSandboxChannelResponse
SetHasTokenKey sets the HasTokenKey field's value.
func (s *APNSSandboxChannelResponse) SetId(v string) *APNSSandboxChannelResponse
SetId sets the Id field's value.
func (s *APNSSandboxChannelResponse) SetIsArchived(v bool) *APNSSandboxChannelResponse
SetIsArchived sets the IsArchived field's value.
func (s *APNSSandboxChannelResponse) SetLastModifiedBy(v string) *APNSSandboxChannelResponse
SetLastModifiedBy sets the LastModifiedBy field's value.
func (s *APNSSandboxChannelResponse) SetLastModifiedDate(v string) *APNSSandboxChannelResponse
SetLastModifiedDate sets the LastModifiedDate field's value.
func (s *APNSSandboxChannelResponse) SetPlatform(v string) *APNSSandboxChannelResponse
SetPlatform sets the Platform field's value.
func (s *APNSSandboxChannelResponse) SetVersion(v int64) *APNSSandboxChannelResponse
SetVersion sets the Version field's value.
func (s APNSSandboxChannelResponse) String() string
String returns the string representation
type APNSVoipChannelRequest struct {
// The bundle id used for APNs Tokens.
BundleId *string `type:"string"`
// The distribution certificate from Apple.
Certificate *string `type:"string"`
// The default authentication method used for APNs.
DefaultAuthenticationMethod *string `type:"string"`
// If the channel is enabled for sending messages.
Enabled *bool `type:"boolean"`
// The certificate private key.
PrivateKey *string `type:"string"`
// The team id used for APNs Tokens.
TeamId *string `type:"string"`
// The token key used for APNs Tokens.
TokenKey *string `type:"string"`
// The token key used for APNs Tokens.
TokenKeyId *string `type:"string"`
// contains filtered or unexported fields
}
Apple VoIP Push Notification Service channel definition.
func (s APNSVoipChannelRequest) GoString() string
GoString returns the string representation
func (s *APNSVoipChannelRequest) SetBundleId(v string) *APNSVoipChannelRequest
SetBundleId sets the BundleId field's value.
func (s *APNSVoipChannelRequest) SetCertificate(v string) *APNSVoipChannelRequest
SetCertificate sets the Certificate field's value.
func (s *APNSVoipChannelRequest) SetDefaultAuthenticationMethod(v string) *APNSVoipChannelRequest
SetDefaultAuthenticationMethod sets the DefaultAuthenticationMethod field's value.
func (s *APNSVoipChannelRequest) SetEnabled(v bool) *APNSVoipChannelRequest
SetEnabled sets the Enabled field's value.
func (s *APNSVoipChannelRequest) SetPrivateKey(v string) *APNSVoipChannelRequest
SetPrivateKey sets the PrivateKey field's value.
func (s *APNSVoipChannelRequest) SetTeamId(v string) *APNSVoipChannelRequest
SetTeamId sets the TeamId field's value.
func (s *APNSVoipChannelRequest) SetTokenKey(v string) *APNSVoipChannelRequest
SetTokenKey sets the TokenKey field's value.
func (s *APNSVoipChannelRequest) SetTokenKeyId(v string) *APNSVoipChannelRequest
SetTokenKeyId sets the TokenKeyId field's value.
func (s APNSVoipChannelRequest) String() string
String returns the string representation
type APNSVoipChannelResponse struct {
// Application id
ApplicationId *string `type:"string"`
// When was this segment created
CreationDate *string `type:"string"`
// The default authentication method used for APNs.
DefaultAuthenticationMethod *string `type:"string"`
// If the channel is enabled for sending messages.
Enabled *bool `type:"boolean"`
// Not used. Retained for backwards compatibility.
HasCredential *bool `type:"boolean"`
// If the channel is registered with a token key for authentication.
HasTokenKey *bool `type:"boolean"`
// Channel ID. Not used, only for backwards compatibility.
Id *string `type:"string"`
// Is this channel archived
IsArchived *bool `type:"boolean"`
// Who made the last change
LastModifiedBy *string `type:"string"`
// Last date this was updated
LastModifiedDate *string `type:"string"`
// The platform type. Will be APNS.
Platform *string `type:"string"`
// Version of channel
Version *int64 `type:"integer"`
// contains filtered or unexported fields
}
Apple VoIP Push Notification Service channel definition.
func (s APNSVoipChannelResponse) GoString() string
GoString returns the string representation
func (s *APNSVoipChannelResponse) SetApplicationId(v string) *APNSVoipChannelResponse
SetApplicationId sets the ApplicationId field's value.
func (s *APNSVoipChannelResponse) SetCreationDate(v string) *APNSVoipChannelResponse
SetCreationDate sets the CreationDate field's value.
func (s *APNSVoipChannelResponse) SetDefaultAuthenticationMethod(v string) *APNSVoipChannelResponse
SetDefaultAuthenticationMethod sets the DefaultAuthenticationMethod field's value.
func (s *APNSVoipChannelResponse) SetEnabled(v bool) *APNSVoipChannelResponse
SetEnabled sets the Enabled field's value.
func (s *APNSVoipChannelResponse) SetHasCredential(v bool) *APNSVoipChannelResponse
SetHasCredential sets the HasCredential field's value.
func (s *APNSVoipChannelResponse) SetHasTokenKey(v bool) *APNSVoipChannelResponse
SetHasTokenKey sets the HasTokenKey field's value.
func (s *APNSVoipChannelResponse) SetId(v string) *APNSVoipChannelResponse
SetId sets the Id field's value.
func (s *APNSVoipChannelResponse) SetIsArchived(v bool) *APNSVoipChannelResponse
SetIsArchived sets the IsArchived field's value.
func (s *APNSVoipChannelResponse) SetLastModifiedBy(v string) *APNSVoipChannelResponse
SetLastModifiedBy sets the LastModifiedBy field's value.
func (s *APNSVoipChannelResponse) SetLastModifiedDate(v string) *APNSVoipChannelResponse
SetLastModifiedDate sets the LastModifiedDate field's value.
func (s *APNSVoipChannelResponse) SetPlatform(v string) *APNSVoipChannelResponse
SetPlatform sets the Platform field's value.
func (s *APNSVoipChannelResponse) SetVersion(v int64) *APNSVoipChannelResponse
SetVersion sets the Version field's value.
func (s APNSVoipChannelResponse) String() string
String returns the string representation
type APNSVoipSandboxChannelRequest struct {
// The bundle id used for APNs Tokens.
BundleId *string `type:"string"`
// The distribution certificate from Apple.
Certificate *string `type:"string"`
// The default authentication method used for APNs.
DefaultAuthenticationMethod *string `type:"string"`
// If the channel is enabled for sending messages.
Enabled *bool `type:"boolean"`
// The certificate private key.
PrivateKey *string `type:"string"`
// The team id used for APNs Tokens.
TeamId *string `type:"string"`
// The token key used for APNs Tokens.
TokenKey *string `type:"string"`
// The token key used for APNs Tokens.
TokenKeyId *string `type:"string"`
// contains filtered or unexported fields
}
Apple VoIP Developer Push Notification Service channel definition.
func (s APNSVoipSandboxChannelRequest) GoString() string
GoString returns the string representation
func (s *APNSVoipSandboxChannelRequest) SetBundleId(v string) *APNSVoipSandboxChannelRequest
SetBundleId sets the BundleId field's value.
func (s *APNSVoipSandboxChannelRequest) SetCertificate(v string) *APNSVoipSandboxChannelRequest
SetCertificate sets the Certificate field's value.
func (s *APNSVoipSandboxChannelRequest) SetDefaultAuthenticationMethod(v string) *APNSVoipSandboxChannelRequest
SetDefaultAuthenticationMethod sets the DefaultAuthenticationMethod field's value.
func (s *APNSVoipSandboxChannelRequest) SetEnabled(v bool) *APNSVoipSandboxChannelRequest
SetEnabled sets the Enabled field's value.
func (s *APNSVoipSandboxChannelRequest) SetPrivateKey(v string) *APNSVoipSandboxChannelRequest
SetPrivateKey sets the PrivateKey field's value.
func (s *APNSVoipSandboxChannelRequest) SetTeamId(v string) *APNSVoipSandboxChannelRequest
SetTeamId sets the TeamId field's value.
func (s *APNSVoipSandboxChannelRequest) SetTokenKey(v string) *APNSVoipSandboxChannelRequest
SetTokenKey sets the TokenKey field's value.
func (s *APNSVoipSandboxChannelRequest) SetTokenKeyId(v string) *APNSVoipSandboxChannelRequest
SetTokenKeyId sets the TokenKeyId field's value.
func (s APNSVoipSandboxChannelRequest) String() string
String returns the string representation
type APNSVoipSandboxChannelResponse struct {
// Application id
ApplicationId *string `type:"string"`
// When was this segment created
CreationDate *string `type:"string"`
// The default authentication method used for APNs.
DefaultAuthenticationMethod *string `type:"string"`
// If the channel is enabled for sending messages.
Enabled *bool `type:"boolean"`
// Not used. Retained for backwards compatibility.
HasCredential *bool `type:"boolean"`
// If the channel is registered with a token key for authentication.
HasTokenKey *bool `type:"boolean"`
// Channel ID. Not used, only for backwards compatibility.
Id *string `type:"string"`
// Is this channel archived
IsArchived *bool `type:"boolean"`
// Who made the last change
LastModifiedBy *string `type:"string"`
// Last date this was updated
LastModifiedDate *string `type:"string"`
// The platform type. Will be APNS.
Platform *string `type:"string"`
// Version of channel
Version *int64 `type:"integer"`
// contains filtered or unexported fields
}
Apple VoIP Developer Push Notification Service channel definition.
func (s APNSVoipSandboxChannelResponse) GoString() string
GoString returns the string representation
func (s *APNSVoipSandboxChannelResponse) SetApplicationId(v string) *APNSVoipSandboxChannelResponse
SetApplicationId sets the ApplicationId field's value.
func (s *APNSVoipSandboxChannelResponse) SetCreationDate(v string) *APNSVoipSandboxChannelResponse
SetCreationDate sets the CreationDate field's value.
func (s *APNSVoipSandboxChannelResponse) SetDefaultAuthenticationMethod(v string) *APNSVoipSandboxChannelResponse
SetDefaultAuthenticationMethod sets the DefaultAuthenticationMethod field's value.
func (s *APNSVoipSandboxChannelResponse) SetEnabled(v bool) *APNSVoipSandboxChannelResponse
SetEnabled sets the Enabled field's value.
func (s *APNSVoipSandboxChannelResponse) SetHasCredential(v bool) *APNSVoipSandboxChannelResponse
SetHasCredential sets the HasCredential field's value.
func (s *APNSVoipSandboxChannelResponse) SetHasTokenKey(v bool) *APNSVoipSandboxChannelResponse
SetHasTokenKey sets the HasTokenKey field's value.
func (s *APNSVoipSandboxChannelResponse) SetId(v string) *APNSVoipSandboxChannelResponse
SetId sets the Id field's value.
func (s *APNSVoipSandboxChannelResponse) SetIsArchived(v bool) *APNSVoipSandboxChannelResponse
SetIsArchived sets the IsArchived field's value.
func (s *APNSVoipSandboxChannelResponse) SetLastModifiedBy(v string) *APNSVoipSandboxChannelResponse
SetLastModifiedBy sets the LastModifiedBy field's value.
func (s *APNSVoipSandboxChannelResponse) SetLastModifiedDate(v string) *APNSVoipSandboxChannelResponse
SetLastModifiedDate sets the LastModifiedDate field's value.
func (s *APNSVoipSandboxChannelResponse) SetPlatform(v string) *APNSVoipSandboxChannelResponse
SetPlatform sets the Platform field's value.
func (s *APNSVoipSandboxChannelResponse) SetVersion(v int64) *APNSVoipSandboxChannelResponse
SetVersion sets the Version field's value.
func (s APNSVoipSandboxChannelResponse) String() string
String returns the string representation
type ActivitiesResponse struct {
// List of campaign activities
Item []*ActivityResponse `type:"list"`
// The string that you use in a subsequent request to get the next page of results
// in a paginated response.
NextToken *string `type:"string"`
// contains filtered or unexported fields
}
Activities for campaign.
func (s ActivitiesResponse) GoString() string
GoString returns the string representation
func (s *ActivitiesResponse) SetItem(v []*ActivityResponse) *ActivitiesResponse
SetItem sets the Item field's value.
func (s *ActivitiesResponse) SetNextToken(v string) *ActivitiesResponse
SetNextToken sets the NextToken field's value.
func (s ActivitiesResponse) String() string
String returns the string representation
type ActivityResponse struct {
// The ID of the application to which the campaign applies.
ApplicationId *string `type:"string"`
// The ID of the campaign to which the activity applies.
CampaignId *string `type:"string"`
// The actual time the activity was marked CANCELLED or COMPLETED. Provided
// in ISO 8601 format.
End *string `type:"string"`
// The unique activity ID.
Id *string `type:"string"`
// Indicates whether the activity succeeded.Valid values: SUCCESS, FAIL
Result *string `type:"string"`
// The scheduled start time for the activity in ISO 8601 format.
ScheduledStart *string `type:"string"`
// The actual start time of the activity in ISO 8601 format.
Start *string `type:"string"`
// The state of the activity.Valid values: PENDING, INITIALIZING, RUNNING, PAUSED,
// CANCELLED, COMPLETED
State *string `type:"string"`
// The total number of endpoints to which the campaign successfully delivered
// messages.
SuccessfulEndpointCount *int64 `type:"integer"`
// The total number of timezones completed.
TimezonesCompletedCount *int64 `type:"integer"`
// The total number of unique timezones present in the segment.
TimezonesTotalCount *int64 `type:"integer"`
// The total number of endpoints to which the campaign attempts to deliver messages.
TotalEndpointCount *int64 `type:"integer"`
// The ID of a variation of the campaign used for A/B testing.
TreatmentId *string `type:"string"`
// contains filtered or unexported fields
}
Activity definition
func (s ActivityResponse) GoString() string
GoString returns the string representation
func (s *ActivityResponse) SetApplicationId(v string) *ActivityResponse
SetApplicationId sets the ApplicationId field's value.
func (s *ActivityResponse) SetCampaignId(v string) *ActivityResponse
SetCampaignId sets the CampaignId field's value.
func (s *ActivityResponse) SetEnd(v string) *ActivityResponse
SetEnd sets the End field's value.
func (s *ActivityResponse) SetId(v string) *ActivityResponse
SetId sets the Id field's value.
func (s *ActivityResponse) SetResult(v string) *ActivityResponse
SetResult sets the Result field's value.
func (s *ActivityResponse) SetScheduledStart(v string) *ActivityResponse
SetScheduledStart sets the ScheduledStart field's value.
func (s *ActivityResponse) SetStart(v string) *ActivityResponse
SetStart sets the Start field's value.
func (s *ActivityResponse) SetState(v string) *ActivityResponse
SetState sets the State field's value.
func (s *ActivityResponse) SetSuccessfulEndpointCount(v int64) *ActivityResponse
SetSuccessfulEndpointCount sets the SuccessfulEndpointCount field's value.
func (s *ActivityResponse) SetTimezonesCompletedCount(v int64) *ActivityResponse
SetTimezonesCompletedCount sets the TimezonesCompletedCount field's value.
func (s *ActivityResponse) SetTimezonesTotalCount(v int64) *ActivityResponse
SetTimezonesTotalCount sets the TimezonesTotalCount field's value.
func (s *ActivityResponse) SetTotalEndpointCount(v int64) *ActivityResponse
SetTotalEndpointCount sets the TotalEndpointCount field's value.
func (s *ActivityResponse) SetTreatmentId(v string) *ActivityResponse
SetTreatmentId sets the TreatmentId field's value.
func (s ActivityResponse) String() string
String returns the string representation
type AddressConfiguration struct {
// Body override. If specified will override default body.
BodyOverride *string `type:"string"`
// The channel type.Valid values: GCM | APNS | APNS_SANDBOX | APNS_VOIP | APNS_VOIP_SANDBOX
// | ADM | SMS | EMAIL | BAIDU
ChannelType *string `type:"string" enum:"ChannelType"`
// A map of custom attributes to attributes to be attached to the message for
// this address. This payload is added to the push notification's 'data.pinpoint'
// object or added to the email/sms delivery receipt event attributes.
Context map[string]*string `type:"map"`
// The Raw JSON formatted string to be used as the payload. This value overrides
// the message.
RawContent *string `type:"string"`
// A map of substitution values for the message to be merged with the DefaultMessage's
// substitutions. Substitutions on this map take precedence over the all other
// substitutions.
Substitutions map[string][]*string `type:"map"`
// Title override. If specified will override default title if applicable.
TitleOverride *string `type:"string"`
// contains filtered or unexported fields
}
Address configuration.
func (s AddressConfiguration) GoString() string
GoString returns the string representation
func (s *AddressConfiguration) SetBodyOverride(v string) *AddressConfiguration
SetBodyOverride sets the BodyOverride field's value.
func (s *AddressConfiguration) SetChannelType(v string) *AddressConfiguration
SetChannelType sets the ChannelType field's value.
func (s *AddressConfiguration) SetContext(v map[string]*string) *AddressConfiguration
SetContext sets the Context field's value.
func (s *AddressConfiguration) SetRawContent(v string) *AddressConfiguration
SetRawContent sets the RawContent field's value.
func (s *AddressConfiguration) SetSubstitutions(v map[string][]*string) *AddressConfiguration
SetSubstitutions sets the Substitutions field's value.
func (s *AddressConfiguration) SetTitleOverride(v string) *AddressConfiguration
SetTitleOverride sets the TitleOverride field's value.
func (s AddressConfiguration) String() string
String returns the string representation
type ApplicationResponse struct {
// The arn for the application.
Arn *string `type:"string"`
// The unique application ID.
Id *string `type:"string"`
// The display name of the application.
Name *string `type:"string"`
// The Tags for the application.
Tags map[string]*string `locationName:"tags" type:"map"`
// contains filtered or unexported fields
}
Application Response.
func (s ApplicationResponse) GoString() string
GoString returns the string representation
func (s *ApplicationResponse) SetArn(v string) *ApplicationResponse
SetArn sets the Arn field's value.
func (s *ApplicationResponse) SetId(v string) *ApplicationResponse
SetId sets the Id field's value.
func (s *ApplicationResponse) SetName(v string) *ApplicationResponse
SetName sets the Name field's value.
func (s *ApplicationResponse) SetTags(v map[string]*string) *ApplicationResponse
SetTags sets the Tags field's value.
func (s ApplicationResponse) String() string
String returns the string representation
type ApplicationSettingsResource struct {
// The unique ID for the application.
ApplicationId *string `type:"string"`
// Default campaign hook.
CampaignHook *CampaignHook `type:"structure"`
// The date that the settings were last updated in ISO 8601 format.
LastModifiedDate *string `type:"string"`
// The default campaign limits for the app. These limits apply to each campaign
// for the app, unless the campaign overrides the default with limits of its
// own.
Limits *CampaignLimits `type:"structure"`
// The default quiet time for the app. Campaigns in the app don't send messages
// to endpoints during the quiet time.Note: Make sure that your endpoints include
// the Demographics.Timezone attribute if you plan to enable a quiet time for
// your app. If your endpoints don't include this attribute, they'll receive
// the messages that you send them, even if quiet time is enabled.When you set
// up an app to use quiet time, campaigns in that app don't send messages during
// the time range you specified, as long as all of the following are true:-
// The endpoint includes a valid Demographic.Timezone attribute.- The current
// time in the endpoint's time zone is later than or equal to the time specified
// in the QuietTime.Start attribute for the app (or campaign, if applicable).-
// The current time in the endpoint's time zone is earlier than or equal to
// the time specified in the QuietTime.End attribute for the app (or campaign,
// if applicable).Individual campaigns within the app can have their own quiet
// time settings, which override the quiet time settings at the app level.
QuietTime *QuietTime `type:"structure"`
// contains filtered or unexported fields
}
Application settings.
func (s ApplicationSettingsResource) GoString() string
GoString returns the string representation
func (s *ApplicationSettingsResource) SetApplicationId(v string) *ApplicationSettingsResource
SetApplicationId sets the ApplicationId field's value.
func (s *ApplicationSettingsResource) SetCampaignHook(v *CampaignHook) *ApplicationSettingsResource
SetCampaignHook sets the CampaignHook field's value.
func (s *ApplicationSettingsResource) SetLastModifiedDate(v string) *ApplicationSettingsResource
SetLastModifiedDate sets the LastModifiedDate field's value.
func (s *ApplicationSettingsResource) SetLimits(v *CampaignLimits) *ApplicationSettingsResource
SetLimits sets the Limits field's value.
func (s *ApplicationSettingsResource) SetQuietTime(v *QuietTime) *ApplicationSettingsResource
SetQuietTime sets the QuietTime field's value.
func (s ApplicationSettingsResource) String() string
String returns the string representation
type ApplicationsResponse struct {
// List of applications returned in this page.
Item []*ApplicationResponse `type:"list"`
// The string that you use in a subsequent request to get the next page of results
// in a paginated response.
NextToken *string `type:"string"`
// contains filtered or unexported fields
}
Get Applications Result.
func (s ApplicationsResponse) GoString() string
GoString returns the string representation
func (s *ApplicationsResponse) SetItem(v []*ApplicationResponse) *ApplicationsResponse
SetItem sets the Item field's value.
func (s *ApplicationsResponse) SetNextToken(v string) *ApplicationsResponse
SetNextToken sets the NextToken field's value.
func (s ApplicationsResponse) String() string
String returns the string representation
type AttributeDimension struct {
// The type of dimension:INCLUSIVE - Endpoints that match the criteria are included
// in the segment.EXCLUSIVE - Endpoints that match the criteria are excluded
// from the segment.
AttributeType *string `type:"string" enum:"AttributeType"`
// The criteria values for the segment dimension. Endpoints with matching attribute
// values are included or excluded from the segment, depending on the setting
// for Type.
Values []*string `type:"list"`
// contains filtered or unexported fields
}
Custom attibute dimension
func (s AttributeDimension) GoString() string
GoString returns the string representation
func (s *AttributeDimension) SetAttributeType(v string) *AttributeDimension
SetAttributeType sets the AttributeType field's value.
func (s *AttributeDimension) SetValues(v []*string) *AttributeDimension
SetValues sets the Values field's value.
func (s AttributeDimension) String() string
String returns the string representation
type AttributesResource struct {
// The unique ID for the application.
ApplicationId *string `type:"string"`
// The attribute type for the application.
AttributeType *string `type:"string"`
// The attributes for the application.
Attributes []*string `type:"list"`
// contains filtered or unexported fields
}
Attributes.
func (s AttributesResource) GoString() string
GoString returns the string representation
func (s *AttributesResource) SetApplicationId(v string) *AttributesResource
SetApplicationId sets the ApplicationId field's value.
func (s *AttributesResource) SetAttributeType(v string) *AttributesResource
SetAttributeType sets the AttributeType field's value.
func (s *AttributesResource) SetAttributes(v []*string) *AttributesResource
SetAttributes sets the Attributes field's value.
func (s AttributesResource) String() string
String returns the string representation
type BaiduChannelRequest struct {
// Platform credential API key from Baidu.
ApiKey *string `type:"string"`
// If the channel is enabled for sending messages.
Enabled *bool `type:"boolean"`
// Platform credential Secret key from Baidu.
SecretKey *string `type:"string"`
// contains filtered or unexported fields
}
Baidu Cloud Push credentials
func (s BaiduChannelRequest) GoString() string
GoString returns the string representation
func (s *BaiduChannelRequest) SetApiKey(v string) *BaiduChannelRequest
SetApiKey sets the ApiKey field's value.
func (s *BaiduChannelRequest) SetEnabled(v bool) *BaiduChannelRequest
SetEnabled sets the Enabled field's value.
func (s *BaiduChannelRequest) SetSecretKey(v string) *BaiduChannelRequest
SetSecretKey sets the SecretKey field's value.
func (s BaiduChannelRequest) String() string
String returns the string representation
type BaiduChannelResponse struct {
// Application id
ApplicationId *string `type:"string"`
// When was this segment created
CreationDate *string `type:"string"`
// The Baidu API key from Baidu.
Credential *string `type:"string"`
// If the channel is enabled for sending messages.
Enabled *bool `type:"boolean"`
// Not used. Retained for backwards compatibility.
HasCredential *bool `type:"boolean"`
// Channel ID. Not used, only for backwards compatibility.
Id *string `type:"string"`
// Is this channel archived
IsArchived *bool `type:"boolean"`
// Who made the last change
LastModifiedBy *string `type:"string"`
// Last date this was updated
LastModifiedDate *string `type:"string"`
// The platform type. Will be BAIDU
Platform *string `type:"string"`
// Version of channel
Version *int64 `type:"integer"`
// contains filtered or unexported fields
}
Baidu Cloud Messaging channel definition
func (s BaiduChannelResponse) GoString() string
GoString returns the string representation
func (s *BaiduChannelResponse) SetApplicationId(v string) *BaiduChannelResponse
SetApplicationId sets the ApplicationId field's value.
func (s *BaiduChannelResponse) SetCreationDate(v string) *BaiduChannelResponse
SetCreationDate sets the CreationDate field's value.
func (s *BaiduChannelResponse) SetCredential(v string) *BaiduChannelResponse
SetCredential sets the Credential field's value.
func (s *BaiduChannelResponse) SetEnabled(v bool) *BaiduChannelResponse
SetEnabled sets the Enabled field's value.
func (s *BaiduChannelResponse) SetHasCredential(v bool) *BaiduChannelResponse
SetHasCredential sets the HasCredential field's value.
func (s *BaiduChannelResponse) SetId(v string) *BaiduChannelResponse
SetId sets the Id field's value.
func (s *BaiduChannelResponse) SetIsArchived(v bool) *BaiduChannelResponse
SetIsArchived sets the IsArchived field's value.
func (s *BaiduChannelResponse) SetLastModifiedBy(v string) *BaiduChannelResponse
SetLastModifiedBy sets the LastModifiedBy field's value.
func (s *BaiduChannelResponse) SetLastModifiedDate(v string) *BaiduChannelResponse
SetLastModifiedDate sets the LastModifiedDate field's value.
func (s *BaiduChannelResponse) SetPlatform(v string) *BaiduChannelResponse
SetPlatform sets the Platform field's value.
func (s *BaiduChannelResponse) SetVersion(v int64) *BaiduChannelResponse
SetVersion sets the Version field's value.
func (s BaiduChannelResponse) String() string
String returns the string representation
type BaiduMessage struct {
// The action that occurs if the user taps a push notification delivered by
// the campaign: OPEN_APP - Your app launches, or it becomes the foreground
// app if it has been sent to the background. This is the default action. DEEP_LINK
// - Uses deep linking features in iOS and Android to open your app and display
// a designated user interface within the app. URL - The default mobile browser
// on the user's device launches and opens a web page at the URL you specify.
// Possible values include: OPEN_APP | DEEP_LINK | URL
Action *string `type:"string" enum:"Action"`
// The message body of the notification.
Body *string `type:"string"`
// The data payload used for a silent push. This payload is added to the notifications'
// data.pinpoint.jsonBody' object
Data map[string]*string `type:"map"`
// The icon image name of the asset saved in your application.
IconReference *string `type:"string"`
// The URL that points to an image used as the large icon to the notification
// content view.
ImageIconUrl *string `type:"string"`
// The URL that points to an image used in the push notification.
ImageUrl *string `type:"string"`
// The Raw JSON formatted string to be used as the payload. This value overrides
// the message.
RawContent *string `type:"string"`
// Indicates if the message should display on the users device. Silent pushes
// can be used for Remote Configuration and Phone Home use cases.
SilentPush *bool `type:"boolean"`
// The URL that points to an image used as the small icon for the notification
// which will be used to represent the notification in the status bar and content
// view
SmallImageIconUrl *string `type:"string"`
// Indicates a sound to play when the device receives the notification. Supports
// default, or the filename of a sound resource bundled in the app. Android
// sound files must reside in /res/raw/
Sound *string `type:"string"`
// Default message substitutions. Can be overridden by individual address substitutions.
Substitutions map[string][]*string `type:"map"`
// This parameter specifies how long (in seconds) the message should be kept
// in Baidu storage if the device is offline. The and the default value and
// the maximum time to live supported is 7 days (604800 seconds)
TimeToLive *int64 `type:"integer"`
// The message title that displays above the message on the user's device.
Title *string `type:"string"`
// The URL to open in the user's mobile browser. Used if the value for Action
// is URL.
Url *string `type:"string"`
// contains filtered or unexported fields
}
Baidu Message.
func (s BaiduMessage) GoString() string
GoString returns the string representation
func (s *BaiduMessage) SetAction(v string) *BaiduMessage
SetAction sets the Action field's value.
func (s *BaiduMessage) SetBody(v string) *BaiduMessage
SetBody sets the Body field's value.
func (s *BaiduMessage) SetData(v map[string]*string) *BaiduMessage
SetData sets the Data field's value.
func (s *BaiduMessage) SetIconReference(v string) *BaiduMessage
SetIconReference sets the IconReference field's value.
func (s *BaiduMessage) SetImageIconUrl(v string) *BaiduMessage
SetImageIconUrl sets the ImageIconUrl field's value.
func (s *BaiduMessage) SetImageUrl(v string) *BaiduMessage
SetImageUrl sets the ImageUrl field's value.
func (s *BaiduMessage) SetRawContent(v string) *BaiduMessage
SetRawContent sets the RawContent field's value.
func (s *BaiduMessage) SetSilentPush(v bool) *BaiduMessage
SetSilentPush sets the SilentPush field's value.
func (s *BaiduMessage) SetSmallImageIconUrl(v string) *BaiduMessage
SetSmallImageIconUrl sets the SmallImageIconUrl field's value.
func (s *BaiduMessage) SetSound(v string) *BaiduMessage
SetSound sets the Sound field's value.
func (s *BaiduMessage) SetSubstitutions(v map[string][]*string) *BaiduMessage
SetSubstitutions sets the Substitutions field's value.
func (s *BaiduMessage) SetTimeToLive(v int64) *BaiduMessage
SetTimeToLive sets the TimeToLive field's value.
func (s *BaiduMessage) SetTitle(v string) *BaiduMessage
SetTitle sets the Title field's value.
func (s *BaiduMessage) SetUrl(v string) *BaiduMessage
SetUrl sets the Url field's value.
func (s BaiduMessage) String() string
String returns the string representation
type CampaignEmailMessage struct {
// The email text body.
Body *string `type:"string"`
// The email address used to send the email from. Defaults to use FromAddress
// specified in the Email Channel.
FromAddress *string `type:"string"`
// The email html body.
HtmlBody *string `type:"string"`
// The email title (Or subject).
Title *string `type:"string"`
// contains filtered or unexported fields
}
The email message configuration.
func (s CampaignEmailMessage) GoString() string
GoString returns the string representation
func (s *CampaignEmailMessage) SetBody(v string) *CampaignEmailMessage
SetBody sets the Body field's value.
func (s *CampaignEmailMessage) SetFromAddress(v string) *CampaignEmailMessage
SetFromAddress sets the FromAddress field's value.
func (s *CampaignEmailMessage) SetHtmlBody(v string) *CampaignEmailMessage
SetHtmlBody sets the HtmlBody field's value.
func (s *CampaignEmailMessage) SetTitle(v string) *CampaignEmailMessage
SetTitle sets the Title field's value.
func (s CampaignEmailMessage) String() string
String returns the string representation
type CampaignEventFilter struct {
// An object that defines the dimensions for the event filter.
Dimensions *EventDimensions `type:"structure"`
// The type of event that causes the campaign to be sent. Possible values:SYSTEM
// - Send the campaign when a system event occurs. See the System resource for
// more information.ENDPOINT - Send the campaign when an endpoint event occurs.
// See the Event resource for more information.
FilterType *string `type:"string" enum:"FilterType"`
// contains filtered or unexported fields
}
An object that defines the events that cause the campaign to be sent.
func (s CampaignEventFilter) GoString() string
GoString returns the string representation
func (s *CampaignEventFilter) SetDimensions(v *EventDimensions) *CampaignEventFilter
SetDimensions sets the Dimensions field's value.
func (s *CampaignEventFilter) SetFilterType(v string) *CampaignEventFilter
SetFilterType sets the FilterType field's value.
func (s CampaignEventFilter) String() string
String returns the string representation
type CampaignHook struct {
// Lambda function name or arn to be called for delivery
LambdaFunctionName *string `type:"string"`
// What mode Lambda should be invoked in.
Mode *string `type:"string" enum:"Mode"`
// Web URL to call for hook. If the URL has authentication specified it will
// be added as authentication to the request
WebUrl *string `type:"string"`
// contains filtered or unexported fields
}
Campaign hook information.
func (s CampaignHook) GoString() string
GoString returns the string representation
func (s *CampaignHook) SetLambdaFunctionName(v string) *CampaignHook
SetLambdaFunctionName sets the LambdaFunctionName field's value.
func (s *CampaignHook) SetMode(v string) *CampaignHook
SetMode sets the Mode field's value.
func (s *CampaignHook) SetWebUrl(v string) *CampaignHook
SetWebUrl sets the WebUrl field's value.
func (s CampaignHook) String() string
String returns the string representation
type CampaignLimits struct {
// The maximum number of messages that each campaign can send to a single endpoint
// in a 24-hour period.
Daily *int64 `type:"integer"`
// The length of time (in seconds) that the campaign can run before it ends
// and message deliveries stop. This duration begins at the scheduled start
// time for the campaign. The minimum value is 60.
MaximumDuration *int64 `type:"integer"`
// The number of messages that the campaign can send per second. The minimum
// value is 50, and the maximum is 20000.
MessagesPerSecond *int64 `type:"integer"`
// The maximum number of messages that an individual campaign can send to a
// single endpoint over the course of the campaign.
Total *int64 `type:"integer"`
// contains filtered or unexported fields
}
Campaign Limits are used to limit the number of messages that can be sent to a single endpoint.
func (s CampaignLimits) GoString() string
GoString returns the string representation
func (s *CampaignLimits) SetDaily(v int64) *CampaignLimits
SetDaily sets the Daily field's value.
func (s *CampaignLimits) SetMaximumDuration(v int64) *CampaignLimits
SetMaximumDuration sets the MaximumDuration field's value.
func (s *CampaignLimits) SetMessagesPerSecond(v int64) *CampaignLimits
SetMessagesPerSecond sets the MessagesPerSecond field's value.
func (s *CampaignLimits) SetTotal(v int64) *CampaignLimits
SetTotal sets the Total field's value.
func (s CampaignLimits) String() string
String returns the string representation
type CampaignResponse struct {
// Treatments that are defined in addition to the default treatment.
AdditionalTreatments []*TreatmentResource `type:"list"`
// The ID of the application to which the campaign applies.
ApplicationId *string `type:"string"`
// The arn for the campaign.
Arn *string `type:"string"`
// The date the campaign was created in ISO 8601 format.
CreationDate *string `type:"string"`
// The status of the campaign's default treatment. Only present for A/B test
// campaigns.
DefaultState *CampaignState `type:"structure"`
// A description of the campaign.
Description *string `type:"string"`
// The allocated percentage of end users who will not receive messages from
// this campaign.
HoldoutPercent *int64 `type:"integer"`
// Campaign hook information.
Hook *CampaignHook `type:"structure"`
// The unique campaign ID.
Id *string `type:"string"`
// Indicates whether the campaign is paused. A paused campaign does not send
// messages unless you resume it by setting IsPaused to false.
IsPaused *bool `type:"boolean"`
// The date the campaign was last updated in ISO 8601 format.
LastModifiedDate *string `type:"string"`
// The campaign limits settings.
Limits *CampaignLimits `type:"structure"`
// The message configuration settings.
MessageConfiguration *MessageConfiguration `type:"structure"`
// The custom name of the campaign.
Name *string `type:"string"`
// The campaign schedule.
Schedule *Schedule `type:"structure"`
// The ID of the segment to which the campaign sends messages.
SegmentId *string `type:"string"`
// The version of the segment to which the campaign sends messages.
SegmentVersion *int64 `type:"integer"`
// The campaign status.An A/B test campaign will have a status of COMPLETED
// only when all treatments have a status of COMPLETED.
State *CampaignState `type:"structure"`
// The Tags for the campaign.
Tags map[string]*string `locationName:"tags" type:"map"`
// A custom description for the treatment.
TreatmentDescription *string `type:"string"`
// The custom name of a variation of the campaign used for A/B testing.
TreatmentName *string `type:"string"`
// The campaign version number.
Version *int64 `type:"integer"`
// contains filtered or unexported fields
}
Campaign definition
func (s CampaignResponse) GoString() string
GoString returns the string representation
func (s *CampaignResponse) SetAdditionalTreatments(v []*TreatmentResource) *CampaignResponse
SetAdditionalTreatments sets the AdditionalTreatments field's value.
func (s *CampaignResponse) SetApplicationId(v string) *CampaignResponse
SetApplicationId sets the ApplicationId field's value.
func (s *CampaignResponse) SetArn(v string) *CampaignResponse
SetArn sets the Arn field's value.
func (s *CampaignResponse) SetCreationDate(v string) *CampaignResponse
SetCreationDate sets the CreationDate field's value.
func (s *CampaignResponse) SetDefaultState(v *CampaignState) *CampaignResponse
SetDefaultState sets the DefaultState field's value.
func (s *CampaignResponse) SetDescription(v string) *CampaignResponse
SetDescription sets the Description field's value.
func (s *CampaignResponse) SetHoldoutPercent(v int64) *CampaignResponse
SetHoldoutPercent sets the HoldoutPercent field's value.
func (s *CampaignResponse) SetHook(v *CampaignHook) *CampaignResponse
SetHook sets the Hook field's value.
func (s *CampaignResponse) SetId(v string) *CampaignResponse
SetId sets the Id field's value.
func (s *CampaignResponse) SetIsPaused(v bool) *CampaignResponse
SetIsPaused sets the IsPaused field's value.
func (s *CampaignResponse) SetLastModifiedDate(v string) *CampaignResponse
SetLastModifiedDate sets the LastModifiedDate field's value.
func (s *CampaignResponse) SetLimits(v *CampaignLimits) *CampaignResponse
SetLimits sets the Limits field's value.
func (s *CampaignResponse) SetMessageConfiguration(v *MessageConfiguration) *CampaignResponse
SetMessageConfiguration sets the MessageConfiguration field's value.
func (s *CampaignResponse) SetName(v string) *CampaignResponse
SetName sets the Name field's value.
func (s *CampaignResponse) SetSchedule(v *Schedule) *CampaignResponse
SetSchedule sets the Schedule field's value.
func (s *CampaignResponse) SetSegmentId(v string) *CampaignResponse
SetSegmentId sets the SegmentId field's value.
func (s *CampaignResponse) SetSegmentVersion(v int64) *CampaignResponse
SetSegmentVersion sets the SegmentVersion field's value.
func (s *CampaignResponse) SetState(v *CampaignState) *CampaignResponse
SetState sets the State field's value.
func (s *CampaignResponse) SetTags(v map[string]*string) *CampaignResponse
SetTags sets the Tags field's value.
func (s *CampaignResponse) SetTreatmentDescription(v string) *CampaignResponse
SetTreatmentDescription sets the TreatmentDescription field's value.
func (s *CampaignResponse) SetTreatmentName(v string) *CampaignResponse
SetTreatmentName sets the TreatmentName field's value.
func (s *CampaignResponse) SetVersion(v int64) *CampaignResponse
SetVersion sets the Version field's value.
func (s CampaignResponse) String() string
String returns the string representation
type CampaignSmsMessage struct {
// The SMS text body.
Body *string `type:"string"`
// Is this is a transactional SMS message, otherwise a promotional message.
MessageType *string `type:"string" enum:"MessageType"`
// Sender ID of sent message.
SenderId *string `type:"string"`
// contains filtered or unexported fields
}
SMS message configuration.
func (s CampaignSmsMessage) GoString() string
GoString returns the string representation
func (s *CampaignSmsMessage) SetBody(v string) *CampaignSmsMessage
SetBody sets the Body field's value.
func (s *CampaignSmsMessage) SetMessageType(v string) *CampaignSmsMessage
SetMessageType sets the MessageType field's value.
func (s *CampaignSmsMessage) SetSenderId(v string) *CampaignSmsMessage
SetSenderId sets the SenderId field's value.
func (s CampaignSmsMessage) String() string
String returns the string representation
type CampaignState struct {
// The status of the campaign, or the status of a treatment that belongs to
// an A/B test campaign.Valid values: SCHEDULED, EXECUTING, PENDING_NEXT_RUN,
// COMPLETED, PAUSED
CampaignStatus *string `type:"string" enum:"CampaignStatus"`
// contains filtered or unexported fields
}
State of the Campaign
func (s CampaignState) GoString() string
GoString returns the string representation
func (s *CampaignState) SetCampaignStatus(v string) *CampaignState
SetCampaignStatus sets the CampaignStatus field's value.
func (s CampaignState) String() string
String returns the string representation
type CampaignsResponse struct {
// A list of campaigns.
Item []*CampaignResponse `type:"list"`
// The string that you use in a subsequent request to get the next page of results
// in a paginated response.
NextToken *string `type:"string"`
// contains filtered or unexported fields
}
List of available campaigns.
func (s CampaignsResponse) GoString() string
GoString returns the string representation
func (s *CampaignsResponse) SetItem(v []*CampaignResponse) *CampaignsResponse
SetItem sets the Item field's value.
func (s *CampaignsResponse) SetNextToken(v string) *CampaignsResponse
SetNextToken sets the NextToken field's value.
func (s CampaignsResponse) String() string
String returns the string representation
type ChannelResponse struct {
// Application id
ApplicationId *string `type:"string"`
// When was this segment created
CreationDate *string `type:"string"`
// If the channel is enabled for sending messages.
Enabled *bool `type:"boolean"`
// Not used. Retained for backwards compatibility.
HasCredential *bool `type:"boolean"`
// Channel ID. Not used, only for backwards compatibility.
Id *string `type:"string"`
// Is this channel archived
IsArchived *bool `type:"boolean"`
// Who made the last change
LastModifiedBy *string `type:"string"`
// Last date this was updated
LastModifiedDate *string `type:"string"`
// Version of channel
Version *int64 `type:"integer"`
// contains filtered or unexported fields
}
Base definition for channel response.
func (s ChannelResponse) GoString() string
GoString returns the string representation
func (s *ChannelResponse) SetApplicationId(v string) *ChannelResponse
SetApplicationId sets the ApplicationId field's value.
func (s *ChannelResponse) SetCreationDate(v string) *ChannelResponse
SetCreationDate sets the CreationDate field's value.
func (s *ChannelResponse) SetEnabled(v bool) *ChannelResponse
SetEnabled sets the Enabled field's value.
func (s *ChannelResponse) SetHasCredential(v bool) *ChannelResponse
SetHasCredential sets the HasCredential field's value.
func (s *ChannelResponse) SetId(v string) *ChannelResponse
SetId sets the Id field's value.
func (s *ChannelResponse) SetIsArchived(v bool) *ChannelResponse
SetIsArchived sets the IsArchived field's value.
func (s *ChannelResponse) SetLastModifiedBy(v string) *ChannelResponse
SetLastModifiedBy sets the LastModifiedBy field's value.
func (s *ChannelResponse) SetLastModifiedDate(v string) *ChannelResponse
SetLastModifiedDate sets the LastModifiedDate field's value.
func (s *ChannelResponse) SetVersion(v int64) *ChannelResponse
SetVersion sets the Version field's value.
func (s ChannelResponse) String() string
String returns the string representation
type ChannelsResponse struct {
// A map of channels, with the ChannelType as the key and the Channel as the
// value.
Channels map[string]*ChannelResponse `type:"map"`
// contains filtered or unexported fields
}
Get channels definition
func (s ChannelsResponse) GoString() string
GoString returns the string representation
func (s *ChannelsResponse) SetChannels(v map[string]*ChannelResponse) *ChannelsResponse
SetChannels sets the Channels field's value.
func (s ChannelsResponse) String() string
String returns the string representation
type CreateAppInput struct {
// Application Request.
//
// CreateApplicationRequest is a required field
CreateApplicationRequest *CreateApplicationRequest `type:"structure" required:"true"`
// contains filtered or unexported fields
}
func (s CreateAppInput) GoString() string
GoString returns the string representation
func (s *CreateAppInput) SetCreateApplicationRequest(v *CreateApplicationRequest) *CreateAppInput
SetCreateApplicationRequest sets the CreateApplicationRequest field's value.
func (s CreateAppInput) String() string
String returns the string representation
func (s *CreateAppInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateAppOutput struct {
// Application Response.
//
// ApplicationResponse is a required field
ApplicationResponse *ApplicationResponse `type:"structure" required:"true"`
// contains filtered or unexported fields
}
func (s CreateAppOutput) GoString() string
GoString returns the string representation
func (s *CreateAppOutput) SetApplicationResponse(v *ApplicationResponse) *CreateAppOutput
SetApplicationResponse sets the ApplicationResponse field's value.
func (s CreateAppOutput) String() string
String returns the string representation
type CreateApplicationRequest struct {
// The display name of the application. Used in the Amazon Pinpoint console.
Name *string `type:"string"`
// The Tags for the app.
Tags map[string]*string `locationName:"tags" type:"map"`
// contains filtered or unexported fields
}
Application Request.
func (s CreateApplicationRequest) GoString() string
GoString returns the string representation
func (s *CreateApplicationRequest) SetName(v string) *CreateApplicationRequest
SetName sets the Name field's value.
func (s *CreateApplicationRequest) SetTags(v map[string]*string) *CreateApplicationRequest
SetTags sets the Tags field's value.
func (s CreateApplicationRequest) String() string
String returns the string representation
type CreateCampaignInput struct {
// ApplicationId is a required field
ApplicationId *string `location:"uri" locationName:"application-id" type:"string" required:"true"`
// Used to create a campaign.
//
// WriteCampaignRequest is a required field
WriteCampaignRequest *WriteCampaignRequest `type:"structure" required:"true"`
// contains filtered or unexported fields
}
func (s CreateCampaignInput) GoString() string
GoString returns the string representation
func (s *CreateCampaignInput) SetApplicationId(v string) *CreateCampaignInput
SetApplicationId sets the ApplicationId field's value.
func (s *CreateCampaignInput) SetWriteCampaignRequest(v *WriteCampaignRequest) *CreateCampaignInput
SetWriteCampaignRequest sets the WriteCampaignRequest field's value.
func (s CreateCampaignInput) String() string
String returns the string representation
func (s *CreateCampaignInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateCampaignOutput struct {
// Campaign definition
//
// CampaignResponse is a required field
CampaignResponse *CampaignResponse `type:"structure" required:"true"`
// contains filtered or unexported fields
}
func (s CreateCampaignOutput) GoString() string
GoString returns the string representation
func (s *CreateCampaignOutput) SetCampaignResponse(v *CampaignResponse) *CreateCampaignOutput
SetCampaignResponse sets the CampaignResponse field's value.
func (s CreateCampaignOutput) String() string
String returns the string representation
type CreateExportJobInput struct {
// ApplicationId is a required field
ApplicationId *string `location:"uri" locationName:"application-id" type:"string" required:"true"`
// Export job request.
//
// ExportJobRequest is a required field
ExportJobRequest *ExportJobRequest `type:"structure" required:"true"`
// contains filtered or unexported fields
}
func (s CreateExportJobInput) GoString() string
GoString returns the string representation
func (s *CreateExportJobInput) SetApplicationId(v string) *CreateExportJobInput
SetApplicationId sets the ApplicationId field's value.
func (s *CreateExportJobInput) SetExportJobRequest(v *ExportJobRequest) *CreateExportJobInput
SetExportJobRequest sets the ExportJobRequest field's value.
func (s CreateExportJobInput) String() string
String returns the string representation
func (s *CreateExportJobInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateExportJobOutput struct {
// Export job response.
//
// ExportJobResponse is a required field
ExportJobResponse *ExportJobResponse `type:"structure" required:"true"`
// contains filtered or unexported fields
}
func (s CreateExportJobOutput) GoString() string
GoString returns the string representation
func (s *CreateExportJobOutput) SetExportJobResponse(v *ExportJobResponse) *CreateExportJobOutput
SetExportJobResponse sets the ExportJobResponse field's value.
func (s CreateExportJobOutput) String() string
String returns the string representation
type CreateImportJobInput struct {
// ApplicationId is a required field
ApplicationId *string `location:"uri" locationName:"application-id" type:"string" required:"true"`
// Import job request.
//
// ImportJobRequest is a required field
ImportJobRequest *ImportJobRequest `type:"structure" required:"true"`
// contains filtered or unexported fields
}
func (s CreateImportJobInput) GoString() string
GoString returns the string representation
func (s *CreateImportJobInput) SetApplicationId(v string) *CreateImportJobInput
SetApplicationId sets the ApplicationId field's value.
func (s *CreateImportJobInput) SetImportJobRequest(v *ImportJobRequest) *CreateImportJobInput
SetImportJobRequest sets the ImportJobRequest field's value.
func (s CreateImportJobInput) String() string
String returns the string representation
func (s *CreateImportJobInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateImportJobOutput struct {
// Import job response.
//
// ImportJobResponse is a required field
ImportJobResponse *ImportJobResponse `type:"structure" required:"true"`
// contains filtered or unexported fields
}
func (s CreateImportJobOutput) GoString() string
GoString returns the string representation
func (s *CreateImportJobOutput) SetImportJobResponse(v *ImportJobResponse) *CreateImportJobOutput
SetImportJobResponse sets the ImportJobResponse field's value.
func (s CreateImportJobOutput) String() string
String returns the string representation
type CreateSegmentInput struct {
// ApplicationId is a required field
ApplicationId *string `location:"uri" locationName:"application-id" type:"string" required:"true"`
// Segment definition.
//
// WriteSegmentRequest is a required field
WriteSegmentRequest *WriteSegmentRequest `type:"structure" required:"true"`
// contains filtered or unexported fields
}
func (s CreateSegmentInput) GoString() string
GoString returns the string representation
func (s *CreateSegmentInput) SetApplicationId(v string) *CreateSegmentInput
SetApplicationId sets the ApplicationId field's value.
func (s *CreateSegmentInput) SetWriteSegmentRequest(v *WriteSegmentRequest) *CreateSegmentInput
SetWriteSegmentRequest sets the WriteSegmentRequest field's value.
func (s CreateSegmentInput) String() string
String returns the string representation
func (s *CreateSegmentInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateSegmentOutput struct {
// Segment definition.
//
// SegmentResponse is a required field
SegmentResponse *SegmentResponse `type:"structure" required:"true"`
// contains filtered or unexported fields
}
func (s CreateSegmentOutput) GoString() string
GoString returns the string representation
func (s *CreateSegmentOutput) SetSegmentResponse(v *SegmentResponse) *CreateSegmentOutput
SetSegmentResponse sets the SegmentResponse field's value.
func (s CreateSegmentOutput) String() string
String returns the string representation
type DefaultMessage struct {
// The message body of the notification, the email body or the text message.
Body *string `type:"string"`
// Default message substitutions. Can be overridden by individual address substitutions.
Substitutions map[string][]*string `type:"map"`
// contains filtered or unexported fields
}
The default message to use across all channels.
func (s DefaultMessage) GoString() string
GoString returns the string representation
func (s *DefaultMessage) SetBody(v string) *DefaultMessage
SetBody sets the Body field's value.
func (s *DefaultMessage) SetSubstitutions(v map[string][]*string) *DefaultMessage
SetSubstitutions sets the Substitutions field's value.
func (s DefaultMessage) String() string
String returns the string representation
type DefaultPushNotificationMessage struct {
// The action that occurs if the user taps a push notification delivered by
// the campaign: OPEN_APP - Your app launches, or it becomes the foreground
// app if it has been sent to the background. This is the default action. DEEP_LINK
// - Uses deep linking features in iOS and Android to open your app and display
// a designated user interface within the app. URL - The default mobile browser
// on the user's device launches and opens a web page at the URL you specify.
// Possible values include: OPEN_APP | DEEP_LINK | URL
Action *string `type:"string" enum:"Action"`
// The message body of the notification.
Body *string `type:"string"`
// The data payload used for a silent push. This payload is added to the notifications'
// data.pinpoint.jsonBody' object
Data map[string]*string `type:"map"`
// Indicates if the message should display on the recipient's device. You can
// use silent pushes for remote configuration or to deliver messages to in-app
// notification centers.
SilentPush *bool `type:"boolean"`
// Default message substitutions. Can be overridden by individual address substitutions.
Substitutions map[string][]*string `type:"map"`
// The message title that displays above the message on the user's device.
Title *string `type:"string"`
// The URL to open in the user's mobile browser. Used if the value for Action
// is URL.
Url *string `type:"string"`
// contains filtered or unexported fields
}
Default Push Notification Message.
func (s DefaultPushNotificationMessage) GoString() string
GoString returns the string representation
func (s *DefaultPushNotificationMessage) SetAction(v string) *DefaultPushNotificationMessage
SetAction sets the Action field's value.
func (s *DefaultPushNotificationMessage) SetBody(v string) *DefaultPushNotificationMessage
SetBody sets the Body field's value.
func (s *DefaultPushNotificationMessage) SetData(v map[string]*string) *DefaultPushNotificationMessage
SetData sets the Data field's value.
func (s *DefaultPushNotificationMessage) SetSilentPush(v bool) *DefaultPushNotificationMessage
SetSilentPush sets the SilentPush field's value.
func (s *DefaultPushNotificationMessage) SetSubstitutions(v map[string][]*string) *DefaultPushNotificationMessage
SetSubstitutions sets the Substitutions field's value.
func (s *DefaultPushNotificationMessage) SetTitle(v string) *DefaultPushNotificationMessage
SetTitle sets the Title field's value.
func (s *DefaultPushNotificationMessage) SetUrl(v string) *DefaultPushNotificationMessage
SetUrl sets the Url field's value.
func (s DefaultPushNotificationMessage) String() string
String returns the string representation
type DeleteAdmChannelInput struct {
// ApplicationId is a required field
ApplicationId *string `location:"uri" locationName:"application-id" type:"string" required:"true"`
// contains filtered or unexported fields
}
func (s DeleteAdmChannelInput) GoString() string
GoString returns the string representation
func (s *DeleteAdmChannelInput) SetApplicationId(v string) *DeleteAdmChannelInput
SetApplicationId sets the ApplicationId field's value.
func (s DeleteAdmChannelInput) String() string
String returns the string representation
func (s *DeleteAdmChannelInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteAdmChannelOutput struct {
// Amazon Device Messaging channel definition.
//
// ADMChannelResponse is a required field
ADMChannelResponse *ADMChannelResponse `type:"structure" required:"true"`
// contains filtered or unexported fields
}
func (s DeleteAdmChannelOutput) GoString() string
GoString returns the string representation
func (s *DeleteAdmChannelOutput) SetADMChannelResponse(v *ADMChannelResponse) *DeleteAdmChannelOutput
SetADMChannelResponse sets the ADMChannelResponse field's value.
func (s DeleteAdmChannelOutput) String() string
String returns the string representation
type DeleteApnsChannelInput struct {
// ApplicationId is a required field
ApplicationId *string `location:"uri" locationName:"application-id" type:"string" required:"true"`
// contains filtered or unexported fields
}
func (s DeleteApnsChannelInput) GoString() string
GoString returns the string representation
func (s *DeleteApnsChannelInput) SetApplicationId(v string) *DeleteApnsChannelInput
SetApplicationId sets the ApplicationId field's value.
func (s DeleteApnsChannelInput) String() string
String returns the string representation
func (s *DeleteApnsChannelInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteApnsChannelOutput struct {
// Apple Distribution Push Notification Service channel definition.
//
// APNSChannelResponse is a required field
APNSChannelResponse *APNSChannelResponse `type:"structure" required:"true"`
// contains filtered or unexported fields
}
func (s DeleteApnsChannelOutput) GoString() string
GoString returns the string representation
func (s *DeleteApnsChannelOutput) SetAPNSChannelResponse(v *APNSChannelResponse) *DeleteApnsChannelOutput
SetAPNSChannelResponse sets the APNSChannelResponse field's value.
func (s DeleteApnsChannelOutput) String() string
String returns the string representation
type DeleteApnsSandboxChannelInput struct {
// ApplicationId is a required field
ApplicationId *string `location:"uri" locationName:"application-id" type:"string" required:"true"`
// contains filtered or unexported fields
}
func (s DeleteApnsSandboxChannelInput) GoString() string
GoString returns the string representation
func (s *DeleteApnsSandboxChannelInput) SetApplicationId(v string) *DeleteApnsSandboxChannelInput
SetApplicationId sets the ApplicationId field's value.
func (s DeleteApnsSandboxChannelInput) String() string
String returns the string representation
func (s *DeleteApnsSandboxChannelInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteApnsSandboxChannelOutput struct {
// Apple Development Push Notification Service channel definition.
//
// APNSSandboxChannelResponse is a required field
APNSSandboxChannelResponse *APNSSandboxChannelResponse `type:"structure" required:"true"`
// contains filtered or unexported fields
}
func (s DeleteApnsSandboxChannelOutput) GoString() string
GoString returns the string representation
func (s *DeleteApnsSandboxChannelOutput) SetAPNSSandboxChannelResponse(v *APNSSandboxChannelResponse) *DeleteApnsSandboxChannelOutput
SetAPNSSandboxChannelResponse sets the APNSSandboxChannelResponse field's value.
func (s DeleteApnsSandboxChannelOutput) String() string
String returns the string representation
type DeleteApnsVoipChannelInput struct {
// ApplicationId is a required field
ApplicationId *string `location:"uri" locationName:"application-id" type:"string" required:"true"`
// contains filtered or unexported fields
}
func (s DeleteApnsVoipChannelInput) GoString() string
GoString returns the string representation
func (s *DeleteApnsVoipChannelInput) SetApplicationId(v string) *DeleteApnsVoipChannelInput
SetApplicationId sets the ApplicationId field's value.
func (s DeleteApnsVoipChannelInput) String() string
String returns the string representation
func (s *DeleteApnsVoipChannelInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteApnsVoipChannelOutput struct {
// Apple VoIP Push Notification Service channel definition.
//
// APNSVoipChannelResponse is a required field
APNSVoipChannelResponse *APNSVoipChannelResponse `type:"structure" required:"true"`
// contains filtered or unexported fields
}
func (s DeleteApnsVoipChannelOutput) GoString() string
GoString returns the string representation
func (s *DeleteApnsVoipChannelOutput) SetAPNSVoipChannelResponse(v *APNSVoipChannelResponse) *DeleteApnsVoipChannelOutput
SetAPNSVoipChannelResponse sets the APNSVoipChannelResponse field's value.
func (s DeleteApnsVoipChannelOutput) String() string
String returns the string representation
type DeleteApnsVoipSandboxChannelInput struct {
// ApplicationId is a required field
ApplicationId *string `location:"uri" locationName:"application-id" type:"string" required:"true"`
// contains filtered or unexported fields
}
func (s DeleteApnsVoipSandboxChannelInput) GoString() string
GoString returns the string representation
func (s *DeleteApnsVoipSandboxChannelInput) SetApplicationId(v string) *DeleteApnsVoipSandboxChannelInput
SetApplicationId sets the ApplicationId field's value.
func (s DeleteApnsVoipSandboxChannelInput) String() string
String returns the string representation
func (s *DeleteApnsVoipSandboxChannelInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteApnsVoipSandboxChannelOutput struct {
// Apple VoIP Developer Push Notification Service channel definition.
//
// APNSVoipSandboxChannelResponse is a required field
APNSVoipSandboxChannelResponse *APNSVoipSandboxChannelResponse `type:"structure" required:"true"`
// contains filtered or unexported fields
}
func (s DeleteApnsVoipSandboxChannelOutput) GoString() string
GoString returns the string representation
func (s *DeleteApnsVoipSandboxChannelOutput) SetAPNSVoipSandboxChannelResponse(v *APNSVoipSandboxChannelResponse) *DeleteApnsVoipSandboxChannelOutput
SetAPNSVoipSandboxChannelResponse sets the APNSVoipSandboxChannelResponse field's value.
func (s DeleteApnsVoipSandboxChannelOutput) String() string
String returns the string representation
type DeleteAppInput struct {
// ApplicationId is a required field
ApplicationId *string `location:"uri" locationName:"application-id" type:"string" required:"true"`
// contains filtered or unexported fields
}
func (s DeleteAppInput) GoString() string
GoString returns the string representation
func (s *DeleteAppInput) SetApplicationId(v string) *DeleteAppInput
SetApplicationId sets the ApplicationId field's value.
func (s DeleteAppInput) String() string
String returns the string representation
func (s *DeleteAppInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteAppOutput struct {
// Application Response.
//
// ApplicationResponse is a required field
ApplicationResponse *ApplicationResponse `type:"structure" required:"true"`
// contains filtered or unexported fields
}
func (s DeleteAppOutput) GoString() string
GoString returns the string representation
func (s *DeleteAppOutput) SetApplicationResponse(v *ApplicationResponse) *DeleteAppOutput
SetApplicationResponse sets the ApplicationResponse field's value.
func (s DeleteAppOutput) String() string
String returns the string representation
type DeleteBaiduChannelInput struct {
// ApplicationId is a required field
ApplicationId *string `location:"uri" locationName:"application-id" type:"string" required:"true"`
// contains filtered or unexported fields
}
func (s DeleteBaiduChannelInput) GoString() string
GoString returns the string representation
func (s *DeleteBaiduChannelInput) SetApplicationId(v string) *DeleteBaiduChannelInput
SetApplicationId sets the ApplicationId field's value.
func (s DeleteBaiduChannelInput) String() string
String returns the string representation
func (s *DeleteBaiduChannelInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteBaiduChannelOutput struct {
// Baidu Cloud Messaging channel definition
//
// BaiduChannelResponse is a required field
BaiduChannelResponse *BaiduChannelResponse `type:"structure" required:"true"`
// contains filtered or unexported fields
}
func (s DeleteBaiduChannelOutput) GoString() string
GoString returns the string representation
func (s *DeleteBaiduChannelOutput) SetBaiduChannelResponse(v *BaiduChannelResponse) *DeleteBaiduChannelOutput
SetBaiduChannelResponse sets the BaiduChannelResponse field's value.
func (s DeleteBaiduChannelOutput) String() string
String returns the string representation
type DeleteCampaignInput struct {
// ApplicationId is a required field
ApplicationId *string `location:"uri" locationName:"application-id" type:"string" required:"true"`
// CampaignId is a required field
CampaignId *string `location:"uri" locationName:"campaign-id" type:"string" required:"true"`
// contains filtered or unexported fields
}
func (s DeleteCampaignInput) GoString() string
GoString returns the string representation
func (s *DeleteCampaignInput) SetApplicationId(v string) *DeleteCampaignInput
SetApplicationId sets the ApplicationId field's value.
func (s *DeleteCampaignInput) SetCampaignId(v string) *DeleteCampaignInput
SetCampaignId sets the CampaignId field's value.
func (s DeleteCampaignInput) String() string
String returns the string representation
func (s *DeleteCampaignInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteCampaignOutput struct {
// Campaign definition
//
// CampaignResponse is a required field
CampaignResponse *CampaignResponse `type:"structure" required:"true"`
// contains filtered or unexported fields
}
func (s DeleteCampaignOutput) GoString() string
GoString returns the string representation
func (s *DeleteCampaignOutput) SetCampaignResponse(v *CampaignResponse) *DeleteCampaignOutput
SetCampaignResponse sets the CampaignResponse field's value.
func (s DeleteCampaignOutput) String() string
String returns the string representation
type DeleteEmailChannelInput struct {
// ApplicationId is a required field
ApplicationId *string `location:"uri" locationName:"application-id" type:"string" required:"true"`
// contains filtered or unexported fields
}
func (s DeleteEmailChannelInput) GoString() string
GoString returns the string representation
func (s *DeleteEmailChannelInput) SetApplicationId(v string) *DeleteEmailChannelInput
SetApplicationId sets the ApplicationId field's value.
func (s DeleteEmailChannelInput) String() string
String returns the string representation
func (s *DeleteEmailChannelInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteEmailChannelOutput struct {
// Email Channel Response.
//
// EmailChannelResponse is a required field
EmailChannelResponse *EmailChannelResponse `type:"structure" required:"true"`
// contains filtered or unexported fields
}
func (s DeleteEmailChannelOutput) GoString() string
GoString returns the string representation
func (s *DeleteEmailChannelOutput) SetEmailChannelResponse(v *EmailChannelResponse) *DeleteEmailChannelOutput
SetEmailChannelResponse sets the EmailChannelResponse field's value.
func (s DeleteEmailChannelOutput) String() string
String returns the string representation
type DeleteEndpointInput struct {
// ApplicationId is a required field
ApplicationId *string `location:"uri" locationName:"application-id" type:"string" required:"true"`
// EndpointId is a required field
EndpointId *string `location:"uri" locationName:"endpoint-id" type:"string" required:"true"`
// contains filtered or unexported fields
}
func (s DeleteEndpointInput) GoString() string
GoString returns the string representation
func (s *DeleteEndpointInput) SetApplicationId(v string) *DeleteEndpointInput
SetApplicationId sets the ApplicationId field's value.
func (s *DeleteEndpointInput) SetEndpointId(v string) *DeleteEndpointInput
SetEndpointId sets the EndpointId field's value.
func (s DeleteEndpointInput) String() string
String returns the string representation
func (s *DeleteEndpointInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteEndpointOutput struct {
// Endpoint response
//
// EndpointResponse is a required field
EndpointResponse *EndpointResponse `type:"structure" required:"true"`
// contains filtered or unexported fields
}
func (s DeleteEndpointOutput) GoString() string
GoString returns the string representation
func (s *DeleteEndpointOutput) SetEndpointResponse(v *EndpointResponse) *DeleteEndpointOutput
SetEndpointResponse sets the EndpointResponse field's value.
func (s DeleteEndpointOutput) String() string
String returns the string representation
type DeleteEventStreamInput struct {
// ApplicationId is a required field
ApplicationId *string `location:"uri" locationName:"application-id" type:"string" required:"true"`
// contains filtered or unexported fields
}
func (s DeleteEventStreamInput) GoString() string
GoString returns the string representation
func (s *DeleteEventStreamInput) SetApplicationId(v string) *DeleteEventStreamInput
SetApplicationId sets the ApplicationId field's value.
func (s DeleteEventStreamInput) String() string
String returns the string representation
func (s *DeleteEventStreamInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteEventStreamOutput struct {
// Model for an event publishing subscription export.
//
// EventStream is a required field
EventStream *EventStream `type:"structure" required:"true"`
// contains filtered or unexported fields
}
func (s DeleteEventStreamOutput) GoString() string
GoString returns the string representation
func (s *DeleteEventStreamOutput) SetEventStream(v *EventStream) *DeleteEventStreamOutput
SetEventStream sets the EventStream field's value.
func (s DeleteEventStreamOutput) String() string
String returns the string representation
type DeleteGcmChannelInput struct {
// ApplicationId is a required field
ApplicationId *string `location:"uri" locationName:"application-id" type:"string" required:"true"`
// contains filtered or unexported fields
}
func (s DeleteGcmChannelInput) GoString() string
GoString returns the string representation
func (s *DeleteGcmChannelInput) SetApplicationId(v string) *DeleteGcmChannelInput
SetApplicationId sets the ApplicationId field's value.
func (s DeleteGcmChannelInput) String() string
String returns the string representation
func (s *DeleteGcmChannelInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteGcmChannelOutput struct {
// Google Cloud Messaging channel definition
//
// GCMChannelResponse is a required field
GCMChannelResponse *GCMChannelResponse `type:"structure" required:"true"`
// contains filtered or unexported fields
}
func (s DeleteGcmChannelOutput) GoString() string
GoString returns the string representation
func (s *DeleteGcmChannelOutput) SetGCMChannelResponse(v *GCMChannelResponse) *DeleteGcmChannelOutput
SetGCMChannelResponse sets the GCMChannelResponse field's value.
func (s DeleteGcmChannelOutput) String() string
String returns the string representation
type DeleteSegmentInput struct {
// ApplicationId is a required field
ApplicationId *string `location:"uri" locationName:"application-id" type:"string" required:"true"`
// SegmentId is a required field
SegmentId *string `location:"uri" locationName:"segment-id" type:"string" required:"true"`
// contains filtered or unexported fields
}
func (s DeleteSegmentInput) GoString() string
GoString returns the string representation
func (s *DeleteSegmentInput) SetApplicationId(v string) *DeleteSegmentInput
SetApplicationId sets the ApplicationId field's value.
func (s *DeleteSegmentInput) SetSegmentId(v string) *DeleteSegmentInput
SetSegmentId sets the SegmentId field's value.
func (s DeleteSegmentInput) String() string
String returns the string representation
func (s *DeleteSegmentInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteSegmentOutput struct {
// Segment definition.
//
// SegmentResponse is a required field
SegmentResponse *SegmentResponse `type:"structure" required:"true"`
// contains filtered or unexported fields
}
func (s DeleteSegmentOutput) GoString() string
GoString returns the string representation
func (s *DeleteSegmentOutput) SetSegmentResponse(v *SegmentResponse) *DeleteSegmentOutput
SetSegmentResponse sets the SegmentResponse field's value.
func (s DeleteSegmentOutput) String() string
String returns the string representation
type DeleteSmsChannelInput struct {
// ApplicationId is a required field
ApplicationId *string `location:"uri" locationName:"application-id" type:"string" required:"true"`
// contains filtered or unexported fields
}
func (s DeleteSmsChannelInput) GoString() string
GoString returns the string representation
func (s *DeleteSmsChannelInput) SetApplicationId(v string) *DeleteSmsChannelInput
SetApplicationId sets the ApplicationId field's value.
func (s DeleteSmsChannelInput) String() string
String returns the string representation
func (s *DeleteSmsChannelInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteSmsChannelOutput struct {
// SMS Channel Response.
//
// SMSChannelResponse is a required field
SMSChannelResponse *SMSChannelResponse `type:"structure" required:"true"`
// contains filtered or unexported fields
}
func (s DeleteSmsChannelOutput) GoString() string
GoString returns the string representation
func (s *DeleteSmsChannelOutput) SetSMSChannelResponse(v *SMSChannelResponse) *DeleteSmsChannelOutput
SetSMSChannelResponse sets the SMSChannelResponse field's value.
func (s DeleteSmsChannelOutput) String() string
String returns the string representation
type DeleteUserEndpointsInput struct {
// ApplicationId is a required field
ApplicationId *string `location:"uri" locationName:"application-id" type:"string" required:"true"`
// UserId is a required field
UserId *string `location:"uri" locationName:"user-id" type:"string" required:"true"`
// contains filtered or unexported fields
}
func (s DeleteUserEndpointsInput) GoString() string
GoString returns the string representation
func (s *DeleteUserEndpointsInput) SetApplicationId(v string) *DeleteUserEndpointsInput
SetApplicationId sets the ApplicationId field's value.
func (s *DeleteUserEndpointsInput) SetUserId(v string) *DeleteUserEndpointsInput
SetUserId sets the UserId field's value.
func (s DeleteUserEndpointsInput) String() string
String returns the string representation
func (s *DeleteUserEndpointsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteUserEndpointsOutput struct {
// List of endpoints
//
// EndpointsResponse is a required field
EndpointsResponse *EndpointsResponse `type:"structure" required:"true"`
// contains filtered or unexported fields
}
func (s DeleteUserEndpointsOutput) GoString() string
GoString returns the string representation
func (s *DeleteUserEndpointsOutput) SetEndpointsResponse(v *EndpointsResponse) *DeleteUserEndpointsOutput
SetEndpointsResponse sets the EndpointsResponse field's value.
func (s DeleteUserEndpointsOutput) String() string
String returns the string representation
type DeleteVoiceChannelInput struct {
// ApplicationId is a required field
ApplicationId *string `location:"uri" locationName:"application-id" type:"string" required:"true"`
// contains filtered or unexported fields
}
func (s DeleteVoiceChannelInput) GoString() string
GoString returns the string representation
func (s *DeleteVoiceChannelInput) SetApplicationId(v string) *DeleteVoiceChannelInput
SetApplicationId sets the ApplicationId field's value.
func (s DeleteVoiceChannelInput) String() string
String returns the string representation
func (s *DeleteVoiceChannelInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteVoiceChannelOutput struct {
// Voice Channel Response.
//
// VoiceChannelResponse is a required field
VoiceChannelResponse *VoiceChannelResponse `type:"structure" required:"true"`
// contains filtered or unexported fields
}
func (s DeleteVoiceChannelOutput) GoString() string
GoString returns the string representation
func (s *DeleteVoiceChannelOutput) SetVoiceChannelResponse(v *VoiceChannelResponse) *DeleteVoiceChannelOutput
SetVoiceChannelResponse sets the VoiceChannelResponse field's value.
func (s DeleteVoiceChannelOutput) String() string
String returns the string representation
type DirectMessageConfiguration struct {
// The message to ADM channels. Overrides the default push notification message.
ADMMessage *ADMMessage `type:"structure"`
// The message to APNS channels. Overrides the default push notification message.
APNSMessage *APNSMessage `type:"structure"`
// The message to Baidu GCM channels. Overrides the default push notification
// message.
BaiduMessage *BaiduMessage `type:"structure"`
// The default message for all channels.
DefaultMessage *DefaultMessage `type:"structure"`
// The default push notification message for all push channels.
DefaultPushNotificationMessage *DefaultPushNotificationMessage `type:"structure"`
// The message to Email channels. Overrides the default message.
EmailMessage *EmailMessage `type:"structure"`
// The message to GCM channels. Overrides the default push notification message.
GCMMessage *GCMMessage `type:"structure"`
// The message to SMS channels. Overrides the default message.
SMSMessage *SMSMessage `type:"structure"`
// The message to Voice channels. Overrides the default message.
VoiceMessage *VoiceMessage `type:"structure"`
// contains filtered or unexported fields
}
Message definitions for the default message and any messages that are tailored for specific channels.
func (s DirectMessageConfiguration) GoString() string
GoString returns the string representation
func (s *DirectMessageConfiguration) SetADMMessage(v *ADMMessage) *DirectMessageConfiguration
SetADMMessage sets the ADMMessage field's value.
func (s *DirectMessageConfiguration) SetAPNSMessage(v *APNSMessage) *DirectMessageConfiguration
SetAPNSMessage sets the APNSMessage field's value.
func (s *DirectMessageConfiguration) SetBaiduMessage(v *BaiduMessage) *DirectMessageConfiguration
SetBaiduMessage sets the BaiduMessage field's value.
func (s *DirectMessageConfiguration) SetDefaultMessage(v *DefaultMessage) *DirectMessageConfiguration
SetDefaultMessage sets the DefaultMessage field's value.
func (s *DirectMessageConfiguration) SetDefaultPushNotificationMessage(v *DefaultPushNotificationMessage) *DirectMessageConfiguration
SetDefaultPushNotificationMessage sets the DefaultPushNotificationMessage field's value.
func (s *DirectMessageConfiguration) SetEmailMessage(v *EmailMessage) *DirectMessageConfiguration
SetEmailMessage sets the EmailMessage field's value.
func (s *DirectMessageConfiguration) SetGCMMessage(v *GCMMessage) *DirectMessageConfiguration
SetGCMMessage sets the GCMMessage field's value.
func (s *DirectMessageConfiguration) SetSMSMessage(v *SMSMessage) *DirectMessageConfiguration
SetSMSMessage sets the SMSMessage field's value.
func (s *DirectMessageConfiguration) SetVoiceMessage(v *VoiceMessage) *DirectMessageConfiguration
SetVoiceMessage sets the VoiceMessage field's value.
func (s DirectMessageConfiguration) String() string
String returns the string representation
type EmailChannelRequest struct {
// The configuration set that you want to use when you send email using the
// Pinpoint Email API.
ConfigurationSet *string `type:"string"`
// If the channel is enabled for sending messages.
Enabled *bool `type:"boolean"`
// The email address used to send emails from.
FromAddress *string `type:"string"`
// The ARN of an identity verified with SES.
Identity *string `type:"string"`
// The ARN of an IAM Role used to submit events to Mobile Analytics' event ingestion
// service
RoleArn *string `type:"string"`
// contains filtered or unexported fields
}
Email Channel Request
func (s EmailChannelRequest) GoString() string
GoString returns the string representation
func (s *EmailChannelRequest) SetConfigurationSet(v string) *EmailChannelRequest
SetConfigurationSet sets the ConfigurationSet field's value.
func (s *EmailChannelRequest) SetEnabled(v bool) *EmailChannelRequest
SetEnabled sets the Enabled field's value.
func (s *EmailChannelRequest) SetFromAddress(v string) *EmailChannelRequest
SetFromAddress sets the FromAddress field's value.
func (s *EmailChannelRequest) SetIdentity(v string) *EmailChannelRequest
SetIdentity sets the Identity field's value.
func (s *EmailChannelRequest) SetRoleArn(v string) *EmailChannelRequest
SetRoleArn sets the RoleArn field's value.
func (s EmailChannelRequest) String() string
String returns the string representation
type EmailChannelResponse struct {
// The unique ID of the application to which the email channel belongs.
ApplicationId *string `type:"string"`
// The configuration set that you want to use when you send email using the
// Pinpoint Email API.
ConfigurationSet *string `type:"string"`
// The date that the settings were last updated in ISO 8601 format.
CreationDate *string `type:"string"`
// If the channel is enabled for sending messages.
Enabled *bool `type:"boolean"`
// The email address used to send emails from.
FromAddress *string `type:"string"`
// Not used. Retained for backwards compatibility.
HasCredential *bool `type:"boolean"`
// Channel ID. Not used, only for backwards compatibility.
Id *string `type:"string"`
// The ARN of an identity verified with SES.
Identity *string `type:"string"`
// Is this channel archived
IsArchived *bool `type:"boolean"`
// Who last updated this entry
LastModifiedBy *string `type:"string"`
// Last date this was updated
LastModifiedDate *string `type:"string"`
// Messages per second that can be sent
MessagesPerSecond *int64 `type:"integer"`
// Platform type. Will be "EMAIL"
Platform *string `type:"string"`
// The ARN of an IAM Role used to submit events to Mobile Analytics' event ingestion
// service
RoleArn *string `type:"string"`
// Version of channel
Version *int64 `type:"integer"`
// contains filtered or unexported fields
}
Email Channel Response.
func (s EmailChannelResponse) GoString() string
GoString returns the string representation
func (s *EmailChannelResponse) SetApplicationId(v string) *EmailChannelResponse
SetApplicationId sets the ApplicationId field's value.
func (s *EmailChannelResponse) SetConfigurationSet(v string) *EmailChannelResponse
SetConfigurationSet sets the ConfigurationSet field's value.
func (s *EmailChannelResponse) SetCreationDate(v string) *EmailChannelResponse
SetCreationDate sets the CreationDate field's value.
func (s *EmailChannelResponse) SetEnabled(v bool) *EmailChannelResponse
SetEnabled sets the Enabled field's value.
func (s *EmailChannelResponse) SetFromAddress(v string) *EmailChannelResponse
SetFromAddress sets the FromAddress field's value.
func (s *EmailChannelResponse) SetHasCredential(v bool) *EmailChannelResponse
SetHasCredential sets the HasCredential field's value.
func (s *EmailChannelResponse) SetId(v string) *EmailChannelResponse
SetId sets the Id field's value.
func (s *EmailChannelResponse) SetIdentity(v string) *EmailChannelResponse
SetIdentity sets the Identity field's value.
func (s *EmailChannelResponse) SetIsArchived(v bool) *EmailChannelResponse
SetIsArchived sets the IsArchived field's value.
func (s *EmailChannelResponse) SetLastModifiedBy(v string) *EmailChannelResponse
SetLastModifiedBy sets the LastModifiedBy field's value.
func (s *EmailChannelResponse) SetLastModifiedDate(v string) *EmailChannelResponse
SetLastModifiedDate sets the LastModifiedDate field's value.
func (s *EmailChannelResponse) SetMessagesPerSecond(v int64) *EmailChannelResponse
SetMessagesPerSecond sets the MessagesPerSecond field's value.
func (s *EmailChannelResponse) SetPlatform(v string) *EmailChannelResponse
SetPlatform sets the Platform field's value.
func (s *EmailChannelResponse) SetRoleArn(v string) *EmailChannelResponse
SetRoleArn sets the RoleArn field's value.
func (s *EmailChannelResponse) SetVersion(v int64) *EmailChannelResponse
SetVersion sets the Version field's value.
func (s EmailChannelResponse) String() string
String returns the string representation
type EmailMessage struct {
// The body of the email message.
Body *string `type:"string"`
// The email address that bounces and complaints will be forwarded to when feedback
// forwarding is enabled.
FeedbackForwardingAddress *string `type:"string"`
// The email address used to send the email from. Defaults to use FromAddress
// specified in the Email Channel.
FromAddress *string `type:"string"`
// An email represented as a raw MIME message.
RawEmail *RawEmail `type:"structure"`
// The reply-to email address(es) for the email. If the recipient replies to
// the email, each reply-to address will receive the reply.
ReplyToAddresses []*string `type:"list"`
// An email composed of a subject, a text part and a html part.
SimpleEmail *SimpleEmail `type:"structure"`
// Default message substitutions. Can be overridden by individual address substitutions.
Substitutions map[string][]*string `type:"map"`
// contains filtered or unexported fields
}
Email Message.
func (s EmailMessage) GoString() string
GoString returns the string representation
func (s *EmailMessage) SetBody(v string) *EmailMessage
SetBody sets the Body field's value.
func (s *EmailMessage) SetFeedbackForwardingAddress(v string) *EmailMessage
SetFeedbackForwardingAddress sets the FeedbackForwardingAddress field's value.
func (s *EmailMessage) SetFromAddress(v string) *EmailMessage
SetFromAddress sets the FromAddress field's value.
func (s *EmailMessage) SetRawEmail(v *RawEmail) *EmailMessage
SetRawEmail sets the RawEmail field's value.
func (s *EmailMessage) SetReplyToAddresses(v []*string) *EmailMessage
SetReplyToAddresses sets the ReplyToAddresses field's value.
func (s *EmailMessage) SetSimpleEmail(v *SimpleEmail) *EmailMessage
SetSimpleEmail sets the SimpleEmail field's value.
func (s *EmailMessage) SetSubstitutions(v map[string][]*string) *EmailMessage
SetSubstitutions sets the Substitutions field's value.
func (s EmailMessage) String() string
String returns the string representation
type EndpointBatchItem struct {
// The destination for messages that you send to this endpoint. The address
// varies by channel. For mobile push channels, use the token provided by the
// push notification service, such as the APNs device token or the FCM registration
// token. For the SMS channel, use a phone number in E.164 format, such as +12065550100.
// For the email channel, use an email address.
Address *string `type:"string"`
// Custom attributes that describe the endpoint by associating a name with an
// array of values. For example, an attribute named "interests" might have the
// values ["science", "politics", "travel"]. You can use these attributes as
// selection criteria when you create a segment of users to engage with a messaging
// campaign.The following characters are not recommended in attribute names:
// # : ? \ /. The Amazon Pinpoint console does not display attributes that include
// these characters in the name. This limitation does not apply to attribute
// values.
Attributes map[string][]*string `type:"map"`
// The channel type.Valid values: GCM | APNS | APNS_SANDBOX | APNS_VOIP | APNS_VOIP_SANDBOX
// | ADM | SMS | EMAIL | BAIDU
ChannelType *string `type:"string" enum:"ChannelType"`
// The endpoint demographic attributes.
Demographic *EndpointDemographic `type:"structure"`
// The last time the endpoint was updated. Provided in ISO 8601 format.
EffectiveDate *string `type:"string"`
// Unused.
EndpointStatus *string `type:"string"`
// The unique Id for the Endpoint in the batch.
Id *string `type:"string"`
// The endpoint location attributes.
Location *EndpointLocation `type:"structure"`
// Custom metrics that your app reports to Amazon Pinpoint.
Metrics map[string]*float64 `type:"map"`
// Indicates whether a user has opted out of receiving messages with one of
// the following values:ALL - User has opted out of all messages.NONE - Users
// has not opted out and receives all messages.
OptOut *string `type:"string"`
// The unique ID for the most recent request to update the endpoint.
RequestId *string `type:"string"`
// Custom user-specific attributes that your app reports to Amazon Pinpoint.
User *EndpointUser `type:"structure"`
// contains filtered or unexported fields
}
Endpoint update request
func (s EndpointBatchItem) GoString() string
GoString returns the string representation
func (s *EndpointBatchItem) SetAddress(v string) *EndpointBatchItem
SetAddress sets the Address field's value.
func (s *EndpointBatchItem) SetAttributes(v map[string][]*string) *EndpointBatchItem
SetAttributes sets the Attributes field's value.
func (s *EndpointBatchItem) SetChannelType(v string) *EndpointBatchItem
SetChannelType sets the ChannelType field's value.
func (s *EndpointBatchItem) SetDemographic(v *EndpointDemographic) *EndpointBatchItem
SetDemographic sets the Demographic field's value.
func (s *EndpointBatchItem) SetEffectiveDate(v string) *EndpointBatchItem
SetEffectiveDate sets the EffectiveDate field's value.
func (s *EndpointBatchItem) SetEndpointStatus(v string) *EndpointBatchItem
SetEndpointStatus sets the EndpointStatus field's value.
func (s *EndpointBatchItem) SetId(v string) *EndpointBatchItem
SetId sets the Id field's value.
func (s *EndpointBatchItem) SetLocation(v *EndpointLocation) *EndpointBatchItem
SetLocation sets the Location field's value.
func (s *EndpointBatchItem) SetMetrics(v map[string]*float64) *EndpointBatchItem
SetMetrics sets the Metrics field's value.
func (s *EndpointBatchItem) SetOptOut(v string) *EndpointBatchItem
SetOptOut sets the OptOut field's value.
func (s *EndpointBatchItem) SetRequestId(v string) *EndpointBatchItem
SetRequestId sets the RequestId field's value.
func (s *EndpointBatchItem) SetUser(v *EndpointUser) *EndpointBatchItem
SetUser sets the User field's value.
func (s EndpointBatchItem) String() string
String returns the string representation
type EndpointBatchRequest struct {
// List of items to update. Maximum 100 items
Item []*EndpointBatchItem `type:"list"`
// contains filtered or unexported fields
}
Endpoint batch update request.
func (s EndpointBatchRequest) GoString() string
GoString returns the string representation
func (s *EndpointBatchRequest) SetItem(v []*EndpointBatchItem) *EndpointBatchRequest
SetItem sets the Item field's value.
func (s EndpointBatchRequest) String() string
String returns the string representation
type EndpointDemographic struct {
// The version of the application associated with the endpoint.
AppVersion *string `type:"string"`
// The endpoint locale in the following format: The ISO 639-1 alpha-2 code,
// followed by an underscore, followed by an ISO 3166-1 alpha-2 value.
Locale *string `type:"string"`
// The manufacturer of the endpoint device, such as Apple or Samsung.
Make *string `type:"string"`
// The model name or number of the endpoint device, such as iPhone.
Model *string `type:"string"`
// The model version of the endpoint device.
ModelVersion *string `type:"string"`
// The platform of the endpoint device, such as iOS or Android.
Platform *string `type:"string"`
// The platform version of the endpoint device.
PlatformVersion *string `type:"string"`
// The timezone of the endpoint. Specified as a tz database value, such as Americas/Los_Angeles.
Timezone *string `type:"string"`
// contains filtered or unexported fields
}
Demographic information about the endpoint.
func (s EndpointDemographic) GoString() string
GoString returns the string representation
func (s *EndpointDemographic) SetAppVersion(v string) *EndpointDemographic
SetAppVersion sets the AppVersion field's value.
func (s *EndpointDemographic) SetLocale(v string) *EndpointDemographic
SetLocale sets the Locale field's value.
func (s *EndpointDemographic) SetMake(v string) *EndpointDemographic
SetMake sets the Make field's value.
func (s *EndpointDemographic) SetModel(v string) *EndpointDemographic
SetModel sets the Model field's value.
func (s *EndpointDemographic) SetModelVersion(v string) *EndpointDemographic
SetModelVersion sets the ModelVersion field's value.
func (s *EndpointDemographic) SetPlatform(v string) *EndpointDemographic
SetPlatform sets the Platform field's value.
func (s *EndpointDemographic) SetPlatformVersion(v string) *EndpointDemographic
SetPlatformVersion sets the PlatformVersion field's value.
func (s *EndpointDemographic) SetTimezone(v string) *EndpointDemographic
SetTimezone sets the Timezone field's value.
func (s EndpointDemographic) String() string
String returns the string representation
type EndpointItemResponse struct {
// A custom message associated with the registration of an endpoint when issuing
// a response.
Message *string `type:"string"`
// The status code associated with the merging of an endpoint when issuing a
// response.
StatusCode *int64 `type:"integer"`
// contains filtered or unexported fields
}
A complex object that holds the status code and message as a result of processing an endpoint.
func (s EndpointItemResponse) GoString() string
GoString returns the string representation
func (s *EndpointItemResponse) SetMessage(v string) *EndpointItemResponse
SetMessage sets the Message field's value.
func (s *EndpointItemResponse) SetStatusCode(v int64) *EndpointItemResponse
SetStatusCode sets the StatusCode field's value.
func (s EndpointItemResponse) String() string
String returns the string representation
type EndpointLocation struct {
// The city where the endpoint is located.
City *string `type:"string"`
// The two-letter code for the country or region of the endpoint. Specified
// as an ISO 3166-1 alpha-2 code, such as "US" for the United States.
Country *string `type:"string"`
// The latitude of the endpoint location, rounded to one decimal place.
Latitude *float64 `type:"double"`
// The longitude of the endpoint location, rounded to one decimal place.
Longitude *float64 `type:"double"`
// The postal code or zip code of the endpoint.
PostalCode *string `type:"string"`
// The region of the endpoint location. For example, in the United States, this
// corresponds to a state.
Region *string `type:"string"`
// contains filtered or unexported fields
}
Location data for the endpoint.
func (s EndpointLocation) GoString() string
GoString returns the string representation
func (s *EndpointLocation) SetCity(v string) *EndpointLocation
SetCity sets the City field's value.
func (s *EndpointLocation) SetCountry(v string) *EndpointLocation
SetCountry sets the Country field's value.
func (s *EndpointLocation) SetLatitude(v float64) *EndpointLocation
SetLatitude sets the Latitude field's value.
func (s *EndpointLocation) SetLongitude(v float64) *EndpointLocation
SetLongitude sets the Longitude field's value.
func (s *EndpointLocation) SetPostalCode(v string) *EndpointLocation
SetPostalCode sets the PostalCode field's value.
func (s *EndpointLocation) SetRegion(v string) *EndpointLocation
SetRegion sets the Region field's value.
func (s EndpointLocation) String() string
String returns the string representation
type EndpointMessageResult struct {
// Address that endpoint message was delivered to.
Address *string `type:"string"`
// The delivery status of the message. Possible values:SUCCESS - The message
// was successfully delivered to the endpoint.TRANSIENT_FAILURE - A temporary
// error occurred. Amazon Pinpoint will attempt to deliver the message again
// later.FAILURE_PERMANENT - An error occurred when delivering the message to
// the endpoint. Amazon Pinpoint won't attempt to send the message again.TIMEOUT
// - The message couldn't be sent within the timeout period.QUIET_TIME - The
// local time for the endpoint was within the QuietTime for the campaign or
// app.DAILY_CAP - The endpoint has received the maximum number of messages
// it can receive within a 24-hour period.HOLDOUT - The endpoint was in a hold
// out treatment for the campaign.THROTTLED - Amazon Pinpoint throttled sending
// to this endpoint.EXPIRED - The endpoint address is expired.CAMPAIGN_CAP -
// The endpoint received the maximum number of messages allowed by the campaign.SERVICE_FAILURE
// - A service-level failure prevented Amazon Pinpoint from delivering the message.UNKNOWN
// - An unknown error occurred.
DeliveryStatus *string `type:"string" enum:"DeliveryStatus"`
// Unique message identifier associated with the message that was sent.
MessageId *string `type:"string"`
// Downstream service status code.
StatusCode *int64 `type:"integer"`
// Status message for message delivery.
StatusMessage *string `type:"string"`
// If token was updated as part of delivery. (This is GCM Specific)
UpdatedToken *string `type:"string"`
// contains filtered or unexported fields
}
The result from sending a message to an endpoint.
func (s EndpointMessageResult) GoString() string
GoString returns the string representation
func (s *EndpointMessageResult) SetAddress(v string) *EndpointMessageResult
SetAddress sets the Address field's value.
func (s *EndpointMessageResult) SetDeliveryStatus(v string) *EndpointMessageResult
SetDeliveryStatus sets the DeliveryStatus field's value.
func (s *EndpointMessageResult) SetMessageId(v string) *EndpointMessageResult
SetMessageId sets the MessageId field's value.
func (s *EndpointMessageResult) SetStatusCode(v int64) *EndpointMessageResult
SetStatusCode sets the StatusCode field's value.
func (s *EndpointMessageResult) SetStatusMessage(v string) *EndpointMessageResult
SetStatusMessage sets the StatusMessage field's value.
func (s *EndpointMessageResult) SetUpdatedToken(v string) *EndpointMessageResult
SetUpdatedToken sets the UpdatedToken field's value.
func (s EndpointMessageResult) String() string
String returns the string representation
type EndpointRequest struct {
// The destination for messages that you send to this endpoint. The address
// varies by channel. For mobile push channels, use the token provided by the
// push notification service, such as the APNs device token or the FCM registration
// token. For the SMS channel, use a phone number in E.164 format, such as +12065550100.
// For the email channel, use an email address.
Address *string `type:"string"`
// Custom attributes that describe the endpoint by associating a name with an
// array of values. For example, an attribute named "interests" might have the
// values ["science", "politics", "travel"]. You can use these attributes as
// selection criteria when you create a segment of users to engage with a messaging
// campaign.The following characters are not recommended in attribute names:
// # : ? \ /. The Amazon Pinpoint console does not display attributes that include
// these characters in the name. This limitation does not apply to attribute
// values.
Attributes map[string][]*string `type:"map"`
// The channel type.Valid values: GCM | APNS | APNS_SANDBOX | APNS_VOIP | APNS_VOIP_SANDBOX
// | ADM | SMS | EMAIL | BAIDU
ChannelType *string `type:"string" enum:"ChannelType"`
// Demographic attributes for the endpoint.
Demographic *EndpointDemographic `type:"structure"`
// The date and time when the endpoint was updated, shown in ISO 8601 format.
EffectiveDate *string `type:"string"`
// Unused.
EndpointStatus *string `type:"string"`
// The endpoint location attributes.
Location *EndpointLocation `type:"structure"`
// Custom metrics that your app reports to Amazon Pinpoint.
Metrics map[string]*float64 `type:"map"`
// Indicates whether a user has opted out of receiving messages with one of
// the following values:ALL - User has opted out of all messages.NONE - Users
// has not opted out and receives all messages.
OptOut *string `type:"string"`
// The unique ID for the most recent request to update the endpoint.
RequestId *string `type:"string"`
// Custom user-specific attributes that your app reports to Amazon Pinpoint.
User *EndpointUser `type:"structure"`
// contains filtered or unexported fields
}
An endpoint update request.
func (s EndpointRequest) GoString() string
GoString returns the string representation
func (s *EndpointRequest) SetAddress(v string) *EndpointRequest
SetAddress sets the Address field's value.
func (s *EndpointRequest) SetAttributes(v map[string][]*string) *EndpointRequest
SetAttributes sets the Attributes field's value.
func (s *EndpointRequest) SetChannelType(v string) *EndpointRequest
SetChannelType sets the ChannelType field's value.
func (s *EndpointRequest) SetDemographic(v *EndpointDemographic) *EndpointRequest
SetDemographic sets the Demographic field's value.
func (s *EndpointRequest) SetEffectiveDate(v string) *EndpointRequest
SetEffectiveDate sets the EffectiveDate field's value.
func (s *EndpointRequest) SetEndpointStatus(v string) *EndpointRequest
SetEndpointStatus sets the EndpointStatus field's value.
func (s *EndpointRequest) SetLocation(v *EndpointLocation) *EndpointRequest
SetLocation sets the Location field's value.
func (s *EndpointRequest) SetMetrics(v map[string]*float64) *EndpointRequest
SetMetrics sets the Metrics field's value.
func (s *EndpointRequest) SetOptOut(v string) *EndpointRequest
SetOptOut sets the OptOut field's value.
func (s *EndpointRequest) SetRequestId(v string) *EndpointRequest
SetRequestId sets the RequestId field's value.
func (s *EndpointRequest) SetUser(v *EndpointUser) *EndpointRequest
SetUser sets the User field's value.
func (s EndpointRequest) String() string
String returns the string representation
type EndpointResponse struct {
// The address of the endpoint as provided by your push provider. For example,
// the DeviceToken or RegistrationId.
Address *string `type:"string"`
// The ID of the application that is associated with the endpoint.
ApplicationId *string `type:"string"`
// Custom attributes that describe the endpoint by associating a name with an
// array of values. For example, an attribute named "interests" might have the
// following values: ["science", "politics", "travel"]. You can use these attributes
// as selection criteria when you create segments.The Amazon Pinpoint console
// can't display attribute names that include the following characters: hash/pound
// sign (#), colon (:), question mark (?), backslash (\), and forward slash
// (/). For this reason, you should avoid using these characters in the names
// of custom attributes.
Attributes map[string][]*string `type:"map"`
// The channel type.Valid values: GCM | APNS | APNS_SANDBOX | APNS_VOIP | APNS_VOIP_SANDBOX
// | ADM | SMS | EMAIL | BAIDU
ChannelType *string `type:"string" enum:"ChannelType"`
// A number from 0-99 that represents the cohort the endpoint is assigned to.
// Endpoints are grouped into cohorts randomly, and each cohort contains approximately
// 1 percent of the endpoints for an app. Amazon Pinpoint assigns cohorts to
// the holdout or treatment allocations for a campaign.
CohortId *string `type:"string"`
// The date and time when the endpoint was created, shown in ISO 8601 format.
CreationDate *string `type:"string"`
// The endpoint demographic attributes.
Demographic *EndpointDemographic `type:"structure"`
// The date and time when the endpoint was last updated, shown in ISO 8601 format.
EffectiveDate *string `type:"string"`
// Unused.
EndpointStatus *string `type:"string"`
// The unique ID that you assigned to the endpoint. The ID should be a globally
// unique identifier (GUID) to ensure that it doesn't conflict with other endpoint
// IDs associated with the application.
Id *string `type:"string"`
// The endpoint location attributes.
Location *EndpointLocation `type:"structure"`
// Custom metrics that your app reports to Amazon Pinpoint.
Metrics map[string]*float64 `type:"map"`
// Indicates whether a user has opted out of receiving messages with one of
// the following values:ALL - User has opted out of all messages.NONE - Users
// has not opted out and receives all messages.
OptOut *string `type:"string"`
// The unique ID for the most recent request to update the endpoint.
RequestId *string `type:"string"`
// Custom user-specific attributes that your app reports to Amazon Pinpoint.
User *EndpointUser `type:"structure"`
// contains filtered or unexported fields
}
Endpoint response
func (s EndpointResponse) GoString() string
GoString returns the string representation
func (s *EndpointResponse) SetAddress(v string) *EndpointResponse
SetAddress sets the Address field's value.
func (s *EndpointResponse) SetApplicationId(v string) *EndpointResponse
SetApplicationId sets the ApplicationId field's value.
func (s *EndpointResponse) SetAttributes(v map[string][]*string) *EndpointResponse
SetAttributes sets the Attributes field's value.
func (s *EndpointResponse) SetChannelType(v string) *EndpointResponse
SetChannelType sets the ChannelType field's value.
func (s *EndpointResponse) SetCohortId(v string) *EndpointResponse
SetCohortId sets the CohortId field's value.
func (s *EndpointResponse) SetCreationDate(v string) *EndpointResponse
SetCreationDate sets the CreationDate field's value.
func (s *EndpointResponse) SetDemographic(v *EndpointDemographic) *EndpointResponse
SetDemographic sets the Demographic field's value.
func (s *EndpointResponse) SetEffectiveDate(v string) *EndpointResponse
SetEffectiveDate sets the EffectiveDate field's value.
func (s *EndpointResponse) SetEndpointStatus(v string) *EndpointResponse
SetEndpointStatus sets the EndpointStatus field's value.
func (s *EndpointResponse) SetId(v string) *EndpointResponse
SetId sets the Id field's value.
func (s *EndpointResponse) SetLocation(v *EndpointLocation) *EndpointResponse
SetLocation sets the Location field's value.
func (s *EndpointResponse) SetMetrics(v map[string]*float64) *EndpointResponse
SetMetrics sets the Metrics field's value.
func (s *EndpointResponse) SetOptOut(v string) *EndpointResponse
SetOptOut sets the OptOut field's value.
func (s *EndpointResponse) SetRequestId(v string) *EndpointResponse
SetRequestId sets the RequestId field's value.
func (s *EndpointResponse) SetUser(v *EndpointUser) *EndpointResponse
SetUser sets the User field's value.
func (s EndpointResponse) String() string
String returns the string representation
type EndpointSendConfiguration struct {
// Body override. If specified will override default body.
BodyOverride *string `type:"string"`
// A map of custom attributes to attributes to be attached to the message for
// this address. This payload is added to the push notification's 'data.pinpoint'
// object or added to the email/sms delivery receipt event attributes.
Context map[string]*string `type:"map"`
// The Raw JSON formatted string to be used as the payload. This value overrides
// the message.
RawContent *string `type:"string"`
// A map of substitution values for the message to be merged with the DefaultMessage's
// substitutions. Substitutions on this map take precedence over the all other
// substitutions.
Substitutions map[string][]*string `type:"map"`
// Title override. If specified will override default title if applicable.
TitleOverride *string `type:"string"`
// contains filtered or unexported fields
}
Endpoint send configuration.
func (s EndpointSendConfiguration) GoString() string
GoString returns the string representation
func (s *EndpointSendConfiguration) SetBodyOverride(v string) *EndpointSendConfiguration
SetBodyOverride sets the BodyOverride field's value.
func (s *EndpointSendConfiguration) SetContext(v map[string]*string) *EndpointSendConfiguration
SetContext sets the Context field's value.
func (s *EndpointSendConfiguration) SetRawContent(v string) *EndpointSendConfiguration
SetRawContent sets the RawContent field's value.
func (s *EndpointSendConfiguration) SetSubstitutions(v map[string][]*string) *EndpointSendConfiguration
SetSubstitutions sets the Substitutions field's value.
func (s *EndpointSendConfiguration) SetTitleOverride(v string) *EndpointSendConfiguration
SetTitleOverride sets the TitleOverride field's value.
func (s EndpointSendConfiguration) String() string
String returns the string representation
type EndpointUser struct {
// Custom attributes that describe the user by associating a name with an array
// of values. For example, an attribute named "interests" might have the following
// values: ["science", "politics", "travel"]. You can use these attributes as
// selection criteria when you create segments.The Amazon Pinpoint console can't
// display attribute names that include the following characters: hash/pound
// sign (#), colon (:), question mark (?), backslash (\), and forward slash
// (/). For this reason, you should avoid using these characters in the names
// of custom attributes.
UserAttributes map[string][]*string `type:"map"`
// The unique ID of the user.
UserId *string `type:"string"`
// contains filtered or unexported fields
}
Endpoint user specific custom userAttributes
func (s EndpointUser) GoString() string
GoString returns the string representation
func (s *EndpointUser) SetUserAttributes(v map[string][]*string) *EndpointUser
SetUserAttributes sets the UserAttributes field's value.
func (s *EndpointUser) SetUserId(v string) *EndpointUser
SetUserId sets the UserId field's value.
func (s EndpointUser) String() string
String returns the string representation
type EndpointsResponse struct {
// The list of endpoints.
Item []*EndpointResponse `type:"list"`
// contains filtered or unexported fields
}
List of endpoints
func (s EndpointsResponse) GoString() string
GoString returns the string representation
func (s *EndpointsResponse) SetItem(v []*EndpointResponse) *EndpointsResponse
SetItem sets the Item field's value.
func (s EndpointsResponse) String() string
String returns the string representation
type Event struct {
// The package name associated with the app that's recording the event.
AppPackageName *string `type:"string"`
// The title of the app that's recording the event.
AppTitle *string `type:"string"`
// The version number of the app that's recording the event.
AppVersionCode *string `type:"string"`
// Custom attributes that are associated with the event you're adding or updating.
Attributes map[string]*string `type:"map"`
// The version of the SDK that's running on the client device.
ClientSdkVersion *string `type:"string"`
// The name of the custom event that you're recording.
EventType *string `type:"string"`
// Custom metrics related to the event.
Metrics map[string]*float64 `type:"map"`
// The name of the SDK that's being used to record the event.
SdkName *string `type:"string"`
// Information about the session in which the event occurred.
Session *Session `type:"structure"`
// The date and time when the event occurred, in ISO 8601 format.
Timestamp *string `type:"string"`
// contains filtered or unexported fields
}
Model for creating or updating events.
func (s Event) GoString() string
GoString returns the string representation
func (s *Event) SetAppPackageName(v string) *Event
SetAppPackageName sets the AppPackageName field's value.
func (s *Event) SetAppTitle(v string) *Event
SetAppTitle sets the AppTitle field's value.
func (s *Event) SetAppVersionCode(v string) *Event
SetAppVersionCode sets the AppVersionCode field's value.
func (s *Event) SetAttributes(v map[string]*string) *Event
SetAttributes sets the Attributes field's value.
func (s *Event) SetClientSdkVersion(v string) *Event
SetClientSdkVersion sets the ClientSdkVersion field's value.
func (s *Event) SetEventType(v string) *Event
SetEventType sets the EventType field's value.
func (s *Event) SetMetrics(v map[string]*float64) *Event
SetMetrics sets the Metrics field's value.
func (s *Event) SetSdkName(v string) *Event
SetSdkName sets the SdkName field's value.
func (s *Event) SetSession(v *Session) *Event
SetSession sets the Session field's value.
func (s *Event) SetTimestamp(v string) *Event
SetTimestamp sets the Timestamp field's value.
func (s Event) String() string
String returns the string representation
type EventDimensions struct {
// Custom attributes that your app reports to Amazon Pinpoint. You can use these
// attributes as selection criteria when you create an event filter.
Attributes map[string]*AttributeDimension `type:"map"`
// The name of the event that causes the campaign to be sent. This can be a
// standard event type that Amazon Pinpoint generates, such as _session.start,
// or a custom event that's specific to your app.
EventType *SetDimension `type:"structure"`
// Custom metrics that your app reports to Amazon Pinpoint. You can use these
// attributes as selection criteria when you create an event filter.
Metrics map[string]*MetricDimension `type:"map"`
// contains filtered or unexported fields
}
Event dimensions.
func (s EventDimensions) GoString() string
GoString returns the string representation
func (s *EventDimensions) SetAttributes(v map[string]*AttributeDimension) *EventDimensions
SetAttributes sets the Attributes field's value.
func (s *EventDimensions) SetEventType(v *SetDimension) *EventDimensions
SetEventType sets the EventType field's value.
func (s *EventDimensions) SetMetrics(v map[string]*MetricDimension) *EventDimensions
SetMetrics sets the Metrics field's value.
func (s EventDimensions) String() string
String returns the string representation
type EventItemResponse struct {
// A custom message that is associated with the processing of an event.
Message *string `type:"string"`
// The status returned in the response as a result of processing the event.Possible
// values: 400 (for invalid events) and 202 (for events that were accepted).
StatusCode *int64 `type:"integer"`
// contains filtered or unexported fields
}
A complex object that holds the status code and message as a result of processing an event.
func (s EventItemResponse) GoString() string
GoString returns the string representation
func (s *EventItemResponse) SetMessage(v string) *EventItemResponse
SetMessage sets the Message field's value.
func (s *EventItemResponse) SetStatusCode(v int64) *EventItemResponse
SetStatusCode sets the StatusCode field's value.
func (s EventItemResponse) String() string
String returns the string representation
type EventStream struct {
// The ID of the application from which events should be published.
ApplicationId *string `type:"string"`
// The Amazon Resource Name (ARN) of the Amazon Kinesis stream or Firehose delivery
// stream to which you want to publish events. Firehose ARN: arn:aws:firehose:REGION:ACCOUNT_ID:deliverystream/STREAM_NAME
// Kinesis ARN: arn:aws:kinesis:REGION:ACCOUNT_ID:stream/STREAM_NAME
DestinationStreamArn *string `type:"string"`
// (Deprecated) Your AWS account ID, which you assigned to the ExternalID key
// in an IAM trust policy. Used by Amazon Pinpoint to assume an IAM role. This
// requirement is removed, and external IDs are not recommended for IAM roles
// assumed by Amazon Pinpoint.
ExternalId *string `type:"string"`
// The date the event stream was last updated in ISO 8601 format.
LastModifiedDate *string `type:"string"`
// The IAM user who last modified the event stream.
LastUpdatedBy *string `type:"string"`
// The IAM role that authorizes Amazon Pinpoint to publish events to the stream
// in your account.
RoleArn *string `type:"string"`
// contains filtered or unexported fields
}
Model for an event publishing subscription export.
func (s EventStream) GoString() string
GoString returns the string representation
func (s *EventStream) SetApplicationId(v string) *EventStream
SetApplicationId sets the ApplicationId field's value.
func (s *EventStream) SetDestinationStreamArn(v string) *EventStream
SetDestinationStreamArn sets the DestinationStreamArn field's value.
func (s *EventStream) SetExternalId(v string) *EventStream
SetExternalId sets the ExternalId field's value.
func (s *EventStream) SetLastModifiedDate(v string) *EventStream
SetLastModifiedDate sets the LastModifiedDate field's value.
func (s *EventStream) SetLastUpdatedBy(v string) *EventStream
SetLastUpdatedBy sets the LastUpdatedBy field's value.
func (s *EventStream) SetRoleArn(v string) *EventStream
SetRoleArn sets the RoleArn field's value.
func (s EventStream) String() string
String returns the string representation
type EventsBatch struct {
// The PublicEndpoint attached to the EndpointId from the request.
Endpoint *PublicEndpoint `type:"structure"`
// An object that contains a set of events associated with the endpoint.
Events map[string]*Event `type:"map"`
// contains filtered or unexported fields
}
A batch of PublicEndpoints and Events to process.
func (s EventsBatch) GoString() string
GoString returns the string representation
func (s *EventsBatch) SetEndpoint(v *PublicEndpoint) *EventsBatch
SetEndpoint sets the Endpoint field's value.
func (s *EventsBatch) SetEvents(v map[string]*Event) *EventsBatch
SetEvents sets the Events field's value.
func (s EventsBatch) String() string
String returns the string representation
type EventsRequest struct {
// A batch of events to process. Each BatchItem consists of an endpoint ID as
// the key, and an EventsBatch object as the value.
BatchItem map[string]*EventsBatch `type:"map"`
// contains filtered or unexported fields
}
A set of events to process.
func (s EventsRequest) GoString() string
GoString returns the string representation
func (s *EventsRequest) SetBatchItem(v map[string]*EventsBatch) *EventsRequest
SetBatchItem sets the BatchItem field's value.
func (s EventsRequest) String() string
String returns the string representation
type EventsResponse struct {
// A map that contains a multipart response for each endpoint. Each item in
// this object uses the endpoint ID as the key, and the item response as the
// value.If no item response exists, the value can also be one of the following:
// 202 (if the request was processed successfully) or 400 (if the payload was
// invalid, or required fields were missing).
Results map[string]*ItemResponse `type:"map"`
// contains filtered or unexported fields
}
Custom messages associated with events.
func (s EventsResponse) GoString() string
GoString returns the string representation
func (s *EventsResponse) SetResults(v map[string]*ItemResponse) *EventsResponse
SetResults sets the Results field's value.
func (s EventsResponse) String() string
String returns the string representation
type ExportJobRequest struct {
// The Amazon Resource Name (ARN) of an IAM role that grants Amazon Pinpoint
// access to the Amazon S3 location that endpoints will be exported to.
RoleArn *string `type:"string"`
// A URL that points to the location within an Amazon S3 bucket that will receive
// the export. The location is typically a folder with multiple files.The URL
// should follow this format: s3://bucket-name/folder-name/Amazon Pinpoint will
// export endpoints to this location.
S3UrlPrefix *string `type:"string"`
// The ID of the segment to export endpoints from. If not present, Amazon Pinpoint
// exports all of the endpoints that belong to the application.
SegmentId *string `type:"string"`
// The version of the segment to export if specified.
SegmentVersion *int64 `type:"integer"`
// contains filtered or unexported fields
}
Export job request.
func (s ExportJobRequest) GoString() string
GoString returns the string representation
func (s *ExportJobRequest) SetRoleArn(v string) *ExportJobRequest
SetRoleArn sets the RoleArn field's value.
func (s *ExportJobRequest) SetS3UrlPrefix(v string) *ExportJobRequest
SetS3UrlPrefix sets the S3UrlPrefix field's value.
func (s *ExportJobRequest) SetSegmentId(v string) *ExportJobRequest
SetSegmentId sets the SegmentId field's value.
func (s *ExportJobRequest) SetSegmentVersion(v int64) *ExportJobRequest
SetSegmentVersion sets the SegmentVersion field's value.
func (s ExportJobRequest) String() string
String returns the string representation
type ExportJobResource struct {
// The Amazon Resource Name (ARN) of an IAM role that grants Amazon Pinpoint
// access to the Amazon S3 location that endpoints will be exported to.
RoleArn *string `type:"string"`
// A URL that points to the location within an Amazon S3 bucket that will receive
// the export. The location is typically a folder with multiple files.The URL
// should follow this format: s3://bucket-name/folder-name/Amazon Pinpoint will
// export endpoints to this location.
S3UrlPrefix *string `type:"string"`
// The ID of the segment to export endpoints from. If not present, Amazon Pinpoint
// exports all of the endpoints that belong to the application.
SegmentId *string `type:"string"`
// The version of the segment to export if specified.
SegmentVersion *int64 `type:"integer"`
// contains filtered or unexported fields
}
Export job resource.
func (s ExportJobResource) GoString() string
GoString returns the string representation
func (s *ExportJobResource) SetRoleArn(v string) *ExportJobResource
SetRoleArn sets the RoleArn field's value.
func (s *ExportJobResource) SetS3UrlPrefix(v string) *ExportJobResource
SetS3UrlPrefix sets the S3UrlPrefix field's value.
func (s *ExportJobResource) SetSegmentId(v string) *ExportJobResource
SetSegmentId sets the SegmentId field's value.
func (s *ExportJobResource) SetSegmentVersion(v int64) *ExportJobResource
SetSegmentVersion sets the SegmentVersion field's value.
func (s ExportJobResource) String() string
String returns the string representation
type ExportJobResponse struct {
// The unique ID of the application associated with the export job.
ApplicationId *string `type:"string"`
// The number of pieces that have successfully completed as of the time of the
// request.
CompletedPieces *int64 `type:"integer"`
// The date the job completed in ISO 8601 format.
CompletionDate *string `type:"string"`
// The date the job was created in ISO 8601 format.
CreationDate *string `type:"string"`
// The export job settings.
Definition *ExportJobResource `type:"structure"`
// The number of pieces that failed to be processed as of the time of the request.
FailedPieces *int64 `type:"integer"`
// Provides up to 100 of the first failed entries for the job, if any exist.
Failures []*string `type:"list"`
// The unique ID of the job.
Id *string `type:"string"`
// The status of the job.Valid values: CREATED, INITIALIZING, PROCESSING, COMPLETING,
// COMPLETED, FAILING, FAILEDThe job status is FAILED if one or more pieces
// failed.
JobStatus *string `type:"string" enum:"JobStatus"`
// The number of endpoints that were not processed; for example, because of
// syntax errors.
TotalFailures *int64 `type:"integer"`
// The total number of pieces that must be processed to finish the job. Each
// piece is an approximately equal portion of the endpoints.
TotalPieces *int64 `type:"integer"`
// The number of endpoints that were processed by the job.
TotalProcessed *int64 `type:"integer"`
// The job type. Will be 'EXPORT'.
Type *string `type:"string"`
// contains filtered or unexported fields
}
Export job response.
func (s ExportJobResponse) GoString() string
GoString returns the string representation
func (s *ExportJobResponse) SetApplicationId(v string) *ExportJobResponse
SetApplicationId sets the ApplicationId field's value.
func (s *ExportJobResponse) SetCompletedPieces(v int64) *ExportJobResponse
SetCompletedPieces sets the CompletedPieces field's value.
func (s *ExportJobResponse) SetCompletionDate(v string) *ExportJobResponse
SetCompletionDate sets the CompletionDate field's value.
func (s *ExportJobResponse) SetCreationDate(v string) *ExportJobResponse
SetCreationDate sets the CreationDate field's value.
func (s *ExportJobResponse) SetDefinition(v *ExportJobResource) *ExportJobResponse
SetDefinition sets the Definition field's value.
func (s *ExportJobResponse) SetFailedPieces(v int64) *ExportJobResponse
SetFailedPieces sets the FailedPieces field's value.
func (s *ExportJobResponse) SetFailures(v []*string) *ExportJobResponse
SetFailures sets the Failures field's value.
func (s *ExportJobResponse) SetId(v string) *ExportJobResponse
SetId sets the Id field's value.
func (s *ExportJobResponse) SetJobStatus(v string) *ExportJobResponse
SetJobStatus sets the JobStatus field's value.
func (s *ExportJobResponse) SetTotalFailures(v int64) *ExportJobResponse
SetTotalFailures sets the TotalFailures field's value.
func (s *ExportJobResponse) SetTotalPieces(v int64) *ExportJobResponse
SetTotalPieces sets the TotalPieces field's value.
func (s *ExportJobResponse) SetTotalProcessed(v int64) *ExportJobResponse
SetTotalProcessed sets the TotalProcessed field's value.
func (s *ExportJobResponse) SetType(v string) *ExportJobResponse
SetType sets the Type field's value.
func (s ExportJobResponse) String() string
String returns the string representation
type ExportJobsResponse struct {
// A list of export jobs for the application.
Item []*ExportJobResponse `type:"list"`
// The string that you use in a subsequent request to get the next page of results
// in a paginated response.
NextToken *string `type:"string"`
// contains filtered or unexported fields
}
Export job list.
func (s ExportJobsResponse) GoString() string
GoString returns the string representation
func (s *ExportJobsResponse) SetItem(v []*ExportJobResponse) *ExportJobsResponse
SetItem sets the Item field's value.
func (s *ExportJobsResponse) SetNextToken(v string) *ExportJobsResponse
SetNextToken sets the NextToken field's value.
func (s ExportJobsResponse) String() string
String returns the string representation
type GCMChannelRequest struct {
// Platform credential API key from Google.
ApiKey *string `type:"string"`
// If the channel is enabled for sending messages.
Enabled *bool `type:"boolean"`
// contains filtered or unexported fields
}
Google Cloud Messaging credentials
func (s GCMChannelRequest) GoString() string
GoString returns the string representation
func (s *GCMChannelRequest) SetApiKey(v string) *GCMChannelRequest
SetApiKey sets the ApiKey field's value.
func (s *GCMChannelRequest) SetEnabled(v bool) *GCMChannelRequest
SetEnabled sets the Enabled field's value.
func (s GCMChannelRequest) String() string
String returns the string representation
type GCMChannelResponse struct {
// The ID of the application to which the channel applies.
ApplicationId *string `type:"string"`
// When was this segment created
CreationDate *string `type:"string"`
// The GCM API key from Google.
Credential *string `type:"string"`
// If the channel is enabled for sending messages.
Enabled *bool `type:"boolean"`
// Not used. Retained for backwards compatibility.
HasCredential *bool `type:"boolean"`
// Channel ID. Not used. Present only for backwards compatibility.
Id *string `type:"string"`
// Is this channel archived
IsArchived *bool `type:"boolean"`
// Who last updated this entry
LastModifiedBy *string `type:"string"`
// Last date this was updated
LastModifiedDate *string `type:"string"`
// The platform type. Will be GCM
Platform *string `type:"string"`
// Version of channel
Version *int64 `type:"integer"`
// contains filtered or unexported fields
}
Google Cloud Messaging channel definition
func (s GCMChannelResponse) GoString() string
GoString returns the string representation
func (s *GCMChannelResponse) SetApplicationId(v string) *GCMChannelResponse
SetApplicationId sets the ApplicationId field's value.
func (s *GCMChannelResponse) SetCreationDate(v string) *GCMChannelResponse
SetCreationDate sets the CreationDate field's value.
func (s *GCMChannelResponse) SetCredential(v string) *GCMChannelResponse
SetCredential sets the Credential field's value.
func (s *GCMChannelResponse) SetEnabled(v bool) *GCMChannelResponse
SetEnabled sets the Enabled field's value.
func (s *GCMChannelResponse) SetHasCredential(v bool) *GCMChannelResponse
SetHasCredential sets the HasCredential field's value.
func (s *GCMChannelResponse) SetId(v string) *GCMChannelResponse
SetId sets the Id field's value.
func (s *GCMChannelResponse) SetIsArchived(v bool) *GCMChannelResponse
SetIsArchived sets the IsArchived field's value.
func (s *GCMChannelResponse) SetLastModifiedBy(v string) *GCMChannelResponse
SetLastModifiedBy sets the LastModifiedBy field's value.
func (s *GCMChannelResponse) SetLastModifiedDate(v string) *GCMChannelResponse
SetLastModifiedDate sets the LastModifiedDate field's value.
func (s *GCMChannelResponse) SetPlatform(v string) *GCMChannelResponse
SetPlatform sets the Platform field's value.
func (s *GCMChannelResponse) SetVersion(v int64) *GCMChannelResponse
SetVersion sets the Version field's value.
func (s GCMChannelResponse) String() string
String returns the string representation
type GCMMessage struct {
// The action that occurs if the user taps a push notification delivered by
// the campaign: OPEN_APP - Your app launches, or it becomes the foreground
// app if it has been sent to the background. This is the default action. DEEP_LINK
// - Uses deep linking features in iOS and Android to open your app and display
// a designated user interface within the app. URL - The default mobile browser
// on the user's device launches and opens a web page at the URL you specify.
// Possible values include: OPEN_APP | DEEP_LINK | URL
Action *string `type:"string" enum:"Action"`
// The message body of the notification.
Body *string `type:"string"`
// This parameter identifies a group of messages (e.g., with collapse_key: "Updates
// Available") that can be collapsed, so that only the last message gets sent
// when delivery can be resumed. This is intended to avoid sending too many
// of the same messages when the device comes back online or becomes active.
CollapseKey *string `type:"string"`
// The data payload used for a silent push. This payload is added to the notifications'
// data.pinpoint.jsonBody' object
Data map[string]*string `type:"map"`
// The icon image name of the asset saved in your application.
IconReference *string `type:"string"`
// The URL that points to an image used as the large icon to the notification
// content view.
ImageIconUrl *string `type:"string"`
// The URL that points to an image used in the push notification.
ImageUrl *string `type:"string"`
// The message priority. Amazon Pinpoint uses this value to set the FCM or GCM
// priority parameter when it sends the message. Accepts the following values:"Normal"
// - Messages might be delayed. Delivery is optimized for battery usage on the
// receiving device. Use normal priority unless immediate delivery is required."High"
// - Messages are sent immediately and might wake a sleeping device.The equivalent
// values for APNs messages are "5" and "10". Amazon Pinpoint accepts these
// values here and converts them.For more information, see About FCM Messages
// in the Firebase documentation.
Priority *string `type:"string"`
// The Raw JSON formatted string to be used as the payload. This value overrides
// the message.
RawContent *string `type:"string"`
// This parameter specifies the package name of the application where the registration
// tokens must match in order to receive the message.
RestrictedPackageName *string `type:"string"`
// Indicates if the message should display on the users device. Silent pushes
// can be used for Remote Configuration and Phone Home use cases.
SilentPush *bool `type:"boolean"`
// The URL that points to an image used as the small icon for the notification
// which will be used to represent the notification in the status bar and content
// view
SmallImageIconUrl *string `type:"string"`
// Indicates a sound to play when the device receives the notification. Supports
// default, or the filename of a sound resource bundled in the app. Android
// sound files must reside in /res/raw/
Sound *string `type:"string"`
// Default message substitutions. Can be overridden by individual address substitutions.
Substitutions map[string][]*string `type:"map"`
// The length of time (in seconds) that FCM or GCM stores and attempts to deliver
// the message. If unspecified, the value defaults to the maximum, which is
// 2,419,200 seconds (28 days). Amazon Pinpoint uses this value to set the FCM
// or GCM time_to_live parameter.
TimeToLive *int64 `type:"integer"`
// The message title that displays above the message on the user's device.
Title *string `type:"string"`
// The URL to open in the user's mobile browser. Used if the value for Action
// is URL.
Url *string `type:"string"`
// contains filtered or unexported fields
}
GCM Message.
func (s GCMMessage) GoString() string
GoString returns the string representation
func (s *GCMMessage) SetAction(v string) *GCMMessage
SetAction sets the Action field's value.
func (s *GCMMessage) SetBody(v string) *GCMMessage
SetBody sets the Body field's value.
func (s *GCMMessage) SetCollapseKey(v string) *GCMMessage
SetCollapseKey sets the CollapseKey field's value.
func (s *GCMMessage) SetData(v map[string]*string) *GCMMessage
SetData sets the Data field's value.
func (s *GCMMessage) SetIconReference(v string) *GCMMessage
SetIconReference sets the IconReference field's value.
func (s *GCMMessage) SetImageIconUrl(v string) *GCMMessage
SetImageIconUrl sets the ImageIconUrl field's value.
func (s *GCMMessage) SetImageUrl(v string) *GCMMessage
SetImageUrl sets the ImageUrl field's value.
func (s *GCMMessage) SetPriority(v string) *GCMMessage
SetPriority sets the Priority field's value.
func (s *GCMMessage) SetRawContent(v string) *GCMMessage
SetRawContent sets the RawContent field's value.
func (s *GCMMessage) SetRestrictedPackageName(v string) *GCMMessage
SetRestrictedPackageName sets the RestrictedPackageName field's value.
func (s *GCMMessage) SetSilentPush(v bool) *GCMMessage
SetSilentPush sets the SilentPush field's value.
func (s *GCMMessage) SetSmallImageIconUrl(v string) *GCMMessage
SetSmallImageIconUrl sets the SmallImageIconUrl field's value.
func (s *GCMMessage) SetSound(v string) *GCMMessage
SetSound sets the Sound field's value.
func (s *GCMMessage) SetSubstitutions(v map[string][]*string) *GCMMessage
SetSubstitutions sets the Substitutions field's value.
func (s *GCMMessage) SetTimeToLive(v int64) *GCMMessage
SetTimeToLive sets the TimeToLive field's value.
func (s *GCMMessage) SetTitle(v string) *GCMMessage
SetTitle sets the Title field's value.
func (s *GCMMessage) SetUrl(v string) *GCMMessage
SetUrl sets the Url field's value.
func (s GCMMessage) String() string
String returns the string representation
type GPSCoordinates struct {
// Latitude
Latitude *float64 `type:"double"`
// Longitude
Longitude *float64 `type:"double"`
// contains filtered or unexported fields
}
GPS coordinates
func (s GPSCoordinates) GoString() string
GoString returns the string representation
func (s *GPSCoordinates) SetLatitude(v float64) *GPSCoordinates
SetLatitude sets the Latitude field's value.
func (s *GPSCoordinates) SetLongitude(v float64) *GPSCoordinates
SetLongitude sets the Longitude field's value.
func (s GPSCoordinates) String() string
String returns the string representation
type GPSPointDimension struct {
// Coordinate to measure distance from.
Coordinates *GPSCoordinates `type:"structure"`
// Range in kilometers from the coordinate.
RangeInKilometers *float64 `type:"double"`
// contains filtered or unexported fields
}
GPS point location dimension
func (s GPSPointDimension) GoString() string
GoString returns the string representation
func (s *GPSPointDimension) SetCoordinates(v *GPSCoordinates) *GPSPointDimension
SetCoordinates sets the Coordinates field's value.
func (s *GPSPointDimension) SetRangeInKilometers(v float64) *GPSPointDimension
SetRangeInKilometers sets the RangeInKilometers field's value.
func (s GPSPointDimension) String() string
String returns the string representation
type GetAdmChannelInput struct {
// ApplicationId is a required field
ApplicationId *string `location:"uri" locationName:"application-id" type:"string" required:"true"`
// contains filtered or unexported fields
}
func (s GetAdmChannelInput) GoString() string
GoString returns the string representation
func (s *GetAdmChannelInput) SetApplicationId(v string) *GetAdmChannelInput
SetApplicationId sets the ApplicationId field's value.
func (s GetAdmChannelInput) String() string
String returns the string representation
func (s *GetAdmChannelInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetAdmChannelOutput struct {
// Amazon Device Messaging channel definition.
//
// ADMChannelResponse is a required field
ADMChannelResponse *ADMChannelResponse `type:"structure" required:"true"`
// contains filtered or unexported fields
}
func (s GetAdmChannelOutput) GoString() string
GoString returns the string representation
func (s *GetAdmChannelOutput) SetADMChannelResponse(v *ADMChannelResponse) *GetAdmChannelOutput
SetADMChannelResponse sets the ADMChannelResponse field's value.
func (s GetAdmChannelOutput) String() string
String returns the string representation
type GetApnsChannelInput struct {
// ApplicationId is a required field
ApplicationId *string `location:"uri" locationName:"application-id" type:"string" required:"true"`
// contains filtered or unexported fields
}
func (s GetApnsChannelInput) GoString() string
GoString returns the string representation
func (s *GetApnsChannelInput) SetApplicationId(v string) *GetApnsChannelInput
SetApplicationId sets the ApplicationId field's value.
func (s GetApnsChannelInput) String() string
String returns the string representation
func (s *GetApnsChannelInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetApnsChannelOutput struct {
// Apple Distribution Push Notification Service channel definition.
//
// APNSChannelResponse is a required field
APNSChannelResponse *APNSChannelResponse `type:"structure" required:"true"`
// contains filtered or unexported fields
}
func (s GetApnsChannelOutput) GoString() string
GoString returns the string representation
func (s *GetApnsChannelOutput) SetAPNSChannelResponse(v *APNSChannelResponse) *GetApnsChannelOutput
SetAPNSChannelResponse sets the APNSChannelResponse field's value.
func (s GetApnsChannelOutput) String() string
String returns the string representation
type GetApnsSandboxChannelInput struct {
// ApplicationId is a required field
ApplicationId *string `location:"uri" locationName:"application-id" type:"string" required:"true"`
// contains filtered or unexported fields
}
func (s GetApnsSandboxChannelInput) GoString() string
GoString returns the string representation
func (s *GetApnsSandboxChannelInput) SetApplicationId(v string) *GetApnsSandboxChannelInput
SetApplicationId sets the ApplicationId field's value.
func (s GetApnsSandboxChannelInput) String() string
String returns the string representation
func (s *GetApnsSandboxChannelInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetApnsSandboxChannelOutput struct {
// Apple Development Push Notification Service channel definition.
//
// APNSSandboxChannelResponse is a required field
APNSSandboxChannelResponse *APNSSandboxChannelResponse `type:"structure" required:"true"`
// contains filtered or unexported fields
}
func (s GetApnsSandboxChannelOutput) GoString() string
GoString returns the string representation
func (s *GetApnsSandboxChannelOutput) SetAPNSSandboxChannelResponse(v *APNSSandboxChannelResponse) *GetApnsSandboxChannelOutput
SetAPNSSandboxChannelResponse sets the APNSSandboxChannelResponse field's value.
func (s GetApnsSandboxChannelOutput) String() string
String returns the string representation
type GetApnsVoipChannelInput struct {
// ApplicationId is a required field
ApplicationId *string `location:"uri" locationName:"application-id" type:"string" required:"true"`
// contains filtered or unexported fields
}
func (s GetApnsVoipChannelInput) GoString() string
GoString returns the string representation
func (s *GetApnsVoipChannelInput) SetApplicationId(v string) *GetApnsVoipChannelInput
SetApplicationId sets the ApplicationId field's value.
func (s GetApnsVoipChannelInput) String() string
String returns the string representation
func (s *GetApnsVoipChannelInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetApnsVoipChannelOutput struct {
// Apple VoIP Push Notification Service channel definition.
//
// APNSVoipChannelResponse is a required field
APNSVoipChannelResponse *APNSVoipChannelResponse `type:"structure" required:"true"`
// contains filtered or unexported fields
}
func (s GetApnsVoipChannelOutput) GoString() string
GoString returns the string representation
func (s *GetApnsVoipChannelOutput) SetAPNSVoipChannelResponse(v *APNSVoipChannelResponse) *GetApnsVoipChannelOutput
SetAPNSVoipChannelResponse sets the APNSVoipChannelResponse field's value.
func (s GetApnsVoipChannelOutput) String() string
String returns the string representation
type GetApnsVoipSandboxChannelInput struct {
// ApplicationId is a required field
ApplicationId *string `location:"uri" locationName:"application-id" type:"string" required:"true"`
// contains filtered or unexported fields
}
func (s GetApnsVoipSandboxChannelInput) GoString() string
GoString returns the string representation
func (s *GetApnsVoipSandboxChannelInput) SetApplicationId(v string) *GetApnsVoipSandboxChannelInput
SetApplicationId sets the ApplicationId field's value.
func (s GetApnsVoipSandboxChannelInput) String() string
String returns the string representation
func (s *GetApnsVoipSandboxChannelInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetApnsVoipSandboxChannelOutput struct {
// Apple VoIP Developer Push Notification Service channel definition.
//
// APNSVoipSandboxChannelResponse is a required field
APNSVoipSandboxChannelResponse *APNSVoipSandboxChannelResponse `type:"structure" required:"true"`
// contains filtered or unexported fields
}
func (s GetApnsVoipSandboxChannelOutput) GoString() string
GoString returns the string representation
func (s *GetApnsVoipSandboxChannelOutput) SetAPNSVoipSandboxChannelResponse(v *APNSVoipSandboxChannelResponse) *GetApnsVoipSandboxChannelOutput
SetAPNSVoipSandboxChannelResponse sets the APNSVoipSandboxChannelResponse field's value.
func (s GetApnsVoipSandboxChannelOutput) String() string
String returns the string representation
type GetAppInput struct {
// ApplicationId is a required field
ApplicationId *string `location:"uri" locationName:"application-id" type:"string" required:"true"`
// contains filtered or unexported fields
}
func (s GetAppInput) GoString() string
GoString returns the string representation
func (s *GetAppInput) SetApplicationId(v string) *GetAppInput
SetApplicationId sets the ApplicationId field's value.
func (s GetAppInput) String() string
String returns the string representation
func (s *GetAppInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetAppOutput struct {
// Application Response.
//
// ApplicationResponse is a required field
ApplicationResponse *ApplicationResponse `type:"structure" required:"true"`
// contains filtered or unexported fields
}
func (s GetAppOutput) GoString() string
GoString returns the string representation
func (s *GetAppOutput) SetApplicationResponse(v *ApplicationResponse) *GetAppOutput
SetApplicationResponse sets the ApplicationResponse field's value.
func (s GetAppOutput) String() string
String returns the string representation
type GetApplicationSettingsInput struct {
// ApplicationId is a required field
ApplicationId *string `location:"uri" locationName:"application-id" type:"string" required:"true"`
// contains filtered or unexported fields
}
func (s GetApplicationSettingsInput) GoString() string
GoString returns the string representation
func (s *GetApplicationSettingsInput) SetApplicationId(v string) *GetApplicationSettingsInput
SetApplicationId sets the ApplicationId field's value.
func (s GetApplicationSettingsInput) String() string
String returns the string representation
func (s *GetApplicationSettingsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetApplicationSettingsOutput struct {
// Application settings.
//
// ApplicationSettingsResource is a required field
ApplicationSettingsResource *ApplicationSettingsResource `type:"structure" required:"true"`
// contains filtered or unexported fields
}
func (s GetApplicationSettingsOutput) GoString() string
GoString returns the string representation
func (s *GetApplicationSettingsOutput) SetApplicationSettingsResource(v *ApplicationSettingsResource) *GetApplicationSettingsOutput
SetApplicationSettingsResource sets the ApplicationSettingsResource field's value.
func (s GetApplicationSettingsOutput) String() string
String returns the string representation
type GetAppsInput struct {
PageSize *string `location:"querystring" locationName:"page-size" type:"string"`
Token *string `location:"querystring" locationName:"token" type:"string"`
// contains filtered or unexported fields
}
func (s GetAppsInput) GoString() string
GoString returns the string representation
func (s *GetAppsInput) SetPageSize(v string) *GetAppsInput
SetPageSize sets the PageSize field's value.
func (s *GetAppsInput) SetToken(v string) *GetAppsInput
SetToken sets the Token field's value.
func (s GetAppsInput) String() string
String returns the string representation
type GetAppsOutput struct {
// Get Applications Result.
//
// ApplicationsResponse is a required field
ApplicationsResponse *ApplicationsResponse `type:"structure" required:"true"`
// contains filtered or unexported fields
}
func (s GetAppsOutput) GoString() string
GoString returns the string representation
func (s *GetAppsOutput) SetApplicationsResponse(v *ApplicationsResponse) *GetAppsOutput
SetApplicationsResponse sets the ApplicationsResponse field's value.
func (s GetAppsOutput) String() string
String returns the string representation
type GetBaiduChannelInput struct {
// ApplicationId is a required field
ApplicationId *string `location:"uri" locationName:"application-id" type:"string" required:"true"`
// contains filtered or unexported fields
}
func (s GetBaiduChannelInput) GoString() string
GoString returns the string representation
func (s *GetBaiduChannelInput) SetApplicationId(v string) *GetBaiduChannelInput
SetApplicationId sets the ApplicationId field's value.
func (s GetBaiduChannelInput) String() string
String returns the string representation
func (s *GetBaiduChannelInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetBaiduChannelOutput struct {
// Baidu Cloud Messaging channel definition
//
// BaiduChannelResponse is a required field
BaiduChannelResponse *BaiduChannelResponse `type:"structure" required:"true"`
// contains filtered or unexported fields
}
func (s GetBaiduChannelOutput) GoString() string
GoString returns the string representation
func (s *GetBaiduChannelOutput) SetBaiduChannelResponse(v *BaiduChannelResponse) *GetBaiduChannelOutput
SetBaiduChannelResponse sets the BaiduChannelResponse field's value.
func (s GetBaiduChannelOutput) String() string
String returns the string representation
type GetCampaignActivitiesInput struct {
// ApplicationId is a required field
ApplicationId *string `location:"uri" locationName:"application-id" type:"string" required:"true"`
// CampaignId is a required field
CampaignId *string `location:"uri" locationName:"campaign-id" type:"string" required:"true"`
PageSize *string `location:"querystring" locationName:"page-size" type:"string"`
Token *string `location:"querystring" locationName:"token" type:"string"`
// contains filtered or unexported fields
}
func (s GetCampaignActivitiesInput) GoString() string
GoString returns the string representation
func (s *GetCampaignActivitiesInput) SetApplicationId(v string) *GetCampaignActivitiesInput
SetApplicationId sets the ApplicationId field's value.
func (s *GetCampaignActivitiesInput) SetCampaignId(v string) *GetCampaignActivitiesInput
SetCampaignId sets the CampaignId field's value.
func (s *GetCampaignActivitiesInput) SetPageSize(v string) *GetCampaignActivitiesInput
SetPageSize sets the PageSize field's value.
func (s *GetCampaignActivitiesInput) SetToken(v string) *GetCampaignActivitiesInput
SetToken sets the Token field's value.
func (s GetCampaignActivitiesInput) String() string
String returns the string representation
func (s *GetCampaignActivitiesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetCampaignActivitiesOutput struct {
// Activities for campaign.
//
// ActivitiesResponse is a required field
ActivitiesResponse *ActivitiesResponse `type:"structure" required:"true"`
// contains filtered or unexported fields
}
func (s GetCampaignActivitiesOutput) GoString() string
GoString returns the string representation
func (s *GetCampaignActivitiesOutput) SetActivitiesResponse(v *ActivitiesResponse) *GetCampaignActivitiesOutput
SetActivitiesResponse sets the ActivitiesResponse field's value.
func (s GetCampaignActivitiesOutput) String() string
String returns the string representation
type GetCampaignInput struct {
// ApplicationId is a required field
ApplicationId *string `location:"uri" locationName:"application-id" type:"string" required:"true"`
// CampaignId is a required field
CampaignId *string `location:"uri" locationName:"campaign-id" type:"string" required:"true"`
// contains filtered or unexported fields
}
func (s GetCampaignInput) GoString() string
GoString returns the string representation
func (s *GetCampaignInput) SetApplicationId(v string) *GetCampaignInput
SetApplicationId sets the ApplicationId field's value.
func (s *GetCampaignInput) SetCampaignId(v string) *GetCampaignInput
SetCampaignId sets the CampaignId field's value.
func (s GetCampaignInput) String() string
String returns the string representation
func (s *GetCampaignInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetCampaignOutput struct {
// Campaign definition
//
// CampaignResponse is a required field
CampaignResponse *CampaignResponse `type:"structure" required:"true"`
// contains filtered or unexported fields
}
func (s GetCampaignOutput) GoString() string
GoString returns the string representation
func (s *GetCampaignOutput) SetCampaignResponse(v *CampaignResponse) *GetCampaignOutput
SetCampaignResponse sets the CampaignResponse field's value.
func (s GetCampaignOutput) String() string
String returns the string representation
type GetCampaignVersionInput struct {
// ApplicationId is a required field
ApplicationId *string `location:"uri" locationName:"application-id" type:"string" required:"true"`
// CampaignId is a required field
CampaignId *string `location:"uri" locationName:"campaign-id" type:"string" required:"true"`
// Version is a required field
Version *string `location:"uri" locationName:"version" type:"string" required:"true"`
// contains filtered or unexported fields
}
func (s GetCampaignVersionInput) GoString() string
GoString returns the string representation
func (s *GetCampaignVersionInput) SetApplicationId(v string) *GetCampaignVersionInput
SetApplicationId sets the ApplicationId field's value.
func (s *GetCampaignVersionInput) SetCampaignId(v string) *GetCampaignVersionInput
SetCampaignId sets the CampaignId field's value.
func (s *GetCampaignVersionInput) SetVersion(v string) *GetCampaignVersionInput
SetVersion sets the Version field's value.
func (s GetCampaignVersionInput) String() string
String returns the string representation
func (s *GetCampaignVersionInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetCampaignVersionOutput struct {
// Campaign definition
//
// CampaignResponse is a required field
CampaignResponse *CampaignResponse `type:"structure" required:"true"`
// contains filtered or unexported fields
}
func (s GetCampaignVersionOutput) GoString() string
GoString returns the string representation
func (s *GetCampaignVersionOutput) SetCampaignResponse(v *CampaignResponse) *GetCampaignVersionOutput
SetCampaignResponse sets the CampaignResponse field's value.
func (s GetCampaignVersionOutput) String() string
String returns the string representation
type GetCampaignVersionsInput struct {
// ApplicationId is a required field
ApplicationId *string `location:"uri" locationName:"application-id" type:"string" required:"true"`
// CampaignId is a required field
CampaignId *string `location:"uri" locationName:"campaign-id" type:"string" required:"true"`
PageSize *string `location:"querystring" locationName:"page-size" type:"string"`
Token *string `location:"querystring" locationName:"token" type:"string"`
// contains filtered or unexported fields
}
func (s GetCampaignVersionsInput) GoString() string
GoString returns the string representation
func (s *GetCampaignVersionsInput) SetApplicationId(v string) *GetCampaignVersionsInput
SetApplicationId sets the ApplicationId field's value.
func (s *GetCampaignVersionsInput) SetCampaignId(v string) *GetCampaignVersionsInput
SetCampaignId sets the CampaignId field's value.
func (s *GetCampaignVersionsInput) SetPageSize(v string) *GetCampaignVersionsInput
SetPageSize sets the PageSize field's value.
func (s *GetCampaignVersionsInput) SetToken(v string) *GetCampaignVersionsInput
SetToken sets the Token field's value.
func (s GetCampaignVersionsInput) String() string
String returns the string representation
func (s *GetCampaignVersionsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetCampaignVersionsOutput struct {
// List of available campaigns.
//
// CampaignsResponse is a required field
CampaignsResponse *CampaignsResponse `type:"structure" required:"true"`
// contains filtered or unexported fields
}
func (s GetCampaignVersionsOutput) GoString() string
GoString returns the string representation
func (s *GetCampaignVersionsOutput) SetCampaignsResponse(v *CampaignsResponse) *GetCampaignVersionsOutput
SetCampaignsResponse sets the CampaignsResponse field's value.
func (s GetCampaignVersionsOutput) String() string
String returns the string representation
type GetCampaignsInput struct {
// ApplicationId is a required field
ApplicationId *string `location:"uri" locationName:"application-id" type:"string" required:"true"`
PageSize *string `location:"querystring" locationName:"page-size" type:"string"`
Token *string `location:"querystring" locationName:"token" type:"string"`
// contains filtered or unexported fields
}
func (s GetCampaignsInput) GoString() string
GoString returns the string representation
func (s *GetCampaignsInput) SetApplicationId(v string) *GetCampaignsInput
SetApplicationId sets the ApplicationId field's value.
func (s *GetCampaignsInput) SetPageSize(v string) *GetCampaignsInput
SetPageSize sets the PageSize field's value.
func (s *GetCampaignsInput) SetToken(v string) *GetCampaignsInput
SetToken sets the Token field's value.
func (s GetCampaignsInput) String() string
String returns the string representation
func (s *GetCampaignsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetCampaignsOutput struct {
// List of available campaigns.
//
// CampaignsResponse is a required field
CampaignsResponse *CampaignsResponse `type:"structure" required:"true"`
// contains filtered or unexported fields
}
func (s GetCampaignsOutput) GoString() string
GoString returns the string representation
func (s *GetCampaignsOutput) SetCampaignsResponse(v *CampaignsResponse) *GetCampaignsOutput
SetCampaignsResponse sets the CampaignsResponse field's value.
func (s GetCampaignsOutput) String() string
String returns the string representation
type GetChannelsInput struct {
// ApplicationId is a required field
ApplicationId *string `location:"uri" locationName:"application-id" type:"string" required:"true"`
// contains filtered or unexported fields
}
func (s GetChannelsInput) GoString() string
GoString returns the string representation
func (s *GetChannelsInput) SetApplicationId(v string) *GetChannelsInput
SetApplicationId sets the ApplicationId field's value.
func (s GetChannelsInput) String() string
String returns the string representation
func (s *GetChannelsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetChannelsOutput struct {
// Get channels definition
//
// ChannelsResponse is a required field
ChannelsResponse *ChannelsResponse `type:"structure" required:"true"`
// contains filtered or unexported fields
}
func (s GetChannelsOutput) GoString() string
GoString returns the string representation
func (s *GetChannelsOutput) SetChannelsResponse(v *ChannelsResponse) *GetChannelsOutput
SetChannelsResponse sets the ChannelsResponse field's value.
func (s GetChannelsOutput) String() string
String returns the string representation
type GetEmailChannelInput struct {
// ApplicationId is a required field
ApplicationId *string `location:"uri" locationName:"application-id" type:"string" required:"true"`
// contains filtered or unexported fields
}
func (s GetEmailChannelInput) GoString() string
GoString returns the string representation
func (s *GetEmailChannelInput) SetApplicationId(v string) *GetEmailChannelInput
SetApplicationId sets the ApplicationId field's value.
func (s GetEmailChannelInput) String() string
String returns the string representation
func (s *GetEmailChannelInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetEmailChannelOutput struct {
// Email Channel Response.
//
// EmailChannelResponse is a required field
EmailChannelResponse *EmailChannelResponse `type:"structure" required:"true"`
// contains filtered or unexported fields
}
func (s GetEmailChannelOutput) GoString() string
GoString returns the string representation
func (s *GetEmailChannelOutput) SetEmailChannelResponse(v *EmailChannelResponse) *GetEmailChannelOutput
SetEmailChannelResponse sets the EmailChannelResponse field's value.
func (s GetEmailChannelOutput) String() string
String returns the string representation
type GetEndpointInput struct {
// ApplicationId is a required field
ApplicationId *string `location:"uri" locationName:"application-id" type:"string" required:"true"`
// EndpointId is a required field
EndpointId *string `location:"uri" locationName:"endpoint-id" type:"string" required:"true"`
// contains filtered or unexported fields
}
func (s GetEndpointInput) GoString() string
GoString returns the string representation
func (s *GetEndpointInput) SetApplicationId(v string) *GetEndpointInput
SetApplicationId sets the ApplicationId field's value.
func (s *GetEndpointInput) SetEndpointId(v string) *GetEndpointInput
SetEndpointId sets the EndpointId field's value.
func (s GetEndpointInput) String() string
String returns the string representation
func (s *GetEndpointInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetEndpointOutput struct {
// Endpoint response
//
// EndpointResponse is a required field
EndpointResponse *EndpointResponse `type:"structure" required:"true"`
// contains filtered or unexported fields
}
func (s GetEndpointOutput) GoString() string
GoString returns the string representation
func (s *GetEndpointOutput) SetEndpointResponse(v *EndpointResponse) *GetEndpointOutput
SetEndpointResponse sets the EndpointResponse field's value.
func (s GetEndpointOutput) String() string
String returns the string representation
type GetEventStreamInput struct {
// ApplicationId is a required field
ApplicationId *string `location:"uri" locationName:"application-id" type:"string" required:"true"`
// contains filtered or unexported fields
}
func (s GetEventStreamInput) GoString() string
GoString returns the string representation
func (s *GetEventStreamInput) SetApplicationId(v string) *GetEventStreamInput
SetApplicationId sets the ApplicationId field's value.
func (s GetEventStreamInput) String() string
String returns the string representation
func (s *GetEventStreamInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetEventStreamOutput struct {
// Model for an event publishing subscription export.
//
// EventStream is a required field
EventStream *EventStream `type:"structure" required:"true"`
// contains filtered or unexported fields
}
func (s GetEventStreamOutput) GoString() string
GoString returns the string representation
func (s *GetEventStreamOutput) SetEventStream(v *EventStream) *GetEventStreamOutput
SetEventStream sets the EventStream field's value.
func (s GetEventStreamOutput) String() string
String returns the string representation
type GetExportJobInput struct {
// ApplicationId is a required field
ApplicationId *string `location:"uri" locationName:"application-id" type:"string" required:"true"`
// JobId is a required field
JobId *string `location:"uri" locationName:"job-id" type:"string" required:"true"`
// contains filtered or unexported fields
}
func (s GetExportJobInput) GoString() string
GoString returns the string representation
func (s *GetExportJobInput) SetApplicationId(v string) *GetExportJobInput
SetApplicationId sets the ApplicationId field's value.
func (s *GetExportJobInput) SetJobId(v string) *GetExportJobInput
SetJobId sets the JobId field's value.
func (s GetExportJobInput) String() string
String returns the string representation
func (s *GetExportJobInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetExportJobOutput struct {
// Export job response.
//
// ExportJobResponse is a required field
ExportJobResponse *ExportJobResponse `type:"structure" required:"true"`
// contains filtered or unexported fields
}
func (s GetExportJobOutput) GoString() string
GoString returns the string representation
func (s *GetExportJobOutput) SetExportJobResponse(v *ExportJobResponse) *GetExportJobOutput
SetExportJobResponse sets the ExportJobResponse field's value.
func (s GetExportJobOutput) String() string
String returns the string representation
type GetExportJobsInput struct {
// ApplicationId is a required field
ApplicationId *string `location:"uri" locationName:"application-id" type:"string" required:"true"`
PageSize *string `location:"querystring" locationName:"page-size" type:"string"`
Token *string `location:"querystring" locationName:"token" type:"string"`
// contains filtered or unexported fields
}
func (s GetExportJobsInput) GoString() string
GoString returns the string representation
func (s *GetExportJobsInput) SetApplicationId(v string) *GetExportJobsInput
SetApplicationId sets the ApplicationId field's value.
func (s *GetExportJobsInput) SetPageSize(v string) *GetExportJobsInput
SetPageSize sets the PageSize field's value.
func (s *GetExportJobsInput) SetToken(v string) *GetExportJobsInput
SetToken sets the Token field's value.
func (s GetExportJobsInput) String() string
String returns the string representation
func (s *GetExportJobsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetExportJobsOutput struct {
// Export job list.
//
// ExportJobsResponse is a required field
ExportJobsResponse *ExportJobsResponse `type:"structure" required:"true"`
// contains filtered or unexported fields
}
func (s GetExportJobsOutput) GoString() string
GoString returns the string representation
func (s *GetExportJobsOutput) SetExportJobsResponse(v *ExportJobsResponse) *GetExportJobsOutput
SetExportJobsResponse sets the ExportJobsResponse field's value.
func (s GetExportJobsOutput) String() string
String returns the string representation
type GetGcmChannelInput struct {
// ApplicationId is a required field
ApplicationId *string `location:"uri" locationName:"application-id" type:"string" required:"true"`
// contains filtered or unexported fields
}
func (s GetGcmChannelInput) GoString() string
GoString returns the string representation
func (s *GetGcmChannelInput) SetApplicationId(v string) *GetGcmChannelInput
SetApplicationId sets the ApplicationId field's value.
func (s GetGcmChannelInput) String() string
String returns the string representation
func (s *GetGcmChannelInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetGcmChannelOutput struct {
// Google Cloud Messaging channel definition
//
// GCMChannelResponse is a required field
GCMChannelResponse *GCMChannelResponse `type:"structure" required:"true"`
// contains filtered or unexported fields
}
func (s GetGcmChannelOutput) GoString() string
GoString returns the string representation
func (s *GetGcmChannelOutput) SetGCMChannelResponse(v *GCMChannelResponse) *GetGcmChannelOutput
SetGCMChannelResponse sets the GCMChannelResponse field's value.
func (s GetGcmChannelOutput) String() string
String returns the string representation
type GetImportJobInput struct {
// ApplicationId is a required field
ApplicationId *string `location:"uri" locationName:"application-id" type:"string" required:"true"`
// JobId is a required field
JobId *string `location:"uri" locationName:"job-id" type:"string" required:"true"`
// contains filtered or unexported fields
}
func (s GetImportJobInput) GoString() string
GoString returns the string representation
func (s *GetImportJobInput) SetApplicationId(v string) *GetImportJobInput
SetApplicationId sets the ApplicationId field's value.
func (s *GetImportJobInput) SetJobId(v string) *GetImportJobInput
SetJobId sets the JobId field's value.
func (s GetImportJobInput) String() string
String returns the string representation
func (s *GetImportJobInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetImportJobOutput struct {
// Import job response.
//
// ImportJobResponse is a required field
ImportJobResponse *ImportJobResponse `type:"structure" required:"true"`
// contains filtered or unexported fields
}
func (s GetImportJobOutput) GoString() string
GoString returns the string representation
func (s *GetImportJobOutput) SetImportJobResponse(v *ImportJobResponse) *GetImportJobOutput
SetImportJobResponse sets the ImportJobResponse field's value.
func (s GetImportJobOutput) String() string
String returns the string representation
type GetImportJobsInput struct {
// ApplicationId is a required field
ApplicationId *string `location:"uri" locationName:"application-id" type:"string" required:"true"`
PageSize *string `location:"querystring" locationName:"page-size" type:"string"`
Token *string `location:"querystring" locationName:"token" type:"string"`
// contains filtered or unexported fields
}
func (s GetImportJobsInput) GoString() string
GoString returns the string representation
func (s *GetImportJobsInput) SetApplicationId(v string) *GetImportJobsInput
SetApplicationId sets the ApplicationId field's value.
func (s *GetImportJobsInput) SetPageSize(v string) *GetImportJobsInput
SetPageSize sets the PageSize field's value.
func (s *GetImportJobsInput) SetToken(v string) *GetImportJobsInput
SetToken sets the Token field's value.
func (s GetImportJobsInput) String() string
String returns the string representation
func (s *GetImportJobsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetImportJobsOutput struct {
// Import job list.
//
// ImportJobsResponse is a required field
ImportJobsResponse *ImportJobsResponse `type:"structure" required:"true"`
// contains filtered or unexported fields
}
func (s GetImportJobsOutput) GoString() string
GoString returns the string representation
func (s *GetImportJobsOutput) SetImportJobsResponse(v *ImportJobsResponse) *GetImportJobsOutput
SetImportJobsResponse sets the ImportJobsResponse field's value.
func (s GetImportJobsOutput) String() string
String returns the string representation
type GetSegmentExportJobsInput struct {
// ApplicationId is a required field
ApplicationId *string `location:"uri" locationName:"application-id" type:"string" required:"true"`
PageSize *string `location:"querystring" locationName:"page-size" type:"string"`
// SegmentId is a required field
SegmentId *string `location:"uri" locationName:"segment-id" type:"string" required:"true"`
Token *string `location:"querystring" locationName:"token" type:"string"`
// contains filtered or unexported fields
}
func (s GetSegmentExportJobsInput) GoString() string
GoString returns the string representation
func (s *GetSegmentExportJobsInput) SetApplicationId(v string) *GetSegmentExportJobsInput
SetApplicationId sets the ApplicationId field's value.
func (s *GetSegmentExportJobsInput) SetPageSize(v string) *GetSegmentExportJobsInput
SetPageSize sets the PageSize field's value.
func (s *GetSegmentExportJobsInput) SetSegmentId(v string) *GetSegmentExportJobsInput
SetSegmentId sets the SegmentId field's value.
func (s *GetSegmentExportJobsInput) SetToken(v string) *GetSegmentExportJobsInput
SetToken sets the Token field's value.
func (s GetSegmentExportJobsInput) String() string
String returns the string representation
func (s *GetSegmentExportJobsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetSegmentExportJobsOutput struct {
// Export job list.
//
// ExportJobsResponse is a required field
ExportJobsResponse *ExportJobsResponse `type:"structure" required:"true"`
// contains filtered or unexported fields
}
func (s GetSegmentExportJobsOutput) GoString() string
GoString returns the string representation
func (s *GetSegmentExportJobsOutput) SetExportJobsResponse(v *ExportJobsResponse) *GetSegmentExportJobsOutput
SetExportJobsResponse sets the ExportJobsResponse field's value.
func (s GetSegmentExportJobsOutput) String() string
String returns the string representation
type GetSegmentImportJobsInput struct {
// ApplicationId is a required field
ApplicationId *string `location:"uri" locationName:"application-id" type:"string" required:"true"`
PageSize *string `location:"querystring" locationName:"page-size" type:"string"`
// SegmentId is a required field
SegmentId *string `location:"uri" locationName:"segment-id" type:"string" required:"true"`
Token *string `location:"querystring" locationName:"token" type:"string"`
// contains filtered or unexported fields
}
func (s GetSegmentImportJobsInput) GoString() string
GoString returns the string representation
func (s *GetSegmentImportJobsInput) SetApplicationId(v string) *GetSegmentImportJobsInput
SetApplicationId sets the ApplicationId field's value.
func (s *GetSegmentImportJobsInput) SetPageSize(v string) *GetSegmentImportJobsInput
SetPageSize sets the PageSize field's value.
func (s *GetSegmentImportJobsInput) SetSegmentId(v string) *GetSegmentImportJobsInput
SetSegmentId sets the SegmentId field's value.
func (s *GetSegmentImportJobsInput) SetToken(v string) *GetSegmentImportJobsInput
SetToken sets the Token field's value.
func (s GetSegmentImportJobsInput) String() string
String returns the string representation
func (s *GetSegmentImportJobsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetSegmentImportJobsOutput struct {
// Import job list.
//
// ImportJobsResponse is a required field
ImportJobsResponse *ImportJobsResponse `type:"structure" required:"true"`
// contains filtered or unexported fields
}
func (s GetSegmentImportJobsOutput) GoString() string
GoString returns the string representation
func (s *GetSegmentImportJobsOutput) SetImportJobsResponse(v *ImportJobsResponse) *GetSegmentImportJobsOutput
SetImportJobsResponse sets the ImportJobsResponse field's value.
func (s GetSegmentImportJobsOutput) String() string
String returns the string representation
type GetSegmentInput struct {
// ApplicationId is a required field
ApplicationId *string `location:"uri" locationName:"application-id" type:"string" required:"true"`
// SegmentId is a required field
SegmentId *string `location:"uri" locationName:"segment-id" type:"string" required:"true"`
// contains filtered or unexported fields
}
func (s GetSegmentInput) GoString() string
GoString returns the string representation
func (s *GetSegmentInput) SetApplicationId(v string) *GetSegmentInput
SetApplicationId sets the ApplicationId field's value.
func (s *GetSegmentInput) SetSegmentId(v string) *GetSegmentInput
SetSegmentId sets the SegmentId field's value.
func (s GetSegmentInput) String() string
String returns the string representation
func (s *GetSegmentInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetSegmentOutput struct {
// Segment definition.
//
// SegmentResponse is a required field
SegmentResponse *SegmentResponse `type:"structure" required:"true"`
// contains filtered or unexported fields
}
func (s GetSegmentOutput) GoString() string
GoString returns the string representation
func (s *GetSegmentOutput) SetSegmentResponse(v *SegmentResponse) *GetSegmentOutput
SetSegmentResponse sets the SegmentResponse field's value.
func (s GetSegmentOutput) String() string
String returns the string representation
type GetSegmentVersionInput struct {
// ApplicationId is a required field
ApplicationId *string `location:"uri" locationName:"application-id" type:"string" required:"true"`
// SegmentId is a required field
SegmentId *string `location:"uri" locationName:"segment-id" type:"string" required:"true"`
// Version is a required field
Version *string `location:"uri" locationName:"version" type:"string" required:"true"`
// contains filtered or unexported fields
}
func (s GetSegmentVersionInput) GoString() string
GoString returns the string representation
func (s *GetSegmentVersionInput) SetApplicationId(v string) *GetSegmentVersionInput
SetApplicationId sets the ApplicationId field's value.
func (s *GetSegmentVersionInput) SetSegmentId(v string) *GetSegmentVersionInput
SetSegmentId sets the SegmentId field's value.
func (s *GetSegmentVersionInput) SetVersion(v string) *GetSegmentVersionInput
SetVersion sets the Version field's value.
func (s GetSegmentVersionInput) String() string
String returns the string representation
func (s *GetSegmentVersionInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetSegmentVersionOutput struct {
// Segment definition.
//
// SegmentResponse is a required field
SegmentResponse *SegmentResponse `type:"structure" required:"true"`
// contains filtered or unexported fields
}
func (s GetSegmentVersionOutput) GoString() string
GoString returns the string representation
func (s *GetSegmentVersionOutput) SetSegmentResponse(v *SegmentResponse) *GetSegmentVersionOutput
SetSegmentResponse sets the SegmentResponse field's value.
func (s GetSegmentVersionOutput) String() string
String returns the string representation
type GetSegmentVersionsInput struct {
// ApplicationId is a required field
ApplicationId *string `location:"uri" locationName:"application-id" type:"string" required:"true"`
PageSize *string `location:"querystring" locationName:"page-size" type:"string"`
// SegmentId is a required field
SegmentId *string `location:"uri" locationName:"segment-id" type:"string" required:"true"`
Token *string `location:"querystring" locationName:"token" type:"string"`
// contains filtered or unexported fields
}
func (s GetSegmentVersionsInput) GoString() string
GoString returns the string representation
func (s *GetSegmentVersionsInput) SetApplicationId(v string) *GetSegmentVersionsInput
SetApplicationId sets the ApplicationId field's value.
func (s *GetSegmentVersionsInput) SetPageSize(v string) *GetSegmentVersionsInput
SetPageSize sets the PageSize field's value.
func (s *GetSegmentVersionsInput) SetSegmentId(v string) *GetSegmentVersionsInput
SetSegmentId sets the SegmentId field's value.
func (s *GetSegmentVersionsInput) SetToken(v string) *GetSegmentVersionsInput
SetToken sets the Token field's value.
func (s GetSegmentVersionsInput) String() string
String returns the string representation
func (s *GetSegmentVersionsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetSegmentVersionsOutput struct {
// Segments in your account.
//
// SegmentsResponse is a required field
SegmentsResponse *SegmentsResponse `type:"structure" required:"true"`
// contains filtered or unexported fields
}
func (s GetSegmentVersionsOutput) GoString() string
GoString returns the string representation
func (s *GetSegmentVersionsOutput) SetSegmentsResponse(v *SegmentsResponse) *GetSegmentVersionsOutput
SetSegmentsResponse sets the SegmentsResponse field's value.
func (s GetSegmentVersionsOutput) String() string
String returns the string representation
type GetSegmentsInput struct {
// ApplicationId is a required field
ApplicationId *string `location:"uri" locationName:"application-id" type:"string" required:"true"`
PageSize *string `location:"querystring" locationName:"page-size" type:"string"`
Token *string `location:"querystring" locationName:"token" type:"string"`
// contains filtered or unexported fields
}
func (s GetSegmentsInput) GoString() string
GoString returns the string representation
func (s *GetSegmentsInput) SetApplicationId(v string) *GetSegmentsInput
SetApplicationId sets the ApplicationId field's value.
func (s *GetSegmentsInput) SetPageSize(v string) *GetSegmentsInput
SetPageSize sets the PageSize field's value.
func (s *GetSegmentsInput) SetToken(v string) *GetSegmentsInput
SetToken sets the Token field's value.
func (s GetSegmentsInput) String() string
String returns the string representation
func (s *GetSegmentsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetSegmentsOutput struct {
// Segments in your account.
//
// SegmentsResponse is a required field
SegmentsResponse *SegmentsResponse `type:"structure" required:"true"`
// contains filtered or unexported fields
}
func (s GetSegmentsOutput) GoString() string
GoString returns the string representation
func (s *GetSegmentsOutput) SetSegmentsResponse(v *SegmentsResponse) *GetSegmentsOutput
SetSegmentsResponse sets the SegmentsResponse field's value.
func (s GetSegmentsOutput) String() string
String returns the string representation
type GetSmsChannelInput struct {
// ApplicationId is a required field
ApplicationId *string `location:"uri" locationName:"application-id" type:"string" required:"true"`
// contains filtered or unexported fields
}
func (s GetSmsChannelInput) GoString() string
GoString returns the string representation
func (s *GetSmsChannelInput) SetApplicationId(v string) *GetSmsChannelInput
SetApplicationId sets the ApplicationId field's value.
func (s GetSmsChannelInput) String() string
String returns the string representation
func (s *GetSmsChannelInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetSmsChannelOutput struct {
// SMS Channel Response.
//
// SMSChannelResponse is a required field
SMSChannelResponse *SMSChannelResponse `type:"structure" required:"true"`
// contains filtered or unexported fields
}
func (s GetSmsChannelOutput) GoString() string
GoString returns the string representation
func (s *GetSmsChannelOutput) SetSMSChannelResponse(v *SMSChannelResponse) *GetSmsChannelOutput
SetSMSChannelResponse sets the SMSChannelResponse field's value.
func (s GetSmsChannelOutput) String() string
String returns the string representation
type GetUserEndpointsInput struct {
// ApplicationId is a required field
ApplicationId *string `location:"uri" locationName:"application-id" type:"string" required:"true"`
// UserId is a required field
UserId *string `location:"uri" locationName:"user-id" type:"string" required:"true"`
// contains filtered or unexported fields
}
func (s GetUserEndpointsInput) GoString() string
GoString returns the string representation
func (s *GetUserEndpointsInput) SetApplicationId(v string) *GetUserEndpointsInput
SetApplicationId sets the ApplicationId field's value.
func (s *GetUserEndpointsInput) SetUserId(v string) *GetUserEndpointsInput
SetUserId sets the UserId field's value.
func (s GetUserEndpointsInput) String() string
String returns the string representation
func (s *GetUserEndpointsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetUserEndpointsOutput struct {
// List of endpoints
//
// EndpointsResponse is a required field
EndpointsResponse *EndpointsResponse `type:"structure" required:"true"`
// contains filtered or unexported fields
}
func (s GetUserEndpointsOutput) GoString() string
GoString returns the string representation
func (s *GetUserEndpointsOutput) SetEndpointsResponse(v *EndpointsResponse) *GetUserEndpointsOutput
SetEndpointsResponse sets the EndpointsResponse field's value.
func (s GetUserEndpointsOutput) String() string
String returns the string representation
type GetVoiceChannelInput struct {
// ApplicationId is a required field
ApplicationId *string `location:"uri" locationName:"application-id" type:"string" required:"true"`
// contains filtered or unexported fields
}
func (s GetVoiceChannelInput) GoString() string
GoString returns the string representation
func (s *GetVoiceChannelInput) SetApplicationId(v string) *GetVoiceChannelInput
SetApplicationId sets the ApplicationId field's value.
func (s GetVoiceChannelInput) String() string
String returns the string representation
func (s *GetVoiceChannelInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetVoiceChannelOutput struct {
// Voice Channel Response.
//
// VoiceChannelResponse is a required field
VoiceChannelResponse *VoiceChannelResponse `type:"structure" required:"true"`
// contains filtered or unexported fields
}
func (s GetVoiceChannelOutput) GoString() string
GoString returns the string representation
func (s *GetVoiceChannelOutput) SetVoiceChannelResponse(v *VoiceChannelResponse) *GetVoiceChannelOutput
SetVoiceChannelResponse sets the VoiceChannelResponse field's value.
func (s GetVoiceChannelOutput) String() string
String returns the string representation
type ImportJobRequest struct {
// Sets whether the endpoints create a segment when they are imported.
DefineSegment *bool `type:"boolean"`
// (Deprecated) Your AWS account ID, which you assigned to the ExternalID key
// in an IAM trust policy. Used by Amazon Pinpoint to assume an IAM role. This
// requirement is removed, and external IDs are not recommended for IAM roles
// assumed by Amazon Pinpoint.
ExternalId *string `type:"string"`
// The format of the files that contain the endpoint definitions.Valid values:
// CSV, JSON
Format *string `type:"string" enum:"Format"`
// Sets whether the endpoints are registered with Amazon Pinpoint when they
// are imported.
RegisterEndpoints *bool `type:"boolean"`
// The Amazon Resource Name (ARN) of an IAM role that grants Amazon Pinpoint
// access to the Amazon S3 location that contains the endpoints to import.
RoleArn *string `type:"string"`
// The URL of the S3 bucket that contains the segment information to import.
// The location can be a folder or a single file. The URL should use the following
// format: s3://bucket-name/folder-name/file-nameAmazon Pinpoint imports endpoints
// from this location and any subfolders it contains.
S3Url *string `type:"string"`
// The ID of the segment to update if the import job is meant to update an existing
// segment.
SegmentId *string `type:"string"`
// A custom name for the segment created by the import job. Use if DefineSegment
// is true.
SegmentName *string `type:"string"`
// contains filtered or unexported fields
}
Import job request.
func (s ImportJobRequest) GoString() string
GoString returns the string representation
func (s *ImportJobRequest) SetDefineSegment(v bool) *ImportJobRequest
SetDefineSegment sets the DefineSegment field's value.
func (s *ImportJobRequest) SetExternalId(v string) *ImportJobRequest
SetExternalId sets the ExternalId field's value.
func (s *ImportJobRequest) SetFormat(v string) *ImportJobRequest
SetFormat sets the Format field's value.
func (s *ImportJobRequest) SetRegisterEndpoints(v bool) *ImportJobRequest
SetRegisterEndpoints sets the RegisterEndpoints field's value.
func (s *ImportJobRequest) SetRoleArn(v string) *ImportJobRequest
SetRoleArn sets the RoleArn field's value.
func (s *ImportJobRequest) SetS3Url(v string) *ImportJobRequest
SetS3Url sets the S3Url field's value.
func (s *ImportJobRequest) SetSegmentId(v string) *ImportJobRequest
SetSegmentId sets the SegmentId field's value.
func (s *ImportJobRequest) SetSegmentName(v string) *ImportJobRequest
SetSegmentName sets the SegmentName field's value.
func (s ImportJobRequest) String() string
String returns the string representation
type ImportJobResource struct {
// Sets whether the endpoints create a segment when they are imported.
DefineSegment *bool `type:"boolean"`
// (Deprecated) Your AWS account ID, which you assigned to the ExternalID key
// in an IAM trust policy. Used by Amazon Pinpoint to assume an IAM role. This
// requirement is removed, and external IDs are not recommended for IAM roles
// assumed by Amazon Pinpoint.
ExternalId *string `type:"string"`
// The format of the files that contain the endpoint definitions.Valid values:
// CSV, JSON
Format *string `type:"string" enum:"Format"`
// Sets whether the endpoints are registered with Amazon Pinpoint when they
// are imported.
RegisterEndpoints *bool `type:"boolean"`
// The Amazon Resource Name (ARN) of an IAM role that grants Amazon Pinpoint
// access to the Amazon S3 location that contains the endpoints to import.
RoleArn *string `type:"string"`
// The URL of the S3 bucket that contains the segment information to import.
// The location can be a folder or a single file. The URL should use the following
// format: s3://bucket-name/folder-name/file-nameAmazon Pinpoint imports endpoints
// from this location and any subfolders it contains.
S3Url *string `type:"string"`
// The ID of the segment to update if the import job is meant to update an existing
// segment.
SegmentId *string `type:"string"`
// A custom name for the segment created by the import job. Use if DefineSegment
// is true.
SegmentName *string `type:"string"`
// contains filtered or unexported fields
}
Import job resource
func (s ImportJobResource) GoString() string
GoString returns the string representation
func (s *ImportJobResource) SetDefineSegment(v bool) *ImportJobResource
SetDefineSegment sets the DefineSegment field's value.
func (s *ImportJobResource) SetExternalId(v string) *ImportJobResource
SetExternalId sets the ExternalId field's value.
func (s *ImportJobResource) SetFormat(v string) *ImportJobResource
SetFormat sets the Format field's value.
func (s *ImportJobResource) SetRegisterEndpoints(v bool) *ImportJobResource
SetRegisterEndpoints sets the RegisterEndpoints field's value.
func (s *ImportJobResource) SetRoleArn(v string) *ImportJobResource
SetRoleArn sets the RoleArn field's value.
func (s *ImportJobResource) SetS3Url(v string) *ImportJobResource
SetS3Url sets the S3Url field's value.
func (s *ImportJobResource) SetSegmentId(v string) *ImportJobResource
SetSegmentId sets the SegmentId field's value.
func (s *ImportJobResource) SetSegmentName(v string) *ImportJobResource
SetSegmentName sets the SegmentName field's value.
func (s ImportJobResource) String() string
String returns the string representation
type ImportJobResponse struct {
// The unique ID of the application to which the import job applies.
ApplicationId *string `type:"string"`
// The number of pieces that have successfully imported as of the time of the
// request.
CompletedPieces *int64 `type:"integer"`
// The date the import job completed in ISO 8601 format.
CompletionDate *string `type:"string"`
// The date the import job was created in ISO 8601 format.
CreationDate *string `type:"string"`
// The import job settings.
Definition *ImportJobResource `type:"structure"`
// The number of pieces that have failed to import as of the time of the request.
FailedPieces *int64 `type:"integer"`
// Provides up to 100 of the first failed entries for the job, if any exist.
Failures []*string `type:"list"`
// The unique ID of the import job.
Id *string `type:"string"`
// The status of the import job.Valid values: CREATED, INITIALIZING, PROCESSING,
// COMPLETING, COMPLETED, FAILING, FAILEDThe job status is FAILED if one or
// more pieces failed to import.
JobStatus *string `type:"string" enum:"JobStatus"`
// The number of endpoints that failed to import; for example, because of syntax
// errors.
TotalFailures *int64 `type:"integer"`
// The total number of pieces that must be imported to finish the job. Each
// piece is an approximately equal portion of the endpoints to import.
TotalPieces *int64 `type:"integer"`
// The number of endpoints that were processed by the import job.
TotalProcessed *int64 `type:"integer"`
// The job type. Will be Import.
Type *string `type:"string"`
// contains filtered or unexported fields
}
Import job response.
func (s ImportJobResponse) GoString() string
GoString returns the string representation
func (s *ImportJobResponse) SetApplicationId(v string) *ImportJobResponse
SetApplicationId sets the ApplicationId field's value.
func (s *ImportJobResponse) SetCompletedPieces(v int64) *ImportJobResponse
SetCompletedPieces sets the CompletedPieces field's value.
func (s *ImportJobResponse) SetCompletionDate(v string) *ImportJobResponse
SetCompletionDate sets the CompletionDate field's value.
func (s *ImportJobResponse) SetCreationDate(v string) *ImportJobResponse
SetCreationDate sets the CreationDate field's value.
func (s *ImportJobResponse) SetDefinition(v *ImportJobResource) *ImportJobResponse
SetDefinition sets the Definition field's value.
func (s *ImportJobResponse) SetFailedPieces(v int64) *ImportJobResponse
SetFailedPieces sets the FailedPieces field's value.
func (s *ImportJobResponse) SetFailures(v []*string) *ImportJobResponse
SetFailures sets the Failures field's value.
func (s *ImportJobResponse) SetId(v string) *ImportJobResponse
SetId sets the Id field's value.
func (s *ImportJobResponse) SetJobStatus(v string) *ImportJobResponse
SetJobStatus sets the JobStatus field's value.
func (s *ImportJobResponse) SetTotalFailures(v int64) *ImportJobResponse
SetTotalFailures sets the TotalFailures field's value.
func (s *ImportJobResponse) SetTotalPieces(v int64) *ImportJobResponse
SetTotalPieces sets the TotalPieces field's value.
func (s *ImportJobResponse) SetTotalProcessed(v int64) *ImportJobResponse
SetTotalProcessed sets the TotalProcessed field's value.
func (s *ImportJobResponse) SetType(v string) *ImportJobResponse
SetType sets the Type field's value.
func (s ImportJobResponse) String() string
String returns the string representation
type ImportJobsResponse struct {
// A list of import jobs for the application.
Item []*ImportJobResponse `type:"list"`
// The string that you use in a subsequent request to get the next page of results
// in a paginated response.
NextToken *string `type:"string"`
// contains filtered or unexported fields
}
Import job list.
func (s ImportJobsResponse) GoString() string
GoString returns the string representation
func (s *ImportJobsResponse) SetItem(v []*ImportJobResponse) *ImportJobsResponse
SetItem sets the Item field's value.
func (s *ImportJobsResponse) SetNextToken(v string) *ImportJobsResponse
SetNextToken sets the NextToken field's value.
func (s ImportJobsResponse) String() string
String returns the string representation
type ItemResponse struct {
// The response received after the endpoint was accepted.
EndpointItemResponse *EndpointItemResponse `type:"structure"`
// A multipart response object that contains a key and value for each event
// ID in the request. In each object, the event ID is the key, and an EventItemResponse
// object is the value.
EventsItemResponse map[string]*EventItemResponse `type:"map"`
// contains filtered or unexported fields
}
The response that's provided after registering the endpoint.
func (s ItemResponse) GoString() string
GoString returns the string representation
func (s *ItemResponse) SetEndpointItemResponse(v *EndpointItemResponse) *ItemResponse
SetEndpointItemResponse sets the EndpointItemResponse field's value.
func (s *ItemResponse) SetEventsItemResponse(v map[string]*EventItemResponse) *ItemResponse
SetEventsItemResponse sets the EventsItemResponse field's value.
func (s ItemResponse) String() string
String returns the string representation
type ListTagsForResourceInput struct {
// ResourceArn is a required field
ResourceArn *string `location:"uri" locationName:"resource-arn" type:"string" required:"true"`
// contains filtered or unexported fields
}
func (s ListTagsForResourceInput) GoString() string
GoString returns the string representation
func (s *ListTagsForResourceInput) SetResourceArn(v string) *ListTagsForResourceInput
SetResourceArn sets the ResourceArn field's value.
func (s ListTagsForResourceInput) String() string
String returns the string representation
func (s *ListTagsForResourceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListTagsForResourceOutput struct {
// TagsModel is a required field
TagsModel *TagsModel `type:"structure" required:"true"`
// contains filtered or unexported fields
}
func (s ListTagsForResourceOutput) GoString() string
GoString returns the string representation
func (s *ListTagsForResourceOutput) SetTagsModel(v *TagsModel) *ListTagsForResourceOutput
SetTagsModel sets the TagsModel field's value.
func (s ListTagsForResourceOutput) String() string
String returns the string representation
type Message struct {
// The action that occurs if the user taps a push notification delivered by
// the campaign:OPEN_APP - Your app launches, or it becomes the foreground app
// if it has been sent to the background. This is the default action.DEEP_LINK
// - Uses deep linking features in iOS and Android to open your app and display
// a designated user interface within the app.URL - The default mobile browser
// on the user's device launches and opens a web page at the URL you specify.
Action *string `type:"string" enum:"Action"`
// The message body. Can include up to 140 characters.
Body *string `type:"string"`
// The URL that points to the icon image for the push notification icon, for
// example, the app icon.
ImageIconUrl *string `type:"string"`
// The URL that points to the small icon image for the push notification icon,
// for example, the app icon.
ImageSmallIconUrl *string `type:"string"`
// The URL that points to an image used in the push notification.
ImageUrl *string `type:"string"`
// The JSON payload used for a silent push.
JsonBody *string `type:"string"`
// A URL that refers to the location of an image or video that you want to display
// in the push notification.
MediaUrl *string `type:"string"`
// The Raw JSON formatted string to be used as the payload. This value overrides
// the message.
RawContent *string `type:"string"`
// Indicates if the message should display on the users device.Silent pushes
// can be used for Remote Configuration and Phone Home use cases.
SilentPush *bool `type:"boolean"`
// This parameter specifies how long (in seconds) the message should be kept
// if the service is unable to deliver the notification the first time. If the
// value is 0, it treats the notification as if it expires immediately and does
// not store the notification or attempt to redeliver it. This value is converted
// to the expiration field when sent to the service. It only applies to APNs
// and GCM
TimeToLive *int64 `type:"integer"`
// The message title that displays above the message on the user's device.
Title *string `type:"string"`
// The URL to open in the user's mobile browser. Used if the value for Action
// is URL.
Url *string `type:"string"`
// contains filtered or unexported fields
}
Message to send
func (s Message) GoString() string
GoString returns the string representation
func (s *Message) SetAction(v string) *Message
SetAction sets the Action field's value.
func (s *Message) SetBody(v string) *Message
SetBody sets the Body field's value.
func (s *Message) SetImageIconUrl(v string) *Message
SetImageIconUrl sets the ImageIconUrl field's value.
func (s *Message) SetImageSmallIconUrl(v string) *Message
SetImageSmallIconUrl sets the ImageSmallIconUrl field's value.
func (s *Message) SetImageUrl(v string) *Message
SetImageUrl sets the ImageUrl field's value.
func (s *Message) SetJsonBody(v string) *Message
SetJsonBody sets the JsonBody field's value.
func (s *Message) SetMediaUrl(v string) *Message
SetMediaUrl sets the MediaUrl field's value.
func (s *Message) SetRawContent(v string) *Message
SetRawContent sets the RawContent field's value.
func (s *Message) SetSilentPush(v bool) *Message
SetSilentPush sets the SilentPush field's value.
func (s *Message) SetTimeToLive(v int64) *Message
SetTimeToLive sets the TimeToLive field's value.
func (s *Message) SetTitle(v string) *Message
SetTitle sets the Title field's value.
func (s *Message) SetUrl(v string) *Message
SetUrl sets the Url field's value.
func (s Message) String() string
String returns the string representation
type MessageBody struct {
// The error message that's returned from the API.
Message *string `type:"string"`
// The unique message body ID.
RequestID *string `type:"string"`
// contains filtered or unexported fields
}
Simple message object.
func (s MessageBody) GoString() string
GoString returns the string representation
func (s *MessageBody) SetMessage(v string) *MessageBody
SetMessage sets the Message field's value.
func (s *MessageBody) SetRequestID(v string) *MessageBody
SetRequestID sets the RequestID field's value.
func (s MessageBody) String() string
String returns the string representation
type MessageConfiguration struct {
// The message that the campaign delivers to ADM channels. Overrides the default
// message.
ADMMessage *Message `type:"structure"`
// The message that the campaign delivers to APNS channels. Overrides the default
// message.
APNSMessage *Message `type:"structure"`
// The message that the campaign delivers to Baidu channels. Overrides the default
// message.
BaiduMessage *Message `type:"structure"`
// The default message for all channels.
DefaultMessage *Message `type:"structure"`
// The email message configuration.
EmailMessage *CampaignEmailMessage `type:"structure"`
// The message that the campaign delivers to GCM channels. Overrides the default
// message.
GCMMessage *Message `type:"structure"`
// The SMS message configuration.
SMSMessage *CampaignSmsMessage `type:"structure"`
// contains filtered or unexported fields
}
Message configuration for a campaign.
func (s MessageConfiguration) GoString() string
GoString returns the string representation
func (s *MessageConfiguration) SetADMMessage(v *Message) *MessageConfiguration
SetADMMessage sets the ADMMessage field's value.
func (s *MessageConfiguration) SetAPNSMessage(v *Message) *MessageConfiguration
SetAPNSMessage sets the APNSMessage field's value.
func (s *MessageConfiguration) SetBaiduMessage(v *Message) *MessageConfiguration
SetBaiduMessage sets the BaiduMessage field's value.
func (s *MessageConfiguration) SetDefaultMessage(v *Message) *MessageConfiguration
SetDefaultMessage sets the DefaultMessage field's value.
func (s *MessageConfiguration) SetEmailMessage(v *CampaignEmailMessage) *MessageConfiguration
SetEmailMessage sets the EmailMessage field's value.
func (s *MessageConfiguration) SetGCMMessage(v *Message) *MessageConfiguration
SetGCMMessage sets the GCMMessage field's value.
func (s *MessageConfiguration) SetSMSMessage(v *CampaignSmsMessage) *MessageConfiguration
SetSMSMessage sets the SMSMessage field's value.
func (s MessageConfiguration) String() string
String returns the string representation
type MessageRequest struct {
// A map of key-value pairs, where each key is an address and each value is
// an AddressConfiguration object. An address can be a push notification token,
// a phone number, or an email address.
Addresses map[string]*AddressConfiguration `type:"map"`
// A map of custom attributes to attributes to be attached to the message. This
// payload is added to the push notification's 'data.pinpoint' object or added
// to the email/sms delivery receipt event attributes.
Context map[string]*string `type:"map"`
// A map of key-value pairs, where each key is an endpoint ID and each value
// is an EndpointSendConfiguration object. Within an EndpointSendConfiguration
// object, you can tailor the message for an endpoint by specifying message
// overrides or substitutions.
Endpoints map[string]*EndpointSendConfiguration `type:"map"`
// Message configuration.
MessageConfiguration *DirectMessageConfiguration `type:"structure"`
// A unique ID that you can use to trace a message. This ID is visible to recipients.
TraceId *string `type:"string"`
// contains filtered or unexported fields
}
Send message request.
func (s MessageRequest) GoString() string
GoString returns the string representation
func (s *MessageRequest) SetAddresses(v map[string]*AddressConfiguration) *MessageRequest
SetAddresses sets the Addresses field's value.
func (s *MessageRequest) SetContext(v map[string]*string) *MessageRequest
SetContext sets the Context field's value.
func (s *MessageRequest) SetEndpoints(v map[string]*EndpointSendConfiguration) *MessageRequest
SetEndpoints sets the Endpoints field's value.
func (s *MessageRequest) SetMessageConfiguration(v *DirectMessageConfiguration) *MessageRequest
SetMessageConfiguration sets the MessageConfiguration field's value.
func (s *MessageRequest) SetTraceId(v string) *MessageRequest
SetTraceId sets the TraceId field's value.
func (s MessageRequest) String() string
String returns the string representation
type MessageResponse struct {
// Application id of the message.
ApplicationId *string `type:"string"`
// A map containing a multi part response for each address, with the endpointId
// as the key and the result as the value.
EndpointResult map[string]*EndpointMessageResult `type:"map"`
// Original request Id for which this message was delivered.
RequestId *string `type:"string"`
// A map containing a multi part response for each address, with the address
// as the key(Email address, phone number or push token) and the result as the
// value.
Result map[string]*MessageResult `type:"map"`
// contains filtered or unexported fields
}
Send message response.
func (s MessageResponse) GoString() string
GoString returns the string representation
func (s *MessageResponse) SetApplicationId(v string) *MessageResponse
SetApplicationId sets the ApplicationId field's value.
func (s *MessageResponse) SetEndpointResult(v map[string]*EndpointMessageResult) *MessageResponse
SetEndpointResult sets the EndpointResult field's value.
func (s *MessageResponse) SetRequestId(v string) *MessageResponse
SetRequestId sets the RequestId field's value.
func (s *MessageResponse) SetResult(v map[string]*MessageResult) *MessageResponse
SetResult sets the Result field's value.
func (s MessageResponse) String() string
String returns the string representation
type MessageResult struct {
// The delivery status of the message. Possible values:SUCCESS - The message
// was successfully delivered to the endpoint.TRANSIENT_FAILURE - A temporary
// error occurred. Amazon Pinpoint will attempt to deliver the message again
// later.FAILURE_PERMANENT - An error occurred when delivering the message to
// the endpoint. Amazon Pinpoint won't attempt to send the message again.TIMEOUT
// - The message couldn't be sent within the timeout period.QUIET_TIME - The
// local time for the endpoint was within the QuietTime for the campaign or
// app.DAILY_CAP - The endpoint has received the maximum number of messages
// it can receive within a 24-hour period.HOLDOUT - The endpoint was in a hold
// out treatment for the campaign.THROTTLED - Amazon Pinpoint throttled sending
// to this endpoint.EXPIRED - The endpoint address is expired.CAMPAIGN_CAP -
// The endpoint received the maximum number of messages allowed by the campaign.SERVICE_FAILURE
// - A service-level failure prevented Amazon Pinpoint from delivering the message.UNKNOWN
// - An unknown error occurred.
DeliveryStatus *string `type:"string" enum:"DeliveryStatus"`
// Unique message identifier associated with the message that was sent.
MessageId *string `type:"string"`
// Downstream service status code.
StatusCode *int64 `type:"integer"`
// Status message for message delivery.
StatusMessage *string `type:"string"`
// If token was updated as part of delivery. (This is GCM Specific)
UpdatedToken *string `type:"string"`
// contains filtered or unexported fields
}
The result from sending a message to an address.
func (s MessageResult) GoString() string
GoString returns the string representation
func (s *MessageResult) SetDeliveryStatus(v string) *MessageResult
SetDeliveryStatus sets the DeliveryStatus field's value.
func (s *MessageResult) SetMessageId(v string) *MessageResult
SetMessageId sets the MessageId field's value.
func (s *MessageResult) SetStatusCode(v int64) *MessageResult
SetStatusCode sets the StatusCode field's value.
func (s *MessageResult) SetStatusMessage(v string) *MessageResult
SetStatusMessage sets the StatusMessage field's value.
func (s *MessageResult) SetUpdatedToken(v string) *MessageResult
SetUpdatedToken sets the UpdatedToken field's value.
func (s MessageResult) String() string
String returns the string representation
type MetricDimension struct {
// The operator that you're using to compare metric values. Possible values:
// GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, or EQUAL
ComparisonOperator *string `type:"string"`
// The value to be compared.
Value *float64 `type:"double"`
// contains filtered or unexported fields
}
Custom metric dimension
func (s MetricDimension) GoString() string
GoString returns the string representation
func (s *MetricDimension) SetComparisonOperator(v string) *MetricDimension
SetComparisonOperator sets the ComparisonOperator field's value.
func (s *MetricDimension) SetValue(v float64) *MetricDimension
SetValue sets the Value field's value.
func (s MetricDimension) String() string
String returns the string representation
type NumberValidateRequest struct {
// (Optional) The two-character ISO country code for the country or region where
// the phone number was originally registered.
IsoCountryCode *string `type:"string"`
// The phone number to get information about. The phone number that you provide
// should include a country code. If the number doesn't include a valid country
// code, the operation might result in an error.
PhoneNumber *string `type:"string"`
// contains filtered or unexported fields
}
Phone Number Validate request.
func (s NumberValidateRequest) GoString() string
GoString returns the string representation
func (s *NumberValidateRequest) SetIsoCountryCode(v string) *NumberValidateRequest
SetIsoCountryCode sets the IsoCountryCode field's value.
func (s *NumberValidateRequest) SetPhoneNumber(v string) *NumberValidateRequest
SetPhoneNumber sets the PhoneNumber field's value.
func (s NumberValidateRequest) String() string
String returns the string representation
type NumberValidateResponse struct {
// The carrier or servive provider that the phone number is currently registered
// with.
Carrier *string `type:"string"`
// The city where the phone number was originally registered.
City *string `type:"string"`
// The cleansed phone number, shown in E.164 format.
CleansedPhoneNumberE164 *string `type:"string"`
// The cleansed phone number, shown in the local phone number format.
CleansedPhoneNumberNational *string `type:"string"`
// The country or region where the phone number was originally registered.
Country *string `type:"string"`
// The two-character ISO code for the country or region where the phone number
// was originally registered.
CountryCodeIso2 *string `type:"string"`
// The numeric code for the country or region where the phone number was originally
// registered.
CountryCodeNumeric *string `type:"string"`
// The county where the phone number was originally registered.
County *string `type:"string"`
// The two-character code (in ISO 3166-1 alpha-2 format) for the country or
// region in the request body.
OriginalCountryCodeIso2 *string `type:"string"`
// The phone number that you included in the request body.
OriginalPhoneNumber *string `type:"string"`
// A description of the phone type. Possible values are MOBILE, LANDLINE, VOIP,
// INVALID, PREPAID, and OTHER.
PhoneType *string `type:"string"`
// The phone type, represented by an integer. Possible values include 0 (MOBILE),
// 1 (LANDLINE), 2 (VOIP), 3 (INVALID), 4 (OTHER), and 5 (PREPAID).
PhoneTypeCode *int64 `type:"integer"`
// The time zone for the location where the phone number was originally registered.
Timezone *string `type:"string"`
// The postal code for the location where the phone number was originally registered.
ZipCode *string `type:"string"`
// contains filtered or unexported fields
}
Phone Number Validate response.
func (s NumberValidateResponse) GoString() string
GoString returns the string representation
func (s *NumberValidateResponse) SetCarrier(v string) *NumberValidateResponse
SetCarrier sets the Carrier field's value.
func (s *NumberValidateResponse) SetCity(v string) *NumberValidateResponse
SetCity sets the City field's value.
func (s *NumberValidateResponse) SetCleansedPhoneNumberE164(v string) *NumberValidateResponse
SetCleansedPhoneNumberE164 sets the CleansedPhoneNumberE164 field's value.
func (s *NumberValidateResponse) SetCleansedPhoneNumberNational(v string) *NumberValidateResponse
SetCleansedPhoneNumberNational sets the CleansedPhoneNumberNational field's value.
func (s *NumberValidateResponse) SetCountry(v string) *NumberValidateResponse
SetCountry sets the Country field's value.
func (s *NumberValidateResponse) SetCountryCodeIso2(v string) *NumberValidateResponse
SetCountryCodeIso2 sets the CountryCodeIso2 field's value.
func (s *NumberValidateResponse) SetCountryCodeNumeric(v string) *NumberValidateResponse
SetCountryCodeNumeric sets the CountryCodeNumeric field's value.
func (s *NumberValidateResponse) SetCounty(v string) *NumberValidateResponse
SetCounty sets the County field's value.
func (s *NumberValidateResponse) SetOriginalCountryCodeIso2(v string) *NumberValidateResponse
SetOriginalCountryCodeIso2 sets the OriginalCountryCodeIso2 field's value.
func (s *NumberValidateResponse) SetOriginalPhoneNumber(v string) *NumberValidateResponse
SetOriginalPhoneNumber sets the OriginalPhoneNumber field's value.
func (s *NumberValidateResponse) SetPhoneType(v string) *NumberValidateResponse
SetPhoneType sets the PhoneType field's value.
func (s *NumberValidateResponse) SetPhoneTypeCode(v int64) *NumberValidateResponse
SetPhoneTypeCode sets the PhoneTypeCode field's value.
func (s *NumberValidateResponse) SetTimezone(v string) *NumberValidateResponse
SetTimezone sets the Timezone field's value.
func (s *NumberValidateResponse) SetZipCode(v string) *NumberValidateResponse
SetZipCode sets the ZipCode field's value.
func (s NumberValidateResponse) String() string
String returns the string representation
type PhoneNumberValidateInput struct {
// Phone Number Validate request.
//
// NumberValidateRequest is a required field
NumberValidateRequest *NumberValidateRequest `type:"structure" required:"true"`
// contains filtered or unexported fields
}
func (s PhoneNumberValidateInput) GoString() string
GoString returns the string representation
func (s *PhoneNumberValidateInput) SetNumberValidateRequest(v *NumberValidateRequest) *PhoneNumberValidateInput
SetNumberValidateRequest sets the NumberValidateRequest field's value.
func (s PhoneNumberValidateInput) String() string
String returns the string representation
func (s *PhoneNumberValidateInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type PhoneNumberValidateOutput struct {
// Phone Number Validate response.
//
// NumberValidateResponse is a required field
NumberValidateResponse *NumberValidateResponse `type:"structure" required:"true"`
// contains filtered or unexported fields
}
func (s PhoneNumberValidateOutput) GoString() string
GoString returns the string representation
func (s *PhoneNumberValidateOutput) SetNumberValidateResponse(v *NumberValidateResponse) *PhoneNumberValidateOutput
SetNumberValidateResponse sets the NumberValidateResponse field's value.
func (s PhoneNumberValidateOutput) String() string
String returns the string representation
type Pinpoint struct {
*client.Client
}
Pinpoint provides the API operation methods for making requests to Amazon Pinpoint. See this package's package overview docs for details on the service.
Pinpoint methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.
func New(p client.ConfigProvider, cfgs ...*aws.Config) *Pinpoint
New creates a new instance of the Pinpoint client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.
Example:
// Create a Pinpoint client from just a session.
svc := pinpoint.New(mySession)
// Create a Pinpoint client with additional configuration
svc := pinpoint.New(mySession, aws.NewConfig().WithRegion("us-west-2"))
func (c *Pinpoint) CreateApp(input *CreateAppInput) (*CreateAppOutput, error)
CreateApp API operation for Amazon Pinpoint.
Creates or updates an app.
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's API operation CreateApp for usage and error information.
Returned Error Codes:
* ErrCodeBadRequestException "BadRequestException" Simple message object. * ErrCodeInternalServerErrorException "InternalServerErrorException" Simple message object. * ErrCodeForbiddenException "ForbiddenException" Simple message object. * ErrCodeNotFoundException "NotFoundException" Simple message object. * ErrCodeMethodNotAllowedException "MethodNotAllowedException" Simple message object. * ErrCodeTooManyRequestsException "TooManyRequestsException" Simple message object.
See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/CreateApp
func (c *Pinpoint) CreateAppRequest(input *CreateAppInput) (req *request.Request, output *CreateAppOutput)
CreateAppRequest generates a "aws/request.Request" representing the client's request for the CreateApp 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 CreateApp for more information on using the CreateApp 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 CreateAppRequest method.
req, resp := client.CreateAppRequest(params)
err := req.Send()
if err == nil { // resp is now filled
fmt.Println(resp)
}
See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/CreateApp
func (c *Pinpoint) CreateAppWithContext(ctx aws.Context, input *CreateAppInput, opts ...request.Option) (*CreateAppOutput, error)
CreateAppWithContext is the same as CreateApp with the addition of the ability to pass a context and additional request options.
See CreateApp 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 (c *Pinpoint) CreateCampaign(input *CreateCampaignInput) (*CreateCampaignOutput, error)
CreateCampaign API operation for Amazon Pinpoint.
Creates or updates a campaign.
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's API operation CreateCampaign for usage and error information.
Returned Error Codes:
* ErrCodeBadRequestException "BadRequestException" Simple message object. * ErrCodeInternalServerErrorException "InternalServerErrorException" Simple message object. * ErrCodeForbiddenException "ForbiddenException" Simple message object. * ErrCodeNotFoundException "NotFoundException" Simple message object. * ErrCodeMethodNotAllowedException "MethodNotAllowedException" Simple message object. * ErrCodeTooManyRequestsException "TooManyRequestsException" Simple message object.
See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/CreateCampaign
func (c *Pinpoint) CreateCampaignRequest(input *CreateCampaignInput) (req *request.Request, output *CreateCampaignOutput)
CreateCampaignRequest generates a "aws/request.Request" representing the client's request for the CreateCampaign 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 CreateCampaign for more information on using the CreateCampaign 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 CreateCampaignRequest method.
req, resp := client.CreateCampaignRequest(params)
err := req.Send()
if err == nil { // resp is now filled
fmt.Println(resp)
}
See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/CreateCampaign
func (c *Pinpoint) CreateCampaignWithContext(ctx aws.Context, input *CreateCampaignInput, opts ...request.Option) (*CreateCampaignOutput, error)
CreateCampaignWithContext is the same as CreateCampaign with the addition of the ability to pass a context and additional request options.
See CreateCampaign 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 (c *Pinpoint) CreateExportJob(input *CreateExportJobInput) (*CreateExportJobOutput, error)
CreateExportJob API operation for Amazon Pinpoint.
Creates an export job.
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's API operation CreateExportJob for usage and error information.
Returned Error Codes:
* ErrCodeBadRequestException "BadRequestException" Simple message object. * ErrCodeInternalServerErrorException "InternalServerErrorException" Simple message object. * ErrCodeForbiddenException "ForbiddenException" Simple message object. * ErrCodeNotFoundException "NotFoundException" Simple message object. * ErrCodeMethodNotAllowedException "MethodNotAllowedException" Simple message object. * ErrCodeTooManyRequestsException "TooManyRequestsException" Simple message object.
See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/CreateExportJob
func (c *Pinpoint) CreateExportJobRequest(input *CreateExportJobInput) (req *request.Request, output *CreateExportJobOutput)
CreateExportJobRequest generates a "aws/request.Request" representing the client's request for the CreateExportJob 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 CreateExportJob for more information on using the CreateExportJob 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 CreateExportJobRequest method.
req, resp := client.CreateExportJobRequest(params)
err := req.Send()
if err == nil { // resp is now filled
fmt.Println(resp)
}
See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/CreateExportJob
func (c *Pinpoint) CreateExportJobWithContext(ctx aws.Context, input *CreateExportJobInput, opts ...request.Option) (*CreateExportJobOutput, error)
CreateExportJobWithContext is the same as CreateExportJob with the addition of the ability to pass a context and additional request options.
See CreateExportJob 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 (c *Pinpoint) CreateImportJob(input *CreateImportJobInput) (*CreateImportJobOutput, error)
CreateImportJob API operation for Amazon Pinpoint.
Creates or updates an import job.
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's API operation CreateImportJob for usage and error information.
Returned Error Codes:
* ErrCodeBadRequestException "BadRequestException" Simple message object. * ErrCodeInternalServerErrorException "InternalServerErrorException" Simple message object. * ErrCodeForbiddenException "ForbiddenException" Simple message object. * ErrCodeNotFoundException "NotFoundException" Simple message object. * ErrCodeMethodNotAllowedException "MethodNotAllowedException" Simple message object. * ErrCodeTooManyRequestsException "TooManyRequestsException" Simple message object.
See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/CreateImportJob
func (c *Pinpoint) CreateImportJobRequest(input *CreateImportJobInput) (req *request.Request, output *CreateImportJobOutput)
CreateImportJobRequest generates a "aws/request.Request" representing the client's request for the CreateImportJob 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 CreateImportJob for more information on using the CreateImportJob 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 CreateImportJobRequest method.
req, resp := client.CreateImportJobRequest(params)
err := req.Send()
if err == nil { // resp is now filled
fmt.Println(resp)
}
See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/CreateImportJob
func (c *Pinpoint) CreateImportJobWithContext(ctx aws.Context, input *CreateImportJobInput, opts ...request.Option) (*CreateImportJobOutput, error)
CreateImportJobWithContext is the same as CreateImportJob with the addition of the ability to pass a context and additional request options.
See CreateImportJob 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 (c *Pinpoint) CreateSegment(input *CreateSegmentInput) (*CreateSegmentOutput, error)
CreateSegment API operation for Amazon Pinpoint.
Used to create or update a segment.
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's API operation CreateSegment for usage and error information.
Returned Error Codes:
* ErrCodeBadRequestException "BadRequestException" Simple message object. * ErrCodeInternalServerErrorException "InternalServerErrorException" Simple message object. * ErrCodeForbiddenException "ForbiddenException" Simple message object. * ErrCodeNotFoundException "NotFoundException" Simple message object. * ErrCodeMethodNotAllowedException "MethodNotAllowedException" Simple message object. * ErrCodeTooManyRequestsException "TooManyRequestsException" Simple message object.
See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/CreateSegment
func (c *Pinpoint) CreateSegmentRequest(input *CreateSegmentInput) (req *request.Request, output *CreateSegmentOutput)
CreateSegmentRequest generates a "aws/request.Request" representing the client's request for the CreateSegment 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 CreateSegment for more information on using the CreateSegment 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 CreateSegmentRequest method.
req, resp := client.CreateSegmentRequest(params)
err := req.Send()
if err == nil { // resp is now filled
fmt.Println(resp)
}
See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/CreateSegment
func (c *Pinpoint) CreateSegmentWithContext(ctx aws.Context, input *CreateSegmentInput, opts ...request.Option) (*CreateSegmentOutput, error)
CreateSegmentWithContext is the same as CreateSegment with the addition of the ability to pass a context and additional request options.
See CreateSegment 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 (c *Pinpoint) DeleteAdmChannel(input *DeleteAdmChannelInput) (*DeleteAdmChannelOutput, error)
DeleteAdmChannel API operation for Amazon Pinpoint.
Delete an ADM channel.
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's API operation DeleteAdmChannel for usage and error information.
Returned Error Codes:
* ErrCodeBadRequestException "BadRequestException" Simple message object. * ErrCodeInternalServerErrorException "InternalServerErrorException" Simple message object. * ErrCodeForbiddenException "ForbiddenException" Simple message object. * ErrCodeNotFoundException "NotFoundException" Simple message object. * ErrCodeMethodNotAllowedException "MethodNotAllowedException" Simple message object. * ErrCodeTooManyRequestsException "TooManyRequestsException" Simple message object.
See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/DeleteAdmChannel
func (c *Pinpoint) DeleteAdmChannelRequest(input *DeleteAdmChannelInput) (req *request.Request, output *DeleteAdmChannelOutput)
DeleteAdmChannelRequest generates a "aws/request.Request" representing the client's request for the DeleteAdmChannel 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 DeleteAdmChannel for more information on using the DeleteAdmChannel 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 DeleteAdmChannelRequest method.
req, resp := client.DeleteAdmChannelRequest(params)
err := req.Send()
if err == nil { // resp is now filled
fmt.Println(resp)
}
See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/DeleteAdmChannel
func (c *Pinpoint) DeleteAdmChannelWithContext(ctx aws.Context, input *DeleteAdmChannelInput, opts ...request.Option) (*DeleteAdmChannelOutput, error)
DeleteAdmChannelWithContext is the same as DeleteAdmChannel with the addition of the ability to pass a context and additional request options.
See DeleteAdmChannel 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 (c *Pinpoint) DeleteApnsChannel(input *DeleteApnsChannelInput) (*DeleteApnsChannelOutput, error)
DeleteApnsChannel API operation for Amazon Pinpoint.
Deletes the APNs channel for an app.
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's API operation DeleteApnsChannel for usage and error information.
Returned Error Codes:
* ErrCodeBadRequestException "BadRequestException" Simple message object. * ErrCodeInternalServerErrorException "InternalServerErrorException" Simple message object. * ErrCodeForbiddenException "ForbiddenException" Simple message object. * ErrCodeNotFoundException "NotFoundException" Simple message object. * ErrCodeMethodNotAllowedException "MethodNotAllowedException" Simple message object. * ErrCodeTooManyRequestsException "TooManyRequestsException" Simple message object.
See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/DeleteApnsChannel
func (c *Pinpoint) DeleteApnsChannelRequest(input *DeleteApnsChannelInput) (req *request.Request, output *DeleteApnsChannelOutput)
DeleteApnsChannelRequest generates a "aws/request.Request" representing the client's request for the DeleteApnsChannel 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 DeleteApnsChannel for more information on using the DeleteApnsChannel 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 DeleteApnsChannelRequest method.
req, resp := client.DeleteApnsChannelRequest(params)
err := req.Send()
if err == nil { // resp is now filled
fmt.Println(resp)
}
See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/DeleteApnsChannel
func (c *Pinpoint) DeleteApnsChannelWithContext(ctx aws.Context, input *DeleteApnsChannelInput, opts ...request.Option) (*DeleteApnsChannelOutput, error)
DeleteApnsChannelWithContext is the same as DeleteApnsChannel with the addition of the ability to pass a context and additional request options.
See DeleteApnsChannel 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 (c *Pinpoint) DeleteApnsSandboxChannel(input *DeleteApnsSandboxChannelInput) (*DeleteApnsSandboxChannelOutput, error)
DeleteApnsSandboxChannel API operation for Amazon Pinpoint.
Delete an APNS sandbox channel.
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's API operation DeleteApnsSandboxChannel for usage and error information.
Returned Error Codes:
* ErrCodeBadRequestException "BadRequestException" Simple message object. * ErrCodeInternalServerErrorException "InternalServerErrorException" Simple message object. * ErrCodeForbiddenException "ForbiddenException" Simple message object. * ErrCodeNotFoundException "NotFoundException" Simple message object. * ErrCodeMethodNotAllowedException "MethodNotAllowedException" Simple message object. * ErrCodeTooManyRequestsException "TooManyRequestsException" Simple message object.
See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/DeleteApnsSandboxChannel
func (c *Pinpoint) DeleteApnsSandboxChannelRequest(input *DeleteApnsSandboxChannelInput) (req *request.Request, output *DeleteApnsSandboxChannelOutput)
DeleteApnsSandboxChannelRequest generates a "aws/request.Request" representing the client's request for the DeleteApnsSandboxChannel 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 DeleteApnsSandboxChannel for more information on using the DeleteApnsSandboxChannel 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 DeleteApnsSandboxChannelRequest method.
req, resp := client.DeleteApnsSandboxChannelRequest(params)
err := req.Send()
if err == nil { // resp is now filled
fmt.Println(resp)
}
See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/DeleteApnsSandboxChannel
func (c *Pinpoint) DeleteApnsSandboxChannelWithContext(ctx aws.Context, input *DeleteApnsSandboxChannelInput, opts ...request.Option) (*DeleteApnsSandboxChannelOutput, error)
DeleteApnsSandboxChannelWithContext is the same as DeleteApnsSandboxChannel with the addition of the ability to pass a context and additional request options.
See DeleteApnsSandboxChannel 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 (c *Pinpoint) DeleteApnsVoipChannel(input *DeleteApnsVoipChannelInput) (*DeleteApnsVoipChannelOutput, error)
DeleteApnsVoipChannel API operation for Amazon Pinpoint.
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's API operation DeleteApnsVoipChannel for usage and error information.
Returned Error Codes:
* ErrCodeBadRequestException "BadRequestException" Simple message object. * ErrCodeInternalServerErrorException "InternalServerErrorException" Simple message object. * ErrCodeForbiddenException "ForbiddenException" Simple message object. * ErrCodeNotFoundException "NotFoundException" Simple message object. * ErrCodeMethodNotAllowedException "MethodNotAllowedException" Simple message object. * ErrCodeTooManyRequestsException "TooManyRequestsException" Simple message object.
See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/DeleteApnsVoipChannel
func (c *Pinpoint) DeleteApnsVoipChannelRequest(input *DeleteApnsVoipChannelInput) (req *request.Request, output *DeleteApnsVoipChannelOutput)
DeleteApnsVoipChannelRequest generates a "aws/request.Request" representing the client's request for the DeleteApnsVoipChannel 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 DeleteApnsVoipChannel for more information on using the DeleteApnsVoipChannel 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 DeleteApnsVoipChannelRequest method.
req, resp := client.DeleteApnsVoipChannelRequest(params)
err := req.Send()
if err == nil { // resp is now filled
fmt.Println(resp)
}
See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/DeleteApnsVoipChannel
func (c *Pinpoint) DeleteApnsVoipChannelWithContext(ctx aws.Context, input *DeleteApnsVoipChannelInput, opts ...request.Option) (*DeleteApnsVoipChannelOutput, error)
DeleteApnsVoipChannelWithContext is the same as DeleteApnsVoipChannel with the addition of the ability to pass a context and additional request options.
See DeleteApnsVoipChannel 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 (c *Pinpoint) DeleteApnsVoipSandboxChannel(input *DeleteApnsVoipSandboxChannelInput) (*DeleteApnsVoipSandboxChannelOutput, error)
DeleteApnsVoipSandboxChannel API operation for Amazon Pinpoint.
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's API operation DeleteApnsVoipSandboxChannel for usage and error information.
Returned Error Codes:
* ErrCodeBadRequestException "BadRequestException" Simple message object. * ErrCodeInternalServerErrorException "InternalServerErrorException" Simple message object. * ErrCodeForbiddenException "ForbiddenException" Simple message object. * ErrCodeNotFoundException "NotFoundException" Simple message object. * ErrCodeMethodNotAllowedException "MethodNotAllowedException" Simple message object. * ErrCodeTooManyRequestsException "TooManyRequestsException" Simple message object.
See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/DeleteApnsVoipSandboxChannel
func (c *Pinpoint) DeleteApnsVoipSandboxChannelRequest(input *DeleteApnsVoipSandboxChannelInput) (req *request.Request, output *DeleteApnsVoipSandboxChannelOutput)
DeleteApnsVoipSandboxChannelRequest generates a "aws/request.Request" representing the client's request for the DeleteApnsVoipSandboxChannel 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 DeleteApnsVoipSandboxChannel for more information on using the DeleteApnsVoipSandboxChannel 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 DeleteApnsVoipSandboxChannelRequest method.
req, resp := client.DeleteApnsVoipSandboxChannelRequest(params)
err := req.Send()
if err == nil { // resp is now filled
fmt.Println(resp)
}
See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/DeleteApnsVoipSandboxChannel
func (c *Pinpoint) DeleteApnsVoipSandboxChannelWithContext(ctx aws.Context, input *DeleteApnsVoipSandboxChannelInput, opts ...request.Option) (*DeleteApnsVoipSandboxChannelOutput, error)
DeleteApnsVoipSandboxChannelWithContext is the same as DeleteApnsVoipSandboxChannel with the addition of the ability to pass a context and additional request options.
See DeleteApnsVoipSandboxChannel 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 (c *Pinpoint) DeleteApp(input *DeleteAppInput) (*DeleteAppOutput, error)
DeleteApp API operation for Amazon Pinpoint.
Deletes an app.
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's API operation DeleteApp for usage and error information.
Returned Error Codes:
* ErrCodeBadRequestException "BadRequestException" Simple message object. * ErrCodeInternalServerErrorException "InternalServerErrorException" Simple message object. * ErrCodeForbiddenException "ForbiddenException" Simple message object. * ErrCodeNotFoundException "NotFoundException" Simple message object. * ErrCodeMethodNotAllowedException "MethodNotAllowedException" Simple message object. * ErrCodeTooManyRequestsException "TooManyRequestsException" Simple message object.
See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/DeleteApp
func (c *Pinpoint) DeleteAppRequest(input *DeleteAppInput) (req *request.Request, output *DeleteAppOutput)
DeleteAppRequest generates a "aws/request.Request" representing the client's request for the DeleteApp 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 DeleteApp for more information on using the DeleteApp 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 DeleteAppRequest method.
req, resp := client.DeleteAppRequest(params)
err := req.Send()
if err == nil { // resp is now filled
fmt.Println(resp)
}
See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/DeleteApp
func (c *Pinpoint) DeleteAppWithContext(ctx aws.Context, input *DeleteAppInput, opts ...request.Option) (*DeleteAppOutput, error)
DeleteAppWithContext is the same as DeleteApp with the addition of the ability to pass a context and additional request options.
See DeleteApp 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 (c *Pinpoint) DeleteBaiduChannel(input *DeleteBaiduChannelInput) (*DeleteBaiduChannelOutput, error)
DeleteBaiduChannel API operation for Amazon Pinpoint.
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's API operation DeleteBaiduChannel for usage and error information.
Returned Error Codes:
* ErrCodeBadRequestException "BadRequestException" Simple message object. * ErrCodeInternalServerErrorException "InternalServerErrorException" Simple message object. * ErrCodeForbiddenException "ForbiddenException" Simple message object. * ErrCodeNotFoundException "NotFoundException" Simple message object. * ErrCodeMethodNotAllowedException "MethodNotAllowedException" Simple message object. * ErrCodeTooManyRequestsException "TooManyRequestsException" Simple message object.
See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/DeleteBaiduChannel
func (c *Pinpoint) DeleteBaiduChannelRequest(input *DeleteBaiduChannelInput) (req *request.Request, output *DeleteBaiduChannelOutput)
DeleteBaiduChannelRequest generates a "aws/request.Request" representing the client's request for the DeleteBaiduChannel 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 DeleteBaiduChannel for more information on using the DeleteBaiduChannel 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 DeleteBaiduChannelRequest method.
req, resp := client.DeleteBaiduChannelRequest(params)
err := req.Send()
if err == nil { // resp is now filled
fmt.Println(resp)
}
See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/DeleteBaiduChannel
func (c *Pinpoint) DeleteBaiduChannelWithContext(ctx aws.Context, input *DeleteBaiduChannelInput, opts ...request.Option) (*DeleteBaiduChannelOutput, error)
DeleteBaiduChannelWithContext is the same as DeleteBaiduChannel with the addition of the ability to pass a context and additional request options.
See DeleteBaiduChannel 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 (c *Pinpoint) DeleteCampaign(input *DeleteCampaignInput) (*DeleteCampaignOutput, error)
DeleteCampaign API operation for Amazon Pinpoint.
Deletes a campaign.
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's API operation DeleteCampaign for usage and error information.
Returned Error Codes:
* ErrCodeBadRequestException "BadRequestException" Simple message object. * ErrCodeInternalServerErrorException "InternalServerErrorException" Simple message object. * ErrCodeForbiddenException "ForbiddenException" Simple message object. * ErrCodeNotFoundException "NotFoundException" Simple message object. * ErrCodeMethodNotAllowedException "MethodNotAllowedException" Simple message object. * ErrCodeTooManyRequestsException "TooManyRequestsException" Simple message object.
See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/DeleteCampaign
func (c *Pinpoint) DeleteCampaignRequest(input *DeleteCampaignInput) (req *request.Request, output *DeleteCampaignOutput)
DeleteCampaignRequest generates a "aws/request.Request" representing the client's request for the DeleteCampaign 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 DeleteCampaign for more information on using the DeleteCampaign 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 DeleteCampaignRequest method.
req, resp := client.DeleteCampaignRequest(params)
err := req.Send()
if err == nil { // resp is now filled
fmt.Println(resp)
}
See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/DeleteCampaign
func (c *Pinpoint) DeleteCampaignWithContext(ctx aws.Context, input *DeleteCampaignInput, opts ...request.Option) (*DeleteCampaignOutput, error)
DeleteCampaignWithContext is the same as DeleteCampaign with the addition of the ability to pass a context and additional request options.
See DeleteCampaign 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 (c *Pinpoint) DeleteEmailChannel(input *DeleteEmailChannelInput) (*DeleteEmailChannelOutput, error)
DeleteEmailChannel API operation for Amazon Pinpoint.
Delete an email channel.
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's API operation DeleteEmailChannel for usage and error information.
Returned Error Codes:
* ErrCodeBadRequestException "BadRequestException" Simple message object. * ErrCodeInternalServerErrorException "InternalServerErrorException" Simple message object. * ErrCodeForbiddenException "ForbiddenException" Simple message object. * ErrCodeNotFoundException "NotFoundException" Simple message object. * ErrCodeMethodNotAllowedException "MethodNotAllowedException" Simple message object. * ErrCodeTooManyRequestsException "TooManyRequestsException" Simple message object.
See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/DeleteEmailChannel
func (c *Pinpoint) DeleteEmailChannelRequest(input *DeleteEmailChannelInput) (req *request.Request, output *DeleteEmailChannelOutput)
DeleteEmailChannelRequest generates a "aws/request.Request" representing the client's request for the DeleteEmailChannel 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 DeleteEmailChannel for more information on using the DeleteEmailChannel 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 DeleteEmailChannelRequest method.
req, resp := client.DeleteEmailChannelRequest(params)
err := req.Send()
if err == nil { // resp is now filled
fmt.Println(resp)
}
See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/DeleteEmailChannel
func (c *Pinpoint) DeleteEmailChannelWithContext(ctx aws.Context, input *DeleteEmailChannelInput, opts ...request.Option) (*DeleteEmailChannelOutput, error)
DeleteEmailChannelWithContext is the same as DeleteEmailChannel with the addition of the ability to pass a context and additional request options.
See DeleteEmailChannel 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 (c *Pinpoint) DeleteEndpoint(input *DeleteEndpointInput) (*DeleteEndpointOutput, error)
DeleteEndpoint API operation for Amazon Pinpoint.
Deletes an endpoint.
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's API operation DeleteEndpoint for usage and error information.
Returned Error Codes:
* ErrCodeBadRequestException "BadRequestException" Simple message object. * ErrCodeInternalServerErrorException "InternalServerErrorException" Simple message object. * ErrCodeForbiddenException "ForbiddenException" Simple message object. * ErrCodeNotFoundException "NotFoundException" Simple message object. * ErrCodeMethodNotAllowedException "MethodNotAllowedException" Simple message object. * ErrCodeTooManyRequestsException "TooManyRequestsException" Simple message object.
See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/DeleteEndpoint
func (c *Pinpoint) DeleteEndpointRequest(input *DeleteEndpointInput) (req *request.Request, output *DeleteEndpointOutput)
DeleteEndpointRequest generates a "aws/request.Request" representing the client's request for the DeleteEndpoint 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 DeleteEndpoint for more information on using the DeleteEndpoint 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 DeleteEndpointRequest method.
req, resp := client.DeleteEndpointRequest(params)
err := req.Send()
if err == nil { // resp is now filled
fmt.Println(resp)
}
See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/DeleteEndpoint
func (c *Pinpoint) DeleteEndpointWithContext(ctx aws.Context, input *DeleteEndpointInput, opts ...request.Option) (*DeleteEndpointOutput, error)
DeleteEndpointWithContext is the same as DeleteEndpoint with the addition of the ability to pass a context and additional request options.
See DeleteEndpoint 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 (c *Pinpoint) DeleteEventStream(input *DeleteEventStreamInput) (*DeleteEventStreamOutput, error)
DeleteEventStream API operation for Amazon Pinpoint.
Deletes the event stream for an app.
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's API operation DeleteEventStream for usage and error information.
Returned Error Codes:
* ErrCodeBadRequestException "BadRequestException" Simple message object. * ErrCodeInternalServerErrorException "InternalServerErrorException" Simple message object. * ErrCodeForbiddenException "ForbiddenException" Simple message object. * ErrCodeNotFoundException "NotFoundException" Simple message object. * ErrCodeMethodNotAllowedException "MethodNotAllowedException" Simple message object. * ErrCodeTooManyRequestsException "TooManyRequestsException" Simple message object.
See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/DeleteEventStream
func (c *Pinpoint) DeleteEventStreamRequest(input *DeleteEventStreamInput) (req *request.Request, output *DeleteEventStreamOutput)
DeleteEventStreamRequest generates a "aws/request.Request" representing the client's request for the DeleteEventStream 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 DeleteEventStream for more information on using the DeleteEventStream 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 DeleteEventStreamRequest method.
req, resp := client.DeleteEventStreamRequest(params)
err := req.Send()
if err == nil { // resp is now filled
fmt.Println(resp)
}
See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/DeleteEventStream
func (c *Pinpoint) DeleteEventStreamWithContext(ctx aws.Context, input *DeleteEventStreamInput, opts ...request.Option) (*DeleteEventStreamOutput, error)
DeleteEventStreamWithContext is the same as DeleteEventStream with the addition of the ability to pass a context and additional request options.
See DeleteEventStream 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 (c *Pinpoint) DeleteGcmChannel(input *DeleteGcmChannelInput) (*DeleteGcmChannelOutput, error)
DeleteGcmChannel API operation for Amazon Pinpoint.
Deletes the GCM channel for an app.
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's API operation DeleteGcmChannel for usage and error information.
Returned Error Codes:
* ErrCodeBadRequestException "BadRequestException" Simple message object. * ErrCodeInternalServerErrorException "InternalServerErrorException" Simple message object. * ErrCodeForbiddenException "ForbiddenException" Simple message object. * ErrCodeNotFoundException "NotFoundException" Simple message object. * ErrCodeMethodNotAllowedException "MethodNotAllowedException" Simple message object. * ErrCodeTooManyRequestsException "TooManyRequestsException" Simple message object.
See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/DeleteGcmChannel
func (c *Pinpoint) DeleteGcmChannelRequest(input *DeleteGcmChannelInput) (req *request.Request, output *DeleteGcmChannelOutput)
DeleteGcmChannelRequest generates a "aws/request.Request" representing the client's request for the DeleteGcmChannel 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 DeleteGcmChannel for more information on using the DeleteGcmChannel 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 DeleteGcmChannelRequest method.
req, resp := client.DeleteGcmChannelRequest(params)
err := req.Send()
if err == nil { // resp is now filled
fmt.Println(resp)
}
See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/DeleteGcmChannel
func (c *Pinpoint) DeleteGcmChannelWithContext(ctx aws.Context, input *DeleteGcmChannelInput, opts ...request.Option) (*DeleteGcmChannelOutput, error)
DeleteGcmChannelWithContext is the same as DeleteGcmChannel with the addition of the ability to pass a context and additional request options.
See DeleteGcmChannel 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 (c *Pinpoint) DeleteSegment(input *DeleteSegmentInput) (*DeleteSegmentOutput, error)
DeleteSegment API operation for Amazon Pinpoint.
Deletes a segment.
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's API operation DeleteSegment for usage and error information.
Returned Error Codes:
* ErrCodeBadRequestException "BadRequestException" Simple message object. * ErrCodeInternalServerErrorException "InternalServerErrorException" Simple message object. * ErrCodeForbiddenException "ForbiddenException" Simple message object. * ErrCodeNotFoundException "NotFoundException" Simple message object. * ErrCodeMethodNotAllowedException "MethodNotAllowedException" Simple message object. * ErrCodeTooManyRequestsException "TooManyRequestsException" Simple message object.
See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/DeleteSegment
func (c *Pinpoint) DeleteSegmentRequest(input *DeleteSegmentInput) (req *request.Request, output *DeleteSegmentOutput)
DeleteSegmentRequest generates a "aws/request.Request" representing the client's request for the DeleteSegment 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 DeleteSegment for more information on using the DeleteSegment 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 DeleteSegmentRequest method.
req, resp := client.DeleteSegmentRequest(params)
err := req.Send()
if err == nil { // resp is now filled
fmt.Println(resp)
}
See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/DeleteSegment
func (c *Pinpoint) DeleteSegmentWithContext(ctx aws.Context, input *DeleteSegmentInput, opts ...request.Option) (*DeleteSegmentOutput, error)
DeleteSegmentWithContext is the same as DeleteSegment with the addition of the ability to pass a context and additional request options.
See DeleteSegment 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 (c *Pinpoint) DeleteSmsChannel(input *DeleteSmsChannelInput) (*DeleteSmsChannelOutput, error)
DeleteSmsChannel API operation for Amazon Pinpoint.
Delete an SMS channel.
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's API operation DeleteSmsChannel for usage and error information.
Returned Error Codes:
* ErrCodeBadRequestException "BadRequestException" Simple message object. * ErrCodeInternalServerErrorException "InternalServerErrorException" Simple message object. * ErrCodeForbiddenException "ForbiddenException" Simple message object. * ErrCodeNotFoundException "NotFoundException" Simple message object. * ErrCodeMethodNotAllowedException "MethodNotAllowedException" Simple message object. * ErrCodeTooManyRequestsException "TooManyRequestsException" Simple message object.
See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/DeleteSmsChannel
func (c *Pinpoint) DeleteSmsChannelRequest(input *DeleteSmsChannelInput) (req *request.Request, output *DeleteSmsChannelOutput)
DeleteSmsChannelRequest generates a "aws/request.Request" representing the client's request for the DeleteSmsChannel 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 DeleteSmsChannel for more information on using the DeleteSmsChannel 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 DeleteSmsChannelRequest method.
req, resp := client.DeleteSmsChannelRequest(params)
err := req.Send()
if err == nil { // resp is now filled
fmt.Println(resp)
}
See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/DeleteSmsChannel
func (c *Pinpoint) DeleteSmsChannelWithContext(ctx aws.Context, input *DeleteSmsChannelInput, opts ...request.Option) (*DeleteSmsChannelOutput, error)
DeleteSmsChannelWithContext is the same as DeleteSmsChannel with the addition of the ability to pass a context and additional request options.
See DeleteSmsChannel 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 (c *Pinpoint) DeleteUserEndpoints(input *DeleteUserEndpointsInput) (*DeleteUserEndpointsOutput, error)
DeleteUserEndpoints API operation for Amazon Pinpoint.
Deletes endpoints that are associated with a User ID.
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's API operation DeleteUserEndpoints for usage and error information.
Returned Error Codes:
* ErrCodeBadRequestException "BadRequestException" Simple message object. * ErrCodeInternalServerErrorException "InternalServerErrorException" Simple message object. * ErrCodeForbiddenException "ForbiddenException" Simple message object. * ErrCodeNotFoundException "NotFoundException" Simple message object. * ErrCodeMethodNotAllowedException "MethodNotAllowedException" Simple message object. * ErrCodeTooManyRequestsException "TooManyRequestsException" Simple message object.
See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/DeleteUserEndpoints
func (c *Pinpoint) DeleteUserEndpointsRequest(input *DeleteUserEndpointsInput) (req *request.Request, output *DeleteUserEndpointsOutput)
DeleteUserEndpointsRequest generates a "aws/request.Request" representing the client's request for the DeleteUserEndpoints 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 DeleteUserEndpoints for more information on using the DeleteUserEndpoints 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 DeleteUserEndpointsRequest method.
req, resp := client.DeleteUserEndpointsRequest(params)
err := req.Send()
if err == nil { // resp is now filled
fmt.Println(resp)
}
See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/DeleteUserEndpoints
func (c *Pinpoint) DeleteUserEndpointsWithContext(ctx aws.Context, input *DeleteUserEndpointsInput, opts ...request.Option) (*DeleteUserEndpointsOutput, error)
DeleteUserEndpointsWithContext is the same as DeleteUserEndpoints with the addition of the ability to pass a context and additional request options.
See DeleteUserEndpoints 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 (c *Pinpoint) DeleteVoiceChannel(input *DeleteVoiceChannelInput) (*DeleteVoiceChannelOutput, error)
DeleteVoiceChannel API operation for Amazon Pinpoint.
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's API operation DeleteVoiceChannel for usage and error information.
Returned Error Codes:
* ErrCodeBadRequestException "BadRequestException" Simple message object. * ErrCodeInternalServerErrorException "InternalServerErrorException" Simple message object. * ErrCodeForbiddenException "ForbiddenException" Simple message object. * ErrCodeNotFoundException "NotFoundException" Simple message object. * ErrCodeMethodNotAllowedException "MethodNotAllowedException" Simple message object. * ErrCodeTooManyRequestsException "TooManyRequestsException" Simple message object.
See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/DeleteVoiceChannel
func (c *Pinpoint) DeleteVoiceChannelRequest(input *DeleteVoiceChannelInput) (req *request.Request, output *DeleteVoiceChannelOutput)
DeleteVoiceChannelRequest generates a "aws/request.Request" representing the client's request for the DeleteVoiceChannel 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 DeleteVoiceChannel for more information on using the DeleteVoiceChannel 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 DeleteVoiceChannelRequest method.
req, resp := client.DeleteVoiceChannelRequest(params)
err := req.Send()
if err == nil { // resp is now filled
fmt.Println(resp)
}
See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/DeleteVoiceChannel
func (c *Pinpoint) DeleteVoiceChannelWithContext(ctx aws.Context, input *DeleteVoiceChannelInput, opts ...request.Option) (*DeleteVoiceChannelOutput, error)
DeleteVoiceChannelWithContext is the same as DeleteVoiceChannel with the addition of the ability to pass a context and additional request options.
See DeleteVoiceChannel 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 (c *Pinpoint) GetAdmChannel(input *GetAdmChannelInput) (*GetAdmChannelOutput, error)
GetAdmChannel API operation for Amazon Pinpoint.
Get an ADM channel.
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's API operation GetAdmChannel for usage and error information.
Returned Error Codes:
* ErrCodeBadRequestException "BadRequestException" Simple message object. * ErrCodeInternalServerErrorException "InternalServerErrorException" Simple message object. * ErrCodeForbiddenException "ForbiddenException" Simple message object. * ErrCodeNotFoundException "NotFoundException" Simple message object. * ErrCodeMethodNotAllowedException "MethodNotAllowedException" Simple message object. * ErrCodeTooManyRequestsException "TooManyRequestsException" Simple message object.
See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetAdmChannel
func (c *Pinpoint) GetAdmChannelRequest(input *GetAdmChannelInput) (req *request.Request, output *GetAdmChannelOutput)
GetAdmChannelRequest generates a "aws/request.Request" representing the client's request for the GetAdmChannel 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 GetAdmChannel for more information on using the GetAdmChannel 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 GetAdmChannelRequest method.
req, resp := client.GetAdmChannelRequest(params)
err := req.Send()
if err == nil { // resp is now filled
fmt.Println(resp)
}
See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetAdmChannel
func (c *Pinpoint) GetAdmChannelWithContext(ctx aws.Context, input *GetAdmChannelInput, opts ...request.Option) (*GetAdmChannelOutput, error)
GetAdmChannelWithContext is the same as GetAdmChannel with the addition of the ability to pass a context and additional request options.
See GetAdmChannel 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 (c *Pinpoint) GetApnsChannel(input *GetApnsChannelInput) (*GetApnsChannelOutput, error)
GetApnsChannel API operation for Amazon Pinpoint.
Returns information about the APNs channel for an app.
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's API operation GetApnsChannel for usage and error information.
Returned Error Codes:
* ErrCodeBadRequestException "BadRequestException" Simple message object. * ErrCodeInternalServerErrorException "InternalServerErrorException" Simple message object. * ErrCodeForbiddenException "ForbiddenException" Simple message object. * ErrCodeNotFoundException "NotFoundException" Simple message object. * ErrCodeMethodNotAllowedException "MethodNotAllowedException" Simple message object. * ErrCodeTooManyRequestsException "TooManyRequestsException" Simple message object.
See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetApnsChannel
func (c *Pinpoint) GetApnsChannelRequest(input *GetApnsChannelInput) (req *request.Request, output *GetApnsChannelOutput)
GetApnsChannelRequest generates a "aws/request.Request" representing the client's request for the GetApnsChannel 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 GetApnsChannel for more information on using the GetApnsChannel 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 GetApnsChannelRequest method.
req, resp := client.GetApnsChannelRequest(params)
err := req.Send()
if err == nil { // resp is now filled
fmt.Println(resp)
}
See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetApnsChannel
func (c *Pinpoint) GetApnsChannelWithContext(ctx aws.Context, input *GetApnsChannelInput, opts ...request.Option) (*GetApnsChannelOutput, error)
GetApnsChannelWithContext is the same as GetApnsChannel with the addition of the ability to pass a context and additional request options.
See GetApnsChannel 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 (c *Pinpoint) GetApnsSandboxChannel(input *GetApnsSandboxChannelInput) (*GetApnsSandboxChannelOutput, error)
GetApnsSandboxChannel API operation for Amazon Pinpoint.
Get an APNS sandbox channel.
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's API operation GetApnsSandboxChannel for usage and error information.
Returned Error Codes:
* ErrCodeBadRequestException "BadRequestException" Simple message object. * ErrCodeInternalServerErrorException "InternalServerErrorException" Simple message object. * ErrCodeForbiddenException "ForbiddenException" Simple message object. * ErrCodeNotFoundException "NotFoundException" Simple message object. * ErrCodeMethodNotAllowedException "MethodNotAllowedException" Simple message object. * ErrCodeTooManyRequestsException "TooManyRequestsException" Simple message object.
See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetApnsSandboxChannel
func (c *Pinpoint) GetApnsSandboxChannelRequest(input *GetApnsSandboxChannelInput) (req *request.Request, output *GetApnsSandboxChannelOutput)
GetApnsSandboxChannelRequest generates a "aws/request.Request" representing the client's request for the GetApnsSandboxChannel 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 GetApnsSandboxChannel for more information on using the GetApnsSandboxChannel 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 GetApnsSandboxChannelRequest method.
req, resp := client.GetApnsSandboxChannelRequest(params)
err := req.Send()
if err == nil { // resp is now filled
fmt.Println(resp)
}
See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetApnsSandboxChannel
func (c *Pinpoint) GetApnsSandboxChannelWithContext(ctx aws.Context, input *GetApnsSandboxChannelInput, opts ...request.Option) (*GetApnsSandboxChannelOutput, error)
GetApnsSandboxChannelWithContext is the same as GetApnsSandboxChannel with the addition of the ability to pass a context and additional request options.
See GetApnsSandboxChannel 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 (c *Pinpoint) GetApnsVoipChannel(input *GetApnsVoipChannelInput) (*GetApnsVoipChannelOutput, error)
GetApnsVoipChannel API operation for Amazon Pinpoint.
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's API operation GetApnsVoipChannel for usage and error information.
Returned Error Codes:
* ErrCodeBadRequestException "BadRequestException" Simple message object. * ErrCodeInternalServerErrorException "InternalServerErrorException" Simple message object. * ErrCodeForbiddenException "ForbiddenException" Simple message object. * ErrCodeNotFoundException "NotFoundException" Simple message object. * ErrCodeMethodNotAllowedException "MethodNotAllowedException" Simple message object. * ErrCodeTooManyRequestsException "TooManyRequestsException" Simple message object.
See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetApnsVoipChannel
func (c *Pinpoint) GetApnsVoipChannelRequest(input *GetApnsVoipChannelInput) (req *request.Request, output *GetApnsVoipChannelOutput)
GetApnsVoipChannelRequest generates a "aws/request.Request" representing the client's request for the GetApnsVoipChannel 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 GetApnsVoipChannel for more information on using the GetApnsVoipChannel 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 GetApnsVoipChannelRequest method.
req, resp := client.GetApnsVoipChannelRequest(params)
err := req.Send()
if err == nil { // resp is now filled
fmt.Println(resp)
}
See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetApnsVoipChannel
func (c *Pinpoint) GetApnsVoipChannelWithContext(ctx aws.Context, input *GetApnsVoipChannelInput, opts ...request.Option) (*GetApnsVoipChannelOutput, error)
GetApnsVoipChannelWithContext is the same as GetApnsVoipChannel with the addition of the ability to pass a context and additional request options.
See GetApnsVoipChannel 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 (c *Pinpoint) GetApnsVoipSandboxChannel(input *GetApnsVoipSandboxChannelInput) (*GetApnsVoipSandboxChannelOutput, error)
GetApnsVoipSandboxChannel API operation for Amazon Pinpoint.
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's API operation GetApnsVoipSandboxChannel for usage and error information.
Returned Error Codes:
* ErrCodeBadRequestException "BadRequestException" Simple message object. * ErrCodeInternalServerErrorException "InternalServerErrorException" Simple message object. * ErrCodeForbiddenException "ForbiddenException" Simple message object. * ErrCodeNotFoundException "NotFoundException" Simple message object. * ErrCodeMethodNotAllowedException "MethodNotAllowedException" Simple message object. * ErrCodeTooManyRequestsException "TooManyRequestsException" Simple message object.
See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetApnsVoipSandboxChannel
func (c *Pinpoint) GetApnsVoipSandboxChannelRequest(input *GetApnsVoipSandboxChannelInput) (req *request.Request, output *GetApnsVoipSandboxChannelOutput)
GetApnsVoipSandboxChannelRequest generates a "aws/request.Request" representing the client's request for the GetApnsVoipSandboxChannel 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 GetApnsVoipSandboxChannel for more information on using the GetApnsVoipSandboxChannel 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 GetApnsVoipSandboxChannelRequest method.
req, resp := client.GetApnsVoipSandboxChannelRequest(params)
err := req.Send()
if err == nil { // resp is now filled
fmt.Println(resp)
}
See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetApnsVoipSandboxChannel
func (c *Pinpoint) GetApnsVoipSandboxChannelWithContext(ctx aws.Context, input *GetApnsVoipSandboxChannelInput, opts ...request.Option) (*GetApnsVoipSandboxChannelOutput, error)
GetApnsVoipSandboxChannelWithContext is the same as GetApnsVoipSandboxChannel with the addition of the ability to pass a context and additional request options.
See GetApnsVoipSandboxChannel 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 (c *Pinpoint) GetApp(input *GetAppInput) (*GetAppOutput, error)
GetApp API operation for Amazon Pinpoint.
Returns information about an app.
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's API operation GetApp for usage and error information.
Returned Error Codes:
* ErrCodeBadRequestException "BadRequestException" Simple message object. * ErrCodeInternalServerErrorException "InternalServerErrorException" Simple message object. * ErrCodeForbiddenException "ForbiddenException" Simple message object. * ErrCodeNotFoundException "NotFoundException" Simple message object. * ErrCodeMethodNotAllowedException "MethodNotAllowedException" Simple message object. * ErrCodeTooManyRequestsException "TooManyRequestsException" Simple message object.
See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetApp
func (c *Pinpoint) GetAppRequest(input *GetAppInput) (req *request.Request, output *GetAppOutput)
GetAppRequest generates a "aws/request.Request" representing the client's request for the GetApp 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 GetApp for more information on using the GetApp 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 GetAppRequest method.
req, resp := client.GetAppRequest(params)
err := req.Send()
if err == nil { // resp is now filled
fmt.Println(resp)
}
See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetApp
func (c *Pinpoint) GetAppWithContext(ctx aws.Context, input *GetAppInput, opts ...request.Option) (*GetAppOutput, error)
GetAppWithContext is the same as GetApp with the addition of the ability to pass a context and additional request options.
See GetApp 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 (c *Pinpoint) GetApplicationSettings(input *GetApplicationSettingsInput) (*GetApplicationSettingsOutput, error)
GetApplicationSettings API operation for Amazon Pinpoint.
Used to request the settings for an app.
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's API operation GetApplicationSettings for usage and error information.
Returned Error Codes:
* ErrCodeBadRequestException "BadRequestException" Simple message object. * ErrCodeInternalServerErrorException "InternalServerErrorException" Simple message object. * ErrCodeForbiddenException "ForbiddenException" Simple message object. * ErrCodeNotFoundException "NotFoundException" Simple message object. * ErrCodeMethodNotAllowedException "MethodNotAllowedException" Simple message object. * ErrCodeTooManyRequestsException "TooManyRequestsException" Simple message object.
See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetApplicationSettings
func (c *Pinpoint) GetApplicationSettingsRequest(input *GetApplicationSettingsInput) (req *request.Request, output *GetApplicationSettingsOutput)
GetApplicationSettingsRequest generates a "aws/request.Request" representing the client's request for the GetApplicationSettings 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 GetApplicationSettings for more information on using the GetApplicationSettings 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 GetApplicationSettingsRequest method.
req, resp := client.GetApplicationSettingsRequest(params)
err := req.Send()
if err == nil { // resp is now filled
fmt.Println(resp)
}
See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetApplicationSettings
func (c *Pinpoint) GetApplicationSettingsWithContext(ctx aws.Context, input *GetApplicationSettingsInput, opts ...request.Option) (*GetApplicationSettingsOutput, error)
GetApplicationSettingsWithContext is