type ADMChannelRequest struct {
// The Client ID that you received from Amazon to send messages by using ADM.
//
// ClientId is a required field
ClientId *string `type:"string" required:"true"`
// The Client Secret that you received from Amazon to send messages by using
// ADM.
//
// ClientSecret is a required field
ClientSecret *string `type:"string" required:"true"`
// Specifies whether to enable the ADM channel for the application.
Enabled *bool `type:"boolean"`
// contains filtered or unexported fields
}
Specifies the status and settings of the ADM (Amazon Device Messaging) channel for an application.
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
func (s *ADMChannelRequest) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ADMChannelResponse struct {
// The unique identifier for the application that the ADM channel applies to.
ApplicationId *string `type:"string"`
// The date and time when the ADM channel was enabled.
CreationDate *string `type:"string"`
// Specifies whether the ADM channel is enabled for the application.
Enabled *bool `type:"boolean"`
// (Not used) This property is retained only for backward compatibility.
HasCredential *bool `type:"boolean"`
// (Deprecated) An identifier for the ADM channel. This property is retained
// only for backward compatibility.
Id *string `type:"string"`
// Specifies whether the ADM channel is archived.
IsArchived *bool `type:"boolean"`
// The user who last modified the ADM channel.
LastModifiedBy *string `type:"string"`
// The date and time when the ADM channel was last modified.
LastModifiedDate *string `type:"string"`
// The type of messaging or notification platform for the channel. For the ADM
// channel, this value is ADM.
//
// Platform is a required field
Platform *string `type:"string" required:"true"`
// The current version of the ADM channel.
Version *int64 `type:"integer"`
// contains filtered or unexported fields
}
Provides information about the status and settings of the ADM (Amazon Device Messaging) channel for an application.
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 to occur if the recipient taps the push notification. Valid values
// are:
//
// * OPEN_APP - Your app opens or it becomes the foreground app if it was
// sent to the background. This is the default action.
//
// * DEEP_LINK - Your app opens and displays a designated user interface
// in the app. This action uses the deep-linking features of the Android
// platform.
//
// * URL - The default mobile browser on the recipient's device opens and
// loads the web page at a URL that you specify.
Action *string `type:"string" enum:"Action"`
// The body of the notification message.
Body *string `type:"string"`
// An arbitrary string that indicates that multiple messages are logically the
// same and that Amazon Device Messaging (ADM) can drop previously enqueued
// messages in favor of this message.
ConsolidationKey *string `type:"string"`
// The JSON data payload to use for the push notification, if the notification
// is a silent push notification. This payload is added to the data.pinpoint.jsonBody
// object of the notification.
Data map[string]*string `type:"map"`
// The amount of time, in seconds, that ADM should store the message if the
// recipient's device is offline. Amazon Pinpoint specifies this value in the
// expiresAfter parameter when it sends the notification message to ADM.
ExpiresAfter *string `type:"string"`
// The icon image name of the asset saved in your app.
IconReference *string `type:"string"`
// The URL of the large icon image to display in the content view of the push
// notification.
ImageIconUrl *string `type:"string"`
// The URL of an image to display in the push notification.
ImageUrl *string `type:"string"`
// The base64-encoded, MD5 checksum of the value specified by the Data property.
// ADM uses the MD5 value to verify the integrity of the data.
MD5 *string `type:"string"`
// The raw, JSON-formatted string to use as the payload for the notification
// message. This value overrides the message.
RawContent *string `type:"string"`
// Specifies whether the notification is a silent push notification, which is
// a push notification that doesn't display on a recipient's device. Silent
// push notifications can be used for cases such as updating an app's configuration
// or supporting phone home functionality.
SilentPush *bool `type:"boolean"`
// The URL of the small icon image to display in the status bar and the content
// view of the push notification.
SmallImageIconUrl *string `type:"string"`
// The sound to play when the recipient receives the push notification. You
// can use the default stream or specify the file name of a sound resource that's
// bundled in your app. On an Android platform, the sound file must reside in
// /res/raw/.
Sound *string `type:"string"`
// The default message variables to use in the notification message. You can
// override the default variables with individual address variables.
Substitutions map[string][]*string `type:"map"`
// The title to display above the notification message on the recipient's device.
Title *string `type:"string"`
// The URL to open in the recipient's default mobile browser, if a recipient
// taps the push notification and the value of the Action property is URL.
Url *string `type:"string"`
// contains filtered or unexported fields
}
Specifies the settings for a one-time message that's sent directly to an endpoint through the ADM (Amazon Device Messaging) channel.
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 identifier that's assigned to your iOS app. This identifier is
// used for APNs tokens.
BundleId *string `type:"string"`
// The APNs client certificate that you received from Apple, if you want Amazon
// Pinpoint to communicate with APNs by using an APNs certificate.
Certificate *string `type:"string"`
// The default authentication method that you want Amazon Pinpoint to use when
// authenticating with APNs, key or certificate.
DefaultAuthenticationMethod *string `type:"string"`
// Specifies whether to enable the APNs channel for the application.
Enabled *bool `type:"boolean"`
// The private key for the APNs client certificate that you want Amazon Pinpoint
// to use to communicate with APNs.
PrivateKey *string `type:"string"`
// The identifier that's assigned to your Apple developer account team. This
// identifier is used for APNs tokens.
TeamId *string `type:"string"`
// The authentication key to use for APNs tokens.
TokenKey *string `type:"string"`
// The key identifier that's assigned to your APNs signing key, if you want
// Amazon Pinpoint to communicate with APNs by using APNs tokens.
TokenKeyId *string `type:"string"`
// contains filtered or unexported fields
}
Specifies the status and settings of the APNs (Apple Push Notification service) channel for an application.
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 unique identifier for the application that the APNs channel applies to.
ApplicationId *string `type:"string"`
// The date and time when the APNs channel was enabled.
CreationDate *string `type:"string"`
// The default authentication method that Amazon Pinpoint uses to authenticate
// with APNs for this channel, key or certificate.
DefaultAuthenticationMethod *string `type:"string"`
// Specifies whether the APNs channel is enabled for the application.
Enabled *bool `type:"boolean"`
// (Not used) This property is retained only for backward compatibility.
HasCredential *bool `type:"boolean"`
// Specifies whether the APNs channel is configured to communicate with APNs
// by using APNs tokens. To provide an authentication key for APNs tokens, set
// the TokenKey property of the channel.
HasTokenKey *bool `type:"boolean"`
// (Deprecated) An identifier for the APNs channel. This property is retained
// only for backward compatibility.
Id *string `type:"string"`
// Specifies whether the APNs channel is archived.
IsArchived *bool `type:"boolean"`
// The user who last modified the APNs channel.
LastModifiedBy *string `type:"string"`
// The date and time when the APNs channel was last modified.
LastModifiedDate *string `type:"string"`
// The type of messaging or notification platform for the channel. For the APNs
// channel, this value is APNS.
//
// Platform is a required field
Platform *string `type:"string" required:"true"`
// The current version of the APNs channel.
Version *int64 `type:"integer"`
// contains filtered or unexported fields
}
Provides information about the status and settings of the APNs (Apple Push Notification service) channel for an application.
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 to occur if the recipient taps the push notification. Valid values
// are:
//
// * OPEN_APP - Your app opens or it becomes the foreground app if it was
// sent to the background. This is the default action.
//
// * DEEP_LINK - Your app opens and displays a designated user interface
// in the app. This setting uses the deep-linking features of the iOS platform.
//
// * URL - The default mobile browser on the recipient's device opens and
// loads the web page at a URL that you specify.
Action *string `type:"string" enum:"Action"`
// The key that indicates whether and how to modify the badge of your app's
// icon when the recipient receives the push notification. If this key isn't
// included in the dictionary, the badge doesn't change. To remove the badge,
// set this value to 0.
Badge *int64 `type:"integer"`
// The body of the notification message.
Body *string `type:"string"`
// The key that indicates the notification type for the push notification. This
// key is a value that's defined by the identifier property of one of your app's
// registered categories.
Category *string `type:"string"`
// An arbitrary identifier that, if assigned to multiple messages, APNs uses
// to coalesce the messages into a single push notification instead of delivering
// each message individually. This value can't exceed 64 bytes.
//
// Amazon Pinpoint specifies this value in the apns-collapse-id request header
// when it sends the notification message to APNs.
CollapseId *string `type:"string"`
// The JSON payload to use for a silent push notification. This payload is added
// to the data.pinpoint.jsonBody object of the notification.
Data map[string]*string `type:"map"`
// The URL of an image or video to display in the push notification.
MediaUrl *string `type:"string"`
// The authentication method that you want Amazon Pinpoint to use when authenticating
// with Apple Push Notification service (APNs), CERTIFICATE or TOKEN.
PreferredAuthenticationMethod *string `type:"string"`
// para>5 - Low priority, the notification might be delayed, delivered as part
// of a group, or throttled.
// /listitem>
// 10 - High priority, the notification is sent immediately. This is the default
// value. A high priority notification should trigger an alert, play a sound,
// or badge your app's icon on the recipient's device.
// /para>
// Amazon Pinpoint specifies this value in the apns-priority request header
// when it sends the notification message to APNs.
//
// The equivalent values for Firebase Cloud Messaging (FCM), formerly Google
// Cloud Messaging (GCM), are normal, for 5, and high, for 10. If you specify
// an FCM value for this property, Amazon Pinpoint accepts and converts the
// value to the corresponding APNs value.
Priority *string `type:"string"`
// The raw, JSON-formatted string to use as the payload for the notification
// message. This value overrides the message.
RawContent *string `type:"string"`
// Specifies whether the notification is a silent push notification, which is
// a push notification that doesn't display on a recipient's device. Silent
// push notifications can be used for cases such as updating an app's configuration,
// displaying messages in an in-app message center, or supporting phone home
// functionality.
SilentPush *bool `type:"boolean"`
// The key for the sound to play when the recipient receives the push notification.
// The value of this key is the name of a sound file in your app's main bundle
// or the Library/Sounds folder in your app's data container. If the sound file
// can't be found or you specify default for the value, the system plays the
// default alert sound.
Sound *string `type:"string"`
// The default message variables to use in the notification message. You can
// override these default variables with individual address variables.
Substitutions map[string][]*string `type:"map"`
// The key that represents your 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 amount of time, in seconds, that APNs should store and attempt to deliver
// the push notification, if the service is unable to deliver the notification
// the first time. If this value is 0, APNs treats the notification as if it
// expires immediately and the service doesn't store or try to deliver the notification
// again.
//
// Amazon Pinpoint specifies this value in the apns-expiration request header
// when it sends the notification message to APNs.
TimeToLive *int64 `type:"integer"`
// The title to display above the notification message on the recipient's device.
Title *string `type:"string"`
// The URL to open in the recipient's default mobile browser, if a recipient
// taps the push notification and the value of the Action property is URL.
Url *string `type:"string"`
// contains filtered or unexported fields
}
Specifies the settings for a one-time message that's sent directly to an endpoint through the APNs (Apple Push Notification service) channel.
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 identifier that's assigned to your iOS app. This identifier is
// used for APNs tokens.
BundleId *string `type:"string"`
// The APNs client certificate that you received from Apple, if you want Amazon
// Pinpoint to communicate with the APNs sandbox environment by using an APNs
// certificate.
Certificate *string `type:"string"`
// The default authentication method that you want Amazon Pinpoint to use when
// authenticating with the APNs sandbox environment, key or certificate.
DefaultAuthenticationMethod *string `type:"string"`
// Specifies whether to enable the APNs sandbox channel for the application.
Enabled *bool `type:"boolean"`
// The private key for the APNs client certificate that you want Amazon Pinpoint
// to use to communicate with the APNs sandbox environment.
PrivateKey *string `type:"string"`
// The identifier that's assigned to your Apple developer account team. This
// identifier is used for APNs tokens.
TeamId *string `type:"string"`
// The authentication key to use for APNs tokens.
TokenKey *string `type:"string"`
// The key identifier that's assigned to your APNs signing key, if you want
// Amazon Pinpoint to communicate with the APNs sandbox environment by using
// APNs tokens.
TokenKeyId *string `type:"string"`
// contains filtered or unexported fields
}
Specifies the status and settings of the APNs (Apple Push Notification service) sandbox channel for an application.
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 unique identifier for the application that the APNs sandbox channel applies
// to.
ApplicationId *string `type:"string"`
// The date and time when the APNs sandbox channel was enabled.
CreationDate *string `type:"string"`
// The default authentication method that Amazon Pinpoint uses to authenticate
// with the APNs sandbox environment for this channel, key or certificate.
DefaultAuthenticationMethod *string `type:"string"`
// Specifies whether the APNs sandbox channel is enabled for the application.
Enabled *bool `type:"boolean"`
// (Not used) This property is retained only for backward compatibility.
HasCredential *bool `type:"boolean"`
// Specifies whether the APNs sandbox channel is configured to communicate with
// APNs by using APNs tokens. To provide an authentication key for APNs tokens,
// set the TokenKey property of the channel.
HasTokenKey *bool `type:"boolean"`
// (Deprecated) An identifier for the APNs sandbox channel. This property is
// retained only for backward compatibility.
Id *string `type:"string"`
// Specifies whether the APNs sandbox channel is archived.
IsArchived *bool `type:"boolean"`
// The user who last modified the APNs sandbox channel.
LastModifiedBy *string `type:"string"`
// The date and time when the APNs sandbox channel was last modified.
LastModifiedDate *string `type:"string"`
// The type of messaging or notification platform for the channel. For the APNs
// sandbox channel, this value is APNS_SANDBOX.
//
// Platform is a required field
Platform *string `type:"string" required:"true"`
// The current version of the APNs sandbox channel.
Version *int64 `type:"integer"`
// contains filtered or unexported fields
}
Provides information about the status and settings of the APNs (Apple Push Notification service) sandbox channel for an application.
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 identifier that's assigned to your iOS app. This identifier is
// used for APNs tokens.
BundleId *string `type:"string"`
// The APNs client certificate that you received from Apple, if you want Amazon
// Pinpoint to communicate with APNs by using an APNs certificate.
Certificate *string `type:"string"`
// The default authentication method that you want Amazon Pinpoint to use when
// authenticating with APNs, key or certificate.
DefaultAuthenticationMethod *string `type:"string"`
// Specifies whether to enable the APNs VoIP channel for the application.
Enabled *bool `type:"boolean"`
// The private key for the APNs client certificate that you want Amazon Pinpoint
// to use to communicate with APNs.
PrivateKey *string `type:"string"`
// The identifier that's assigned to your Apple developer account team. This
// identifier is used for APNs tokens.
TeamId *string `type:"string"`
// The authentication key to use for APNs tokens.
TokenKey *string `type:"string"`
// The key identifier that's assigned to your APNs signing key, if you want
// Amazon Pinpoint to communicate with APNs by using APNs tokens.
TokenKeyId *string `type:"string"`
// contains filtered or unexported fields
}
Specifies the status and settings of the APNs (Apple Push Notification service) VoIP channel for an application.
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 {
// The unique identifier for the application that the APNs VoIP channel applies
// to.
ApplicationId *string `type:"string"`
// The date and time when the APNs VoIP channel was enabled.
CreationDate *string `type:"string"`
// The default authentication method that Amazon Pinpoint uses to authenticate
// with APNs for this channel, key or certificate.
DefaultAuthenticationMethod *string `type:"string"`
// Specifies whether the APNs VoIP channel is enabled for the application.
Enabled *bool `type:"boolean"`
// (Not used) This property is retained only for backward compatibility.
HasCredential *bool `type:"boolean"`
// Specifies whether the APNs VoIP channel is configured to communicate with
// APNs by using APNs tokens. To provide an authentication key for APNs tokens,
// set the TokenKey property of the channel.
HasTokenKey *bool `type:"boolean"`
// (Deprecated) An identifier for the APNs VoIP channel. This property is retained
// only for backward compatibility.
Id *string `type:"string"`
// Specifies whether the APNs VoIP channel is archived.
IsArchived *bool `type:"boolean"`
// The user who last modified the APNs VoIP channel.
LastModifiedBy *string `type:"string"`
// The date and time when the APNs VoIP channel was last modified.
LastModifiedDate *string `type:"string"`
// The type of messaging or notification platform for the channel. For the APNs
// VoIP channel, this value is APNS_VOIP.
//
// Platform is a required field
Platform *string `type:"string" required:"true"`
// The current version of the APNs VoIP channel.
Version *int64 `type:"integer"`
// contains filtered or unexported fields
}
Provides information about the status and settings of the APNs (Apple Push Notification service) VoIP channel for an application.
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 identifier that's assigned to your iOS app. This identifier is
// used for APNs tokens.
BundleId *string `type:"string"`
// The APNs client certificate that you received from Apple, if you want Amazon
// Pinpoint to communicate with the APNs sandbox environment by using an APNs
// certificate.
Certificate *string `type:"string"`
// The default authentication method that you want Amazon Pinpoint to use when
// authenticating with the APNs sandbox environment for this channel, key or
// certificate.
DefaultAuthenticationMethod *string `type:"string"`
// Specifies whether the APNs VoIP sandbox channel is enabled for the application.
Enabled *bool `type:"boolean"`
// The private key for the APNs client certificate that you want Amazon Pinpoint
// to use to communicate with the APNs sandbox environment.
PrivateKey *string `type:"string"`
// The identifier that's assigned to your Apple developer account team. This
// identifier is used for APNs tokens.
TeamId *string `type:"string"`
// The authentication key to use for APNs tokens.
TokenKey *string `type:"string"`
// The key identifier that's assigned to your APNs signing key, if you want
// Amazon Pinpoint to communicate with the APNs sandbox environment by using
// APNs tokens.
TokenKeyId *string `type:"string"`
// contains filtered or unexported fields
}
Specifies the status and settings of the APNs (Apple Push Notification service) VoIP sandbox channel for an application.
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 {
// The unique identifier for the application that the APNs VoIP sandbox channel
// applies to.
ApplicationId *string `type:"string"`
// The date and time when the APNs VoIP sandbox channel was enabled.
CreationDate *string `type:"string"`
// The default authentication method that Amazon Pinpoint uses to authenticate
// with the APNs sandbox environment for this channel, key or certificate.
DefaultAuthenticationMethod *string `type:"string"`
// Specifies whether the APNs VoIP sandbox channel is enabled for the application.
Enabled *bool `type:"boolean"`
// (Not used) This property is retained only for backward compatibility.
HasCredential *bool `type:"boolean"`
// Specifies whether the APNs VoIP sandbox channel is configured to communicate
// with APNs by using APNs tokens. To provide an authentication key for APNs
// tokens, set the TokenKey property of the channel.
HasTokenKey *bool `type:"boolean"`
// (Deprecated) An identifier for the APNs VoIP sandbox channel. This property
// is retained only for backward compatibility.
Id *string `type:"string"`
// Specifies whether the APNs VoIP sandbox channel is archived.
IsArchived *bool `type:"boolean"`
// The user who last modified the APNs VoIP sandbox channel.
LastModifiedBy *string `type:"string"`
// The date and time when the APNs VoIP sandbox channel was last modified.
LastModifiedDate *string `type:"string"`
// The type of messaging or notification platform for the channel. For the APNs
// VoIP sandbox channel, this value is APNS_VOIP_SANDBOX.
//
// Platform is a required field
Platform *string `type:"string" required:"true"`
// The current version of the APNs VoIP sandbox channel.
Version *int64 `type:"integer"`
// contains filtered or unexported fields
}
Provides information about the status and settings of the APNs (Apple Push Notification service) VoIP sandbox channel for an application.
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 {
// An array of responses, one for each activity that was performed by the campaign.
//
// Item is a required field
Item []*ActivityResponse `type:"list" required:"true"`
// The string to use in a subsequent request to get the next page of results
// in a paginated response. This value is null if there are no additional pages.
NextToken *string `type:"string"`
// contains filtered or unexported fields
}
Provides information about the activities that were performed by a 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 unique identifier for the application that the campaign applies to.
//
// ApplicationId is a required field
ApplicationId *string `type:"string" required:"true"`
// The unique identifier for the campaign that the activity applies to.
//
// CampaignId is a required field
CampaignId *string `type:"string" required:"true"`
// The actual time, in ISO 8601 format, when the activity was marked CANCELLED
// or COMPLETED.
End *string `type:"string"`
// The unique identifier for the activity.
//
// Id is a required field
Id *string `type:"string" required:"true"`
// Specifies whether the activity succeeded. Possible values are SUCCESS and
// FAIL.
Result *string `type:"string"`
// The scheduled start time, in ISO 8601 format, for the activity.
ScheduledStart *string `type:"string"`
// The actual start time, in ISO 8601 format, of the activity.
Start *string `type:"string"`
// The state of the activity. Possible values are: PENDING, INITIALIZING, RUNNING,
// PAUSED, CANCELLED, and COMPLETED.
State *string `type:"string"`
// The total number of endpoints that the campaign successfully delivered messages
// to.
SuccessfulEndpointCount *int64 `type:"integer"`
// The total number of time zones that were completed.
TimezonesCompletedCount *int64 `type:"integer"`
// The total number of unique time zones that are in the segment for the campaign.
TimezonesTotalCount *int64 `type:"integer"`
// The total number of endpoints that the campaign attempted to deliver messages
// to.
TotalEndpointCount *int64 `type:"integer"`
// The unique identifier for the campaign treatment that the activity applies
// to. A treatment is a variation of a campaign that's used for A/B testing
// of a campaign.
TreatmentId *string `type:"string"`
// contains filtered or unexported fields
}
Provides information about an activity that was performed by a campaign.
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 {
// The message body to use instead of the default message body. This value overrides
// the default message body.
BodyOverride *string `type:"string"`
// The channel to use when sending the message.
ChannelType *string `type:"string" enum:"ChannelType"`
// An object that maps custom attributes to attributes for the address and is
// attached to the message. For a push notification, this payload is added to
// the data.pinpoint object. For an email or text message, this payload is added
// to email/SMS delivery receipt event attributes.
Context map[string]*string `type:"map"`
// The raw, JSON-formatted string to use as the payload for the notification
// message. This value overrides the message.
RawContent *string `type:"string"`
// An object that maps variable values for the message. Amazon Pinpoint merges
// these values with the variable values specified by properties of the DefaultMessage
// object. The substitutions in this map take precedence over all other substitutions.
Substitutions map[string][]*string `type:"map"`
// The message title to use instead of the default message title. This value
// overrides the default message title.
TitleOverride *string `type:"string"`
// contains filtered or unexported fields
}
Specifies address-based configuration settings for a message that's sent directly to an endpoint.
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 ApplicationDateRangeKpiResponse struct {
// The unique identifier for the application that the metric applies to.
//
// ApplicationId is a required field
ApplicationId *string `type:"string" required:"true"`
// EndTime is a required field
EndTime *time.Time `type:"timestamp" timestampFormat:"iso8601" required:"true"`
// The name of the metric, also referred to as a key performance indicator (KPI),
// that the data was retrieved for. This value describes the associated metric
// and consists of two or more terms, which are comprised of lowercase alphanumeric
// characters, separated by a hyphen. For a list of valid values, see the Amazon
// Pinpoint Developer Guide (developerguide.html).
//
// KpiName is a required field
KpiName *string `type:"string" required:"true"`
// An array of objects that contains the results of the query. Each object contains
// the value for the metric and metadata about that value.
//
// KpiResult is a required field
KpiResult *BaseKpiResult `type:"structure" required:"true"`
// The string to use in a subsequent request to get the next page of results
// in a paginated response. This value is null for the App Metrics resource.
// The App Metrics resource returns all results in a single page.
NextToken *string `type:"string"`
// StartTime is a required field
StartTime *time.Time `type:"timestamp" timestampFormat:"iso8601" required:"true"`
// contains filtered or unexported fields
}
Provides the results of a query that retrieved the data for a standard metric that applies to an application, and provides information about that query.
func (s ApplicationDateRangeKpiResponse) GoString() string
GoString returns the string representation
func (s *ApplicationDateRangeKpiResponse) SetApplicationId(v string) *ApplicationDateRangeKpiResponse
SetApplicationId sets the ApplicationId field's value.
func (s *ApplicationDateRangeKpiResponse) SetEndTime(v time.Time) *ApplicationDateRangeKpiResponse
SetEndTime sets the EndTime field's value.
func (s *ApplicationDateRangeKpiResponse) SetKpiName(v string) *ApplicationDateRangeKpiResponse
SetKpiName sets the KpiName field's value.
func (s *ApplicationDateRangeKpiResponse) SetKpiResult(v *BaseKpiResult) *ApplicationDateRangeKpiResponse
SetKpiResult sets the KpiResult field's value.
func (s *ApplicationDateRangeKpiResponse) SetNextToken(v string) *ApplicationDateRangeKpiResponse
SetNextToken sets the NextToken field's value.
func (s *ApplicationDateRangeKpiResponse) SetStartTime(v time.Time) *ApplicationDateRangeKpiResponse
SetStartTime sets the StartTime field's value.
func (s ApplicationDateRangeKpiResponse) String() string
String returns the string representation
type ApplicationResponse struct {
// The Amazon Resource Name (ARN) of the application.
//
// Arn is a required field
Arn *string `type:"string" required:"true"`
// The unique identifier for the application. This identifier is displayed as
// the Project ID on the Amazon Pinpoint console.
//
// Id is a required field
Id *string `type:"string" required:"true"`
// The display name of the application. This name is displayed as the Project
// name on the Amazon Pinpoint console.
//
// Name is a required field
Name *string `type:"string" required:"true"`
// A string-to-string map of key-value pairs that identifies the tags that are
// associated with the application. Each tag consists of a required tag key
// and an associated tag value.
Tags map[string]*string `locationName:"tags" type:"map"`
// contains filtered or unexported fields
}
Provides information about an application.
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 identifier for the application. This identifier is displayed as
// the Project ID on the Amazon Pinpoint console.
//
// ApplicationId is a required field
ApplicationId *string `type:"string" required:"true"`
// The settings for the AWS Lambda function to use by default as a code hook
// for campaigns in the application.
CampaignHook *CampaignHook `type:"structure"`
// The date and time, in ISO 8601 format, when the application's settings were
// last modified.
LastModifiedDate *string `type:"string"`
// The default sending limits for campaigns in the application.
Limits *CampaignLimits `type:"structure"`
// The default quiet time for campaigns in the application. Quiet time is a
// specific time range when campaigns don't send messages to endpoints, if all
// the following conditions are met:
//
// * The EndpointDemographic.Timezone property of the endpoint is set to
// a valid value.
//
// * The current time in the endpoint's time zone is later than or equal
// to the time specified by the QuietTime.Start property for the application
// (or a campaign that has custom quiet time settings).
//
// * The current time in the endpoint's time zone is earlier than or equal
// to the time specified by the QuietTime.End property for the application
// (or a campaign that has custom quiet time settings).
//
// If any of the preceding conditions isn't met, the endpoint will receive messages
// from a campaign, even if quiet time is enabled.
QuietTime *QuietTime `type:"structure"`
// contains filtered or unexported fields
}
Provides information about an application, including the default settings for an application.
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 {
// An array of responses, one for each application that was returned.
Item []*ApplicationResponse `type:"list"`
// The string to use in a subsequent request to get the next page of results
// in a paginated response. This value is null if there are no additional pages.
NextToken *string `type:"string"`
// contains filtered or unexported fields
}
Provides information about all of your applications.
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 segment dimension to use. Valid values are: INCLUSIVE, endpoints
// that match the criteria are included in the segment; and, EXCLUSIVE, endpoints
// that match the criteria are excluded from the segment.
AttributeType *string `type:"string" enum:"AttributeType"`
// The criteria values to use for the segment dimension. Depending on the value
// of the AttributeType property, endpoints are included or excluded from the
// segment if their attribute values match the criteria values.
//
// Values is a required field
Values []*string `type:"list" required:"true"`
// contains filtered or unexported fields
}
Specifies attribute-based criteria for including or excluding endpoints from a segment.
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
func (s *AttributeDimension) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type AttributesResource struct {
// The unique identifier for the application.
//
// ApplicationId is a required field
ApplicationId *string `type:"string" required:"true"`
// The type of attribute or attributes that were removed from the endpoints.
// Valid values are:
//
// * endpoint-custom-attributes - Custom attributes that describe endpoints
//
// * endpoint-custom-metrics - Custom metrics that your app reports to Amazon
// Pinpoint for endpoints
//
// * endpoint-user-attributes - Custom attributes that describe users
//
// AttributeType is a required field
AttributeType *string `type:"string" required:"true"`
// An array that specifies the names of the attributes that were removed from
// the endpoints.
Attributes []*string `type:"list"`
// contains filtered or unexported fields
}
Provides information about the type and the names of attributes that were removed from all the endpoints that are associated with an application.
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 {
// The API key that you received from the Baidu Cloud Push service to communicate
// with the service.
//
// ApiKey is a required field
ApiKey *string `type:"string" required:"true"`
// Specifies whether to enable the Baidu channel for the application.
Enabled *bool `type:"boolean"`
// The secret key that you received from the Baidu Cloud Push service to communicate
// with the service.
//
// SecretKey is a required field
SecretKey *string `type:"string" required:"true"`
// contains filtered or unexported fields
}
Specifies the status and settings of the Baidu (Baidu Cloud Push) channel for an application.
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
func (s *BaiduChannelRequest) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type BaiduChannelResponse struct {
// The unique identifier for the application that the Baidu channel applies
// to.
ApplicationId *string `type:"string"`
// The date and time when the Baidu channel was enabled.
CreationDate *string `type:"string"`
// The API key that you received from the Baidu Cloud Push service to communicate
// with the service.
//
// Credential is a required field
Credential *string `type:"string" required:"true"`
// Specifies whether the Baidu channel is enabled for the application.
Enabled *bool `type:"boolean"`
// (Not used) This property is retained only for backward compatibility.
HasCredential *bool `type:"boolean"`
// (Deprecated) An identifier for the Baidu channel. This property is retained
// only for backward compatibility.
Id *string `type:"string"`
// Specifies whether the Baidu channel is archived.
IsArchived *bool `type:"boolean"`
// The user who last modified the Baidu channel.
LastModifiedBy *string `type:"string"`
// The date and time when the Baidu channel was last modified.
LastModifiedDate *string `type:"string"`
// The type of messaging or notification platform for the channel. For the Baidu
// channel, this value is BAIDU.
//
// Platform is a required field
Platform *string `type:"string" required:"true"`
// The current version of the Baidu channel.
Version *int64 `type:"integer"`
// contains filtered or unexported fields
}
Provides information about the status and settings of the Baidu (Baidu Cloud Push) channel for an application.
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 to occur if the recipient taps the push notification. Valid values
// are:
//
// * OPEN_APP - Your app opens or it becomes the foreground app if it was
// sent to the background. This is the default action.
//
// * DEEP_LINK - Your app opens and displays a designated user interface
// in the app. This action uses the deep-linking features of the Android
// platform.
//
// * URL - The default mobile browser on the recipient's device opens and
// loads the web page at a URL that you specify.
Action *string `type:"string" enum:"Action"`
// The body of the notification message.
Body *string `type:"string"`
// The JSON data payload to use for the push notification, if the notification
// is a silent push notification. This payload is added to the data.pinpoint.jsonBody
// object of the notification.
Data map[string]*string `type:"map"`
// The icon image name of the asset saved in your app.
IconReference *string `type:"string"`
// The URL of the large icon image to display in the content view of the push
// notification.
ImageIconUrl *string `type:"string"`
// The URL of an image to display in the push notification.
ImageUrl *string `type:"string"`
// The raw, JSON-formatted string to use as the payload for the notification
// message. This value overrides the message.
RawContent *string `type:"string"`
// Specifies whether the notification is a silent push notification, which is
// a push notification that doesn't display on a recipient's device. Silent
// push notifications can be used for cases such as updating an app's configuration
// or supporting phone home functionality.
SilentPush *bool `type:"boolean"`
// The URL of the small icon image to display in the status bar and the content
// view of the push notification.
SmallImageIconUrl *string `type:"string"`
// The sound to play when the recipient receives the push notification. You
// can use the default stream or specify the file name of a sound resource that's
// bundled in your app. On an Android platform, the sound file must reside in
// /res/raw/.
Sound *string `type:"string"`
// The default message variables to use in the notification message. You can
// override the default variables with individual address variables.
Substitutions map[string][]*string `type:"map"`
// The amount of time, in seconds, that the Baidu Cloud Push service should
// store the message if the recipient's device is offline. The default value
// and maximum supported time is 604,800 seconds (7 days).
TimeToLive *int64 `type:"integer"`
// The title to display above the notification message on the recipient's device.
Title *string `type:"string"`
// The URL to open in the recipient's default mobile browser, if a recipient
// taps the push notification and the value of the Action property is URL.
Url *string `type:"string"`
// contains filtered or unexported fields
}
Specifies the settings for a one-time message that's sent directly to an endpoint through the Baidu (Baidu Cloud Push) channel.
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 BaseKpiResult struct {
// An array of objects that provides the results of a query that retrieved the
// data for a standard metric that applies to an application or campaign.
//
// Rows is a required field
Rows []*ResultRow `type:"list" required:"true"`
// contains filtered or unexported fields
}
Provides the results of a query that retrieved the data for a standard metric that applies to an application or campaign.
func (s BaseKpiResult) GoString() string
GoString returns the string representation
func (s *BaseKpiResult) SetRows(v []*ResultRow) *BaseKpiResult
SetRows sets the Rows field's value.
func (s BaseKpiResult) String() string
String returns the string representation
type CampaignDateRangeKpiResponse struct {
// The unique identifier for the application that the metric applies to.
//
// ApplicationId is a required field
ApplicationId *string `type:"string" required:"true"`
// The unique identifier for the campaign that the metric applies to.
//
// CampaignId is a required field
CampaignId *string `type:"string" required:"true"`
// EndTime is a required field
EndTime *time.Time `type:"timestamp" timestampFormat:"iso8601" required:"true"`
// The name of the metric, also referred to as a key performance indicator (KPI),
// that the data was retrieved for. This value describes the associated metric
// and consists of two or more terms, which are comprised of lowercase alphanumeric
// characters, separated by a hyphen. For a list of valid values, see the Amazon
// Pinpoint Developer Guide (developerguide.html).
//
// KpiName is a required field
KpiName *string `type:"string" required:"true"`
// An array of objects that contains the results of the query. Each object contains
// the value for the metric and metadata about that value.
//
// KpiResult is a required field
KpiResult *BaseKpiResult `type:"structure" required:"true"`
// The string to use in a subsequent request to get the next page of results
// in a paginated response. This value is null for the Campaign Metrics resource.
// The Campaign Metrics resource returns all results in a single page.
NextToken *string `type:"string"`
// StartTime is a required field
StartTime *time.Time `type:"timestamp" timestampFormat:"iso8601" required:"true"`
// contains filtered or unexported fields
}
Provides the results of a query that retrieved the data for a standard metric that applies to a campaign, and provides information about that query.
func (s CampaignDateRangeKpiResponse) GoString() string
GoString returns the string representation
func (s *CampaignDateRangeKpiResponse) SetApplicationId(v string) *CampaignDateRangeKpiResponse
SetApplicationId sets the ApplicationId field's value.
func (s *CampaignDateRangeKpiResponse) SetCampaignId(v string) *CampaignDateRangeKpiResponse
SetCampaignId sets the CampaignId field's value.
func (s *CampaignDateRangeKpiResponse) SetEndTime(v time.Time) *CampaignDateRangeKpiResponse
SetEndTime sets the EndTime field's value.
func (s *CampaignDateRangeKpiResponse) SetKpiName(v string) *CampaignDateRangeKpiResponse
SetKpiName sets the KpiName field's value.
func (s *CampaignDateRangeKpiResponse) SetKpiResult(v *BaseKpiResult) *CampaignDateRangeKpiResponse
SetKpiResult sets the KpiResult field's value.
func (s *CampaignDateRangeKpiResponse) SetNextToken(v string) *CampaignDateRangeKpiResponse
SetNextToken sets the NextToken field's value.
func (s *CampaignDateRangeKpiResponse) SetStartTime(v time.Time) *CampaignDateRangeKpiResponse
SetStartTime sets the StartTime field's value.
func (s CampaignDateRangeKpiResponse) String() string
String returns the string representation
type CampaignEmailMessage struct {
// The body of the email for recipients whose email clients don't support HTML
// content.
Body *string `type:"string"`
// The verified email address to send the email from. The default address is
// the FromAddress specified for the email channel for the application.
FromAddress *string `type:"string"`
// The body of the email, in HTML format, for recipients whose email clients
// support HTML content.
HtmlBody *string `type:"string"`
// The subject line, or title, of the email.
//
// Title is a required field
Title *string `type:"string" required:"true"`
// contains filtered or unexported fields
}
Specifies the content and "From" address for an email message that's sent to recipients of a campaign.
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
func (s *CampaignEmailMessage) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CampaignEventFilter struct {
// The dimension settings of the event filter for the campaign.
//
// Dimensions is a required field
Dimensions *EventDimensions `type:"structure" required:"true"`
// The type of event that causes the campaign to be sent. Valid values are:
// SYSTEM, sends the campaign when a system event occurs; and, ENDPOINT, sends
// the campaign when an endpoint event (Events resource) occurs.
//
// FilterType is a required field
FilterType *string `type:"string" required:"true" enum:"FilterType"`
// contains filtered or unexported fields
}
Specifies the settings for events that cause a 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
func (s *CampaignEventFilter) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CampaignHook struct {
// The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon
// Pinpoint invokes to send messages for a campaign.
LambdaFunctionName *string `type:"string"`
// Specifies which Lambda mode to use when invoking the AWS Lambda function.
Mode *string `type:"string" enum:"Mode"`
// The web URL that Amazon Pinpoint calls to invoke the AWS Lambda function
// over HTTPS.
WebUrl *string `type:"string"`
// contains filtered or unexported fields
}
Specifies the AWS Lambda function to use as a code hook for a campaign.
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 a campaign can send to a single endpoint
// during a 24-hour period. The maximum value is 100.
Daily *int64 `type:"integer"`
// The maximum amount of time, in seconds, that a campaign can attempt to deliver
// a message after the scheduled start time for the campaign. The minimum value
// is 60 seconds.
MaximumDuration *int64 `type:"integer"`
// The maximum number of messages that a campaign can send each second. The
// minimum value is 50. The maximum value is 20,000.
MessagesPerSecond *int64 `type:"integer"`
// The maximum number of messages that a campaign can send to a single endpoint
// during the course of the campaign. The maximum value is 100.
Total *int64 `type:"integer"`
// contains filtered or unexported fields
}
Specifies limits on the messages that a campaign can send.
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 {
// An array of responses, one for each treatment that you defined for the campaign,
// in addition to the default treatment.
AdditionalTreatments []*TreatmentResource `type:"list"`
// The unique identifier for the application that the campaign applies to.
//
// ApplicationId is a required field
ApplicationId *string `type:"string" required:"true"`
// The Amazon Resource Name (ARN) of the campaign.
//
// Arn is a required field
Arn *string `type:"string" required:"true"`
// The date, ISO 8601 format, when the campaign was created.
//
// CreationDate is a required field
CreationDate *string `type:"string" required:"true"`
// The current status of the campaign's default treatment. This value exists
// only for campaigns that have more than one treatment, to support A/B testing.
DefaultState *CampaignState `type:"structure"`
// The custom description of the campaign.
Description *string `type:"string"`
// The allocated percentage of users (segment members) who shouldn't receive
// messages from the campaign.
HoldoutPercent *int64 `type:"integer"`
// The settings for the AWS Lambda function to use as a code hook for the campaign.
Hook *CampaignHook `type:"structure"`
// The unique identifier for the campaign.
//
// Id is a required field
Id *string `type:"string" required:"true"`
// Specifies whether the campaign is paused. A paused campaign doesn't run unless
// you resume it by changing this value to false.
IsPaused *bool `type:"boolean"`
// The date, in ISO 8601 format, when the campaign was last modified.
//
// LastModifiedDate is a required field
LastModifiedDate *string `type:"string" required:"true"`
// The messaging limits for the campaign.
Limits *CampaignLimits `type:"structure"`
// The message configuration settings for the campaign.
MessageConfiguration *MessageConfiguration `type:"structure"`
// The name of the campaign.
Name *string `type:"string"`
// The schedule settings for the campaign.
Schedule *Schedule `type:"structure"`
// The unique identifier for the segment that's associated with the campaign.
//
// SegmentId is a required field
SegmentId *string `type:"string" required:"true"`
// The version number of the segment that's associated with the campaign.
//
// SegmentVersion is a required field
SegmentVersion *int64 `type:"integer" required:"true"`
// The current status of the campaign.
State *CampaignState `type:"structure"`
// A string-to-string map of key-value pairs that identifies the tags that are
// associated with the campaign. Each tag consists of a required tag key and
// an associated tag value.
Tags map[string]*string `locationName:"tags" type:"map"`
// The custom description of a variation of the campaign that's used for A/B
// testing.
TreatmentDescription *string `type:"string"`
// The custom name of a variation of the campaign that's used for A/B testing.
TreatmentName *string `type:"string"`
// The version number of the campaign.
Version *int64 `type:"integer"`
// contains filtered or unexported fields
}
Provides information about the status, configuration, and other settings for a campaign.
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 body of the SMS message.
Body *string `type:"string"`
// The type of SMS message. Valid values are: TRANSACTIONAL, the message is
// critical or time-sensitive, such as a one-time password that supports a customer
// transaction; and, PROMOTIONAL, the message isn't critical or time-sensitive,
// such as a marketing message.
MessageType *string `type:"string" enum:"MessageType"`
// The sender ID to display on recipients' devices when they receive the SMS
// message.
SenderId *string `type:"string"`
// contains filtered or unexported fields
}
Specifies the content and settings for an SMS message that's sent to recipients of a campaign.
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. If a campaign uses A/B testing, the campaign has a
// status of COMPLETED only when all campaign treatments have a status of COMPLETED.
CampaignStatus *string `type:"string" enum:"CampaignStatus"`
// contains filtered or unexported fields
}
Provides information about the status of a 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 {
// An array of responses, one for each campaign that's associated with the application.
//
// Item is a required field
Item []*CampaignResponse `type:"list" required:"true"`
// The string to use in a subsequent request to get the next page of results
// in a paginated response. This value is null if there are no additional pages.
NextToken *string `type:"string"`
// contains filtered or unexported fields
}
Provides information about the configuration and other settings for all the campaigns that are associated with an application.
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 {
// The unique identifier for the application.
ApplicationId *string `type:"string"`
// The date and time, in ISO 8601 format, when the channel was enabled.
CreationDate *string `type:"string"`
// Specifies whether the channel is enabled for the application.
Enabled *bool `type:"boolean"`
// (Not used) This property is retained only for backward compatibility.
HasCredential *bool `type:"boolean"`
// (Deprecated) An identifier for the channel. This property is retained only
// for backward compatibility.
Id *string `type:"string"`
// Specifies whether the channel is archived.
IsArchived *bool `type:"boolean"`
// The user who last modified the channel.
LastModifiedBy *string `type:"string"`
// The date and time, in ISO 8601 format, when the channel was last modified.
LastModifiedDate *string `type:"string"`
// The current version of the channel.
Version *int64 `type:"integer"`
// contains filtered or unexported fields
}
Provides information about the general settings and status of a channel for an application.
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 that contains a multipart response for each channel. For each item
// in this object, the ChannelType is the key and the Channel is the value.
//
// Channels is a required field
Channels map[string]*ChannelResponse `type:"map" required:"true"`
// contains filtered or unexported fields
}
Provides information about the general settings and status of all channels for an application, including channels that aren't enabled for the application.
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 {
// Specifies the display name of an application and the tags to associate with
// the application.
//
// 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 {
// Provides information about an application.
//
// 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. This name is displayed as the Project
// name on the Amazon Pinpoint console.
//
// Name is a required field
Name *string `type:"string" required:"true"`
// A string-to-string map of key-value pairs that defines the tags to associate
// with the application. Each tag consists of a required tag key and an associated
// tag value.
Tags map[string]*string `locationName:"tags" type:"map"`
// contains filtered or unexported fields
}
Specifies the display name of an application and the tags to associate with the application.
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
func (s *CreateApplicationRequest) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateCampaignInput struct {
// ApplicationId is a required field
ApplicationId *string `location:"uri" locationName:"application-id" type:"string" required:"true"`
// Specifies the configuration and other settings for 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 {
// Provides information about the status, configuration, and other settings
// for a campaign.
//
// 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"`
// Specifies the settings for a job that exports endpoint definitions to an
// Amazon Simple Storage Service (Amazon S3) bucket.
//
// 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 {
// Provides information about the status and settings of a job that exports
// endpoint definitions to a file. The file can be added directly to an Amazon
// Simple Storage Service (Amazon S3) bucket by using the Amazon Pinpoint API
// or downloaded directly to a computer by using the Amazon Pinpoint console.
//
// 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"`
// Specifies the settings for a job that imports endpoint definitions from an
// Amazon Simple Storage Service (Amazon S3) bucket.
//
// 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 {
// Provides information about the status and settings of a job that imports
// endpoint definitions from one or more files. The files can be stored in an
// Amazon Simple Storage Service (Amazon S3) bucket or uploaded directly from
// a computer by using the Amazon Pinpoint console.
//
// 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"`
// Specifies the configuration, dimension, and other settings for a segment.
// A WriteSegmentRequest object can include a Dimensions object or a SegmentGroups
// object, but not both.
//
// 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 {
// Provides information about the configuration, dimension, and other settings
// for a segment.
//
// 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 default message body of the push notification, email, or SMS message.
Body *string `type:"string"`
// The default message variables to use in the push notification, email, or
// SMS message. You can override these default variables with individual address
// variables.
Substitutions map[string][]*string `type:"map"`
// contains filtered or unexported fields
}
Specifies the default message to use for 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 default action to occur if a recipient taps the push notification. Valid
// values are:
//
// * OPEN_APP - Your app opens or it becomes the foreground app if it was
// sent to the background. This is the default action.
//
// * DEEP_LINK - Your app opens and displays a designated user interface
// in the app. This setting uses the deep-linking features of the iOS and
// Android platforms.
//
// * URL - The default mobile browser on the recipient's device opens and
// loads the web page at a URL that you specify.
Action *string `type:"string" enum:"Action"`
// The default body of the notification message.
Body *string `type:"string"`
// The JSON data payload to use for the default push notification, if the notification
// is a silent push notification. This payload is added to the data.pinpoint.jsonBody
// object of the notification.
Data map[string]*string `type:"map"`
// Specifies whether the default notification is a silent push notification,
// which is a push notification that doesn't display on a recipient's device.
// Silent push notifications can be used for cases such as updating an app's
// configuration or delivering messages to an in-app notification center.
SilentPush *bool `type:"boolean"`
// The default message variables to use in the notification message. You can
// override the default variables with individual address variables.
Substitutions map[string][]*string `type:"map"`
// The default title to display above the notification message on a recipient's
// device.
Title *string `type:"string"`
// The default URL to open in a recipient's default mobile browser, if a recipient
// taps the push notification and the value of the Action property is URL.
Url *string `type:"string"`
// contains filtered or unexported fields
}
Specifies the default settings and content for a push notification that's sent directly to an endpoint.
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 {
// Provides information about the status and settings of the ADM (Amazon Device
// Messaging) channel for an application.
//
// 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 {
// Provides information about the status and settings of the APNs (Apple Push
// Notification service) channel for an application.
//
// 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 {
// Provides information about the status and settings of the APNs (Apple Push
// Notification service) sandbox channel for an application.
//
// 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 {
// Provides information about the status and settings of the APNs (Apple Push
// Notification service) VoIP channel for an application.
//
// 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 {
// Provides information about the status and settings of the APNs (Apple Push
// Notification service) VoIP sandbox channel for an application.
//
// 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 {
// Provides information about an application.
//
// 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 {
// Provides information about the status and settings of the Baidu (Baidu Cloud
// Push) channel for an application.
//
// 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 {
// Provides information about the status, configuration, and other settings
// for a campaign.
//
// 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 {
// Provides information about the status and settings of the email channel for
// an application.
//
// 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 {
// Provides information about the channel type and other settings for an endpoint.
//
// 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 {
// Specifies settings for publishing event data to an Amazon Kinesis data stream
// or an Amazon Kinesis Data Firehose delivery stream.
//
// 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 {
// Provides information about the status and settings of the GCM channel for
// an application. The GCM channel enables Amazon Pinpoint to send push notifications
// through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging
// (GCM), service.
//
// 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 {
// Provides information about the configuration, dimension, and other settings
// for a segment.
//
// 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 {
// Provides information about the status and settings of the SMS channel for
// an application.
//
// 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 {
// Provides information about all the endpoints that are associated with a user
// ID.
//
// 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 {
// Provides information about the status and settings of the voice channel for
// an application.
//
// 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 default push notification message for the ADM (Amazon Device Messaging)
// channel. This message overrides the default push notification message (DefaultPushNotificationMessage).
ADMMessage *ADMMessage `type:"structure"`
// The default push notification message for the APNs (Apple Push Notification
// service) channel. This message overrides the default push notification message
// (DefaultPushNotificationMessage).
APNSMessage *APNSMessage `type:"structure"`
// The default push notification message for the Baidu (Baidu Cloud Push) channel.
// This message overrides the default push notification message (DefaultPushNotificationMessage).
BaiduMessage *BaiduMessage `type:"structure"`
// The default message body for all channels.
DefaultMessage *DefaultMessage `type:"structure"`
// The default push notification message for all push channels.
DefaultPushNotificationMessage *DefaultPushNotificationMessage `type:"structure"`
// The default message for the email channel. This message overrides the default
// message (DefaultMessage).
EmailMessage *EmailMessage `type:"structure"`
// The default push notification message for the GCM channel, which is used
// to send notifications through the Firebase Cloud Messaging (FCM), formerly
// Google Cloud Messaging (GCM), service. This message overrides the default
// push notification message (DefaultPushNotificationMessage).
GCMMessage *GCMMessage `type:"structure"`
// The default message for the SMS channel. This message overrides the default
// message (DefaultMessage).
SMSMessage *SMSMessage `type:"structure"`
// The default message for the voice channel. This message overrides the default
// message (DefaultMessage).
VoiceMessage *VoiceMessage `type:"structure"`
// contains filtered or unexported fields
}
Specifies the settings and content for the default message and any default messages that you 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 apply to email that you send through
// the channel by using the Amazon Pinpoint Email API (emailAPIreference.html).
ConfigurationSet *string `type:"string"`
// Specifies whether to enable the email channel for the application.
Enabled *bool `type:"boolean"`
// The verified email address that you want to send email from when you send
// email through the channel.
//
// FromAddress is a required field
FromAddress *string `type:"string" required:"true"`
// The Amazon Resource Name (ARN) of the identity, verified with Amazon Simple
// Email Service (Amazon SES), that you want to use when you send email through
// the channel.
//
// Identity is a required field
Identity *string `type:"string" required:"true"`
// The ARN of the AWS Identity and Access Management (IAM) role that you want
// Amazon Pinpoint to use when it submits email-related event data for the channel.
RoleArn *string `type:"string"`
// contains filtered or unexported fields
}
Specifies the status and settings of the email channel for an application.
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
func (s *EmailChannelRequest) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type EmailChannelResponse struct {
// The unique identifier for the application that the email channel applies
// to.
ApplicationId *string `type:"string"`
// The configuration set that's applied to email that's sent through the channel
// by using the Amazon Pinpoint Email API (emailAPIreference.html).
ConfigurationSet *string `type:"string"`
// The date and time, in ISO 8601 format, when the email channel was enabled.
CreationDate *string `type:"string"`
// Specifies whether the email channel is enabled for the application.
Enabled *bool `type:"boolean"`
// The verified email address that you send email from when you send email through
// the channel.
FromAddress *string `type:"string"`
// (Not used) This property is retained only for backward compatibility.
HasCredential *bool `type:"boolean"`
// (Deprecated) An identifier for the email channel. This property is retained
// only for backward compatibility.
Id *string `type:"string"`
// The Amazon Resource Name (ARN) of the identity, verified with Amazon Simple
// Email Service (Amazon SES), that you use when you send email through the
// channel.
Identity *string `type:"string"`
// Specifies whether the email channel is archived.
IsArchived *bool `type:"boolean"`
// The user who last modified the email channel.
LastModifiedBy *string `type:"string"`
// The date and time, in ISO 8601 format, when the email channel was last modified.
LastModifiedDate *string `type:"string"`
// The maximum number of emails that you can send through the channel each second.
MessagesPerSecond *int64 `type:"integer"`
// The type of messaging or notification platform for the channel. For the email
// channel, this value is EMAIL.
//
// Platform is a required field
Platform *string `type:"string" required:"true"`
// The ARN of the AWS Identity and Access Management (IAM) role that Amazon
// Pinpoint uses to submit email-related event data for the channel.
RoleArn *string `type:"string"`
// The current version of the email channel.
Version *int64 `type:"integer"`
// contains filtered or unexported fields
}
Provides information about the status and settings of the email channel for an application.
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 to forward bounces and complaints to, if feedback forwarding
// is enabled.
FeedbackForwardingAddress *string `type:"string"`
// The verified email address to send the email message from. The default value
// is the FromAddress specified for the email channel.
FromAddress *string `type:"string"`
// The email message, represented as a raw MIME message.
RawEmail *RawEmail `type:"structure"`
// The reply-to email address(es) for the email message. If a recipient replies
// to the email, each reply-to address receives the reply.
ReplyToAddresses []*string `type:"list"`
// The email message, composed of a subject, a text part, and an HTML part.
SimpleEmail *SimpleEmail `type:"structure"`
// The default message variables to use in the email message. You can override
// the default variables with individual address variables.
Substitutions map[string][]*string `type:"map"`
// contains filtered or unexported fields
}
Specifies the default settings and content for a one-time email message that's sent directly to an endpoint.
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 address for messages or push notifications that you send
// to the endpoint. The address varies by channel. For a push-notification channel,
// use the token provided by the push notification service, such as an Apple
// Push Notification service (APNs) device token or a Firebase Cloud Messaging
// (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"`
// One or more custom attributes that describe the endpoint by associating a
// name with an array of values. For example, the value of a custom attribute
// named Interests might be: ["science", "music", "travel"]. You can use these
// attributes as filter criteria when you create segments.
//
// When you define the name of a custom attribute, avoid using the following
// characters: number sign (#), colon (:), question mark (?), backslash (\),
// and slash (/). The Amazon Pinpoint console can't display attribute names
// that contain these characters. This limitation doesn't apply to attribute
// values.
Attributes map[string][]*string `type:"map"`
// The channel to use when sending messages or push notifications to the endpoint.
ChannelType *string `type:"string" enum:"ChannelType"`
// The demographic information for the endpoint, such as the time zone and platform.
Demographic *EndpointDemographic `type:"structure"`
// The date and time, in ISO 8601 format, when the endpoint was created or updated.
EffectiveDate *string `type:"string"`
// Not used.
EndpointStatus *string `type:"string"`
// The unique identifier for the endpoint in the context of the batch.
Id *string `type:"string"`
// The geographic information for the endpoint.
Location *EndpointLocation `type:"structure"`
// One or more custom metrics that your app reports to Amazon Pinpoint for the
// endpoint.
Metrics map[string]*float64 `type:"map"`
// Specifies whether the user who's associated with the endpoint has opted out
// of receiving messages and push notifications from you. Possible values are:
// ALL, the user has opted out and doesn't want to receive any messages or push
// notifications; and, NONE, the user hasn't opted out and wants to receive
// all messages and push notifications.
OptOut *string `type:"string"`
// The unique identifier for the request to create or update the endpoint.
RequestId *string `type:"string"`
// One or more custom user attributes that your app reports to Amazon Pinpoint
// for the user who's associated with the endpoint.
User *EndpointUser `type:"structure"`
// contains filtered or unexported fields
}
Specifies an endpoint to create or update and the settings and attributes to set or change for the endpoint.
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 {
// An array that defines the endpoints to create or update and, for each endpoint,
// the property values to set or change. An array can contain a maximum of 100
// items.
//
// Item is a required field
Item []*EndpointBatchItem `type:"list" required:"true"`
// contains filtered or unexported fields
}
Specifies a batch of endpoints to create or update and the settings and attributes to set or change for each endpoint.
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
func (s *EndpointBatchRequest) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type EndpointDemographic struct {
// The version of the app that's associated with the endpoint.
AppVersion *string `type:"string"`
// The locale of the endpoint, 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 time zone of the endpoint, specified as a tz database name value, such
// as America/Los_Angeles.
Timezone *string `type:"string"`
// contains filtered or unexported fields
}
Specifies demographic information about an endpoint, such as the applicable time zone and platform.
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 {
// The custom message that's returned in the response as a result of processing
// the endpoint data.
Message *string `type:"string"`
// The status code that's returned in the response as a result of processing
// the endpoint data.
StatusCode *int64 `type:"integer"`
// contains filtered or unexported fields
}
Provides the status code and message that result from processing data for 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 name of the city where the endpoint is located.
City *string `type:"string"`
// The two-character code, in ISO 3166-1 alpha-2 format, for the country or
// region where the endpoint is located. For example, US for the United States.
Country *string `type:"string"`
// The latitude coordinate of the endpoint location, rounded to one decimal
// place.
Latitude *float64 `type:"double"`
// The longitude coordinate of the endpoint location, rounded to one decimal
// place.
Longitude *float64 `type:"double"`
// The postal or ZIP code for the area where the endpoint is located.
PostalCode *string `type:"string"`
// The name of the region where the endpoint is located. For locations in the
// United States, this value is the name of a state.
Region *string `type:"string"`
// contains filtered or unexported fields
}
Specifies geographic information about an 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 {
// The endpoint address that the message was delivered to.
Address *string `type:"string"`
// The delivery status of the message. Possible values are:
//
// * DUPLICATE - The endpoint address is a duplicate of another endpoint
// address. Amazon Pinpoint won't attempt to send the message again.
//
// * OPT_OUT - The user who's associated with the endpoint has opted out
// of receiving messages from you. Amazon Pinpoint won't attempt to send
// the message again.
//
// * PERMANENT_FAILURE - An error occurred when delivering the message to
// the endpoint. Amazon Pinpoint won't attempt to send the message again.
//
// * SUCCESSFUL - The message was successfully delivered to the endpoint.
//
// * TEMPORARY_FAILURE - A temporary error occurred. Amazon Pinpoint will
// attempt to deliver the message again later.
//
// * THROTTLED - Amazon Pinpoint throttled the operation to send the message
// to the endpoint.
//
// * TIMEOUT - The message couldn't be sent within the timeout period.
//
// * UNKNOWN_FAILURE - An unknown error occurred.
//
// DeliveryStatus is a required field
DeliveryStatus *string `type:"string" required:"true" enum:"DeliveryStatus"`
// The unique identifier for the message that was sent.
MessageId *string `type:"string"`
// The downstream service status code for delivering the message.
//
// StatusCode is a required field
StatusCode *int64 `type:"integer" required:"true"`
// The status message for delivering the message.
StatusMessage *string `type:"string"`
// For push notifications that are sent through the GCM channel, specifies whether
// the token was updated as part of delivering the message.
UpdatedToken *string `type:"string"`
// contains filtered or unexported fields
}
Provides information about the delivery status and results of sending a message directly 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 address for messages or push notifications that you send
// to the endpoint. The address varies by channel. For a push-notification channel,
// use the token provided by the push notification service, such as an Apple
// Push Notification service (APNs) device token or a Firebase Cloud Messaging
// (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"`
// One or more custom attributes that describe the endpoint by associating a
// name with an array of values. For example, the value of a custom attribute
// named Interests might be: ["science", "music", "travel"]. You can use these
// attributes as filter criteria when you create segments.
//
// When you define the name of a custom attribute, avoid using the following
// characters: number sign (#), colon (:), question mark (?), backslash (\),
// and slash (/). The Amazon Pinpoint console can't display attribute names
// that contain these characters. This limitation doesn't apply to attribute
// values.
Attributes map[string][]*string `type:"map"`
// The channel to use when sending messages or push notifications to the endpoint.
ChannelType *string `type:"string" enum:"ChannelType"`
// The demographic information for the endpoint, such as the time zone and platform.
Demographic *EndpointDemographic `type:"structure"`
// The date and time, in ISO 8601 format, when the endpoint is updated.
EffectiveDate *string `type:"string"`
// Not used.
EndpointStatus *string `type:"string"`
// The geographic information for the endpoint.
Location *EndpointLocation `type:"structure"`
// One or more custom metrics that your app reports to Amazon Pinpoint for the
// endpoint.
Metrics map[string]*float64 `type:"map"`
// Specifies whether the user who's associated with the endpoint has opted out
// of receiving messages and push notifications from you. Possible values are:
// ALL, the user has opted out and doesn't want to receive any messages or push
// notifications; and, NONE, the user hasn't opted out and wants to receive
// all messages and push notifications.
OptOut *string `type:"string"`
// The unique identifier for the most recent request to update the endpoint.
RequestId *string `type:"string"`
// One or more custom user attributes that describe the user who's associated
// with the endpoint.
User *EndpointUser `type:"structure"`
// contains filtered or unexported fields
}
Specifies the channel type and other settings for an endpoint.
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 destination address for messages or push notifications that you send
// to the endpoint. The address varies by channel. For example, the address
// for a push-notification channel is typically the token provided by a push
// notification service, such as an Apple Push Notification service (APNs) device
// token or a Firebase Cloud Messaging (FCM) registration token. The address
// for the SMS channel is a phone number in E.164 format, such as +12065550100.
// The address for the email channel is an email address.
Address *string `type:"string"`
// The unique identifier for the application that's associated with the endpoint.
ApplicationId *string `type:"string"`
// One or more custom attributes that describe the endpoint by associating a
// name with an array of values. For example, the value of a custom attribute
// named Interests might be: ["science", "music", "travel"]. You can use these
// attributes as filter criteria when you create segments.
Attributes map[string][]*string `type:"map"`
// The channel that's used when sending messages or push notifications to the
// endpoint.
ChannelType *string `type:"string" enum:"ChannelType"`
// A number from 0-99 that represents the cohort that the endpoint is assigned
// to. Endpoints are grouped into cohorts randomly, and each cohort contains
// approximately 1 percent of the endpoints for an application. Amazon Pinpoint
// assigns cohorts to the holdout or treatment allocations for campaigns.
CohortId *string `type:"string"`
// The date and time, in ISO 8601 format, when the endpoint was created.
CreationDate *string `type:"string"`
// The demographic information for the endpoint, such as the time zone and platform.
Demographic *EndpointDemographic `type:"structure"`
// The date and time, in ISO 8601 format, when the endpoint was last updated.
EffectiveDate *string `type:"string"`
// Not used.
EndpointStatus *string `type:"string"`
// The unique identifier that you assigned to the endpoint. The identifier should
// be a globally unique identifier (GUID) to ensure that it doesn't conflict
// with other endpoint identifiers that are associated with the application.
Id *string `type:"string"`
// The geographic information for the endpoint.
Location *EndpointLocation `type:"structure"`
// One or more custom metrics that your app reports to Amazon Pinpoint for the
// endpoint.
Metrics map[string]*float64 `type:"map"`
// Specifies whether the user who's associated with the endpoint has opted out
// of receiving messages and push notifications from you. Possible values are:
// ALL, the user has opted out and doesn't want to receive any messages or push
// notifications; and, NONE, the user hasn't opted out and wants to receive
// all messages and push notifications.
OptOut *string `type:"string"`
// The unique identifier for the most recent request to update the endpoint.
RequestId *string `type:"string"`
// One or more custom user attributes that your app reports to Amazon Pinpoint
// for the user who's associated with the endpoint.
User *EndpointUser `type:"structure"`
// contains filtered or unexported fields
}
Provides information about the channel type and other settings for an endpoint.
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 {
// The body of the message. If specified, this value overrides the default message
// body.
BodyOverride *string `type:"string"`
// A map of custom attributes to attach to the message for the address. For
// a push notification, this payload is added to the data.pinpoint object. For
// an email or text message, this payload is added to email/SMS delivery receipt
// event attributes.
Context map[string]*string `type:"map"`
// The raw, JSON-formatted string to use as the payload for the message. If
// specified, this value overrides the message.
RawContent *string `type:"string"`
// A map of the message variables to merge with the variables specified for
// the default message (DefaultMessage.Substitutions). The variables specified
// in this map take precedence over all other variables.
Substitutions map[string][]*string `type:"map"`
// The title or subject line of the message. If specified, this value overrides
// the default message title or subject line.
TitleOverride *string `type:"string"`
// contains filtered or unexported fields
}
Specifies the content, including message variables and attributes, to use in a message that's sent directly to an endpoint.
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 {
// One or more custom attributes that describe the user by associating a name
// with an array of values. For example, the value of an attribute named Interests
// might be: ["science", "music", "travel"]. You can use these attributes as
// filter criteria when you create segments.
//
// When you define the name of a custom attribute, avoid using the following
// characters: number sign (#), colon (:), question mark (?), backslash (\),
// and slash (/). The Amazon Pinpoint console can't display attribute names
// that contain these characters. This limitation doesn't apply to attribute
// values.
UserAttributes map[string][]*string `type:"map"`
// The unique identifier for the user.
UserId *string `type:"string"`
// contains filtered or unexported fields
}
Specifies data for one or more attributes that describe the user who's associated with an endpoint.
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 {
// An array of responses, one for each endpoint that's associated with the user
// ID.
//
// Item is a required field
Item []*EndpointResponse `type:"list" required:"true"`
// contains filtered or unexported fields
}
Provides information about all the endpoints that are associated with a user ID.
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 of 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"`
// One or more custom attributes that are associated with the event.
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 event.
//
// EventType is a required field
EventType *string `type:"string" required:"true"`
// One or more custom metrics that are associated with 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, in ISO 8601 format, when the event occurred.
//
// Timestamp is a required field
Timestamp *string `type:"string" required:"true"`
// contains filtered or unexported fields
}
Specifies information about an event that reports data to Amazon Pinpoint.
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
func (s *Event) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type EventDimensions struct {
// One or more 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 type of event that Amazon Pinpoint generates, such as _session.start,
// or a custom event that's specific to your app.
EventType *SetDimension `type:"structure"`
// One or more custom metrics that your app reports to Amazon Pinpoint. You
// can use these metrics as selection criteria when you create an event filter.
Metrics map[string]*MetricDimension `type:"map"`
// contains filtered or unexported fields
}
Specifies the dimensions for an event filter that determines when a campaign is sent.
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
func (s *EventDimensions) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type EventItemResponse struct {
// A custom message that's returned in the response as a result of processing
// the event.
Message *string `type:"string"`
// The status code that's returned in the response as a result of processing
// the event. Possible values are: 202, for events that were accepted; and,
// 400, for events that weren't valid.
StatusCode *int64 `type:"integer"`
// contains filtered or unexported fields
}
Provides the status code and message that result from 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 unique identifier for the application to publish event data for.
//
// ApplicationId is a required field
ApplicationId *string `type:"string" required:"true"`
// The Amazon Resource Name (ARN) of the Amazon Kinesis data stream or Amazon
// Kinesis Data Firehose delivery stream to publish event data to.
//
// For a Kinesis data stream, the ARN format is: arn:aws:kinesis:region:account-id:stream/stream_name
//
// For a Kinesis Data Firehose delivery stream, the ARN format is: arn:aws:firehose:region:account-id:deliverystream/stream_name
//
// DestinationStreamArn is a required field
DestinationStreamArn *string `type:"string" required:"true"`
// (Deprecated) Your AWS account ID, which you assigned to an external ID key
// in an IAM trust policy. Amazon Pinpoint previously used this value to assume
// an IAM role when publishing event data, but we removed this requirement.
// We don't recommend use of external IDs for IAM roles that are assumed by
// Amazon Pinpoint.
ExternalId *string `type:"string"`
// The date, in ISO 8601 format, when the event stream was last modified.
LastModifiedDate *string `type:"string"`
// The IAM user who last modified the event stream.
LastUpdatedBy *string `type:"string"`
// The AWS Identity and Access Management (IAM) role that authorizes Amazon
// Pinpoint to publish event data to the stream in your AWS account.
//
// RoleArn is a required field
RoleArn *string `type:"string" required:"true"`
// contains filtered or unexported fields
}
Specifies settings for publishing event data to an Amazon Kinesis data stream or an Amazon Kinesis Data Firehose delivery stream.
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 {
// A set of properties and attributes that are associated with the endpoint.
//
// Endpoint is a required field
Endpoint *PublicEndpoint `type:"structure" required:"true"`
// A set of properties that are associated with the event.
//
// Events is a required field
Events map[string]*Event `type:"map" required:"true"`
// contains filtered or unexported fields
}
Specifies a batch of endpoints 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
func (s *EventsBatch) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type EventsRequest struct {
// The batch of events to process. For each item in a batch, the endpoint ID
// acts as a key that has an EventsBatch object as its value.
//
// BatchItem is a required field
BatchItem map[string]*EventsBatch `type:"map" required:"true"`
// contains filtered or unexported fields
}
Specifies a batch 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
func (s *EventsRequest) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type EventsResponse struct {
// A map that contains a multipart response for each endpoint. For each item
// in this object, the endpoint ID is the key and the item response is the value.
// If no item response exists, the value can also be one of the following: 202,
// the request was processed successfully; or 400, the payload wasn't valid
// or required fields were missing.
Results map[string]*ItemResponse `type:"map"`
// contains filtered or unexported fields
}
Provides information about endpoints and the events that they're associated with.
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 the AWS Identity and Access Management
// (IAM) role that authorizes Amazon Pinpoint to access the Amazon S3 location
// where you want to export endpoint definitions to.
//
// RoleArn is a required field
RoleArn *string `type:"string" required:"true"`
// The URL of the location in an Amazon Simple Storage Service (Amazon S3) bucket
// where you want to export endpoint definitions to. This location is typically
// a folder that contains multiple files. The URL should be in the following
// format: s3://bucket-name/folder-name/.
//
// S3UrlPrefix is a required field
S3UrlPrefix *string `type:"string" required:"true"`
// The identifier for the segment to export endpoint definitions from. If you
// don't specify this value, Amazon Pinpoint exports definitions for all the
// endpoints that are associated with the application.
SegmentId *string `type:"string"`
// The version of the segment to export endpoint definitions from, if specified.
SegmentVersion *int64 `type:"integer"`
// contains filtered or unexported fields
}
Specifies the settings for a job that exports endpoint definitions to an Amazon Simple Storage Service (Amazon S3) bucket.
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
func (s *ExportJobRequest) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ExportJobResource struct {
// The Amazon Resource Name (ARN) of the AWS Identity and Access Management
// (IAM) role that authorized Amazon Pinpoint to access the Amazon S3 location
// where the endpoint definitions were exported to.
//
// RoleArn is a required field
RoleArn *string `type:"string" required:"true"`
// The URL of the location in an Amazon Simple Storage Service (Amazon S3) bucket
// where the endpoint definitions were exported to. This location is typically
// a folder that contains multiple files. The URL should be in the following
// format: s3://bucket-name/folder-name/.
//
// S3UrlPrefix is a required field
S3UrlPrefix *string `type:"string" required:"true"`
// The identifier for the segment that the endpoint definitions were exported
// from. If this value isn't present, Amazon Pinpoint exported definitions for
// all the endpoints that are associated with the application.
SegmentId *string `type:"string"`
// The version of the segment that the endpoint definitions were exported from.
SegmentVersion *int64 `type:"integer"`
// contains filtered or unexported fields
}
Provides information about the resource settings for a job that exports endpoint definitions to a file. The file can be added directly to an Amazon Simple Storage Service (Amazon S3) bucket by using the Amazon Pinpoint API or downloaded directly to a computer by using the Amazon Pinpoint console.
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 identifier for the application that's associated with the export
// job.
//
// ApplicationId is a required field
ApplicationId *string `type:"string" required:"true"`
// The number of pieces that were processed successfully (completed) by the
// export job, as of the time of the request.
CompletedPieces *int64 `type:"integer"`
// The date, in ISO 8601 format, when the export job was completed.
CompletionDate *string `type:"string"`
// The date, in ISO 8601 format, when the export job was created.
//
// CreationDate is a required field
CreationDate *string `type:"string" required:"true"`
// The resource settings that apply to the export job.
//
// Definition is a required field
Definition *ExportJobResource `type:"structure" required:"true"`
// The number of pieces that weren't processed successfully (failed) by the
// export job, as of the time of the request.
FailedPieces *int64 `type:"integer"`
// An array of entries, one for each of the first 100 entries that weren't processed
// successfully (failed) by the export job, if any.
Failures []*string `type:"list"`
// The unique identifier for the export job.
//
// Id is a required field
Id *string `type:"string" required:"true"`
// The status of the export job. The job status is FAILED if Amazon Pinpoint
// wasn't able to process one or more pieces in the job.
//
// JobStatus is a required field
JobStatus *string `type:"string" required:"true" enum:"JobStatus"`
// The total number of endpoint definitions that weren't processed successfully
// (failed) by the export job, typically because an error, such as a syntax
// error, occurred.
TotalFailures *int64 `type:"integer"`
// The total number of pieces that must be processed to complete the export
// job. Each piece consists of an approximately equal portion of the endpoint
// definitions that are part of the export job.
TotalPieces *int64 `type:"integer"`
// The total number of endpoint definitions that were processed by the export
// job.
TotalProcessed *int64 `type:"integer"`
// The job type. This value is EXPORT for export jobs.
//
// Type is a required field
Type *string `type:"string" required:"true"`
// contains filtered or unexported fields
}
Provides information about the status and settings of a job that exports endpoint definitions to a file. The file can be added directly to an Amazon Simple Storage Service (Amazon S3) bucket by using the Amazon Pinpoint API or downloaded directly to a computer by using the Amazon Pinpoint console.
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 {
// An array of responses, one for each export job that's associated with the
// application (Export Jobs resource) or segment (Segment Export Jobs resource).
//
// Item is a required field
Item []*ExportJobResponse `type:"list" required:"true"`
// The string to use in a subsequent request to get the next page of results
// in a paginated response. This value is null if there are no additional pages.
NextToken *string `type:"string"`
// contains filtered or unexported fields
}
Provides information about all the export jobs that are associated with an application or segment. An export job is a job that exports endpoint definitions to a file.
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 {
// The API key, also referred to as a server key, that you received from Google
// to communicate with Google services.
//
// ApiKey is a required field
ApiKey *string `type:"string" required:"true"`
// Specifies whether to enable the GCM channel for the application.
Enabled *bool `type:"boolean"`
// contains filtered or unexported fields
}
Specifies the status and settings of the GCM channel for an application. This channel enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service.
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
func (s *GCMChannelRequest) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GCMChannelResponse struct {
// The unique identifier for the application that the GCM channel applies to.
ApplicationId *string `type:"string"`
// The date and time when the GCM channel was enabled.
CreationDate *string `type:"string"`
// The API key, also referred to as a server key, that you received from Google
// to communicate with Google services.
//
// Credential is a required field
Credential *string `type:"string" required:"true"`
// Specifies whether the GCM channel is enabled for the application.
Enabled *bool `type:"boolean"`
// (Not used) This property is retained only for backward compatibility.
HasCredential *bool `type:"boolean"`
// (Deprecated) An identifier for the GCM channel. This property is retained
// only for backward compatibility.
Id *string `type:"string"`
// Specifies whether the GCM channel is archived.
IsArchived *bool `type:"boolean"`
// The user who last modified the GCM channel.
LastModifiedBy *string `type:"string"`
// The date and time when the GCM channel was last modified.
LastModifiedDate *string `type:"string"`
// The type of messaging or notification platform for the channel. For the GCM
// channel, this value is GCM.
//
// Platform is a required field
Platform *string `type:"string" required:"true"`
// The current version of the GCM channel.
Version *int64 `type:"integer"`
// contains filtered or unexported fields
}
Provides information about the status and settings of the GCM channel for an application. The GCM channel enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service.
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 to occur if the recipient taps the push notification. Valid values
// are:
//
// * OPEN_APP - Your app opens or it becomes the foreground app if it was
// sent to the background. This is the default action.
//
// * DEEP_LINK - Your app opens and displays a designated user interface
// in the app. This action uses the deep-linking features of the Android
// platform.
//
// * URL - The default mobile browser on the recipient's device opens and
// loads the web page at a URL that you specify.
Action *string `type:"string" enum:"Action"`
// The body of the notification message.
Body *string `type:"string"`
// An arbitrary string that identifies a group of messages that can be collapsed
// to ensure that only the last message is sent when delivery can resume. This
// helps avoid sending too many instances of the same messages when the recipient's
// device comes online again or becomes active.
//
// Amazon Pinpoint specifies this value in the Firebase Cloud Messaging (FCM)
// collapse_key parameter when it sends the notification message to FCM.
CollapseKey *string `type:"string"`
// The JSON data payload to use for the push notification, if the notification
// is a silent push notification. This payload is added to the data.pinpoint.jsonBody
// object of the notification.
Data map[string]*string `type:"map"`
// The icon image name of the asset saved in your app.
IconReference *string `type:"string"`
// The URL of the large icon image to display in the content view of the push
// notification.
ImageIconUrl *string `type:"string"`
// The URL of an image to display in the push notification.
ImageUrl *string `type:"string"`
// para>normal - The notification might be delayed. Delivery is optimized for
// battery usage on the recipient's device. Use this value unless immediate
// delivery is required.
// /listitem>
// high - The notification is sent immediately and might wake a sleeping device.
// /para>
// Amazon Pinpoint specifies this value in the FCM priority parameter when it
// sends the notification message to FCM.
//
// The equivalent values for Apple Push Notification service (APNs) are 5, for
// normal, and 10, for high. If you specify an APNs value for this property,
// Amazon Pinpoint accepts and converts the value to the corresponding FCM value.
Priority *string `type:"string"`
// The raw, JSON-formatted string to use as the payload for the notification
// message. This value overrides the message.
RawContent *string `type:"string"`
// The package name of the application where registration tokens must match
// in order for the recipient to receive the message.
RestrictedPackageName *string `type:"string"`
// Specifies whether the notification is a silent push notification, which is
// a push notification that doesn't display on a recipient's device. Silent
// push notifications can be used for cases such as updating an app's configuration
// or supporting phone home functionality.
SilentPush *bool `type:"boolean"`
// The URL of the small icon image to display in the status bar and the content
// view of the push notification.
SmallImageIconUrl *string `type:"string"`
// The sound to play when the recipient receives the push notification. You
// can use the default stream or specify the file name of a sound resource that's
// bundled in your app. On an Android platform, the sound file must reside in
// /res/raw/.
Sound *string `type:"string"`
// The default message variables to use in the notification message. You can
// override the default variables with individual address variables.
Substitutions map[string][]*string `type:"map"`
// The amount of time, in seconds, that FCM should store and attempt to deliver
// the push notification, if the service is unable to deliver the notification
// the first time. If you don't specify this value, FCM defaults to the maximum
// value, which is 2,419,200 seconds (28 days).
//
// Amazon Pinpoint specifies this value in the FCM time_to_live parameter when
// it sends the notification message to FCM.
TimeToLive *int64 `type:"integer"`
// The title to display above the notification message on the recipient's device.
Title *string `type:"string"`
// The URL to open in the recipient's default mobile browser, if a recipient
// taps the push notification and the value of the Action property is URL.
Url *string `type:"string"`
// contains filtered or unexported fields
}
Specifies the settings for a one-time message that's sent directly to an endpoint through the GCM channel. The GCM channel enables Amazon Pinpoint to send messages to the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service.
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 {
// The latitude coordinate of the location.
//
// Latitude is a required field
Latitude *float64 `type:"double" required:"true"`
// The longitude coordinate of the location.
//
// Longitude is a required field
Longitude *float64 `type:"double" required:"true"`
// contains filtered or unexported fields
}
Specifies the GPS coordinates of a location.
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
func (s *GPSCoordinates) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GPSPointDimension struct {
// The GPS coordinates to measure distance from.
//
// Coordinates is a required field
Coordinates *GPSCoordinates `type:"structure" required:"true"`
// The range, in kilometers, from the GPS coordinates.
RangeInKilometers *float64 `type:"double"`
// contains filtered or unexported fields
}
Specifies GPS-based criteria for including or excluding endpoints from a segment.
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
func (s *GPSPointDimension) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 {
// Provides information about the status and settings of the ADM (Amazon Device
// Messaging) channel for an application.
//
// 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 {
// Provides information about the status and settings of the APNs (Apple Push
// Notification service) channel for an application.
//
// 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 {
// Provides information about the status and settings of the APNs (Apple Push
// Notification service) sandbox channel for an application.
//
// 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 {
// Provides information about the status and settings of the APNs (Apple Push
// Notification service) VoIP channel for an application.
//
// 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 {
// Provides information about the status and settings of the APNs (Apple Push
// Notification service) VoIP sandbox channel for an application.
//
// 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 {
// Provides information about an application.
//
// 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 GetApplicationDateRangeKpiInput struct {
// ApplicationId is a required field
ApplicationId *string `location:"uri" locationName:"application-id" type:"string" required:"true"`
EndTime *time.Time `location:"querystring" locationName:"end-time" type:"timestamp" timestampFormat:"iso8601"`
// KpiName is a required field
KpiName *string `location:"uri" locationName:"kpi-name" type:"string" required:"true"`
NextToken *string `location:"querystring" locationName:"next-token" type:"string"`
PageSize *string `location:"querystring" locationName:"page-size" type:"string"`
StartTime *time.Time `location:"querystring" locationName:"start-time" type:"timestamp" timestampFormat:"iso8601"`
// contains filtered or unexported fields
}
func (s GetApplicationDateRangeKpiInput) GoString() string
GoString returns the string representation
func (s *GetApplicationDateRangeKpiInput) SetApplicationId(v string) *GetApplicationDateRangeKpiInput
SetApplicationId sets the ApplicationId field's value.
func (s *GetApplicationDateRangeKpiInput) SetEndTime(v time.Time) *GetApplicationDateRangeKpiInput
SetEndTime sets the EndTime field's value.
func (s *GetApplicationDateRangeKpiInput) SetKpiName(v string) *GetApplicationDateRangeKpiInput
SetKpiName sets the KpiName field's value.
func (s *GetApplicationDateRangeKpiInput) SetNextToken(v string) *GetApplicationDateRangeKpiInput
SetNextToken sets the NextToken field's value.
func (s *GetApplicationDateRangeKpiInput) SetPageSize(v string) *GetApplicationDateRangeKpiInput
SetPageSize sets the PageSize field's value.
func (s *GetApplicationDateRangeKpiInput) SetStartTime(v time.Time) *GetApplicationDateRangeKpiInput
SetStartTime sets the StartTime field's value.
func (s GetApplicationDateRangeKpiInput) String() string
String returns the string representation
func (s *GetApplicationDateRangeKpiInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetApplicationDateRangeKpiOutput struct {
// Provides the results of a query that retrieved the data for a standard metric
// that applies to an application, and provides information about that query.
//
// ApplicationDateRangeKpiResponse is a required field
ApplicationDateRangeKpiResponse *ApplicationDateRangeKpiResponse `type:"structure" required:"true"`
// contains filtered or unexported fields
}
func (s GetApplicationDateRangeKpiOutput) GoString() string
GoString returns the string representation
func (s *GetApplicationDateRangeKpiOutput) SetApplicationDateRangeKpiResponse(v *ApplicationDateRangeKpiResponse) *GetApplicationDateRangeKpiOutput
SetApplicationDateRangeKpiResponse sets the ApplicationDateRangeKpiResponse field's value.
func (s GetApplicationDateRangeKpiOutput) 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 {
// Provides information about an application, including the default settings
// for an application.
//
// 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 {
// Provides information about all of your applications.
//
// 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 {
// Provides information about the status and settings of the Baidu (Baidu Cloud
// Push) channel for an application.
//
// 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 {
// Provides information about the activities that were performed by a 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 GetCampaignDateRangeKpiInput 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"`
EndTime *time.Time `location:"querystring" locationName:"end-time" type:"timestamp" timestampFormat:"iso8601"`
// KpiName is a required field
KpiName *string `location:"uri" locationName:"kpi-name" type:"string" required:"true"`
NextToken *string `location:"querystring" locationName:"next-token" type:"string"`
PageSize *string `location:"querystring" locationName:"page-size" type:"string"`
StartTime *time.Time `location:"querystring" locationName:"start-time" type:"timestamp" timestampFormat:"iso8601"`
// contains filtered or unexported fields
}
func (s GetCampaignDateRangeKpiInput) GoString() string
GoString returns the string representation
func (s *GetCampaignDateRangeKpiInput) SetApplicationId(v string) *GetCampaignDateRangeKpiInput
SetApplicationId sets the ApplicationId field's value.
func (s *GetCampaignDateRangeKpiInput) SetCampaignId(v string) *GetCampaignDateRangeKpiInput
SetCampaignId sets the CampaignId field's value.
func (s *GetCampaignDateRangeKpiInput) SetEndTime(v time.Time) *GetCampaignDateRangeKpiInput
SetEndTime sets the EndTime field's value.
func (s *GetCampaignDateRangeKpiInput) SetKpiName(v string) *GetCampaignDateRangeKpiInput
SetKpiName sets the KpiName field's value.
func (s *GetCampaignDateRangeKpiInput) SetNextToken(v string) *GetCampaignDateRangeKpiInput
SetNextToken sets the NextToken field's value.
func (s *GetCampaignDateRangeKpiInput) SetPageSize(v string) *GetCampaignDateRangeKpiInput
SetPageSize sets the PageSize field's value.
func (s *GetCampaignDateRangeKpiInput) SetStartTime(v time.Time) *GetCampaignDateRangeKpiInput
SetStartTime sets the StartTime field's value.
func (s GetCampaignDateRangeKpiInput) String() string
String returns the string representation
func (s *GetCampaignDateRangeKpiInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetCampaignDateRangeKpiOutput struct {
// Provides the results of a query that retrieved the data for a standard metric
// that applies to a campaign, and provides information about that query.
//
// CampaignDateRangeKpiResponse is a required field
CampaignDateRangeKpiResponse *CampaignDateRangeKpiResponse `type:"structure" required:"true"`
// contains filtered or unexported fields
}
func (s GetCampaignDateRangeKpiOutput) GoString() string
GoString returns the string representation
func (s *GetCampaignDateRangeKpiOutput) SetCampaignDateRangeKpiResponse(v *CampaignDateRangeKpiResponse) *GetCampaignDateRangeKpiOutput
SetCampaignDateRangeKpiResponse sets the CampaignDateRangeKpiResponse field's value.
func (s GetCampaignDateRangeKpiOutput) 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 {
// Provides information about the status, configuration, and other settings
// for a campaign.
//
// 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 {
// Provides information about the status, configuration, and other settings
// for a campaign.
//
// 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 {
// Provides information about the configuration and other settings for all the
// campaigns that are associated with an application.
//
// 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 {
// Provides information about the configuration and other settings for all the
// campaigns that are associated with an application.
//
// 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 {
// Provides information about the general settings and status of all channels
// for an application, including channels that aren't enabled for the application.
//
// 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 {
// Provides information about the status and settings of the email channel for
// an application.
//
// 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 {
// Provides information about the channel type and other settings for an endpoint.
//
// 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 {
// Specifies settings for publishing event data to an Amazon Kinesis data stream
// or an Amazon Kinesis Data Firehose delivery stream.
//
// 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 {
// Provides information about the status and settings of a job that exports
// endpoint definitions to a file. The file can be added directly to an Amazon
// Simple Storage Service (Amazon S3) bucket by using the Amazon Pinpoint API
// or downloaded directly to a computer by using the Amazon Pinpoint console.
//
// 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 {
// Provides information about all the export jobs that are associated with an
// application or segment. An export job is a job that exports endpoint definitions
// to a file.
//
// 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 {
// Provides information about the status and settings of the GCM channel for
// an application. The GCM channel enables Amazon Pinpoint to send push notifications
// through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging
// (GCM), service.
//
// 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 {
// Provides information about the status and settings of a job that imports
// endpoint definitions from one or more files. The files can be stored in an
// Amazon Simple Storage Service (Amazon S3) bucket or uploaded directly from
// a computer by using the Amazon Pinpoint console.
//
// 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 {
// Provides information about the status and settings of all the import jobs
// that are associated with an application or segment. An import job is a job
// that imports endpoint definitions from one or more files.
//
// 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 {
// Provides information about all the export jobs that are associated with an
// application or segment. An export job is a job that exports endpoint definitions
// to a file.
//
// 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 {
// Provides information about the status and settings of all the import jobs
// that are associated with an application or segment. An import job is a job
// that imports endpoint definitions from one or more files.
//
// 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 {
// Provides information about the configuration, dimension, and other settings
// for a segment.
//
// 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 {
// Provides information about the configuration, dimension, and other settings
// for a segment.
//
// 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 {
// Provides information about all the segments that are associated with an application.
//
// 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 {
// Provides information about all the segments that are associated with an application.
//
// 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 {
// Provides information about the status and settings of the SMS channel for
// an application.
//
// 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 {
// Provides information about all the endpoints that are associated with a user
// ID.
//
// 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 {
// Provides information about the status and settings of the voice channel for
// an application.
//
// 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 {
// Specifies whether to create a segment that contains the endpoints, when the
// endpoint definitions are imported.
DefineSegment *bool `type:"boolean"`
// (Deprecated) Your AWS account ID, which you assigned to an external ID key
// in an IAM trust policy. Amazon Pinpoint previously used this value to assume
// an IAM role when importing endpoint definitions, but we removed this requirement.
// We don't recommend use of external IDs for IAM roles that are assumed by
// Amazon Pinpoint.
ExternalId *string `type:"string"`
// The format of the files that contain the endpoint definitions to import.
// Valid values are: CSV, for comma-separated values format; and, JSON, for
// newline-delimited JSON format. If the Amazon S3 location stores multiple
// files that use different formats, Amazon Pinpoint imports data only from
// the files that use the specified format.
//
// Format is a required field
Format *string `type:"string" required:"true" enum:"Format"`
// Specifies whether to register the endpoints with Amazon Pinpoint, when the
// endpoint definitions are imported.
RegisterEndpoints *bool `type:"boolean"`
// The Amazon Resource Name (ARN) of the AWS Identity and Access Management
// (IAM) role that authorizes Amazon Pinpoint to access the Amazon S3 location
// to import endpoint definitions from.
//
// RoleArn is a required field
RoleArn *string `type:"string" required:"true"`
// The URL of the Amazon Simple Storage Service (Amazon S3) bucket that contains
// the endpoint definitions to import. This location can be a folder or a single
// file. If the location is a folder, Amazon Pinpoint imports endpoint definitions
// from the files in this location, including any subfolders that the folder
// contains.
//
// The URL should be in the following format: s3://bucket-name/folder-name/file-name.
// The location can end with the key for an individual object or a prefix that
// qualifies multiple objects.
//
// S3Url is a required field
S3Url *string `type:"string" required:"true"`
// The identifier for the segment to update or add the imported endpoint definitions
// to, if the import job is meant to update an existing segment.
SegmentId *string `type:"string"`
// The custom name for the segment that's created by the import job, if the
// value of the DefineSegment property is true.
SegmentName *string `type:"string"`
// contains filtered or unexported fields
}
Specifies the settings for a job that imports endpoint definitions from an Amazon Simple Storage Service (Amazon S3) bucket.
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
func (s *ImportJobRequest) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ImportJobResource struct {
// Specifies whether the import job creates a segment that contains the endpoints,
// when the endpoint definitions are imported.
DefineSegment *bool `type:"boolean"`
// (Deprecated) Your AWS account ID, which you assigned to an external ID key
// in an IAM trust policy. Amazon Pinpoint previously used this value to assume
// an IAM role when importing endpoint definitions, but we removed this requirement.
// We don't recommend use of external IDs for IAM roles that are assumed by
// Amazon Pinpoint.
ExternalId *string `type:"string"`
// The format of the files that contain the endpoint definitions to import.
// Valid values are: CSV, for comma-separated values format; and, JSON, for
// newline-delimited JSON format.
//
// If the files are stored in an Amazon S3 location and that location contains
// multiple files that use different formats, Amazon Pinpoint imports data only
// from the files that use the specified format.
//
// Format is a required field
Format *string `type:"string" required:"true" enum:"Format"`
// Specifies whether the import job registers the endpoints with Amazon Pinpoint,
// when the endpoint definitions are imported.
RegisterEndpoints *bool `type:"boolean"`
// The Amazon Resource Name (ARN) of the AWS Identity and Access Management
// (IAM) role that authorizes Amazon Pinpoint to access the Amazon S3 location
// to import endpoint definitions from.
//
// RoleArn is a required field
RoleArn *string `type:"string" required:"true"`
// The URL of the Amazon Simple Storage Service (Amazon S3) bucket that contains
// the endpoint definitions to import. This location can be a folder or a single
// file. If the location is a folder, Amazon Pinpoint imports endpoint definitions
// from the files in this location, including any subfolders that the folder
// contains.
//
// The URL should be in the following format: s3://bucket-name/folder-name/file-name.
// The location can end with the key for an individual object or a prefix that
// qualifies multiple objects.
//
// S3Url is a required field
S3Url *string `type:"string" required:"true"`
// The identifier for the segment that the import job updates or adds endpoint
// definitions to, if the import job updates an existing segment.
SegmentId *string `type:"string"`
// The custom name for the segment that's created by the import job, if the
// value of the DefineSegment property is true.
SegmentName *string `type:"string"`
// contains filtered or unexported fields
}
Provides information about the resource settings for a job that imports endpoint definitions from one or more files. The files can be stored in an Amazon Simple Storage Service (Amazon S3) bucket or uploaded directly from a computer by using the Amazon Pinpoint console.
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 identifier for the application that's associated with the import
// job.
//
// ApplicationId is a required field
ApplicationId *string `type:"string" required:"true"`
// The number of pieces that were processed successfully (completed) by the
// import job, as of the time of the request.
CompletedPieces *int64 `type:"integer"`
// The date, in ISO 8601 format, when the import job was completed.
CompletionDate *string `type:"string"`
// The date, in ISO 8601 format, when the import job was created.
//
// CreationDate is a required field
CreationDate *string `type:"string" required:"true"`
// The resource settings that apply to the import job.
//
// Definition is a required field
Definition *ImportJobResource `type:"structure" required:"true"`
// The number of pieces that weren't processed successfully (failed) by the
// import job, as of the time of the request.
FailedPieces *int64 `type:"integer"`
// An array of entries, one for each of the first 100 entries that weren't processed
// successfully (failed) by the import job, if any.
Failures []*string `type:"list"`
// The unique identifier for the import job.
//
// Id is a required field
Id *string `type:"string" required:"true"`
// The status of the import job. The job status is FAILED if Amazon Pinpoint
// wasn't able to process one or more pieces in the job.
//
// JobStatus is a required field
JobStatus *string `type:"string" required:"true" enum:"JobStatus"`
// The total number of endpoint definitions that weren't processed successfully
// (failed) by the import job, typically because an error, such as a syntax
// error, occurred.
TotalFailures *int64 `type:"integer"`
// The total number of pieces that must be processed to complete the import
// job. Each piece consists of an approximately equal portion of the endpoint
// definitions that are part of the import job.
TotalPieces *int64 `type:"integer"`
// The total number of endpoint definitions that were processed by the import
// job.
TotalProcessed *int64 `type:"integer"`
// The job type. This value is IMPORT for import jobs.
//
// Type is a required field
Type *string `type:"string" required:"true"`
// contains filtered or unexported fields
}
Provides information about the status and settings of a job that imports endpoint definitions from one or more files. The files can be stored in an Amazon Simple Storage Service (Amazon S3) bucket or uploaded directly from a computer by using the Amazon Pinpoint console.
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 {
// An array of responses, one for each import job that's associated with the
// application (Import Jobs resource) or segment (Segment Import Jobs resource).
//
// Item is a required field
Item []*ImportJobResponse `type:"list" required:"true"`
// The string to use in a subsequent request to get the next page of results
// in a paginated response. This value is null if there are no additional pages.
NextToken *string `type:"string"`
// contains filtered or unexported fields
}
Provides information about the status and settings of all the import jobs that are associated with an application or segment. An import job is a job that imports endpoint definitions from one or more files.
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 that was received after the endpoint data was accepted.
EndpointItemResponse *EndpointItemResponse `type:"structure"`
// A multipart response object that contains a key and a value for each event
// 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
}
Provides information about the results of a request to create or update an endpoint that's associated with an event.
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 {
// Specifies the tags (keys and values) for an application, campaign, or segment.
//
// 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 to occur if a recipient taps the push notification. Valid values
// are:
//
// * OPEN_APP - Your app opens or it becomes the foreground app if it was
// sent to the background. This is the default action.
//
// * DEEP_LINK - Your app opens and displays a designated user interface
// in the app. This setting uses the deep-linking features of iOS and Android.
//
// * URL - The default mobile browser on the recipient's device opens and
// loads the web page at a URL that you specify.
Action *string `type:"string" enum:"Action"`
// The body of the notification message. The maximum number of characters is
// 200.
Body *string `type:"string"`
// The URL of the image to display as the push-notification icon, such as the
// icon for the app.
ImageIconUrl *string `type:"string"`
// The URL of the image to display as the small, push-notification icon, such
// as a small version of the icon for the app.
ImageSmallIconUrl *string `type:"string"`
// The URL of an image to display in the push notification.
ImageUrl *string `type:"string"`
// The JSON payload to use for a silent push notification.
JsonBody *string `type:"string"`
// The URL of the image or video to display in the push notification.
MediaUrl *string `type:"string"`
// The raw, JSON-formatted string to use as the payload for the notification
// message. This value overrides other values for the message.
RawContent *string `type:"string"`
// Specifies whether the notification is a silent push notification, which is
// a push notification that doesn't display on a recipient's device. Silent
// push notifications can be used for cases such as updating an app's configuration,
// displaying messages in an in-app message center, or supporting phone home
// functionality.
SilentPush *bool `type:"boolean"`
// The number of seconds that the push-notification service should keep the
// message, if the service is unable to deliver the notification the first time.
// This value is converted to an expiration value when it's sent to a push-notification
// service. If this value is 0, the service treats the notification as if it
// expires immediately and the service doesn't store or try to deliver the notification
// again.
//
// This value doesn't apply to messages that are sent through the Amazon Device
// Messaging (ADM) service.
TimeToLive *int64 `type:"integer"`
// The title to display above the notification message on a recipient's device.
Title *string `type:"string"`
// The URL to open in a recipient's default mobile browser, if a recipient taps
// the push notification and the value of the Action property is URL.
Url *string `type:"string"`
// contains filtered or unexported fields
}
Specifies the content and settings for a push notification that's sent to recipients of a campaign.
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 message that's returned from the API.
Message *string `type:"string"`
// The unique identifier for the request or response.
RequestID *string `type:"string"`
// contains filtered or unexported fields
}
Provides information about an API request or response.
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 sends through the ADM (Amazon Device Messaging)
// channel. This message overrides the default message.
ADMMessage *Message `type:"structure"`
// The message that the campaign sends through the APNs (Apple Push Notification
// service) channel. This message overrides the default message.
APNSMessage *Message `type:"structure"`
// The message that the campaign sends through the Baidu (Baidu Cloud Push)
// channel. This message overrides the default message.
BaiduMessage *Message `type:"structure"`
// The default message that the campaign sends through all the channels that
// are configured for the campaign.
DefaultMessage *Message `type:"structure"`
// The message that the campaign sends through the email channel.
EmailMessage *CampaignEmailMessage `type:"structure"`
// The message that the campaign sends through the GCM channel, which enables
// Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging
// (FCM), formerly Google Cloud Messaging (GCM), service. This message overrides
// the default message.
GCMMessage *Message `type:"structure"`
// The message that the campaign sends through the SMS channel.
SMSMessage *CampaignSmsMessage `type:"structure"`
// contains filtered or unexported fields
}
Specifies the message configuration settings 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
func (s *MessageConfiguration) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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. You can use an AddressConfiguration
// object to tailor the message for an address by specifying settings such as
// content overrides and message variables.
Addresses map[string]*AddressConfiguration `type:"map"`
// A map of custom attributes to attach to the message. For a push notification,
// this payload is added to the data.pinpoint object. For an email or text message,
// this payload is added to 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. You can use an EndpointSendConfiguration
// object to tailor the message for an endpoint by specifying settings such
// as content overrides and message variables.
Endpoints map[string]*EndpointSendConfiguration `type:"map"`
// The set of properties that defines the configuration settings for the message.
//
// MessageConfiguration is a required field
MessageConfiguration *DirectMessageConfiguration `type:"structure" required:"true"`
// The unique identifier for tracing the message. This identifier is visible
// to message recipients.
TraceId *string `type:"string"`
// contains filtered or unexported fields
}
Specifies the objects that define configuration and other settings for a message.
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
func (s *MessageRequest) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type MessageResponse struct {
// The unique identifier for the application that was used to send the message.
//
// ApplicationId is a required field
ApplicationId *string `type:"string" required:"true"`
// A map that contains a multipart response for each address that the message
// was sent to. In the map, the endpoint ID is the key and the result is the
// value.
EndpointResult map[string]*EndpointMessageResult `type:"map"`
// The identifier for the original request that the message was delivered for.
RequestId *string `type:"string"`
// A map that contains a multipart response for each address (email address,
// phone number, or push notification token) that the message was sent to. In
// the map, the address is the key and the result is the value.
Result map[string]*MessageResult `type:"map"`
// contains filtered or unexported fields
}
Provides information about the results of a request to send a message to an endpoint address.
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 are:
//
// * DUPLICATE - The endpoint address is a duplicate of another endpoint
// address. Amazon Pinpoint won't attempt to send the message again.
//
// * OPT_OUT - The user who's associated with the endpoint address has opted
// out of receiving messages from you. Amazon Pinpoint won't attempt to send
// the message again.
//
// * PERMANENT_FAILURE - An error occurred when delivering the message to
// the endpoint address. Amazon Pinpoint won't attempt to send the message
// again.
//
// * SUCCESSFUL - The message was successfully delivered to the endpoint
// address.
//
// * TEMPORARY_FAILURE - A temporary error occurred. Amazon Pinpoint will
// attempt to deliver the message again later.
//
// * THROTTLED - Amazon Pinpoint throttled the operation to send the message
// to the endpoint address.
//
// * TIMEOUT - The message couldn't be sent within the timeout period.
//
// * UNKNOWN_FAILURE - An unknown error occurred.
//
// DeliveryStatus is a required field
DeliveryStatus *string `type:"string" required:"true" enum:"DeliveryStatus"`
// The unique identifier for the message that was sent.
MessageId *string `type:"string"`
// The downstream service status code for delivering the message.
//
// StatusCode is a required field
StatusCode *int64 `type:"integer" required:"true"`
// The status message for delivering the message.
StatusMessage *string `type:"string"`
// For push notifications that are sent through the GCM channel, specifies whether
// the token was updated as part of delivering the message.
UpdatedToken *string `type:"string"`
// contains filtered or unexported fields
}
Provides information about the results of sending a message directly to an endpoint 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 to use when comparing metric values. Valid values are: GREATER_THAN,
// LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.
//
// ComparisonOperator is a required field
ComparisonOperator *string `type:"string" required:"true"`
// The value to compare.
//
// Value is a required field
Value *float64 `type:"double" required:"true"`
// contains filtered or unexported fields
}
Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.
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
func (s *MetricDimension) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type NumberValidateRequest struct {
// The two-character code, in ISO 3166-1 alpha-2 format, for the country or
// region where the phone number was originally registered.
IsoCountryCode *string `type:"string"`
// The phone number to retrieve information about. The phone number that you
// provide should include a valid numeric country code. Otherwise, the operation
// might result in an error.
PhoneNumber *string `type:"string"`
// contains filtered or unexported fields
}
Specifies a phone number to validate and retrieve information about.
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 service provider that the phone number is currently registered
// with. In some countries and regions, this value may be the carrier or service
// provider that the phone number was originally registered with.
Carrier *string `type:"string"`
// The name of the city where the phone number was originally registered.
City *string `type:"string"`
// The cleansed phone number, in E.164 format, for the location where the phone
// number was originally registered.
CleansedPhoneNumberE164 *string `type:"string"`
// The cleansed phone number, in the format for the location where the phone
// number was originally registered.
CleansedPhoneNumberNational *string `type:"string"`
// The name of the country or region where the phone number was originally registered.
Country *string `type:"string"`
// The two-character code, in ISO 3166-1 alpha-2 format, 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 name of the county where the phone number was originally registered.
County *string `type:"string"`
// The two-character code, in ISO 3166-1 alpha-2 format, that was sent in the
// request body.
OriginalCountryCodeIso2 *string `type:"string"`
// The phone number that was sent in the request body.
OriginalPhoneNumber *string `type:"string"`
// The description of the phone type. Valid values are: MOBILE, LANDLINE, VOIP,
// INVALID, PREPAID, and OTHER.
PhoneType *string `type:"string"`
// The phone type, represented by an integer. Valid values are: 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 or ZIP code for the location where the phone number was originally
// registered.
ZipCode *string `type:"string"`
// contains filtered or unexported fields
}
Provides information about a phone number.
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 {
// Specifies a phone number to validate and retrieve information about.
//
// 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 {
// Provides information about a phone number.
//
// 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 an application.
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" Provides information about an API request or response. * ErrCodeInternalServerErrorException "InternalServerErrorException" Provides information about an API request or response. * ErrCodeForbiddenException "ForbiddenException" Provides information about an API request or response. * ErrCodeNotFoundException "NotFoundException" Provides information about an API request or response. * ErrCodeMethodNotAllowedException "MethodNotAllowedException" Provides information about an API request or response. * ErrCodeTooManyRequestsException "TooManyRequestsException" Provides information about an API request or response.
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 a new campaign for an application or updates the settings of an existing campaign for an application.
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" Provides information about an API request or response. * ErrCodeInternalServerErrorException "InternalServerErrorException" Provides information about an API request or response. * ErrCodeForbiddenException "ForbiddenException" Provides information about an API request or response. * ErrCodeNotFoundException "NotFoundException" Provides information about an API request or response. * ErrCodeMethodNotAllowedException "MethodNotAllowedException" Provides information about an API request or response. * ErrCodeTooManyRequestsException "TooManyRequestsException" Provides information about an API request or response.
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 a new export job for an application.
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" Provides information about an API request or response. * ErrCodeInternalServerErrorException "InternalServerErrorException" Provides information about an API request or response. * ErrCodeForbiddenException "ForbiddenException" Provides information about an API request or response. * ErrCodeNotFoundException "NotFoundException" Provides information about an API request or response. * ErrCodeMethodNotAllowedException "MethodNotAllowedException" Provides information about an API request or response. * ErrCodeTooManyRequestsException "TooManyRequestsException" Provides information about an API request or response.
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 a new import job for an application.
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" Provides information about an API request or response. * ErrCodeInternalServerErrorException "InternalServerErrorException" Provides information about an API request or response. * ErrCodeForbiddenException "ForbiddenException" Provides information about an API request or response. * ErrCodeNotFoundException "NotFoundException" Provides information about an API request or response. * ErrCodeMethodNotAllowedException "MethodNotAllowedException" Provides information about an API request or response. * ErrCodeTooManyRequestsException "TooManyRequestsException" Provides information about an API request or response.
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.
Creates a new segment for an application or updates the configuration, dimension, and other settings for an existing segment that's associated with an application.
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" Provides information about an API request or response. * ErrCodeInternalServerErrorException "InternalServerErrorException" Provides information about an API request or response. * ErrCodeForbiddenException "ForbiddenException" Provides information about an API request or response. * ErrCodeNotFoundException "NotFoundException" Provides information about an API request or response. * ErrCodeMethodNotAllowedException "MethodNotAllowedException" Provides information about an API request or response. * ErrCodeTooManyRequestsException "TooManyRequestsException" Provides information about an API request or response.
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.
Disables the ADM channel for an application and deletes any existing settings for the 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" Provides information about an API request or response. * ErrCodeInternalServerErrorExcep