pinpoint

package
v0.24.0 Latest Latest
Warning

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

 Go to latest Published: Jul 22, 2020 License: Apache-2.0 Imports: 9 Imported by: 21

Documentation

Overview

Package pinpoint provides the client and types for making API requests to Amazon Pinpoint.

Doc Engage API - Amazon Pinpoint API

See https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01 for more information on this service.

See pinpoint package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/pinpoint/

Using the Client

To use Amazon Pinpoint with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the Amazon Pinpoint client for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/pinpoint/#New

Index

Constants

View Source 
const (
	ServiceName = "Amazon Pinpoint" // Service's name
	ServiceID   = "Pinpoint"        // Service's identifier
	EndpointsID = "pinpoint"        // Service's Endpoint identifier
)
View Source 
const (

	// ErrCodeBadRequestException for service response error code
	// "BadRequestException".
	//
	// Provides information about an API request or response.
	ErrCodeBadRequestException = "BadRequestException"

	// ErrCodeForbiddenException for service response error code
	// "ForbiddenException".
	//
	// Provides information about an API request or response.
	ErrCodeForbiddenException = "ForbiddenException"

	// ErrCodeInternalServerErrorException for service response error code
	// "InternalServerErrorException".
	//
	// Provides information about an API request or response.
	ErrCodeInternalServerErrorException = "InternalServerErrorException"

	// ErrCodeMethodNotAllowedException for service response error code
	// "MethodNotAllowedException".
	//
	// Provides information about an API request or response.
	ErrCodeMethodNotAllowedException = "MethodNotAllowedException"

	// ErrCodeNotFoundException for service response error code
	// "NotFoundException".
	//
	// Provides information about an API request or response.
	ErrCodeNotFoundException = "NotFoundException"

	// ErrCodePayloadTooLargeException for service response error code
	// "PayloadTooLargeException".
	//
	// Provides information about an API request or response.
	ErrCodePayloadTooLargeException = "PayloadTooLargeException"

	// ErrCodeTooManyRequestsException for service response error code
	// "TooManyRequestsException".
	//
	// Provides information about an API request or response.
	ErrCodeTooManyRequestsException = "TooManyRequestsException"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type ADMChannelRequest 

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 (ADMChannelRequest) MarshalFields added in v0.3.0 

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

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

func (ADMChannelRequest) String 

func (s ADMChannelRequest) String() string

String returns the string representation

func (*ADMChannelRequest) Validate added in v0.10.0 

func (s *ADMChannelRequest) Validate() error

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

type ADMChannelResponse 

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 (ADMChannelResponse) MarshalFields added in v0.3.0 

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

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

func (ADMChannelResponse) String 

func (s ADMChannelResponse) String() string

String returns the string representation

type ADMMessage 

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 Action `type:"string" enum:"true"`

	// 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. If specified, this value overrides all other content 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
	// 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 (ADMMessage) MarshalFields added in v0.3.0 

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

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

func (ADMMessage) String 

func (s ADMMessage) String() string

String returns the string representation

type APNSChannelRequest 

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 (APNSChannelRequest) MarshalFields added in v0.3.0 

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

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

func (APNSChannelRequest) String 

func (s APNSChannelRequest) String() string

String returns the string representation

type APNSChannelResponse 

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 (APNSChannelResponse) MarshalFields added in v0.3.0 

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

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

func (APNSChannelResponse) String 

func (s APNSChannelResponse) String() string

String returns the string representation

type APNSMessage 

type APNSMessage struct {

	// The type of push notification to send. Valid values are:
	//
	//    * alert - For a standard notification that's displayed on recipients'
	//    devices and prompts a recipient to interact with the notification.
	//
	//    * background - For a silent notification that delivers content in the
	//    background and isn't displayed on recipients' devices.
	//
	//    * complication - For a notification that contains update information for
	//    an app’s complication timeline.
	//
	//    * fileprovider - For a notification that signals changes to a File Provider
	//    extension.
	//
	//    * mdm - For a notification that tells managed devices to contact the MDM
	//    server.
	//
	//    * voip - For a notification that provides information about an incoming
	//    VoIP call.
	//
	// Amazon Pinpoint specifies this value in the apns-push-type request header
	// when it sends the notification message to APNs. If you don't specify a value
	// for this property, Amazon Pinpoint sets the value to alert or background
	// automatically, based on the value that you specify for the SilentPush or
	// RawContent property of the message.
	//
	// For more information about the apns-push-type request header, see Sending
	// Notification Requests to APNs (https://developer.apple.com/documentation/usernotifications/setting_up_a_remote_notification_server/sending_notification_requests_to_apns)
	// on the Apple Developer website.
	APNSPushType *string `type:"string"`

	// 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 Action `type:"string" enum:"true"`

	// 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 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. If specified, this value overrides all other content for the message.
	//
	// If you specify the raw content of an APNs push notification, the message
	// payload has to include the content-available key. The value of the content-available
	// key has to be an integer, and can only be 0 or 1. If you're sending a standard
	// notification, set the value of content-available to 0. If you're sending
	// a silent (background) notification, set the value of content-available to
	// 1. Additionally, silent notification payloads can't include the alert, badge,
	// or sound keys. For more information, see Generating a Remote Notification
	// (https://developer.apple.com/documentation/usernotifications/setting_up_a_remote_notification_server/generating_a_remote_notification)
	// and Pushing Background Updates to Your App (https://developer.apple.com/documentation/usernotifications/setting_up_a_remote_notification_server/pushing_background_updates_to_your_app)
	// on the Apple Developer website.
	RawContent *string `type:"string"`

	// Specifies whether the notification is a silent push notification. A silent
	// (or background) push notification isn't displayed on recipients' devices.
	// You can use silent push notifications to make small updates to your app,
	// or to display messages in an in-app message center.
	//
	// Amazon Pinpoint uses this property to determine the correct value for the
	// apns-push-type request header when it sends the notification message to APNs.
	// If you specify a value of true for this property, Amazon Pinpoint sets the
	// value for the apns-push-type header field to background.
	//
	// If you specify the raw content of an APNs push notification, the message
	// payload has to include the content-available key. For silent (background)
	// notifications, set the value of content-available to 1. Additionally, the
	// message payload for a silent notification can't include the alert, badge,
	// or sound keys. For more information, see Generating a Remote Notification
	// (https://developer.apple.com/documentation/usernotifications/setting_up_a_remote_notification_server/generating_a_remote_notification)
	// and Pushing Background Updates to Your App (https://developer.apple.com/documentation/usernotifications/setting_up_a_remote_notification_server/pushing_background_updates_to_your_app)
	// on the Apple Developer website.
	//
	// Apple has indicated that they will throttle "excessive" background notifications
	// based on current traffic volumes. To prevent your notifications being throttled,
	// Apple recommends that you send no more than 3 silent push notifications to
	// each recipient per hour.
	SilentPush *bool `type:"boolean"`

	// The key for the sound to play when the recipient receives the push notification.
	// The value for 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 (APNSMessage) MarshalFields added in v0.3.0 

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

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

func (APNSMessage) String 

func (s APNSMessage) String() string

String returns the string representation

type APNSPushNotificationTemplate added in v0.14.0 

type APNSPushNotificationTemplate struct {

	// The action to occur if a recipient taps a push notification that's based
	// on the message template. 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 Action `type:"string" enum:"true"`

	// The message body to use in push notifications that are based on the message
	// template.
	Body *string `type:"string"`

	// The URL of an image or video to display in push notifications that are based
	// on the message template.
	MediaUrl *string `type:"string"`

	// The raw, JSON-formatted string to use as the payload for push notifications
	// that are based on the message template. If specified, this value overrides
	// all other content for the message template.
	RawContent *string `type:"string"`

	// The key for the sound to play when the recipient receives a push notification
	// that's based on the message template. The value for 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 title to use in push notifications that are based on the message template.
	// This title appears above the notification message on a recipient's device.
	Title *string `type:"string"`

	// The URL to open in the recipient's default mobile browser, if a recipient
	// taps a push notification that's based on the message template and the value
	// of the Action property is URL.
	Url *string `type:"string"`
	// contains filtered or unexported fields
}

Specifies channel-specific content and settings for a message template that can be used in push notifications that are sent through the APNs (Apple Push Notification service) channel.

func (APNSPushNotificationTemplate) MarshalFields added in v0.14.0 

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

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

func (APNSPushNotificationTemplate) String added in v0.14.0 

func (s APNSPushNotificationTemplate) String() string

String returns the string representation

type APNSSandboxChannelRequest 

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 (APNSSandboxChannelRequest) MarshalFields added in v0.3.0 

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

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

func (APNSSandboxChannelRequest) String 

func (s APNSSandboxChannelRequest) String() string

String returns the string representation

type APNSSandboxChannelResponse 

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 (APNSSandboxChannelResponse) MarshalFields added in v0.3.0 

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

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

func (APNSSandboxChannelResponse) String 

func (s APNSSandboxChannelResponse) String() string

String returns the string representation

type APNSVoipChannelRequest added in v0.2.0 

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 (APNSVoipChannelRequest) MarshalFields added in v0.3.0 

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

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

func (APNSVoipChannelRequest) String added in v0.2.0 

func (s APNSVoipChannelRequest) String() string

String returns the string representation

type APNSVoipChannelResponse added in v0.2.0 

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 (APNSVoipChannelResponse) MarshalFields added in v0.3.0 

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

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

func (APNSVoipChannelResponse) String added in v0.2.0 

func (s APNSVoipChannelResponse) String() string

String returns the string representation

type APNSVoipSandboxChannelRequest added in v0.2.0 

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 (APNSVoipSandboxChannelRequest) MarshalFields added in v0.3.0 

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

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

func (APNSVoipSandboxChannelRequest) String added in v0.2.0 

func (s APNSVoipSandboxChannelRequest) String() string

String returns the string representation

type APNSVoipSandboxChannelResponse added in v0.2.0 

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 (APNSVoipSandboxChannelResponse) MarshalFields added in v0.3.0 

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

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

func (APNSVoipSandboxChannelResponse) String added in v0.2.0 

func (s APNSVoipSandboxChannelResponse) String() string

String returns the string representation

type Action 

type Action string
const (
	ActionOpenApp  Action = "OPEN_APP"
	ActionDeepLink Action = "DEEP_LINK"
	ActionUrl      Action = "URL"
)

Enum values for Action

func (Action) MarshalValue added in v0.3.0 

func (enum Action) MarshalValue() (string, error)

func (Action) MarshalValueBuf added in v0.3.0 

func (enum Action) MarshalValueBuf(b []byte) ([]byte, error)

type ActivitiesResponse 

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 (ActivitiesResponse) MarshalFields added in v0.3.0 

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

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

func (ActivitiesResponse) String 

func (s ActivitiesResponse) String() string

String returns the string representation

type Activity added in v0.16.0 

type Activity struct {

	// The settings for a custom message activity. This type of activity calls an
	// AWS Lambda function or web hook that sends messages to participants.
	CUSTOM *CustomMessageActivity `type:"structure"`

	// The settings for a yes/no split activity. This type of activity sends participants
	// down one of two paths in a journey, based on conditions that you specify.
	ConditionalSplit *ConditionalSplitActivity `type:"structure"`

	// The custom description of the activity.
	Description *string `type:"string"`

	// The settings for an email activity. This type of activity sends an email
	// message to participants.
	EMAIL *EmailMessageActivity `type:"structure"`

	// The settings for a holdout activity. This type of activity stops a journey
	// for a specified percentage of participants.
	Holdout *HoldoutActivity `type:"structure"`

	// The settings for a multivariate split activity. This type of activity sends
	// participants down one of as many as five paths (including a default Else
	// path) in a journey, based on conditions that you specify.
	MultiCondition *MultiConditionalSplitActivity `type:"structure"`

	// The settings for a push notification activity. This type of activity sends
	// a push notification to participants.
	PUSH *PushMessageActivity `type:"structure"`

	// The settings for a random split activity. This type of activity randomly
	// sends specified percentages of participants down one of as many as five paths
	// in a journey, based on conditions that you specify.
	RandomSplit *RandomSplitActivity `type:"structure"`

	// The settings for an SMS activity. This type of activity sends a text message
	// to participants.
	SMS *SMSMessageActivity `type:"structure"`

	// The settings for a wait activity. This type of activity waits for a certain
	// amount of time or until a specific date and time before moving participants
	// to the next activity in a journey.
	Wait *WaitActivity `type:"structure"`
	// contains filtered or unexported fields
}

Specifies the configuration and other settings for an activity in a journey.

func (Activity) MarshalFields added in v0.16.0 

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

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

func (Activity) String added in v0.16.0 

func (s Activity) String() string

String returns the string representation

func (*Activity) Validate added in v0.16.0 

func (s *Activity) Validate() error

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

type ActivityResponse 

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 current status 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 (ActivityResponse) MarshalFields added in v0.3.0 

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

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

func (ActivityResponse) String 

func (s ActivityResponse) String() string

String returns the string representation

type AddressConfiguration 

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 ChannelType `type:"string" enum:"true"`

	// An object that maps custom attributes to attributes for the address and is
	// attached to the message. Attribute names are case sensitive.
	//
	// 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 all other values for the message.
	RawContent *string `type:"string"`

	// A map of the message variables to merge with the variables specified by properties
	// of the DefaultMessage object. The variables specified in this map take precedence
	// over all other variables.
	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 (AddressConfiguration) MarshalFields added in v0.3.0 

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

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

func (AddressConfiguration) String 

func (s AddressConfiguration) String() string

String returns the string representation

type AndroidPushNotificationTemplate added in v0.14.0 

type AndroidPushNotificationTemplate struct {

	// The action to occur if a recipient taps a push notification that's based
	// on the message template. 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 Action `type:"string" enum:"true"`

	// The message body to use in a push notification that's based on the message
	// template.
	Body *string `type:"string"`

	// The URL of the large icon image to display in the content view of a push
	// notification that's based on the message template.
	ImageIconUrl *string `type:"string"`

	// The URL of an image to display in a push notification that's based on the
	// message template.
	ImageUrl *string `type:"string"`

	// The raw, JSON-formatted string to use as the payload for a push notification
	// that's based on the message template. If specified, this value overrides
	// all other content for the message template.
	RawContent *string `type:"string"`

	// The URL of the small icon image to display in the status bar and the content
	// view of a push notification that's based on the message template.
	SmallImageIconUrl *string `type:"string"`

	// The sound to play when a recipient receives a push notification that's based
	// on the message template. 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 title to use in a push notification that's based on the message template.
	// This title appears 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
	// a push notification that's based on the message template and the value of
	// the Action property is URL.
	Url *string `type:"string"`
	// contains filtered or unexported fields
}

Specifies channel-specific content and settings for a message template that can be used in push notifications that are sent through the ADM (Amazon Device Messaging), Baidu (Baidu Cloud Push), or GCM (Firebase Cloud Messaging, formerly Google Cloud Messaging) channel.

func (AndroidPushNotificationTemplate) MarshalFields added in v0.14.0 

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

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

func (AndroidPushNotificationTemplate) String added in v0.14.0 

func (s AndroidPushNotificationTemplate) String() string

String returns the string representation

type ApplicationDateRangeKpiResponse added in v0.10.0 

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 possible values, see the
	// Amazon Pinpoint Developer Guide (https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.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 Application Metrics resource
	// because the 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 (ApplicationDateRangeKpiResponse) MarshalFields added in v0.10.0 

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

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

func (ApplicationDateRangeKpiResponse) String added in v0.10.0 

func (s ApplicationDateRangeKpiResponse) String() string

String returns the string representation

type ApplicationResponse 

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 (ApplicationResponse) MarshalFields added in v0.3.0 

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

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

func (ApplicationResponse) String 

func (s ApplicationResponse) String() string

String returns the string representation

type ApplicationSettingsResource 

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 invoke by default as a code hook
	// for campaigns in the application. You can use this hook to customize segments
	// that are used by 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 and journeys in the application.
	Limits *CampaignLimits `type:"structure"`

	// The default quiet time for campaigns and journeys in the application. Quiet
	// time is a specific time range when messages aren't sent 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 or journey 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 or journey that has custom quiet time settings).
	//
	// If any of the preceding conditions isn't met, the endpoint will receive messages
	// from a campaign or journey, 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 (ApplicationSettingsResource) MarshalFields added in v0.3.0 

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

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

func (ApplicationSettingsResource) String 

func (s ApplicationSettingsResource) String() string

String returns the string representation

type ApplicationsResponse 

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 (ApplicationsResponse) MarshalFields added in v0.3.0 

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

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

func (ApplicationsResponse) String 

func (s ApplicationsResponse) String() string

String returns the string representation

type AttributeDimension 

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 AttributeType `type:"string" enum:"true"`

	// 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 (AttributeDimension) MarshalFields added in v0.3.0 

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

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

func (AttributeDimension) String 

func (s AttributeDimension) String() string

String returns the string representation

func (*AttributeDimension) Validate added in v0.10.0 

func (s *AttributeDimension) Validate() error

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

type AttributeType 

type AttributeType string
const (
	AttributeTypeInclusive AttributeType = "INCLUSIVE"
	AttributeTypeExclusive AttributeType = "EXCLUSIVE"
)

Enum values for AttributeType

func (AttributeType) MarshalValue added in v0.3.0 

func (enum AttributeType) MarshalValue() (string, error)

func (AttributeType) MarshalValueBuf added in v0.3.0 

func (enum AttributeType) MarshalValueBuf(b []byte) ([]byte, error)

type AttributesResource added in v0.5.0 

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-metric-attributes - 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 (AttributesResource) MarshalFields added in v0.5.0 

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

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

func (AttributesResource) String added in v0.5.0 

func (s AttributesResource) String() string

String returns the string representation

type BaiduChannelRequest 

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 (BaiduChannelRequest) MarshalFields added in v0.3.0 

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

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

func (BaiduChannelRequest) String 

func (s BaiduChannelRequest) String() string

String returns the string representation

func (*BaiduChannelRequest) Validate added in v0.10.0 

func (s *BaiduChannelRequest) Validate() error

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

type BaiduChannelResponse 

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 (BaiduChannelResponse) MarshalFields added in v0.3.0 

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

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

func (BaiduChannelResponse) String 

func (s BaiduChannelResponse) String() string

String returns the string representation

type BaiduMessage 

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 Action `type:"string" enum:"true"`

	// 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. If specified, this value overrides all other content 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
	// 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 (BaiduMessage) MarshalFields added in v0.3.0 

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

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

func (BaiduMessage) String 

func (s BaiduMessage) String() string

String returns the string representation

type BaseKpiResult added in v0.10.0 

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, campaign, or journey.
	//
	// 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, campaign, or journey.

func (BaseKpiResult) MarshalFields added in v0.10.0 

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

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

func (BaseKpiResult) String added in v0.10.0 

func (s BaseKpiResult) String() string

String returns the string representation

type CampaignCustomMessage added in v0.22.0 

type CampaignCustomMessage struct {

	// The raw, JSON-formatted string to use as the payload for the message. The
	// maximum size is 5 KB.
	Data *string `type:"string"`
	// contains filtered or unexported fields
}

Specifies the contents of a message that's sent through a custom channel to recipients of a campaign.

func (CampaignCustomMessage) MarshalFields added in v0.22.0 

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

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

func (CampaignCustomMessage) String added in v0.22.0 

func (s CampaignCustomMessage) String() string

String returns the string representation

type CampaignDateRangeKpiResponse added in v0.10.0 

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 possible values, see the
	// Amazon Pinpoint Developer Guide (https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.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
	// because the 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 (CampaignDateRangeKpiResponse) MarshalFields added in v0.10.0 

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

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

func (CampaignDateRangeKpiResponse) String added in v0.10.0 

func (s CampaignDateRangeKpiResponse) String() string

String returns the string representation

type CampaignEmailMessage 

type CampaignEmailMessage struct {

	// The body of the email for recipients whose email clients don't render 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
	// render HTML content.
	HtmlBody *string `type:"string"`

	// The subject line, or title, of the email.
	Title *string `type:"string"`
	// contains filtered or unexported fields
}

Specifies the content and "From" address for an email message that's sent to recipients of a campaign.

func (CampaignEmailMessage) MarshalFields added in v0.3.0 

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

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

func (CampaignEmailMessage) String 

func (s CampaignEmailMessage) String() string

String returns the string representation

type CampaignEventFilter added in v0.6.0 

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 FilterType `type:"string" required:"true" enum:"true"`
	// contains filtered or unexported fields
}

Specifies the settings for events that cause a campaign to be sent.

func (CampaignEventFilter) MarshalFields added in v0.6.0 

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

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

func (CampaignEventFilter) String added in v0.6.0 

func (s CampaignEventFilter) String() string

String returns the string representation

func (*CampaignEventFilter) Validate added in v0.10.0 

func (s *CampaignEventFilter) Validate() error

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

type CampaignHook added in v0.4.0 

type CampaignHook struct {

	// The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon
	// Pinpoint invokes to customize a segment for a campaign.
	LambdaFunctionName *string `type:"string"`

	// The mode that Amazon Pinpoint uses to invoke the AWS Lambda function. Possible
	// values are:
	//
	//    * FILTER - Invoke the function to customize the segment that's used by
	//    a campaign.
	//
	//    * DELIVERY - (Deprecated) Previously, invoked the function to send a campaign
	//    through a custom channel. This functionality is not supported anymore.
	//    To send a campaign through a custom channel, use the CustomDeliveryConfiguration
	//    and CampaignCustomMessage objects of the campaign.
	Mode Mode `type:"string" enum:"true"`

	// 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 settings for invoking an AWS Lambda function that customizes a segment for a campaign.

func (CampaignHook) MarshalFields added in v0.4.0 

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

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

func (CampaignHook) String added in v0.4.0 

func (s CampaignHook) String() string

String returns the string representation

type CampaignLimits 

type CampaignLimits struct {

	// The maximum number of messages that a campaign can send to a single endpoint
	// during a 24-hour period. For an application, this value specifies the default
	// limit for the number of messages that campaigns and journeys 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. For
	// an application, this value specifies the default limit for the number of
	// messages that campaigns and journeys 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. If a campaign recurs, this setting applies
	// to all runs of the campaign. The maximum value is 100.
	Total *int64 `type:"integer"`
	// contains filtered or unexported fields
}

For a campaign, specifies limits on the messages that the campaign can send. For an application, specifies the default limits for messages that campaigns and journeys in the application can send.

func (CampaignLimits) MarshalFields added in v0.3.0 

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

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

func (CampaignLimits) String 

func (s CampaignLimits) String() string

String returns the string representation

type CampaignResponse 

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, in ISO 8601 format, when the campaign was created.
	//
	// CreationDate is a required field
	CreationDate *string `type:"string" required:"true"`

	// The delivery configuration settings for sending the campaign through a custom
	// channel.
	CustomDeliveryConfiguration *CustomDeliveryConfiguration `type:"structure"`

	// The current status of the campaign's default treatment. This value exists
	// only for campaigns that have more than one treatment.
	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.
	// You can use this hook to customize the segment that's used by 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 message template that’s used for the campaign.
	TemplateConfiguration *TemplateConfiguration `type:"structure"`

	// The custom description of the default treatment for the campaign.
	TreatmentDescription *string `type:"string"`

	// The custom name of the default treatment for the campaign, if the campaign
	// has multiple treatments. A treatment is a variation of a 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 (CampaignResponse) MarshalFields added in v0.3.0 

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

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

func (CampaignResponse) String 

func (s CampaignResponse) String() string

String returns the string representation

type CampaignSmsMessage 

type CampaignSmsMessage struct {

	// The body of the SMS message.
	Body *string `type:"string"`

	// The SMS message type. Valid values are TRANSACTIONAL (for messages that are
	// critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL
	// (for messsages that aren't critical or time-sensitive, such as marketing
	// messages).
	MessageType MessageType `type:"string" enum:"true"`

	// 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 (CampaignSmsMessage) MarshalFields added in v0.3.0 

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

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

func (CampaignSmsMessage) String 

func (s CampaignSmsMessage) String() string

String returns the string representation

type CampaignState 

type CampaignState struct {

	// The current status of the campaign, or the current 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
	// if all campaign treatments have a status of COMPLETED. If you delete the
	// segment that's associated with a campaign, the campaign fails and has a status
	// of DELETED.
	CampaignStatus CampaignStatus `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

Provides information about the status of a campaign.

func (CampaignState) MarshalFields added in v0.3.0 

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

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

func (CampaignState) String 

func (s CampaignState) String() string

String returns the string representation

type CampaignStatus 

type CampaignStatus string
const (
	CampaignStatusScheduled      CampaignStatus = "SCHEDULED"
	CampaignStatusExecuting      CampaignStatus = "EXECUTING"
	CampaignStatusPendingNextRun CampaignStatus = "PENDING_NEXT_RUN"
	CampaignStatusCompleted      CampaignStatus = "COMPLETED"
	CampaignStatusPaused         CampaignStatus = "PAUSED"
	CampaignStatusDeleted        CampaignStatus = "DELETED"
)

Enum values for CampaignStatus

func (CampaignStatus) MarshalValue added in v0.3.0 

func (enum CampaignStatus) MarshalValue() (string, error)

func (CampaignStatus) MarshalValueBuf added in v0.3.0 

func (enum CampaignStatus) MarshalValueBuf(b []byte) ([]byte, error)

type CampaignsResponse 

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 (CampaignsResponse) MarshalFields added in v0.3.0 

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

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

func (CampaignsResponse) String 

func (s CampaignsResponse) String() string

String returns the string representation

type ChannelResponse added in v0.5.0 

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 (ChannelResponse) MarshalFields added in v0.5.0 

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

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

func (ChannelResponse) String added in v0.5.0 

func (s ChannelResponse) String() string

String returns the string representation

type ChannelType 

type ChannelType string
const (
	ChannelTypePush            ChannelType = "PUSH"
	ChannelTypeGcm             ChannelType = "GCM"
	ChannelTypeApns            ChannelType = "APNS"
	ChannelTypeApnsSandbox     ChannelType = "APNS_SANDBOX"
	ChannelTypeApnsVoip        ChannelType = "APNS_VOIP"
	ChannelTypeApnsVoipSandbox ChannelType = "APNS_VOIP_SANDBOX"
	ChannelTypeAdm             ChannelType = "ADM"
	ChannelTypeSms             ChannelType = "SMS"
	ChannelTypeVoice           ChannelType = "VOICE"
	ChannelTypeEmail           ChannelType = "EMAIL"
	ChannelTypeBaidu           ChannelType = "BAIDU"
	ChannelTypeCustom          ChannelType = "CUSTOM"
)

Enum values for ChannelType

func (ChannelType) MarshalValue added in v0.3.0 

func (enum ChannelType) MarshalValue() (string, error)

func (ChannelType) MarshalValueBuf added in v0.3.0 

func (enum ChannelType) MarshalValueBuf(b []byte) ([]byte, error)

type ChannelsResponse added in v0.5.0 

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 (ChannelsResponse) MarshalFields added in v0.5.0 

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

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

func (ChannelsResponse) String added in v0.5.0 

func (s ChannelsResponse) String() string

String returns the string representation

type Client added in v0.9.0 

type Client struct {
	*aws.Client
}

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

The client's methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New 

func New(config aws.Config) *Client

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

Example: 

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

func (*Client) CreateAppRequest added in v0.9.0 

func (c *Client) CreateAppRequest(input *CreateAppInput) CreateAppRequest

CreateAppRequest returns a request value for making API operation for Amazon Pinpoint.

Creates an application. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/CreateApp

func (*Client) CreateCampaignRequest added in v0.9.0 

func (c *Client) CreateCampaignRequest(input *CreateCampaignInput) CreateCampaignRequest

CreateCampaignRequest returns a request value for making API operation for Amazon Pinpoint.

Creates a new campaign for an application or updates the settings of an existing campaign for an application. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/CreateCampaign

func (*Client) CreateEmailTemplateRequest added in v0.14.0 

func (c *Client) CreateEmailTemplateRequest(input *CreateEmailTemplateInput) CreateEmailTemplateRequest

CreateEmailTemplateRequest returns a request value for making API operation for Amazon Pinpoint.

Creates a message template for messages that are sent through the email channel. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/CreateEmailTemplate

func (*Client) CreateExportJobRequest added in v0.9.0 

func (c *Client) CreateExportJobRequest(input *CreateExportJobInput) CreateExportJobRequest

CreateExportJobRequest returns a request value for making API operation for Amazon Pinpoint.

Creates an export job for an application. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/CreateExportJob

func (*Client) CreateImportJobRequest added in v0.9.0 

func (c *Client) CreateImportJobRequest(input *CreateImportJobInput) CreateImportJobRequest

CreateImportJobRequest returns a request value for making API operation for Amazon Pinpoint.

Creates an import job for an application. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/CreateImportJob

func (*Client) CreateJourneyRequest added in v0.16.0 

func (c *Client) CreateJourneyRequest(input *CreateJourneyInput) CreateJourneyRequest

CreateJourneyRequest returns a request value for making API operation for Amazon Pinpoint.

Creates a journey for an application. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/CreateJourney

func (*Client) CreatePushTemplateRequest added in v0.14.0 

func (c *Client) CreatePushTemplateRequest(input *CreatePushTemplateInput) CreatePushTemplateRequest

CreatePushTemplateRequest returns a request value for making API operation for Amazon Pinpoint.

Creates a message template for messages that are sent through a push notification channel. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/CreatePushTemplate

func (*Client) CreateRecommenderConfigurationRequest added in v0.20.0 

func (c *Client) CreateRecommenderConfigurationRequest(input *CreateRecommenderConfigurationInput) CreateRecommenderConfigurationRequest

CreateRecommenderConfigurationRequest returns a request value for making API operation for Amazon Pinpoint.

Creates an Amazon Pinpoint configuration for a recommender model. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/CreateRecommenderConfiguration

func (*Client) CreateSegmentRequest added in v0.9.0 

func (c *Client) CreateSegmentRequest(input *CreateSegmentInput) CreateSegmentRequest

CreateSegmentRequest returns a request value for making 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. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/CreateSegment

func (*Client) CreateSmsTemplateRequest added in v0.14.0 

func (c *Client) CreateSmsTemplateRequest(input *CreateSmsTemplateInput) CreateSmsTemplateRequest

CreateSmsTemplateRequest returns a request value for making API operation for Amazon Pinpoint.

Creates a message template for messages that are sent through the SMS channel. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/CreateSmsTemplate

func (*Client) CreateVoiceTemplateRequest added in v0.17.0 

func (c *Client) CreateVoiceTemplateRequest(input *CreateVoiceTemplateInput) CreateVoiceTemplateRequest

CreateVoiceTemplateRequest returns a request value for making API operation for Amazon Pinpoint.

Creates a message template for messages that are sent through the voice channel. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/CreateVoiceTemplate

func (*Client) DeleteAdmChannelRequest added in v0.9.0 

func (c *Client) DeleteAdmChannelRequest(input *DeleteAdmChannelInput) DeleteAdmChannelRequest

DeleteAdmChannelRequest returns a request value for making API operation for Amazon Pinpoint.

Disables the ADM channel for an application and deletes any existing settings for the channel. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/DeleteAdmChannel

func (*Client) DeleteApnsChannelRequest added in v0.9.0 

func (c *Client) DeleteApnsChannelRequest(input *DeleteApnsChannelInput) DeleteApnsChannelRequest

DeleteApnsChannelRequest returns a request value for making API operation for Amazon Pinpoint.

Disables the APNs channel for an application and deletes any existing settings for the channel. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/DeleteApnsChannel

func (*Client) DeleteApnsSandboxChannelRequest added in v0.9.0 

func (c *Client) DeleteApnsSandboxChannelRequest(input *DeleteApnsSandboxChannelInput) DeleteApnsSandboxChannelRequest

DeleteApnsSandboxChannelRequest returns a request value for making API operation for Amazon Pinpoint.

Disables the APNs sandbox channel for an application and deletes any existing settings for the channel. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/DeleteApnsSandboxChannel

func (*Client) DeleteApnsVoipChannelRequest added in v0.9.0 

func (c *Client) DeleteApnsVoipChannelRequest(input *DeleteApnsVoipChannelInput) DeleteApnsVoipChannelRequest

DeleteApnsVoipChannelRequest returns a request value for making API operation for Amazon Pinpoint.

Disables the APNs VoIP channel for an application and deletes any existing settings for the channel. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/DeleteApnsVoipChannel

func (*Client) DeleteApnsVoipSandboxChannelRequest added in v0.9.0 

func (c *Client) DeleteApnsVoipSandboxChannelRequest(input *DeleteApnsVoipSandboxChannelInput) DeleteApnsVoipSandboxChannelRequest

DeleteApnsVoipSandboxChannelRequest returns a request value for making API operation for Amazon Pinpoint.

Disables the APNs VoIP sandbox channel for an application and deletes any existing settings for the channel. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/DeleteApnsVoipSandboxChannel

func (*Client) DeleteAppRequest added in v0.9.0 

func (c *Client) DeleteAppRequest(input *DeleteAppInput) DeleteAppRequest

DeleteAppRequest returns a request value for making API operation for Amazon Pinpoint.

Deletes an application. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/DeleteApp

func (*Client) DeleteBaiduChannelRequest added in v0.9.0 

func (c *Client) DeleteBaiduChannelRequest(input *DeleteBaiduChannelInput) DeleteBaiduChannelRequest

DeleteBaiduChannelRequest returns a request value for making API operation for Amazon Pinpoint.

Disables the Baidu channel for an application and deletes any existing settings for the channel. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/DeleteBaiduChannel

func (*Client) DeleteCampaignRequest added in v0.9.0 

func (c *Client) DeleteCampaignRequest(input *DeleteCampaignInput) DeleteCampaignRequest

DeleteCampaignRequest returns a request value for making API operation for Amazon Pinpoint.

Deletes a campaign from an application. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/DeleteCampaign

func (*Client) DeleteEmailChannelRequest added in v0.9.0 

func (c *Client) DeleteEmailChannelRequest(input *DeleteEmailChannelInput) DeleteEmailChannelRequest

DeleteEmailChannelRequest returns a request value for making API operation for Amazon Pinpoint.

Disables the email channel for an application and deletes any existing settings for the channel. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/DeleteEmailChannel

func (*Client) DeleteEmailTemplateRequest added in v0.14.0 

func (c *Client) DeleteEmailTemplateRequest(input *DeleteEmailTemplateInput) DeleteEmailTemplateRequest

DeleteEmailTemplateRequest returns a request value for making API operation for Amazon Pinpoint.

Deletes a message template for messages that were sent through the email channel. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/DeleteEmailTemplate

func (*Client) DeleteEndpointRequest added in v0.9.0 

func (c *Client) DeleteEndpointRequest(input *DeleteEndpointInput) DeleteEndpointRequest

DeleteEndpointRequest returns a request value for making API operation for Amazon Pinpoint.

Deletes an endpoint from an application. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/DeleteEndpoint

func (*Client) DeleteEventStreamRequest added in v0.9.0 

func (c *Client) DeleteEventStreamRequest(input *DeleteEventStreamInput) DeleteEventStreamRequest

DeleteEventStreamRequest returns a request value for making API operation for Amazon Pinpoint.

Deletes the event stream for an application. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/DeleteEventStream

func (*Client) DeleteGcmChannelRequest added in v0.9.0 

func (c *Client) DeleteGcmChannelRequest(input *DeleteGcmChannelInput) DeleteGcmChannelRequest

DeleteGcmChannelRequest returns a request value for making API operation for Amazon Pinpoint.

Disables the GCM channel for an application and deletes any existing settings for the channel. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/DeleteGcmChannel

func (*Client) DeleteJourneyRequest added in v0.16.0 

func (c *Client) DeleteJourneyRequest(input *DeleteJourneyInput) DeleteJourneyRequest

DeleteJourneyRequest returns a request value for making API operation for Amazon Pinpoint.

Deletes a journey from an application. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/DeleteJourney

func (*Client) DeletePushTemplateRequest added in v0.14.0 

func (c *Client) DeletePushTemplateRequest(input *DeletePushTemplateInput) DeletePushTemplateRequest

DeletePushTemplateRequest returns a request value for making API operation for Amazon Pinpoint.

Deletes a message template for messages that were sent through a push notification channel. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/DeletePushTemplate

func (*Client) DeleteRecommenderConfigurationRequest added in v0.20.0 

func (c *Client) DeleteRecommenderConfigurationRequest(input *DeleteRecommenderConfigurationInput) DeleteRecommenderConfigurationRequest

DeleteRecommenderConfigurationRequest returns a request value for making API operation for Amazon Pinpoint.

Deletes an Amazon Pinpoint configuration for a recommender model. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/DeleteRecommenderConfiguration

func (*Client) DeleteSegmentRequest added in v0.9.0 

func (c *Client) DeleteSegmentRequest(input *DeleteSegmentInput) DeleteSegmentRequest

DeleteSegmentRequest returns a request value for making API operation for Amazon Pinpoint.

Deletes a segment from an application. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/DeleteSegment

func (*Client) DeleteSmsChannelRequest added in v0.9.0 

func (c *Client) DeleteSmsChannelRequest(input *DeleteSmsChannelInput) DeleteSmsChannelRequest

DeleteSmsChannelRequest returns a request value for making API operation for Amazon Pinpoint.

Disables the SMS channel for an application and deletes any existing settings for the channel. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/DeleteSmsChannel

func (*Client) DeleteSmsTemplateRequest added in v0.14.0 

func (c *Client) DeleteSmsTemplateRequest(input *DeleteSmsTemplateInput) DeleteSmsTemplateRequest

DeleteSmsTemplateRequest returns a request value for making API operation for Amazon Pinpoint.

Deletes a message template for messages that were sent through the SMS channel. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/DeleteSmsTemplate

func (*Client) DeleteUserEndpointsRequest added in v0.9.0 

func (c *Client) DeleteUserEndpointsRequest(input *DeleteUserEndpointsInput) DeleteUserEndpointsRequest

DeleteUserEndpointsRequest returns a request value for making API operation for Amazon Pinpoint.

Deletes all the endpoints that are associated with a specific user ID. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/DeleteUserEndpoints

func (*Client) DeleteVoiceChannelRequest added in v0.9.0 

func (c *Client) DeleteVoiceChannelRequest(input *DeleteVoiceChannelInput) DeleteVoiceChannelRequest

DeleteVoiceChannelRequest returns a request value for making API operation for Amazon Pinpoint.

Disables the voice channel for an application and deletes any existing settings for the channel. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/DeleteVoiceChannel

func (*Client) DeleteVoiceTemplateRequest added in v0.17.0 

func (c *Client) DeleteVoiceTemplateRequest(input *DeleteVoiceTemplateInput) DeleteVoiceTemplateRequest

DeleteVoiceTemplateRequest returns a request value for making API operation for Amazon Pinpoint.

Deletes a message template for messages that were sent through the voice channel. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/DeleteVoiceTemplate

func (*Client) GetAdmChannelRequest added in v0.9.0 

func (c *Client) GetAdmChannelRequest(input *GetAdmChannelInput) GetAdmChannelRequest

GetAdmChannelRequest returns a request value for making API operation for Amazon Pinpoint.

Retrieves information about the status and settings of the ADM channel for an application. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetAdmChannel

func (*Client) GetApnsChannelRequest added in v0.9.0 

func (c *Client) GetApnsChannelRequest(input *GetApnsChannelInput) GetApnsChannelRequest

GetApnsChannelRequest returns a request value for making API operation for Amazon Pinpoint.

Retrieves information about the status and settings of the APNs channel for an application. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetApnsChannel

func (*Client) GetApnsSandboxChannelRequest added in v0.9.0 

func (c *Client) GetApnsSandboxChannelRequest(input *GetApnsSandboxChannelInput) GetApnsSandboxChannelRequest

GetApnsSandboxChannelRequest returns a request value for making API operation for Amazon Pinpoint.

Retrieves information about the status and settings of the APNs sandbox channel for an application. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetApnsSandboxChannel

func (*Client) GetApnsVoipChannelRequest added in v0.9.0 

func (c *Client) GetApnsVoipChannelRequest(input *GetApnsVoipChannelInput) GetApnsVoipChannelRequest

GetApnsVoipChannelRequest returns a request value for making API operation for Amazon Pinpoint.

Retrieves information about the status and settings of the APNs VoIP channel for an application. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetApnsVoipChannel

func (*Client) GetApnsVoipSandboxChannelRequest added in v0.9.0 

func (c *Client) GetApnsVoipSandboxChannelRequest(input *GetApnsVoipSandboxChannelInput) GetApnsVoipSandboxChannelRequest

GetApnsVoipSandboxChannelRequest returns a request value for making API operation for Amazon Pinpoint.

Retrieves information about the status and settings of the APNs VoIP sandbox channel for an application. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetApnsVoipSandboxChannel

func (*Client) GetAppRequest added in v0.9.0 

func (c *Client) GetAppRequest(input *GetAppInput) GetAppRequest

GetAppRequest returns a request value for making API operation for Amazon Pinpoint.

Retrieves information about an application. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetApp

func (*Client) GetApplicationDateRangeKpiRequest added in v0.10.0 

func (c *Client) GetApplicationDateRangeKpiRequest(input *GetApplicationDateRangeKpiInput) GetApplicationDateRangeKpiRequest

GetApplicationDateRangeKpiRequest returns a request value for making API operation for Amazon Pinpoint.

Retrieves (queries) pre-aggregated data for a standard metric that applies to an application. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetApplicationDateRangeKpi

func (*Client) GetApplicationSettingsRequest added in v0.9.0 

func (c *Client) GetApplicationSettingsRequest(input *GetApplicationSettingsInput) GetApplicationSettingsRequest

GetApplicationSettingsRequest returns a request value for making API operation for Amazon Pinpoint.

Retrieves information about the settings for an application. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetApplicationSettings

func (*Client) GetAppsRequest added in v0.9.0 

func (c *Client) GetAppsRequest(input *GetAppsInput) GetAppsRequest

GetAppsRequest returns a request value for making API operation for Amazon Pinpoint.

Retrieves information about all the applications that are associated with your Amazon Pinpoint account. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetApps

func (*Client) GetBaiduChannelRequest added in v0.9.0 

func (c *Client) GetBaiduChannelRequest(input *GetBaiduChannelInput) GetBaiduChannelRequest

GetBaiduChannelRequest returns a request value for making API operation for Amazon Pinpoint.

Retrieves information about the status and settings of the Baidu channel for an application. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetBaiduChannel

func (*Client) GetCampaignActivitiesRequest added in v0.9.0 

func (c *Client) GetCampaignActivitiesRequest(input *GetCampaignActivitiesInput) GetCampaignActivitiesRequest

GetCampaignActivitiesRequest returns a request value for making API operation for Amazon Pinpoint.

Retrieves information about all the activities for a campaign. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetCampaignActivities

func (*Client) GetCampaignDateRangeKpiRequest added in v0.10.0 

func (c *Client) GetCampaignDateRangeKpiRequest(input *GetCampaignDateRangeKpiInput) GetCampaignDateRangeKpiRequest

GetCampaignDateRangeKpiRequest returns a request value for making API operation for Amazon Pinpoint.

Retrieves (queries) pre-aggregated data for a standard metric that applies to a campaign. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetCampaignDateRangeKpi

func (*Client) GetCampaignRequest added in v0.9.0 

func (c *Client) GetCampaignRequest(input *GetCampaignInput) GetCampaignRequest

GetCampaignRequest returns a request value for making API operation for Amazon Pinpoint.

Retrieves information about the status, configuration, and other settings for a campaign. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetCampaign

func (*Client) GetCampaignVersionRequest added in v0.9.0 

func (c *Client) GetCampaignVersionRequest(input *GetCampaignVersionInput) GetCampaignVersionRequest

GetCampaignVersionRequest returns a request value for making API operation for Amazon Pinpoint.

Retrieves information about the status, configuration, and other settings for a specific version of a campaign. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetCampaignVersion

func (*Client) GetCampaignVersionsRequest added in v0.9.0 

func (c *Client) GetCampaignVersionsRequest(input *GetCampaignVersionsInput) GetCampaignVersionsRequest

GetCampaignVersionsRequest returns a request value for making API operation for Amazon Pinpoint.

Retrieves information about the status, configuration, and other settings for all versions of a campaign. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetCampaignVersions

func (*Client) GetCampaignsRequest added in v0.9.0 

func (c *Client) GetCampaignsRequest(input *GetCampaignsInput) GetCampaignsRequest

GetCampaignsRequest returns a request value for making API operation for Amazon Pinpoint.

Retrieves information about the status, configuration, and other settings for all the campaigns that are associated with an application. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetCampaigns

func (*Client) GetChannelsRequest added in v0.9.0 

func (c *Client) GetChannelsRequest(input *GetChannelsInput) GetChannelsRequest

GetChannelsRequest returns a request value for making API operation for Amazon Pinpoint.

Retrieves information about the history and status of each channel for an application. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetChannels

func (*Client) GetEmailChannelRequest added in v0.9.0 

func (c *Client) GetEmailChannelRequest(input *GetEmailChannelInput) GetEmailChannelRequest

GetEmailChannelRequest returns a request value for making API operation for Amazon Pinpoint.

Retrieves information about the status and settings of the email channel for an application. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetEmailChannel

func (*Client) GetEmailTemplateRequest added in v0.14.0 

func (c *Client) GetEmailTemplateRequest(input *GetEmailTemplateInput) GetEmailTemplateRequest

GetEmailTemplateRequest returns a request value for making API operation for Amazon Pinpoint.

Retrieves the content and settings of a message template for messages that are sent through the email channel. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetEmailTemplate

func (*Client) GetEndpointRequest added in v0.9.0 

func (c *Client) GetEndpointRequest(input *GetEndpointInput) GetEndpointRequest

GetEndpointRequest returns a request value for making API operation for Amazon Pinpoint.

Retrieves information about the settings and attributes of a specific endpoint for an application. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetEndpoint

func (*Client) GetEventStreamRequest added in v0.9.0 

func (c *Client) GetEventStreamRequest(input *GetEventStreamInput) GetEventStreamRequest

GetEventStreamRequest returns a request value for making API operation for Amazon Pinpoint.

Retrieves information about the event stream settings for an application. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetEventStream

func (*Client) GetExportJobRequest added in v0.9.0 

func (c *Client) GetExportJobRequest(input *GetExportJobInput) GetExportJobRequest

GetExportJobRequest returns a request value for making API operation for Amazon Pinpoint.

Retrieves information about the status and settings of a specific export job for an application. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetExportJob

func (*Client) GetExportJobsRequest added in v0.9.0 

func (c *Client) GetExportJobsRequest(input *GetExportJobsInput) GetExportJobsRequest

GetExportJobsRequest returns a request value for making API operation for Amazon Pinpoint.

Retrieves information about the status and settings of all the export jobs for an application. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetExportJobs

func (*Client) GetGcmChannelRequest added in v0.9.0 

func (c *Client) GetGcmChannelRequest(input *GetGcmChannelInput) GetGcmChannelRequest

GetGcmChannelRequest returns a request value for making API operation for Amazon Pinpoint.

Retrieves information about the status and settings of the GCM channel for an application. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetGcmChannel

func (*Client) GetImportJobRequest added in v0.9.0 

func (c *Client) GetImportJobRequest(input *GetImportJobInput) GetImportJobRequest

GetImportJobRequest returns a request value for making API operation for Amazon Pinpoint.

Retrieves information about the status and settings of a specific import job for an application. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetImportJob

func (*Client) GetImportJobsRequest added in v0.9.0 

func (c *Client) GetImportJobsRequest(input *GetImportJobsInput) GetImportJobsRequest

GetImportJobsRequest returns a request value for making API operation for Amazon Pinpoint.

Retrieves information about the status and settings of all the import jobs for an application. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetImportJobs

func (*Client) GetJourneyDateRangeKpiRequest added in v0.16.0 

func (c *Client) GetJourneyDateRangeKpiRequest(input *GetJourneyDateRangeKpiInput) GetJourneyDateRangeKpiRequest

GetJourneyDateRangeKpiRequest returns a request value for making API operation for Amazon Pinpoint.

Retrieves (queries) pre-aggregated data for a standard engagement metric that applies to a journey. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetJourneyDateRangeKpi

func (*Client) GetJourneyExecutionActivityMetricsRequest added in v0.16.0 

func (c *Client) GetJourneyExecutionActivityMetricsRequest(input *GetJourneyExecutionActivityMetricsInput) GetJourneyExecutionActivityMetricsRequest

GetJourneyExecutionActivityMetricsRequest returns a request value for making API operation for Amazon Pinpoint.

Retrieves (queries) pre-aggregated data for a standard execution metric that applies to a journey activity. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetJourneyExecutionActivityMetrics

func (*Client) GetJourneyExecutionMetricsRequest added in v0.16.0 

func (c *Client) GetJourneyExecutionMetricsRequest(input *GetJourneyExecutionMetricsInput) GetJourneyExecutionMetricsRequest

GetJourneyExecutionMetricsRequest returns a request value for making API operation for Amazon Pinpoint.

Retrieves (queries) pre-aggregated data for a standard execution metric that applies to a journey. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetJourneyExecutionMetrics

func (*Client) GetJourneyRequest added in v0.16.0 

func (c *Client) GetJourneyRequest(input *GetJourneyInput) GetJourneyRequest

GetJourneyRequest returns a request value for making API operation for Amazon Pinpoint.

Retrieves information about the status, configuration, and other settings for a journey. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetJourney

func (*Client) GetPushTemplateRequest added in v0.14.0 

func (c *Client) GetPushTemplateRequest(input *GetPushTemplateInput) GetPushTemplateRequest

GetPushTemplateRequest returns a request value for making API operation for Amazon Pinpoint.

Retrieves the content and settings of a message template for messages that are sent through a push notification channel. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetPushTemplate

func (*Client) GetRecommenderConfigurationRequest added in v0.20.0 

func (c *Client) GetRecommenderConfigurationRequest(input *GetRecommenderConfigurationInput) GetRecommenderConfigurationRequest

GetRecommenderConfigurationRequest returns a request value for making API operation for Amazon Pinpoint.

Retrieves information about an Amazon Pinpoint configuration for a recommender model. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetRecommenderConfiguration

func (*Client) GetRecommenderConfigurationsRequest added in v0.20.0 

func (c *Client) GetRecommenderConfigurationsRequest(input *GetRecommenderConfigurationsInput) GetRecommenderConfigurationsRequest

GetRecommenderConfigurationsRequest returns a request value for making API operation for Amazon Pinpoint.

Retrieves information about all the recommender model configurations that are associated with your Amazon Pinpoint account. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetRecommenderConfigurations

func (*Client) GetSegmentExportJobsRequest added in v0.9.0 

func (c *Client) GetSegmentExportJobsRequest(input *GetSegmentExportJobsInput) GetSegmentExportJobsRequest

GetSegmentExportJobsRequest returns a request value for making API operation for Amazon Pinpoint.

Retrieves information about the status and settings of the export jobs for a segment. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetSegmentExportJobs

func (*Client) GetSegmentImportJobsRequest added in v0.9.0 

func (c *Client) GetSegmentImportJobsRequest(input *GetSegmentImportJobsInput) GetSegmentImportJobsRequest

GetSegmentImportJobsRequest returns a request value for making API operation for Amazon Pinpoint.

Retrieves information about the status and settings of the import jobs for a segment. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetSegmentImportJobs

func (*Client) GetSegmentRequest added in v0.9.0 

func (c *Client) GetSegmentRequest(input *GetSegmentInput) GetSegmentRequest

GetSegmentRequest returns a request value for making API operation for Amazon Pinpoint.

Retrieves information about the configuration, dimension, and other settings for a specific segment that's associated with an application. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetSegment

func (*Client) GetSegmentVersionRequest added in v0.9.0 

func (c *Client) GetSegmentVersionRequest(input *GetSegmentVersionInput) GetSegmentVersionRequest

GetSegmentVersionRequest returns a request value for making API operation for Amazon Pinpoint.

Retrieves information about the configuration, dimension, and other settings for a specific version of a segment that's associated with an application. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetSegmentVersion

func (*Client) GetSegmentVersionsRequest added in v0.9.0 

func (c *Client) GetSegmentVersionsRequest(input *GetSegmentVersionsInput) GetSegmentVersionsRequest

GetSegmentVersionsRequest returns a request value for making API operation for Amazon Pinpoint.

Retrieves information about the configuration, dimension, and other settings for all the versions of a specific segment that's associated with an application. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetSegmentVersions

func (*Client) GetSegmentsRequest added in v0.9.0 

func (c *Client) GetSegmentsRequest(input *GetSegmentsInput) GetSegmentsRequest

GetSegmentsRequest returns a request value for making API operation for Amazon Pinpoint.

Retrieves information about the configuration, dimension, and other settings for all the segments that are associated with an application. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetSegments

func (*Client) GetSmsChannelRequest added in v0.9.0 

func (c *Client) GetSmsChannelRequest(input *GetSmsChannelInput) GetSmsChannelRequest

GetSmsChannelRequest returns a request value for making API operation for Amazon Pinpoint.

Retrieves information about the status and settings of the SMS channel for an application. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetSmsChannel

func (*Client) GetSmsTemplateRequest added in v0.14.0 

func (c *Client) GetSmsTemplateRequest(input *GetSmsTemplateInput) GetSmsTemplateRequest

GetSmsTemplateRequest returns a request value for making API operation for Amazon Pinpoint.

Retrieves the content and settings of a message template for messages that are sent through the SMS channel. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetSmsTemplate

func (*Client) GetUserEndpointsRequest added in v0.9.0 

func (c *Client) GetUserEndpointsRequest(input *GetUserEndpointsInput) GetUserEndpointsRequest

GetUserEndpointsRequest returns a request value for making API operation for Amazon Pinpoint.

Retrieves information about all the endpoints that are associated with a specific user ID. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetUserEndpoints

func (*Client) GetVoiceChannelRequest added in v0.9.0 

func (c *Client) GetVoiceChannelRequest(input *GetVoiceChannelInput) GetVoiceChannelRequest

GetVoiceChannelRequest returns a request value for making API operation for Amazon Pinpoint.

Retrieves information about the status and settings of the voice channel for an application. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetVoiceChannel

func (*Client) GetVoiceTemplateRequest added in v0.17.0 

func (c *Client) GetVoiceTemplateRequest(input *GetVoiceTemplateInput) GetVoiceTemplateRequest

GetVoiceTemplateRequest returns a request value for making API operation for Amazon Pinpoint.

Retrieves the content and settings of a message template for messages that are sent through the voice channel. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetVoiceTemplate

func (*Client) ListJourneysRequest added in v0.16.0 

func (c *Client) ListJourneysRequest(input *ListJourneysInput) ListJourneysRequest

ListJourneysRequest returns a request value for making API operation for Amazon Pinpoint.

Retrieves information about the status, configuration, and other settings for all the journeys that are associated with an application. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/ListJourneys

func (*Client) ListTagsForResourceRequest added in v0.9.0 

func (c *Client) ListTagsForResourceRequest(input *ListTagsForResourceInput) ListTagsForResourceRequest

ListTagsForResourceRequest returns a request value for making API operation for Amazon Pinpoint.

Retrieves all the tags (keys and values) that are associated with an application, campaign, message template, or segment. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/ListTagsForResource

func (*Client) ListTemplateVersionsRequest added in v0.19.0 

func (c *Client) ListTemplateVersionsRequest(input *ListTemplateVersionsInput) ListTemplateVersionsRequest

ListTemplateVersionsRequest returns a request value for making API operation for Amazon Pinpoint.

Retrieves information about all the versions of a specific message template. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/ListTemplateVersions

func (*Client) ListTemplatesRequest added in v0.14.0 

func (c *Client) ListTemplatesRequest(input *ListTemplatesInput) ListTemplatesRequest

ListTemplatesRequest returns a request value for making API operation for Amazon Pinpoint.

Retrieves information about all the message templates that are associated with your Amazon Pinpoint account. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/ListTemplates

func (*Client) PhoneNumberValidateRequest added in v0.9.0 

func (c *Client) PhoneNumberValidateRequest(input *PhoneNumberValidateInput) PhoneNumberValidateRequest

PhoneNumberValidateRequest returns a request value for making API operation for Amazon Pinpoint.

Retrieves information about a phone number. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/PhoneNumberValidate

func (*Client) PutEventStreamRequest added in v0.9.0 

func (c *Client) PutEventStreamRequest(input *PutEventStreamInput) PutEventStreamRequest

PutEventStreamRequest returns a request value for making API operation for Amazon Pinpoint.

Creates a new event stream for an application or updates the settings of an existing event stream for an application. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/PutEventStream

func (*Client) PutEventsRequest added in v0.9.0 

func (c *Client) PutEventsRequest(input *PutEventsInput) PutEventsRequest

PutEventsRequest returns a request value for making API operation for Amazon Pinpoint.

Creates a new event to record for endpoints, or creates or updates endpoint data that existing events are associated with. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/PutEvents

func (*Client) RemoveAttributesRequest added in v0.9.0 

func (c *Client) RemoveAttributesRequest(input *RemoveAttributesInput) RemoveAttributesRequest

RemoveAttributesRequest returns a request value for making API operation for Amazon Pinpoint.

Removes one or more attributes, of the same attribute type, from all the endpoints that are associated with an application. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/RemoveAttributes

func (*Client) SendMessagesRequest added in v0.9.0 

func (c *Client) SendMessagesRequest(input *SendMessagesInput) SendMessagesRequest

SendMessagesRequest returns a request value for making API operation for Amazon Pinpoint.

Creates and sends a direct message. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/SendMessages

func (*Client) SendUsersMessagesRequest added in v0.9.0 

func (c *Client) SendUsersMessagesRequest(input *SendUsersMessagesInput) SendUsersMessagesRequest

SendUsersMessagesRequest returns a request value for making API operation for Amazon Pinpoint.

Creates and sends a message to a list of users. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/SendUsersMessages

func (*Client) TagResourceRequest added in v0.9.0 

func (c *Client) TagResourceRequest(input *TagResourceInput) TagResourceRequest

TagResourceRequest returns a request value for making API operation for Amazon Pinpoint.

Adds one or more tags (keys and values) to an application, campaign, message template, or segment. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/TagResource

func (*Client) UntagResourceRequest added in v0.9.0 

func (c *Client) UntagResourceRequest(input *UntagResourceInput) UntagResourceRequest

UntagResourceRequest returns a request value for making API operation for Amazon Pinpoint.

Removes one or more tags (keys and values) from an application, campaign, message template, or segment. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/UntagResource

func (*Client) UpdateAdmChannelRequest added in v0.9.0 

func (c *Client) UpdateAdmChannelRequest(input *UpdateAdmChannelInput) UpdateAdmChannelRequest

UpdateAdmChannelRequest returns a request value for making API operation for Amazon Pinpoint.

Enables the ADM channel for an application or updates the status and settings of the ADM channel for an application. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/UpdateAdmChannel

func (*Client) UpdateApnsChannelRequest added in v0.9.0 

func (c *Client) UpdateApnsChannelRequest(input *UpdateApnsChannelInput) UpdateApnsChannelRequest

UpdateApnsChannelRequest returns a request value for making API operation for Amazon Pinpoint.

Enables the APNs channel for an application or updates the status and settings of the APNs channel for an application. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/UpdateApnsChannel

func (*Client) UpdateApnsSandboxChannelRequest added in v0.9.0 

func (c *Client) UpdateApnsSandboxChannelRequest(input *UpdateApnsSandboxChannelInput) UpdateApnsSandboxChannelRequest

UpdateApnsSandboxChannelRequest returns a request value for making API operation for Amazon Pinpoint.

Enables the APNs sandbox channel for an application or updates the status and settings of the APNs sandbox channel for an application. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/UpdateApnsSandboxChannel

func (*Client) UpdateApnsVoipChannelRequest added in v0.9.0 

func (c *Client) UpdateApnsVoipChannelRequest(input *UpdateApnsVoipChannelInput) UpdateApnsVoipChannelRequest

UpdateApnsVoipChannelRequest returns a request value for making API operation for Amazon Pinpoint.

Enables the APNs VoIP channel for an application or updates the status and settings of the APNs VoIP channel for an application. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/UpdateApnsVoipChannel

func (*Client) UpdateApnsVoipSandboxChannelRequest added in v0.9.0 

func (c *Client) UpdateApnsVoipSandboxChannelRequest(input *UpdateApnsVoipSandboxChannelInput) UpdateApnsVoipSandboxChannelRequest

UpdateApnsVoipSandboxChannelRequest returns a request value for making API operation for Amazon Pinpoint.

Enables the APNs VoIP sandbox channel for an application or updates the status and settings of the APNs VoIP sandbox channel for an application. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/UpdateApnsVoipSandboxChannel

func (*Client) UpdateApplicationSettingsRequest added in v0.9.0 

func (c *Client) UpdateApplicationSettingsRequest(input *UpdateApplicationSettingsInput) UpdateApplicationSettingsRequest

UpdateApplicationSettingsRequest returns a request value for making API operation for Amazon Pinpoint.

Updates the settings for an application. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/UpdateApplicationSettings

func (*Client) UpdateBaiduChannelRequest added in v0.9.0 

func (c *Client) UpdateBaiduChannelRequest(input *UpdateBaiduChannelInput) UpdateBaiduChannelRequest

UpdateBaiduChannelRequest returns a request value for making API operation for Amazon Pinpoint.

Enables the Baidu channel for an application or updates the status and settings of the Baidu channel for an application. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/UpdateBaiduChannel

func (*Client) UpdateCampaignRequest added in v0.9.0 

func (c *Client) UpdateCampaignRequest(input *UpdateCampaignInput) UpdateCampaignRequest

UpdateCampaignRequest returns a request value for making API operation for Amazon Pinpoint.

Updates the configuration and other settings for a campaign. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/UpdateCampaign

func (*Client) UpdateEmailChannelRequest added in v0.9.0 

func (c *Client) UpdateEmailChannelRequest(input *UpdateEmailChannelInput) UpdateEmailChannelRequest

UpdateEmailChannelRequest returns a request value for making API operation for Amazon Pinpoint.

Enables the email channel for an application or updates the status and settings of the email channel for an application. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/UpdateEmailChannel

func (*Client) UpdateEmailTemplateRequest added in v0.14.0 

func (c *Client) UpdateEmailTemplateRequest(input *UpdateEmailTemplateInput) UpdateEmailTemplateRequest

UpdateEmailTemplateRequest returns a request value for making API operation for Amazon Pinpoint.

Updates an existing message template for messages that are sent through the email channel. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/UpdateEmailTemplate

func (*Client) UpdateEndpointRequest added in v0.9.0 

func (c *Client) UpdateEndpointRequest(input *UpdateEndpointInput) UpdateEndpointRequest

UpdateEndpointRequest returns a request value for making API operation for Amazon Pinpoint.

Creates a new endpoint for an application or updates the settings and attributes of an existing endpoint for an application. You can also use this operation to define custom attributes for an endpoint. If an update includes one or more values for a custom attribute, Amazon Pinpoint replaces (overwrites) any existing values with the new values. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/UpdateEndpoint

func (*Client) UpdateEndpointsBatchRequest added in v0.9.0 

func (c *Client) UpdateEndpointsBatchRequest(input *UpdateEndpointsBatchInput) UpdateEndpointsBatchRequest

UpdateEndpointsBatchRequest returns a request value for making API operation for Amazon Pinpoint.

Creates a new batch of endpoints for an application or updates the settings and attributes of a batch of existing endpoints for an application. You can also use this operation to define custom attributes for a batch of endpoints. If an update includes one or more values for a custom attribute, Amazon Pinpoint replaces (overwrites) any existing values with the new values. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/UpdateEndpointsBatch

func (*Client) UpdateGcmChannelRequest added in v0.9.0 

func (c *Client) UpdateGcmChannelRequest(input *UpdateGcmChannelInput) UpdateGcmChannelRequest

UpdateGcmChannelRequest returns a request value for making API operation for Amazon Pinpoint.

Enables the GCM channel for an application or updates the status and settings of the GCM channel for an application. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/UpdateGcmChannel

func (*Client) UpdateJourneyRequest added in v0.16.0 

func (c *Client) UpdateJourneyRequest(input *UpdateJourneyInput) UpdateJourneyRequest

UpdateJourneyRequest returns a request value for making API operation for Amazon Pinpoint.

Updates the configuration and other settings for a journey. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/UpdateJourney

func (*Client) UpdateJourneyStateRequest added in v0.16.0 

func (c *Client) UpdateJourneyStateRequest(input *UpdateJourneyStateInput) UpdateJourneyStateRequest

UpdateJourneyStateRequest returns a request value for making API operation for Amazon Pinpoint.

Cancels (stops) an active journey. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/UpdateJourneyState

func (*Client) UpdatePushTemplateRequest added in v0.14.0 

func (c *Client) UpdatePushTemplateRequest(input *UpdatePushTemplateInput) UpdatePushTemplateRequest

UpdatePushTemplateRequest returns a request value for making API operation for Amazon Pinpoint.

Updates an existing message template for messages that are sent through a push notification channel. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/UpdatePushTemplate

func (*Client) UpdateRecommenderConfigurationRequest added in v0.20.0 

func (c *Client) UpdateRecommenderConfigurationRequest(input *UpdateRecommenderConfigurationInput) UpdateRecommenderConfigurationRequest

UpdateRecommenderConfigurationRequest returns a request value for making API operation for Amazon Pinpoint.

Updates an Amazon Pinpoint configuration for a recommender model. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/UpdateRecommenderConfiguration

func (*Client) UpdateSegmentRequest added in v0.9.0 

func (c *Client) UpdateSegmentRequest(input *UpdateSegmentInput) UpdateSegmentRequest

UpdateSegmentRequest returns a request value for making 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. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/UpdateSegment

func (*Client) UpdateSmsChannelRequest added in v0.9.0 

func (c *Client) UpdateSmsChannelRequest(input *UpdateSmsChannelInput) UpdateSmsChannelRequest

UpdateSmsChannelRequest returns a request value for making API operation for Amazon Pinpoint.

Enables the SMS channel for an application or updates the status and settings of the SMS channel for an application. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/UpdateSmsChannel

func (*Client) UpdateSmsTemplateRequest added in v0.14.0 

func (c *Client) UpdateSmsTemplateRequest(input *UpdateSmsTemplateInput) UpdateSmsTemplateRequest

UpdateSmsTemplateRequest returns a request value for making API operation for Amazon Pinpoint.

Updates an existing message template for messages that are sent through the SMS channel. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/UpdateSmsTemplate

func (*Client) UpdateTemplateActiveVersionRequest added in v0.19.0 

func (c *Client) UpdateTemplateActiveVersionRequest(input *UpdateTemplateActiveVersionInput) UpdateTemplateActiveVersionRequest

UpdateTemplateActiveVersionRequest returns a request value for making API operation for Amazon Pinpoint.

Changes the status of a specific version of a message template to active. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/UpdateTemplateActiveVersion

func (*Client) UpdateVoiceChannelRequest added in v0.9.0 

func (c *Client) UpdateVoiceChannelRequest(input *UpdateVoiceChannelInput) UpdateVoiceChannelRequest

UpdateVoiceChannelRequest returns a request value for making API operation for Amazon Pinpoint.

Enables the voice channel for an application or updates the status and settings of the voice channel for an application. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/UpdateVoiceChannel

func (*Client) UpdateVoiceTemplateRequest added in v0.17.0 

func (c *Client) UpdateVoiceTemplateRequest(input *UpdateVoiceTemplateInput) UpdateVoiceTemplateRequest

UpdateVoiceTemplateRequest returns a request value for making API operation for Amazon Pinpoint.

Updates an existing message template for messages that are sent through the voice channel. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/UpdateVoiceTemplate

type Condition added in v0.16.0 

type Condition struct {

	// The conditions to evaluate for the activity.
	Conditions []SimpleCondition `type:"list"`

	// Specifies how to handle multiple conditions for the activity. For example,
	// if you specify two conditions for an activity, whether both or only one of
	// the conditions must be met for the activity to be performed.
	Operator Operator `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

Specifies the conditions to evaluate for an activity in a journey, and how to evaluate those conditions.

func (Condition) MarshalFields added in v0.16.0 

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

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

func (Condition) String added in v0.16.0 

func (s Condition) String() string

String returns the string representation

func (*Condition) Validate added in v0.16.0 

func (s *Condition) Validate() error

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

type ConditionalSplitActivity added in v0.16.0 

type ConditionalSplitActivity struct {

	// The conditions that define the paths for the activity, and the relationship
	// between the conditions.
	Condition *Condition `type:"structure"`

	// The amount of time to wait before determining whether the conditions are
	// met, or the date and time when Amazon Pinpoint determines whether the conditions
	// are met.
	EvaluationWaitTime *WaitTime `type:"structure"`

	// The unique identifier for the activity to perform if the conditions aren't
	// met.
	FalseActivity *string `type:"string"`

	// The unique identifier for the activity to perform if the conditions are met.
	TrueActivity *string `type:"string"`
	// contains filtered or unexported fields
}

Specifies the settings for a yes/no split activity in a journey. This type of activity sends participants down one of two paths in a journey, based on conditions that you specify.

func (ConditionalSplitActivity) MarshalFields added in v0.16.0 

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

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

func (ConditionalSplitActivity) String added in v0.16.0 

func (s ConditionalSplitActivity) String() string

String returns the string representation

func (*ConditionalSplitActivity) Validate added in v0.16.0 

func (s *ConditionalSplitActivity) Validate() error

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

type CreateAppInput 

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 (CreateAppInput) MarshalFields added in v0.3.0 

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

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

func (CreateAppInput) String 

func (s CreateAppInput) String() string

String returns the string representation

func (*CreateAppInput) Validate 

func (s *CreateAppInput) Validate() error

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

type CreateAppOutput 

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 (CreateAppOutput) MarshalFields added in v0.3.0 

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

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

func (CreateAppOutput) String 

func (s CreateAppOutput) String() string

String returns the string representation

type CreateAppRequest 

type CreateAppRequest struct {
	*aws.Request
	Input *CreateAppInput
	Copy  func(*CreateAppInput) CreateAppRequest
}

CreateAppRequest is the request type for the CreateApp API operation.

func (CreateAppRequest) Send 

func (r CreateAppRequest) Send(ctx context.Context) (*CreateAppResponse, error)

Send marshals and sends the CreateApp API request.

type CreateAppResponse added in v0.9.0 

type CreateAppResponse struct {
	*CreateAppOutput
	// contains filtered or unexported fields
}

CreateAppResponse is the response type for the CreateApp API operation.

func (*CreateAppResponse) SDKResponseMetdata added in v0.9.0 

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

SDKResponseMetdata returns the response metadata for the CreateApp request.

type CreateApplicationRequest 

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 (CreateApplicationRequest) MarshalFields added in v0.3.0 

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

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

func (CreateApplicationRequest) String 

func (s CreateApplicationRequest) String() string

String returns the string representation

func (*CreateApplicationRequest) Validate added in v0.10.0 

func (s *CreateApplicationRequest) Validate() error

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

type CreateCampaignInput 

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 (CreateCampaignInput) MarshalFields added in v0.3.0 

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

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

func (CreateCampaignInput) String 

func (s CreateCampaignInput) String() string

String returns the string representation

func (*CreateCampaignInput) Validate 

func (s *CreateCampaignInput) Validate() error

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

type CreateCampaignOutput 

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 (CreateCampaignOutput) MarshalFields added in v0.3.0 

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

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

func (CreateCampaignOutput) String 

func (s CreateCampaignOutput) String() string

String returns the string representation

type CreateCampaignRequest 

type CreateCampaignRequest struct {
	*aws.Request
	Input *CreateCampaignInput
	Copy  func(*CreateCampaignInput) CreateCampaignRequest
}

CreateCampaignRequest is the request type for the CreateCampaign API operation.

func (CreateCampaignRequest) Send 

func (r CreateCampaignRequest) Send(ctx context.Context) (*CreateCampaignResponse, error)

Send marshals and sends the CreateCampaign API request.

type CreateCampaignResponse added in v0.9.0 

type CreateCampaignResponse struct {
	*CreateCampaignOutput
	// contains filtered or unexported fields
}

CreateCampaignResponse is the response type for the CreateCampaign API operation.

func (*CreateCampaignResponse) SDKResponseMetdata added in v0.9.0 

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

SDKResponseMetdata returns the response metadata for the CreateCampaign request.

type CreateEmailTemplateInput added in v0.14.0 

type CreateEmailTemplateInput struct {

	// Specifies the content and settings for a message template that can be used
	// in messages that are sent through the email channel.
	//
	// EmailTemplateRequest is a required field
	EmailTemplateRequest *EmailTemplateRequest `type:"structure" required:"true"`

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

func (CreateEmailTemplateInput) MarshalFields added in v0.14.0 

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

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

func (CreateEmailTemplateInput) String added in v0.14.0 

func (s CreateEmailTemplateInput) String() string

String returns the string representation

func (*CreateEmailTemplateInput) Validate added in v0.14.0 

func (s *CreateEmailTemplateInput) Validate() error

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

type CreateEmailTemplateOutput added in v0.14.0 

type CreateEmailTemplateOutput struct {

	// Provides information about a request to create a message template.
	//
	// CreateTemplateMessageBody is a required field
	CreateTemplateMessageBody *CreateTemplateMessageBody `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (CreateEmailTemplateOutput) MarshalFields added in v0.14.0 

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

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

func (CreateEmailTemplateOutput) String added in v0.14.0 

func (s CreateEmailTemplateOutput) String() string

String returns the string representation

type CreateEmailTemplateRequest added in v0.14.0 

type CreateEmailTemplateRequest struct {
	*aws.Request
	Input *CreateEmailTemplateInput
	Copy  func(*CreateEmailTemplateInput) CreateEmailTemplateRequest
}

CreateEmailTemplateRequest is the request type for the CreateEmailTemplate API operation.

func (CreateEmailTemplateRequest) Send added in v0.14.0 

func (r CreateEmailTemplateRequest) Send(ctx context.Context) (*CreateEmailTemplateResponse, error)

Send marshals and sends the CreateEmailTemplate API request.

type CreateEmailTemplateResponse added in v0.14.0 

type CreateEmailTemplateResponse struct {
	*CreateEmailTemplateOutput
	// contains filtered or unexported fields
}

CreateEmailTemplateResponse is the response type for the CreateEmailTemplate API operation.

func (*CreateEmailTemplateResponse) SDKResponseMetdata added in v0.14.0 

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

SDKResponseMetdata returns the response metadata for the CreateEmailTemplate request.

type CreateExportJobInput added in v0.4.0 

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 (CreateExportJobInput) MarshalFields added in v0.4.0 

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

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

func (CreateExportJobInput) String added in v0.4.0 

func (s CreateExportJobInput) String() string

String returns the string representation

func (*CreateExportJobInput) Validate added in v0.4.0 

func (s *CreateExportJobInput) Validate() error

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

type CreateExportJobOutput added in v0.4.0 

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 (CreateExportJobOutput) MarshalFields added in v0.4.0 

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

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

func (CreateExportJobOutput) String added in v0.4.0 

func (s CreateExportJobOutput) String() string

String returns the string representation

type CreateExportJobRequest added in v0.4.0 

type CreateExportJobRequest struct {
	*aws.Request
	Input *CreateExportJobInput
	Copy  func(*CreateExportJobInput) CreateExportJobRequest
}

CreateExportJobRequest is the request type for the CreateExportJob API operation.

func (CreateExportJobRequest) Send added in v0.4.0 

func (r CreateExportJobRequest) Send(ctx context.Context) (*CreateExportJobResponse, error)

Send marshals and sends the CreateExportJob API request.

type CreateExportJobResponse added in v0.9.0 

type CreateExportJobResponse struct {
	*CreateExportJobOutput
	// contains filtered or unexported fields
}

CreateExportJobResponse is the response type for the CreateExportJob API operation.

func (*CreateExportJobResponse) SDKResponseMetdata added in v0.9.0 

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

SDKResponseMetdata returns the response metadata for the CreateExportJob request.

type CreateImportJobInput 

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 (CreateImportJobInput) MarshalFields added in v0.3.0 

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

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

func (CreateImportJobInput) String 

func (s CreateImportJobInput) String() string

String returns the string representation

func (*CreateImportJobInput) Validate 

func (s *CreateImportJobInput) Validate() error

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

type CreateImportJobOutput 

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 (CreateImportJobOutput) MarshalFields added in v0.3.0 

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

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

func (CreateImportJobOutput) String 

func (s CreateImportJobOutput) String() string

String returns the string representation

type CreateImportJobRequest 

type CreateImportJobRequest struct {
	*aws.Request
	Input *CreateImportJobInput
	Copy  func(*CreateImportJobInput) CreateImportJobRequest
}

CreateImportJobRequest is the request type for the CreateImportJob API operation.

func (CreateImportJobRequest) Send 

func (r CreateImportJobRequest) Send(ctx context.Context) (*CreateImportJobResponse, error)

Send marshals and sends the CreateImportJob API request.

type CreateImportJobResponse added in v0.9.0 

type CreateImportJobResponse struct {
	*CreateImportJobOutput
	// contains filtered or unexported fields
}

CreateImportJobResponse is the response type for the CreateImportJob API operation.

func (*CreateImportJobResponse) SDKResponseMetdata added in v0.9.0 

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

SDKResponseMetdata returns the response metadata for the CreateImportJob request.

type CreateJourneyInput added in v0.16.0 

type CreateJourneyInput 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 journey.
	//
	// WriteJourneyRequest is a required field
	WriteJourneyRequest *WriteJourneyRequest `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (CreateJourneyInput) MarshalFields added in v0.16.0 

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

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

func (CreateJourneyInput) String added in v0.16.0 

func (s CreateJourneyInput) String() string

String returns the string representation

func (*CreateJourneyInput) Validate added in v0.16.0 

func (s *CreateJourneyInput) Validate() error

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

type CreateJourneyOutput added in v0.16.0 

type CreateJourneyOutput struct {

	// Provides information about the status, configuration, and other settings
	// for a journey.
	//
	// JourneyResponse is a required field
	JourneyResponse *JourneyResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (CreateJourneyOutput) MarshalFields added in v0.16.0 

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

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

func (CreateJourneyOutput) String added in v0.16.0 

func (s CreateJourneyOutput) String() string

String returns the string representation

type CreateJourneyRequest added in v0.16.0 

type CreateJourneyRequest struct {
	*aws.Request
	Input *CreateJourneyInput
	Copy  func(*CreateJourneyInput) CreateJourneyRequest
}

CreateJourneyRequest is the request type for the CreateJourney API operation.

func (CreateJourneyRequest) Send added in v0.16.0 

func (r CreateJourneyRequest) Send(ctx context.Context) (*CreateJourneyResponse, error)

Send marshals and sends the CreateJourney API request.

type CreateJourneyResponse added in v0.16.0 

type CreateJourneyResponse struct {
	*CreateJourneyOutput
	// contains filtered or unexported fields
}

CreateJourneyResponse is the response type for the CreateJourney API operation.

func (*CreateJourneyResponse) SDKResponseMetdata added in v0.16.0 

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

SDKResponseMetdata returns the response metadata for the CreateJourney request.

type CreatePushTemplateInput added in v0.14.0 

type CreatePushTemplateInput struct {

	// Specifies the content and settings for a message template that can be used
	// in messages that are sent through a push notification channel.
	//
	// PushNotificationTemplateRequest is a required field
	PushNotificationTemplateRequest *PushNotificationTemplateRequest `type:"structure" required:"true"`

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

func (CreatePushTemplateInput) MarshalFields added in v0.14.0 

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

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

func (CreatePushTemplateInput) String added in v0.14.0 

func (s CreatePushTemplateInput) String() string

String returns the string representation

func (*CreatePushTemplateInput) Validate added in v0.14.0 

func (s *CreatePushTemplateInput) Validate() error

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

type CreatePushTemplateOutput added in v0.14.0 

type CreatePushTemplateOutput struct {

	// Provides information about a request to create a message template.
	//
	// CreateTemplateMessageBody is a required field
	CreateTemplateMessageBody *CreateTemplateMessageBody `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (CreatePushTemplateOutput) MarshalFields added in v0.14.0 

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

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

func (CreatePushTemplateOutput) String added in v0.14.0 

func (s CreatePushTemplateOutput) String() string

String returns the string representation

type CreatePushTemplateRequest added in v0.14.0 

type CreatePushTemplateRequest struct {
	*aws.Request
	Input *CreatePushTemplateInput
	Copy  func(*CreatePushTemplateInput) CreatePushTemplateRequest
}

CreatePushTemplateRequest is the request type for the CreatePushTemplate API operation.

func (CreatePushTemplateRequest) Send added in v0.14.0 

func (r CreatePushTemplateRequest) Send(ctx context.Context) (*CreatePushTemplateResponse, error)

Send marshals and sends the CreatePushTemplate API request.

type CreatePushTemplateResponse added in v0.14.0 

type CreatePushTemplateResponse struct {
	*CreatePushTemplateOutput
	// contains filtered or unexported fields
}

CreatePushTemplateResponse is the response type for the CreatePushTemplate API operation.

func (*CreatePushTemplateResponse) SDKResponseMetdata added in v0.14.0 

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

SDKResponseMetdata returns the response metadata for the CreatePushTemplate request.

type CreateRecommenderConfiguration added in v0.20.0 

type CreateRecommenderConfiguration struct {

	// A map of key-value pairs that defines 1-10 custom endpoint or user attributes,
	// depending on the value for the RecommendationProviderIdType property. Each
	// of these attributes temporarily stores a recommended item that's retrieved
	// from the recommender model and sent to an AWS Lambda function for additional
	// processing. Each attribute can be used as a message variable in a message
	// template.
	//
	// In the map, the key is the name of a custom attribute and the value is a
	// custom display name for that attribute. The display name appears in the Attribute
	// finder of the template editor on the Amazon Pinpoint console. The following
	// restrictions apply to these names:
	//
	//    * An attribute name must start with a letter or number and it can contain
	//    up to 50 characters. The characters can be letters, numbers, underscores
	//    (_), or hyphens (-). Attribute names are case sensitive and must be unique.
	//
	//    * An attribute display name must start with a letter or number and it
	//    can contain up to 25 characters. The characters can be letters, numbers,
	//    spaces, underscores (_), or hyphens (-).
	//
	// This object is required if the configuration invokes an AWS Lambda function
	// (RecommendationTransformerUri) to process recommendation data. Otherwise,
	// don't include this object in your request.
	Attributes map[string]string `type:"map"`

	// A custom description of the configuration for the recommender model. The
	// description can contain up to 128 characters. The characters can be letters,
	// numbers, spaces, or the following symbols: _ ; () , ‐.
	Description *string `type:"string"`

	// A custom name of the configuration for the recommender model. The name must
	// start with a letter or number and it can contain up to 128 characters. The
	// characters can be letters, numbers, spaces, underscores (_), or hyphens (-).
	Name *string `type:"string"`

	// The type of Amazon Pinpoint ID to associate with unique user IDs in the recommender
	// model. This value enables the model to use attribute and event data that’s
	// specific to a particular endpoint or user in an Amazon Pinpoint application.
	// Valid values are:
	//
	//    * PINPOINT_ENDPOINT_ID - Associate each user in the model with a particular
	//    endpoint in Amazon Pinpoint. The data is correlated based on endpoint
	//    IDs in Amazon Pinpoint. This is the default value.
	//
	//    * PINPOINT_USER_ID - Associate each user in the model with a particular
	//    user and endpoint in Amazon Pinpoint. The data is correlated based on
	//    user IDs in Amazon Pinpoint. If you specify this value, an endpoint definition
	//    in Amazon Pinpoint has to specify both a user ID (UserId) and an endpoint
	//    ID. Otherwise, messages won’t be sent to the user's endpoint.
	RecommendationProviderIdType *string `type:"string"`

	// The Amazon Resource Name (ARN) of the AWS Identity and Access Management
	// (IAM) role that authorizes Amazon Pinpoint to retrieve recommendation data
	// from the recommender model.
	//
	// RecommendationProviderRoleArn is a required field
	RecommendationProviderRoleArn *string `type:"string" required:"true"`

	// The Amazon Resource Name (ARN) of the recommender model to retrieve recommendation
	// data from. This value must match the ARN of an Amazon Personalize campaign.
	//
	// RecommendationProviderUri is a required field
	RecommendationProviderUri *string `type:"string" required:"true"`

	// The name or Amazon Resource Name (ARN) of the AWS Lambda function to invoke
	// for additional processing of recommendation data that's retrieved from the
	// recommender model.
	RecommendationTransformerUri *string `type:"string"`

	// A custom display name for the standard endpoint or user attribute (RecommendationItems)
	// that temporarily stores recommended items for each endpoint or user, depending
	// on the value for the RecommendationProviderIdType property. This value is
	// required if the configuration doesn't invoke an AWS Lambda function (RecommendationTransformerUri)
	// to perform additional processing of recommendation data.
	//
	// This name appears in the Attribute finder of the template editor on the Amazon
	// Pinpoint console. The name can contain up to 25 characters. The characters
	// can be letters, numbers, spaces, underscores (_), or hyphens (-). These restrictions
	// don't apply to attribute values.
	RecommendationsDisplayName *string `type:"string"`

	// The number of recommended items to retrieve from the model for each endpoint
	// or user, depending on the value for the RecommendationProviderIdType property.
	// This number determines how many recommended items are available for use in
	// message variables. The minimum value is 1. The maximum value is 5. The default
	// value is 5.
	//
	// To use multiple recommended items and custom attributes with message variables,
	// you have to use an AWS Lambda function (RecommendationTransformerUri) to
	// perform additional processing of recommendation data.
	RecommendationsPerMessage *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Specifies Amazon Pinpoint configuration settings for retrieving and processing recommendation data from a recommender model.

func (CreateRecommenderConfiguration) MarshalFields added in v0.20.0 

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

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

func (CreateRecommenderConfiguration) String added in v0.20.0 

func (s CreateRecommenderConfiguration) String() string

String returns the string representation

func (*CreateRecommenderConfiguration) Validate added in v0.20.0 

func (s *CreateRecommenderConfiguration) Validate() error

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

type CreateRecommenderConfigurationInput added in v0.20.0 

type CreateRecommenderConfigurationInput struct {

	// Specifies Amazon Pinpoint configuration settings for retrieving and processing
	// recommendation data from a recommender model.
	//
	// CreateRecommenderConfiguration is a required field
	CreateRecommenderConfiguration *CreateRecommenderConfiguration `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (CreateRecommenderConfigurationInput) MarshalFields added in v0.20.0 

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

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

func (CreateRecommenderConfigurationInput) String added in v0.20.0 

func (s CreateRecommenderConfigurationInput) String() string

String returns the string representation

func (*CreateRecommenderConfigurationInput) Validate added in v0.20.0 

func (s *CreateRecommenderConfigurationInput) Validate() error

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

type CreateRecommenderConfigurationOutput added in v0.20.0 

type CreateRecommenderConfigurationOutput struct {

	// Provides information about Amazon Pinpoint configuration settings for retrieving
	// and processing data from a recommender model.
	//
	// RecommenderConfigurationResponse is a required field
	RecommenderConfigurationResponse *RecommenderConfigurationResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (CreateRecommenderConfigurationOutput) MarshalFields added in v0.20.0 

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

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

func (CreateRecommenderConfigurationOutput) String added in v0.20.0 

func (s CreateRecommenderConfigurationOutput) String() string

String returns the string representation

type CreateRecommenderConfigurationRequest added in v0.20.0 

type CreateRecommenderConfigurationRequest struct {
	*aws.Request
	Input *CreateRecommenderConfigurationInput
	Copy  func(*CreateRecommenderConfigurationInput) CreateRecommenderConfigurationRequest
}

CreateRecommenderConfigurationRequest is the request type for the CreateRecommenderConfiguration API operation.

func (CreateRecommenderConfigurationRequest) Send added in v0.20.0 

func (r CreateRecommenderConfigurationRequest) Send(ctx context.Context) (*CreateRecommenderConfigurationResponse, error)

Send marshals and sends the CreateRecommenderConfiguration API request.

type CreateRecommenderConfigurationResponse added in v0.20.0 

type CreateRecommenderConfigurationResponse struct {
	*CreateRecommenderConfigurationOutput
	// contains filtered or unexported fields
}

CreateRecommenderConfigurationResponse is the response type for the CreateRecommenderConfiguration API operation.

func (*CreateRecommenderConfigurationResponse) SDKResponseMetdata added in v0.20.0 

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

SDKResponseMetdata returns the response metadata for the CreateRecommenderConfiguration request.

type CreateSegmentInput 

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 (CreateSegmentInput) MarshalFields added in v0.3.0 

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

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

func (CreateSegmentInput) String 

func (s CreateSegmentInput) String() string

String returns the string representation

func (*CreateSegmentInput) Validate 

func (s *CreateSegmentInput) Validate() error

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

type CreateSegmentOutput 

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 (CreateSegmentOutput) MarshalFields added in v0.3.0 

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

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

func (CreateSegmentOutput) String 

func (s CreateSegmentOutput) String() string

String returns the string representation

type CreateSegmentRequest 

type CreateSegmentRequest struct {
	*aws.Request
	Input *CreateSegmentInput
	Copy  func(*CreateSegmentInput) CreateSegmentRequest
}

CreateSegmentRequest is the request type for the CreateSegment API operation.

func (CreateSegmentRequest) Send 

func (r CreateSegmentRequest) Send(ctx context.Context) (*CreateSegmentResponse, error)

Send marshals and sends the CreateSegment API request.

type CreateSegmentResponse added in v0.9.0 

type CreateSegmentResponse struct {
	*CreateSegmentOutput
	// contains filtered or unexported fields
}

CreateSegmentResponse is the response type for the CreateSegment API operation.

func (*CreateSegmentResponse) SDKResponseMetdata added in v0.9.0 

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

SDKResponseMetdata returns the response metadata for the CreateSegment request.

type CreateSmsTemplateInput added in v0.14.0 

type CreateSmsTemplateInput struct {

	// Specifies the content and settings for a message template that can be used
	// in text messages that are sent through the SMS channel.
	//
	// SMSTemplateRequest is a required field
	SMSTemplateRequest *SMSTemplateRequest `type:"structure" required:"true"`

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

func (CreateSmsTemplateInput) MarshalFields added in v0.14.0 

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

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

func (CreateSmsTemplateInput) String added in v0.14.0 

func (s CreateSmsTemplateInput) String() string

String returns the string representation

func (*CreateSmsTemplateInput) Validate added in v0.14.0 

func (s *CreateSmsTemplateInput) Validate() error

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

type CreateSmsTemplateOutput added in v0.14.0 

type CreateSmsTemplateOutput struct {

	// Provides information about a request to create a message template.
	//
	// CreateTemplateMessageBody is a required field
	CreateTemplateMessageBody *CreateTemplateMessageBody `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (CreateSmsTemplateOutput) MarshalFields added in v0.14.0 

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

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

func (CreateSmsTemplateOutput) String added in v0.14.0 

func (s CreateSmsTemplateOutput) String() string

String returns the string representation

type CreateSmsTemplateRequest added in v0.14.0 

type CreateSmsTemplateRequest struct {
	*aws.Request
	Input *CreateSmsTemplateInput
	Copy  func(*CreateSmsTemplateInput) CreateSmsTemplateRequest
}

CreateSmsTemplateRequest is the request type for the CreateSmsTemplate API operation.

func (CreateSmsTemplateRequest) Send added in v0.14.0 

func (r CreateSmsTemplateRequest) Send(ctx context.Context) (*CreateSmsTemplateResponse, error)

Send marshals and sends the CreateSmsTemplate API request.

type CreateSmsTemplateResponse added in v0.14.0 

type CreateSmsTemplateResponse struct {
	*CreateSmsTemplateOutput
	// contains filtered or unexported fields
}

CreateSmsTemplateResponse is the response type for the CreateSmsTemplate API operation.

func (*CreateSmsTemplateResponse) SDKResponseMetdata added in v0.14.0 

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

SDKResponseMetdata returns the response metadata for the CreateSmsTemplate request.

type CreateTemplateMessageBody added in v0.14.0 

type CreateTemplateMessageBody struct {

	// The Amazon Resource Name (ARN) of the message template that was created.
	Arn *string `type:"string"`

	// The message that's returned from the API for the request to create the message
	// template.
	Message *string `type:"string"`

	// The unique identifier for the request to create the message template.
	RequestID *string `type:"string"`
	// contains filtered or unexported fields
}

Provides information about a request to create a message template.

func (CreateTemplateMessageBody) MarshalFields added in v0.14.0 

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

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

func (CreateTemplateMessageBody) String added in v0.14.0 

func (s CreateTemplateMessageBody) String() string

String returns the string representation

type CreateVoiceTemplateInput added in v0.17.0 

type CreateVoiceTemplateInput struct {

	// TemplateName is a required field
	TemplateName *string `location:"uri" locationName:"template-name" type:"string" required:"true"`

	// Specifies the content and settings for a message template that can be used
	// in messages that are sent through the voice channel.
	//
	// VoiceTemplateRequest is a required field
	VoiceTemplateRequest *VoiceTemplateRequest `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (CreateVoiceTemplateInput) MarshalFields added in v0.17.0 

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

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

func (CreateVoiceTemplateInput) String added in v0.17.0 

func (s CreateVoiceTemplateInput) String() string

String returns the string representation

func (*CreateVoiceTemplateInput) Validate added in v0.17.0 

func (s *CreateVoiceTemplateInput) Validate() error

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

type CreateVoiceTemplateOutput added in v0.17.0 

type CreateVoiceTemplateOutput struct {

	// Provides information about a request to create a message template.
	//
	// CreateTemplateMessageBody is a required field
	CreateTemplateMessageBody *CreateTemplateMessageBody `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (CreateVoiceTemplateOutput) MarshalFields added in v0.17.0 

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

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

func (CreateVoiceTemplateOutput) String added in v0.17.0 

func (s CreateVoiceTemplateOutput) String() string

String returns the string representation

type CreateVoiceTemplateRequest added in v0.17.0 

type CreateVoiceTemplateRequest struct {
	*aws.Request
	Input *CreateVoiceTemplateInput
	Copy  func(*CreateVoiceTemplateInput) CreateVoiceTemplateRequest
}

CreateVoiceTemplateRequest is the request type for the CreateVoiceTemplate API operation.

func (CreateVoiceTemplateRequest) Send added in v0.17.0 

func (r CreateVoiceTemplateRequest) Send(ctx context.Context) (*CreateVoiceTemplateResponse, error)

Send marshals and sends the CreateVoiceTemplate API request.

type CreateVoiceTemplateResponse added in v0.17.0 

type CreateVoiceTemplateResponse struct {
	*CreateVoiceTemplateOutput
	// contains filtered or unexported fields
}

CreateVoiceTemplateResponse is the response type for the CreateVoiceTemplate API operation.

func (*CreateVoiceTemplateResponse) SDKResponseMetdata added in v0.17.0 

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

SDKResponseMetdata returns the response metadata for the CreateVoiceTemplate request.

type CustomDeliveryConfiguration added in v0.22.0 

type CustomDeliveryConfiguration struct {

	// The destination to send the campaign or treatment to. This value can be one
	// of the following:
	//
	//    * The name or Amazon Resource Name (ARN) of an AWS Lambda function to
	//    invoke to handle delivery of the campaign or treatment.
	//
	//    * The URL for a web application or service that supports HTTPS and can
	//    receive the message. The URL has to be a full URL, including the HTTPS
	//    protocol.
	//
	// DeliveryUri is a required field
	DeliveryUri *string `type:"string" required:"true"`

	// The types of endpoints to send the campaign or treatment to. Each valid value
	// maps to a type of channel that you can associate with an endpoint by using
	// the ChannelType property of an endpoint.
	EndpointTypes []EndpointTypesElement `type:"list"`
	// contains filtered or unexported fields
}

Specifies the delivery configuration settings for sending a campaign or campaign treatment through a custom channel. This object is required if you use the CampaignCustomMessage object to define the message to send for the campaign or campaign treatment.

func (CustomDeliveryConfiguration) MarshalFields added in v0.22.0 

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

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

func (CustomDeliveryConfiguration) String added in v0.22.0 

func (s CustomDeliveryConfiguration) String() string

String returns the string representation

func (*CustomDeliveryConfiguration) Validate added in v0.22.0 

func (s *CustomDeliveryConfiguration) Validate() error

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

type CustomMessageActivity added in v0.24.0 

type CustomMessageActivity struct {

	// The destination to send the custom message to. This value can be one of the
	// following:
	//
	//    * The name or Amazon Resource Name (ARN) of an AWS Lambda function to
	//    invoke to handle delivery of the custom message.
	//
	//    * The URL for a web application or service that supports HTTPS and can
	//    receive the message. The URL has to be a full URL, including the HTTPS
	//    protocol.
	DeliveryUri *string `type:"string"`

	// The types of endpoints to send the custom message to. Each valid value maps
	// to a type of channel that you can associate with an endpoint by using the
	// ChannelType property of an endpoint.
	EndpointTypes []EndpointTypesElement `type:"list"`

	// Specifies the message data included in a custom channel message that's sent
	// to participants in a journey.
	MessageConfig *JourneyCustomMessage `type:"structure"`

	// The unique identifier for the next activity to perform, after Amazon Pinpoint
	// calls the AWS Lambda function or web hook.
	NextActivity *string `type:"string"`

	// The name of the custom message template to use for the message. If specified,
	// this value must match the name of an existing message template.
	TemplateName *string `type:"string"`

	// The unique identifier for the version of the message template to use for
	// the message. If specified, this value must match the identifier for an existing
	// template version. To retrieve a list of versions and version identifiers
	// for a template, use the Template Versions resource.
	//
	// If you don't specify a value for this property, Amazon Pinpoint uses the
	// active version of the template. The active version is typically the version
	// of a template that's been most recently reviewed and approved for use, depending
	// on your workflow. It isn't necessarily the latest version of a template.
	TemplateVersion *string `type:"string"`
	// contains filtered or unexported fields
}

The settings for a custom message activity. This type of activity calls an AWS Lambda function or web hook that sends messages to participants.

func (CustomMessageActivity) MarshalFields added in v0.24.0 

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

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

func (CustomMessageActivity) String added in v0.24.0 

func (s CustomMessageActivity) String() string

String returns the string representation

type DefaultMessage 

type DefaultMessage struct {

	// The default body of the message.
	Body *string `type:"string"`

	// The default message variables to use in the 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 for all channels.

func (DefaultMessage) MarshalFields added in v0.3.0 

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

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

func (DefaultMessage) String 

func (s DefaultMessage) String() string

String returns the string representation

type DefaultPushNotificationMessage 

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 Action `type:"string" enum:"true"`

	// 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 (DefaultPushNotificationMessage) MarshalFields added in v0.3.0 

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

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

func (DefaultPushNotificationMessage) String 

func (s DefaultPushNotificationMessage) String() string

String returns the string representation

type DefaultPushNotificationTemplate added in v0.14.0 

type DefaultPushNotificationTemplate struct {

	// The action to occur if a recipient taps a push notification that's based
	// on the message template. 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 Action `type:"string" enum:"true"`

	// The message body to use in push notifications that are based on the message
	// template.
	Body *string `type:"string"`

	// The sound to play when a recipient receives a push notification that's based
	// on the message template. 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/.
	//
	// For an iOS platform, this value is the key for 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 title to use in push notifications that are based on the message template.
	// This title appears 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
	// a push notification that's based on the message template 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 message template that can be used in messages that are sent through a push notification channel.

func (DefaultPushNotificationTemplate) MarshalFields added in v0.14.0 

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

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

func (DefaultPushNotificationTemplate) String added in v0.14.0 

func (s DefaultPushNotificationTemplate) String() string

String returns the string representation

type DeleteAdmChannelInput 

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 (DeleteAdmChannelInput) MarshalFields added in v0.3.0 

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

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

func (DeleteAdmChannelInput) String 

func (s DeleteAdmChannelInput) String() string

String returns the string representation

func (*DeleteAdmChannelInput) Validate 

func (s *DeleteAdmChannelInput) Validate() error

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

type DeleteAdmChannelOutput 

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 (DeleteAdmChannelOutput) MarshalFields added in v0.3.0 

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

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

func (DeleteAdmChannelOutput) String 

func (s DeleteAdmChannelOutput) String() string

String returns the string representation

type DeleteAdmChannelRequest 

type DeleteAdmChannelRequest struct {
	*aws.Request
	Input *DeleteAdmChannelInput
	Copy  func(*DeleteAdmChannelInput) DeleteAdmChannelRequest
}

DeleteAdmChannelRequest is the request type for the DeleteAdmChannel API operation.

func (DeleteAdmChannelRequest) Send 

func (r DeleteAdmChannelRequest) Send(ctx context.Context) (*DeleteAdmChannelResponse, error)

Send marshals and sends the DeleteAdmChannel API request.

type DeleteAdmChannelResponse added in v0.9.0 

type DeleteAdmChannelResponse struct {
	*DeleteAdmChannelOutput
	// contains filtered or unexported fields
}

DeleteAdmChannelResponse is the response type for the DeleteAdmChannel API operation.

func (*DeleteAdmChannelResponse) SDKResponseMetdata added in v0.9.0 

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

SDKResponseMetdata returns the response metadata for the DeleteAdmChannel request.

type DeleteApnsChannelInput 

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 (DeleteApnsChannelInput) MarshalFields added in v0.3.0 

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

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

func (DeleteApnsChannelInput) String 

func (s DeleteApnsChannelInput) String() string

String returns the string representation

func (*DeleteApnsChannelInput) Validate 

func (s *DeleteApnsChannelInput) Validate() error

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

type DeleteApnsChannelOutput 

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 (DeleteApnsChannelOutput) MarshalFields added in v0.3.0 

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

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

func (DeleteApnsChannelOutput) String 

func (s DeleteApnsChannelOutput) String() string

String returns the string representation

type DeleteApnsChannelRequest 

type DeleteApnsChannelRequest struct {
	*aws.Request
	Input *DeleteApnsChannelInput
	Copy  func(*DeleteApnsChannelInput) DeleteApnsChannelRequest
}

DeleteApnsChannelRequest is the request type for the DeleteApnsChannel API operation.

func (DeleteApnsChannelRequest) Send 

func (r DeleteApnsChannelRequest) Send(ctx context.Context) (*DeleteApnsChannelResponse, error)

Send marshals and sends the DeleteApnsChannel API request.

type DeleteApnsChannelResponse added in v0.9.0 

type DeleteApnsChannelResponse struct {
	*DeleteApnsChannelOutput
	// contains filtered or unexported fields
}

DeleteApnsChannelResponse is the response type for the DeleteApnsChannel API operation.

func (*DeleteApnsChannelResponse) SDKResponseMetdata added in v0.9.0 

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

SDKResponseMetdata returns the response metadata for the DeleteApnsChannel request.

type DeleteApnsSandboxChannelInput 

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 (DeleteApnsSandboxChannelInput) MarshalFields added in v0.3.0 

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

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

func (DeleteApnsSandboxChannelInput) String 

func (s DeleteApnsSandboxChannelInput) String() string

String returns the string representation

func (*DeleteApnsSandboxChannelInput) Validate 

func (s *DeleteApnsSandboxChannelInput) Validate() error

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

type DeleteApnsSandboxChannelOutput 

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 (DeleteApnsSandboxChannelOutput) MarshalFields added in v0.3.0 

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

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

func (DeleteApnsSandboxChannelOutput) String 

func (s DeleteApnsSandboxChannelOutput) String() string

String returns the string representation

type DeleteApnsSandboxChannelRequest 

type DeleteApnsSandboxChannelRequest struct {
	*aws.Request
	Input *DeleteApnsSandboxChannelInput
	Copy  func(*DeleteApnsSandboxChannelInput) DeleteApnsSandboxChannelRequest
}

DeleteApnsSandboxChannelRequest is the request type for the DeleteApnsSandboxChannel API operation.

func (DeleteApnsSandboxChannelRequest) Send 

func (r DeleteApnsSandboxChannelRequest) Send(ctx context.Context) (*DeleteApnsSandboxChannelResponse, error)

Send marshals and sends the DeleteApnsSandboxChannel API request.

type DeleteApnsSandboxChannelResponse added in v0.9.0 

type DeleteApnsSandboxChannelResponse struct {
	*DeleteApnsSandboxChannelOutput
	// contains filtered or unexported fields
}

DeleteApnsSandboxChannelResponse is the response type for the DeleteApnsSandboxChannel API operation.

func (*DeleteApnsSandboxChannelResponse) SDKResponseMetdata added in v0.9.0 

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

SDKResponseMetdata returns the response metadata for the DeleteApnsSandboxChannel request.

type DeleteApnsVoipChannelInput added in v0.2.0 

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 (DeleteApnsVoipChannelInput) MarshalFields added in v0.3.0 

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

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

func (DeleteApnsVoipChannelInput) String added in v0.2.0 

func (s DeleteApnsVoipChannelInput) String() string

String returns the string representation

func (*DeleteApnsVoipChannelInput) Validate added in v0.2.0 

func (s *DeleteApnsVoipChannelInput) Validate() error

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

type DeleteApnsVoipChannelOutput added in v0.2.0 

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 (DeleteApnsVoipChannelOutput) MarshalFields added in v0.3.0 

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

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

func (DeleteApnsVoipChannelOutput) String added in v0.2.0 

func (s DeleteApnsVoipChannelOutput) String() string

String returns the string representation

type DeleteApnsVoipChannelRequest added in v0.2.0 

type DeleteApnsVoipChannelRequest struct {
	*aws.Request
	Input *DeleteApnsVoipChannelInput
	Copy  func(*DeleteApnsVoipChannelInput) DeleteApnsVoipChannelRequest
}

DeleteApnsVoipChannelRequest is the request type for the DeleteApnsVoipChannel API operation.

func (DeleteApnsVoipChannelRequest) Send added in v0.2.0 

func (r DeleteApnsVoipChannelRequest) Send(ctx context.Context) (*DeleteApnsVoipChannelResponse, error)

Send marshals and sends the DeleteApnsVoipChannel API request.

type DeleteApnsVoipChannelResponse added in v0.9.0 

type DeleteApnsVoipChannelResponse struct {
	*DeleteApnsVoipChannelOutput
	// contains filtered or unexported fields
}

DeleteApnsVoipChannelResponse is the response type for the DeleteApnsVoipChannel API operation.

func (*DeleteApnsVoipChannelResponse) SDKResponseMetdata added in v0.9.0 

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

SDKResponseMetdata returns the response metadata for the DeleteApnsVoipChannel request.

type DeleteApnsVoipSandboxChannelInput added in v0.2.0 

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 (DeleteApnsVoipSandboxChannelInput) MarshalFields added in v0.3.0 

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

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

func (DeleteApnsVoipSandboxChannelInput) String added in v0.2.0 

func (s DeleteApnsVoipSandboxChannelInput) String() string

String returns the string representation

func (*DeleteApnsVoipSandboxChannelInput) Validate added in v0.2.0 

func (s *DeleteApnsVoipSandboxChannelInput) Validate() error

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

type DeleteApnsVoipSandboxChannelOutput added in v0.2.0 

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 (DeleteApnsVoipSandboxChannelOutput) MarshalFields added in v0.3.0 

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

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

func (DeleteApnsVoipSandboxChannelOutput) String added in v0.2.0 

func (s DeleteApnsVoipSandboxChannelOutput) String() string

String returns the string representation

type DeleteApnsVoipSandboxChannelRequest added in v0.2.0 

type DeleteApnsVoipSandboxChannelRequest struct {
	*aws.Request
	Input *DeleteApnsVoipSandboxChannelInput
	Copy  func(*DeleteApnsVoipSandboxChannelInput) DeleteApnsVoipSandboxChannelRequest
}

DeleteApnsVoipSandboxChannelRequest is the request type for the DeleteApnsVoipSandboxChannel API operation.

func (DeleteApnsVoipSandboxChannelRequest) Send added in v0.2.0 

func (r DeleteApnsVoipSandboxChannelRequest) Send(ctx context.Context) (*DeleteApnsVoipSandboxChannelResponse, error)

Send marshals and sends the DeleteApnsVoipSandboxChannel API request.

type DeleteApnsVoipSandboxChannelResponse added in v0.9.0 

type DeleteApnsVoipSandboxChannelResponse struct {
	*DeleteApnsVoipSandboxChannelOutput
	// contains filtered or unexported fields
}

DeleteApnsVoipSandboxChannelResponse is the response type for the DeleteApnsVoipSandboxChannel API operation.

func (*DeleteApnsVoipSandboxChannelResponse) SDKResponseMetdata added in v0.9.0 

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

SDKResponseMetdata returns the response metadata for the DeleteApnsVoipSandboxChannel request.

type DeleteAppInput 

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 (DeleteAppInput) MarshalFields added in v0.3.0 

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

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

func (DeleteAppInput) String 

func (s DeleteAppInput) String() string

String returns the string representation

func (*DeleteAppInput) Validate 

func (s *DeleteAppInput) Validate() error

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

type DeleteAppOutput 

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 (DeleteAppOutput) MarshalFields added in v0.3.0 

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

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

func (DeleteAppOutput) String 

func (s DeleteAppOutput) String() string

String returns the string representation

type DeleteAppRequest 

type DeleteAppRequest struct {
	*aws.Request
	Input *DeleteAppInput
	Copy  func(*DeleteAppInput) DeleteAppRequest
}

DeleteAppRequest is the request type for the DeleteApp API operation.

func (DeleteAppRequest) Send 

func (r DeleteAppRequest) Send(ctx context.Context) (*DeleteAppResponse, error)

Send marshals and sends the DeleteApp API request.

type DeleteAppResponse added in v0.9.0 

type DeleteAppResponse struct {
	*DeleteAppOutput
	// contains filtered or unexported fields
}

DeleteAppResponse is the response type for the DeleteApp API operation.

func (*DeleteAppResponse) SDKResponseMetdata added in v0.9.0 

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

SDKResponseMetdata returns the response metadata for the DeleteApp request.

type DeleteBaiduChannelInput 

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 (DeleteBaiduChannelInput) MarshalFields added in v0.3.0 

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

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

func (DeleteBaiduChannelInput) String 

func (s DeleteBaiduChannelInput) String() string

String returns the string representation

func (*DeleteBaiduChannelInput) Validate 

func (s *DeleteBaiduChannelInput) Validate() error

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

type DeleteBaiduChannelOutput 

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 (DeleteBaiduChannelOutput) MarshalFields added in v0.3.0 

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

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

func (DeleteBaiduChannelOutput) String 

func (s DeleteBaiduChannelOutput) String() string

String returns the string representation

type DeleteBaiduChannelRequest 

type DeleteBaiduChannelRequest struct {
	*aws.Request
	Input *DeleteBaiduChannelInput
	Copy  func(*DeleteBaiduChannelInput) DeleteBaiduChannelRequest
}

DeleteBaiduChannelRequest is the request type for the DeleteBaiduChannel API operation.

func (DeleteBaiduChannelRequest) Send 

func (r DeleteBaiduChannelRequest) Send(ctx context.Context) (*DeleteBaiduChannelResponse, error)

Send marshals and sends the DeleteBaiduChannel API request.

type DeleteBaiduChannelResponse added in v0.9.0 

type DeleteBaiduChannelResponse struct {
	*DeleteBaiduChannelOutput
	// contains filtered or unexported fields
}

DeleteBaiduChannelResponse is the response type for the DeleteBaiduChannel API operation.

func (*DeleteBaiduChannelResponse) SDKResponseMetdata added in v0.9.0 

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

SDKResponseMetdata returns the response metadata for the DeleteBaiduChannel request.

type DeleteCampaignInput 

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 (DeleteCampaignInput) MarshalFields added in v0.3.0 

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

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

func (DeleteCampaignInput) String 

func (s DeleteCampaignInput) String() string

String returns the string representation

func (*DeleteCampaignInput) Validate 

func (s *DeleteCampaignInput) Validate() error

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

type DeleteCampaignOutput 

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 (DeleteCampaignOutput) MarshalFields added in v0.3.0 

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

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

func (DeleteCampaignOutput) String 

func (s DeleteCampaignOutput) String() string

String returns the string representation

type DeleteCampaignRequest 

type DeleteCampaignRequest struct {
	*aws.Request
	Input *DeleteCampaignInput
	Copy  func(*DeleteCampaignInput) DeleteCampaignRequest
}

DeleteCampaignRequest is the request type for the DeleteCampaign API operation.

func (DeleteCampaignRequest) Send 

func (r DeleteCampaignRequest) Send(ctx context.Context) (*DeleteCampaignResponse, error)

Send marshals and sends the DeleteCampaign API request.

type DeleteCampaignResponse added in v0.9.0 

type DeleteCampaignResponse struct {
	*DeleteCampaignOutput
	// contains filtered or unexported fields
}

DeleteCampaignResponse is the response type for the DeleteCampaign API operation.

func (*DeleteCampaignResponse) SDKResponseMetdata added in v0.9.0 

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

SDKResponseMetdata returns the response metadata for the DeleteCampaign request.

type DeleteEmailChannelInput 

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 (DeleteEmailChannelInput) MarshalFields added in v0.3.0 

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

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

func (DeleteEmailChannelInput) String 

func (s DeleteEmailChannelInput) String() string

String returns the string representation

func (*DeleteEmailChannelInput) Validate 

func (s *DeleteEmailChannelInput) Validate() error

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

type DeleteEmailChannelOutput 

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 (DeleteEmailChannelOutput) MarshalFields added in v0.3.0 

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

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

func (DeleteEmailChannelOutput) String 

func (s DeleteEmailChannelOutput) String() string

String returns the string representation

type DeleteEmailChannelRequest 

type DeleteEmailChannelRequest struct {
	*aws.Request
	Input *DeleteEmailChannelInput
	Copy  func(*DeleteEmailChannelInput) DeleteEmailChannelRequest
}

DeleteEmailChannelRequest is the request type for the DeleteEmailChannel API operation.

func (DeleteEmailChannelRequest) Send 

func (r DeleteEmailChannelRequest) Send(ctx context.Context) (*DeleteEmailChannelResponse, error)

Send marshals and sends the DeleteEmailChannel API request.

type DeleteEmailChannelResponse added in v0.9.0 

type DeleteEmailChannelResponse struct {
	*DeleteEmailChannelOutput
	// contains filtered or unexported fields
}

DeleteEmailChannelResponse is the response type for the DeleteEmailChannel API operation.

func (*DeleteEmailChannelResponse) SDKResponseMetdata added in v0.9.0 

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

SDKResponseMetdata returns the response metadata for the DeleteEmailChannel request.

type DeleteEmailTemplateInput added in v0.14.0 

type DeleteEmailTemplateInput struct {

	// TemplateName is a required field
	TemplateName *string `location:"uri" locationName:"template-name" type:"string" required:"true"`

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

func (DeleteEmailTemplateInput) MarshalFields added in v0.14.0 

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

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

func (DeleteEmailTemplateInput) String added in v0.14.0 

func (s DeleteEmailTemplateInput) String() string

String returns the string representation

func (*DeleteEmailTemplateInput) Validate added in v0.14.0 

func (s *DeleteEmailTemplateInput) Validate() error

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

type DeleteEmailTemplateOutput added in v0.14.0 

type DeleteEmailTemplateOutput struct {

	// Provides information about an API request or response.
	//
	// MessageBody is a required field
	MessageBody *MessageBody `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteEmailTemplateOutput) MarshalFields added in v0.14.0 

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

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

func (DeleteEmailTemplateOutput) String added in v0.14.0 

func (s DeleteEmailTemplateOutput) String() string

String returns the string representation

type DeleteEmailTemplateRequest added in v0.14.0 

type DeleteEmailTemplateRequest struct {
	*aws.Request
	Input *DeleteEmailTemplateInput
	Copy  func(*DeleteEmailTemplateInput) DeleteEmailTemplateRequest
}

DeleteEmailTemplateRequest is the request type for the DeleteEmailTemplate API operation.

func (DeleteEmailTemplateRequest) Send added in v0.14.0 

func (r DeleteEmailTemplateRequest) Send(ctx context.Context) (*DeleteEmailTemplateResponse, error)

Send marshals and sends the DeleteEmailTemplate API request.

type DeleteEmailTemplateResponse added in v0.14.0 

type DeleteEmailTemplateResponse struct {
	*DeleteEmailTemplateOutput
	// contains filtered or unexported fields
}

DeleteEmailTemplateResponse is the response type for the DeleteEmailTemplate API operation.

func (*DeleteEmailTemplateResponse) SDKResponseMetdata added in v0.14.0 

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

SDKResponseMetdata returns the response metadata for the DeleteEmailTemplate request.

type DeleteEndpointInput added in v0.4.0 

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 (DeleteEndpointInput) MarshalFields added in v0.4.0 

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

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

func (DeleteEndpointInput) String added in v0.4.0 

func (s DeleteEndpointInput) String() string

String returns the string representation

func (*DeleteEndpointInput) Validate added in v0.4.0 

func (s *DeleteEndpointInput) Validate() error

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

type DeleteEndpointOutput added in v0.4.0 

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 (DeleteEndpointOutput) MarshalFields added in v0.4.0 

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

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

func (DeleteEndpointOutput) String added in v0.4.0 

func (s DeleteEndpointOutput) String() string

String returns the string representation

type DeleteEndpointRequest added in v0.4.0 

type DeleteEndpointRequest struct {
	*aws.Request
	Input *DeleteEndpointInput
	Copy  func(*DeleteEndpointInput) DeleteEndpointRequest
}

DeleteEndpointRequest is the request type for the DeleteEndpoint API operation.

func (DeleteEndpointRequest) Send added in v0.4.0 

func (r DeleteEndpointRequest) Send(ctx context.Context) (*DeleteEndpointResponse, error)

Send marshals and sends the DeleteEndpoint API request.

type DeleteEndpointResponse added in v0.9.0 

type DeleteEndpointResponse struct {
	*DeleteEndpointOutput
	// contains filtered or unexported fields
}

DeleteEndpointResponse is the response type for the DeleteEndpoint API operation.

func (*DeleteEndpointResponse) SDKResponseMetdata added in v0.9.0 

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

SDKResponseMetdata returns the response metadata for the DeleteEndpoint request.

type DeleteEventStreamInput 

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 (DeleteEventStreamInput) MarshalFields added in v0.3.0 

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

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

func (DeleteEventStreamInput) String 

func (s DeleteEventStreamInput) String() string

String returns the string representation

func (*DeleteEventStreamInput) Validate 

func (s *DeleteEventStreamInput) Validate() error

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

type DeleteEventStreamOutput 

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 (DeleteEventStreamOutput) MarshalFields added in v0.3.0 

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

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

func (DeleteEventStreamOutput) String 

func (s DeleteEventStreamOutput) String() string

String returns the string representation

type DeleteEventStreamRequest 

type DeleteEventStreamRequest struct {
	*aws.Request
	Input *DeleteEventStreamInput
	Copy  func(*DeleteEventStreamInput) DeleteEventStreamRequest
}

DeleteEventStreamRequest is the request type for the DeleteEventStream API operation.

func (DeleteEventStreamRequest) Send 

func (r DeleteEventStreamRequest) Send(ctx context.Context) (*DeleteEventStreamResponse, error)

Send marshals and sends the DeleteEventStream API request.

type DeleteEventStreamResponse added in v0.9.0 

type DeleteEventStreamResponse struct {
	*DeleteEventStreamOutput
	// contains filtered or unexported fields
}

DeleteEventStreamResponse is the response type for the DeleteEventStream API operation.

func (*DeleteEventStreamResponse) SDKResponseMetdata added in v0.9.0 

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

SDKResponseMetdata returns the response metadata for the DeleteEventStream request.

type DeleteGcmChannelInput 

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 (DeleteGcmChannelInput) MarshalFields added in v0.3.0 

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

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

func (DeleteGcmChannelInput) String 

func (s DeleteGcmChannelInput) String() string

String returns the string representation

func (*DeleteGcmChannelInput) Validate 

func (s *DeleteGcmChannelInput) Validate() error

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

type DeleteGcmChannelOutput 

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 (DeleteGcmChannelOutput) MarshalFields added in v0.3.0 

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

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

func (DeleteGcmChannelOutput) String 

func (s DeleteGcmChannelOutput) String() string

String returns the string representation

type DeleteGcmChannelRequest 

type DeleteGcmChannelRequest struct {
	*aws.Request
	Input *DeleteGcmChannelInput
	Copy  func(*DeleteGcmChannelInput) DeleteGcmChannelRequest
}

DeleteGcmChannelRequest is the request type for the DeleteGcmChannel API operation.

func (DeleteGcmChannelRequest) Send 

func (r DeleteGcmChannelRequest) Send(ctx context.Context) (*DeleteGcmChannelResponse, error)

Send marshals and sends the DeleteGcmChannel API request.

type DeleteGcmChannelResponse added in v0.9.0 

type DeleteGcmChannelResponse struct {
	*DeleteGcmChannelOutput
	// contains filtered or unexported fields
}

DeleteGcmChannelResponse is the response type for the DeleteGcmChannel API operation.

func (*DeleteGcmChannelResponse) SDKResponseMetdata added in v0.9.0 

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

SDKResponseMetdata returns the response metadata for the DeleteGcmChannel request.

type DeleteJourneyInput added in v0.16.0 

type DeleteJourneyInput struct {

	// ApplicationId is a required field
	ApplicationId *string `location:"uri" locationName:"application-id" type:"string" required:"true"`

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

func (DeleteJourneyInput) MarshalFields added in v0.16.0 

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

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

func (DeleteJourneyInput) String added in v0.16.0 

func (s DeleteJourneyInput) String() string

String returns the string representation

func (*DeleteJourneyInput) Validate added in v0.16.0 

func (s *DeleteJourneyInput) Validate() error

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

type DeleteJourneyOutput added in v0.16.0 

type DeleteJourneyOutput struct {

	// Provides information about the status, configuration, and other settings
	// for a journey.
	//
	// JourneyResponse is a required field
	JourneyResponse *JourneyResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteJourneyOutput) MarshalFields added in v0.16.0 

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

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

func (DeleteJourneyOutput) String added in v0.16.0 

func (s DeleteJourneyOutput) String() string

String returns the string representation

type DeleteJourneyRequest added in v0.16.0 

type DeleteJourneyRequest struct {
	*aws.Request
	Input *DeleteJourneyInput
	Copy  func(*DeleteJourneyInput) DeleteJourneyRequest
}

DeleteJourneyRequest is the request type for the DeleteJourney API operation.

func (DeleteJourneyRequest) Send added in v0.16.0 

func (r DeleteJourneyRequest) Send(ctx context.Context) (*DeleteJourneyResponse, error)

Send marshals and sends the DeleteJourney API request.

type DeleteJourneyResponse added in v0.16.0 

type DeleteJourneyResponse struct {
	*DeleteJourneyOutput
	// contains filtered or unexported fields
}

DeleteJourneyResponse is the response type for the DeleteJourney API operation.

func (*DeleteJourneyResponse) SDKResponseMetdata added in v0.16.0 

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

SDKResponseMetdata returns the response metadata for the DeleteJourney request.

type DeletePushTemplateInput added in v0.14.0 

type DeletePushTemplateInput struct {

	// TemplateName is a required field
	TemplateName *string `location:"uri" locationName:"template-name" type:"string" required:"true"`

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

func (DeletePushTemplateInput) MarshalFields added in v0.14.0 

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

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

func (DeletePushTemplateInput) String added in v0.14.0 

func (s DeletePushTemplateInput) String() string

String returns the string representation

func (*DeletePushTemplateInput) Validate added in v0.14.0 

func (s *DeletePushTemplateInput) Validate() error

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

type DeletePushTemplateOutput added in v0.14.0 

type DeletePushTemplateOutput struct {

	// Provides information about an API request or response.
	//
	// MessageBody is a required field
	MessageBody *MessageBody `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (DeletePushTemplateOutput) MarshalFields added in v0.14.0 

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

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

func (DeletePushTemplateOutput) String added in v0.14.0 

func (s DeletePushTemplateOutput) String() string

String returns the string representation

type DeletePushTemplateRequest added in v0.14.0 

type DeletePushTemplateRequest struct {
	*aws.Request
	Input *DeletePushTemplateInput
	Copy  func(*DeletePushTemplateInput) DeletePushTemplateRequest
}

DeletePushTemplateRequest is the request type for the DeletePushTemplate API operation.

func (DeletePushTemplateRequest) Send added in v0.14.0 

func (r DeletePushTemplateRequest) Send(ctx context.Context) (*DeletePushTemplateResponse, error)

Send marshals and sends the DeletePushTemplate API request.

type DeletePushTemplateResponse added in v0.14.0 

type DeletePushTemplateResponse struct {
	*DeletePushTemplateOutput
	// contains filtered or unexported fields
}

DeletePushTemplateResponse is the response type for the DeletePushTemplate API operation.

func (*DeletePushTemplateResponse) SDKResponseMetdata added in v0.14.0 

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

SDKResponseMetdata returns the response metadata for the DeletePushTemplate request.

type DeleteRecommenderConfigurationInput added in v0.20.0 

type DeleteRecommenderConfigurationInput struct {

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

func (DeleteRecommenderConfigurationInput) MarshalFields added in v0.20.0 

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

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

func (DeleteRecommenderConfigurationInput) String added in v0.20.0 

func (s DeleteRecommenderConfigurationInput) String() string

String returns the string representation

func (*DeleteRecommenderConfigurationInput) Validate added in v0.20.0 

func (s *DeleteRecommenderConfigurationInput) Validate() error

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

type DeleteRecommenderConfigurationOutput added in v0.20.0 

type DeleteRecommenderConfigurationOutput struct {

	// Provides information about Amazon Pinpoint configuration settings for retrieving
	// and processing data from a recommender model.
	//
	// RecommenderConfigurationResponse is a required field
	RecommenderConfigurationResponse *RecommenderConfigurationResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteRecommenderConfigurationOutput) MarshalFields added in v0.20.0 

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

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

func (DeleteRecommenderConfigurationOutput) String added in v0.20.0 

func (s DeleteRecommenderConfigurationOutput) String() string

String returns the string representation

type DeleteRecommenderConfigurationRequest added in v0.20.0 

type DeleteRecommenderConfigurationRequest struct {
	*aws.Request
	Input *DeleteRecommenderConfigurationInput
	Copy  func(*DeleteRecommenderConfigurationInput) DeleteRecommenderConfigurationRequest
}

DeleteRecommenderConfigurationRequest is the request type for the DeleteRecommenderConfiguration API operation.

func (DeleteRecommenderConfigurationRequest) Send added in v0.20.0 

func (r DeleteRecommenderConfigurationRequest) Send(ctx context.Context) (*DeleteRecommenderConfigurationResponse, error)

Send marshals and sends the DeleteRecommenderConfiguration API request.

type DeleteRecommenderConfigurationResponse added in v0.20.0 

type DeleteRecommenderConfigurationResponse struct {
	*DeleteRecommenderConfigurationOutput
	// contains filtered or unexported fields
}

DeleteRecommenderConfigurationResponse is the response type for the DeleteRecommenderConfiguration API operation.

func (*DeleteRecommenderConfigurationResponse) SDKResponseMetdata added in v0.20.0 

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

SDKResponseMetdata returns the response metadata for the DeleteRecommenderConfiguration request.

type DeleteSegmentInput 

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 (DeleteSegmentInput) MarshalFields added in v0.3.0 

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

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

func (DeleteSegmentInput) String 

func (s DeleteSegmentInput) String() string

String returns the string representation

func (*DeleteSegmentInput) Validate 

func (s *DeleteSegmentInput) Validate() error

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

type DeleteSegmentOutput 

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 (DeleteSegmentOutput) MarshalFields added in v0.3.0 

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

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

func (DeleteSegmentOutput) String 

func (s DeleteSegmentOutput) String() string

String returns the string representation

type DeleteSegmentRequest 

type DeleteSegmentRequest struct {
	*aws.Request
	Input *DeleteSegmentInput
	Copy  func(*DeleteSegmentInput) DeleteSegmentRequest
}

DeleteSegmentRequest is the request type for the DeleteSegment API operation.

func (DeleteSegmentRequest) Send 

func (r DeleteSegmentRequest) Send(ctx context.Context) (*DeleteSegmentResponse, error)

Send marshals and sends the DeleteSegment API request.

type DeleteSegmentResponse added in v0.9.0 

type DeleteSegmentResponse struct {
	*DeleteSegmentOutput
	// contains filtered or unexported fields
}

DeleteSegmentResponse is the response type for the DeleteSegment API operation.

func (*DeleteSegmentResponse) SDKResponseMetdata added in v0.9.0 

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

SDKResponseMetdata returns the response metadata for the DeleteSegment request.

type DeleteSmsChannelInput 

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 (DeleteSmsChannelInput) MarshalFields added in v0.3.0 

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

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

func (DeleteSmsChannelInput) String 

func (s DeleteSmsChannelInput) String() string

String returns the string representation

func (*DeleteSmsChannelInput) Validate 

func (s *DeleteSmsChannelInput) Validate() error

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

type DeleteSmsChannelOutput 

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 (DeleteSmsChannelOutput) MarshalFields added in v0.3.0 

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

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

func (DeleteSmsChannelOutput) String 

func (s DeleteSmsChannelOutput) String() string

String returns the string representation

type DeleteSmsChannelRequest 

type DeleteSmsChannelRequest struct {
	*aws.Request
	Input *DeleteSmsChannelInput
	Copy  func(*DeleteSmsChannelInput) DeleteSmsChannelRequest
}

DeleteSmsChannelRequest is the request type for the DeleteSmsChannel API operation.

func (DeleteSmsChannelRequest) Send 

func (r DeleteSmsChannelRequest) Send(ctx context.Context) (*DeleteSmsChannelResponse, error)

Send marshals and sends the DeleteSmsChannel API request.

type DeleteSmsChannelResponse added in v0.9.0 

type DeleteSmsChannelResponse struct {
	*DeleteSmsChannelOutput
	// contains filtered or unexported fields
}

DeleteSmsChannelResponse is the response type for the DeleteSmsChannel API operation.

func (*DeleteSmsChannelResponse) SDKResponseMetdata added in v0.9.0 

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

SDKResponseMetdata returns the response metadata for the DeleteSmsChannel request.

type DeleteSmsTemplateInput added in v0.14.0 

type DeleteSmsTemplateInput struct {

	// TemplateName is a required field
	TemplateName *string `location:"uri" locationName:"template-name" type:"string" required:"true"`

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

func (DeleteSmsTemplateInput) MarshalFields added in v0.14.0 

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

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

func (DeleteSmsTemplateInput) String added in v0.14.0 

func (s DeleteSmsTemplateInput) String() string

String returns the string representation

func (*DeleteSmsTemplateInput) Validate added in v0.14.0 

func (s *DeleteSmsTemplateInput) Validate() error

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

type DeleteSmsTemplateOutput added in v0.14.0 

type DeleteSmsTemplateOutput struct {

	// Provides information about an API request or response.
	//
	// MessageBody is a required field
	MessageBody *MessageBody `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteSmsTemplateOutput) MarshalFields added in v0.14.0 

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

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

func (DeleteSmsTemplateOutput) String added in v0.14.0 

func (s DeleteSmsTemplateOutput) String() string

String returns the string representation

type DeleteSmsTemplateRequest added in v0.14.0 

type DeleteSmsTemplateRequest struct {
	*aws.Request
	Input *DeleteSmsTemplateInput
	Copy  func(*DeleteSmsTemplateInput) DeleteSmsTemplateRequest
}

DeleteSmsTemplateRequest is the request type for the DeleteSmsTemplate API operation.

func (DeleteSmsTemplateRequest) Send added in v0.14.0 

func (r DeleteSmsTemplateRequest) Send(ctx context.Context) (*DeleteSmsTemplateResponse, error)

Send marshals and sends the DeleteSmsTemplate API request.

type DeleteSmsTemplateResponse added in v0.14.0 

type DeleteSmsTemplateResponse struct {
	*DeleteSmsTemplateOutput
	// contains filtered or unexported fields
}

DeleteSmsTemplateResponse is the response type for the DeleteSmsTemplate API operation.

func (*DeleteSmsTemplateResponse) SDKResponseMetdata added in v0.14.0 

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

SDKResponseMetdata returns the response metadata for the DeleteSmsTemplate request.

type DeleteUserEndpointsInput added in v0.5.0 

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 (DeleteUserEndpointsInput) MarshalFields added in v0.5.0 

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

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

func (DeleteUserEndpointsInput) String added in v0.5.0 

func (s DeleteUserEndpointsInput) String() string

String returns the string representation

func (*DeleteUserEndpointsInput) Validate added in v0.5.0 

func (s *DeleteUserEndpointsInput) Validate() error

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

type DeleteUserEndpointsOutput added in v0.5.0 

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 (DeleteUserEndpointsOutput) MarshalFields added in v0.5.0 

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

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

func (DeleteUserEndpointsOutput) String added in v0.5.0 

func (s DeleteUserEndpointsOutput) String() string

String returns the string representation

type DeleteUserEndpointsRequest added in v0.5.0 

type DeleteUserEndpointsRequest struct {
	*aws.Request
	Input *DeleteUserEndpointsInput
	Copy  func(*DeleteUserEndpointsInput) DeleteUserEndpointsRequest
}

DeleteUserEndpointsRequest is the request type for the DeleteUserEndpoints API operation.

func (DeleteUserEndpointsRequest) Send added in v0.5.0 

func (r DeleteUserEndpointsRequest) Send(ctx context.Context) (*DeleteUserEndpointsResponse, error)

Send marshals and sends the DeleteUserEndpoints API request.

type DeleteUserEndpointsResponse added in v0.9.0 

type DeleteUserEndpointsResponse struct {
	*DeleteUserEndpointsOutput
	// contains filtered or unexported fields
}

DeleteUserEndpointsResponse is the response type for the DeleteUserEndpoints API operation.

func (*DeleteUserEndpointsResponse) SDKResponseMetdata added in v0.9.0 

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

SDKResponseMetdata returns the response metadata for the DeleteUserEndpoints request.

type DeleteVoiceChannelInput added in v0.6.0 

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 (DeleteVoiceChannelInput) MarshalFields added in v0.6.0 

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

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

func (DeleteVoiceChannelInput) String added in v0.6.0 

func (s DeleteVoiceChannelInput) String() string

String returns the string representation

func (*DeleteVoiceChannelInput) Validate added in v0.6.0 

func (s *DeleteVoiceChannelInput) Validate() error

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

type DeleteVoiceChannelOutput added in v0.6.0 

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 (DeleteVoiceChannelOutput) MarshalFields added in v0.6.0 

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

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

func (DeleteVoiceChannelOutput) String added in v0.6.0 

func (s DeleteVoiceChannelOutput) String() string

String returns the string representation

type DeleteVoiceChannelRequest added in v0.6.0 

type DeleteVoiceChannelRequest struct {
	*aws.Request
	Input *DeleteVoiceChannelInput
	Copy  func(*DeleteVoiceChannelInput) DeleteVoiceChannelRequest
}

DeleteVoiceChannelRequest is the request type for the DeleteVoiceChannel API operation.

func (DeleteVoiceChannelRequest) Send added in v0.6.0 

func (r DeleteVoiceChannelRequest) Send(ctx context.Context) (*DeleteVoiceChannelResponse, error)

Send marshals and sends the DeleteVoiceChannel API request.

type DeleteVoiceChannelResponse added in v0.9.0 

type DeleteVoiceChannelResponse struct {
	*DeleteVoiceChannelOutput
	// contains filtered or unexported fields
}

DeleteVoiceChannelResponse is the response type for the DeleteVoiceChannel API operation.

func (*DeleteVoiceChannelResponse) SDKResponseMetdata added in v0.9.0 

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

SDKResponseMetdata returns the response metadata for the DeleteVoiceChannel request.

type DeleteVoiceTemplateInput added in v0.17.0 

type DeleteVoiceTemplateInput struct {

	// TemplateName is a required field
	TemplateName *string `location:"uri" locationName:"template-name" type:"string" required:"true"`

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

func (DeleteVoiceTemplateInput) MarshalFields added in v0.17.0 

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

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

func (DeleteVoiceTemplateInput) String added in v0.17.0 

func (s DeleteVoiceTemplateInput) String() string

String returns the string representation

func (*DeleteVoiceTemplateInput) Validate added in v0.17.0 

func (s *DeleteVoiceTemplateInput) Validate() error

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

type DeleteVoiceTemplateOutput added in v0.17.0 

type DeleteVoiceTemplateOutput struct {

	// Provides information about an API request or response.
	//
	// MessageBody is a required field
	MessageBody *MessageBody `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteVoiceTemplateOutput) MarshalFields added in v0.17.0 

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

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

func (DeleteVoiceTemplateOutput) String added in v0.17.0 

func (s DeleteVoiceTemplateOutput) String() string

String returns the string representation

type DeleteVoiceTemplateRequest added in v0.17.0 

type DeleteVoiceTemplateRequest struct {
	*aws.Request
	Input *DeleteVoiceTemplateInput
	Copy  func(*DeleteVoiceTemplateInput) DeleteVoiceTemplateRequest
}

DeleteVoiceTemplateRequest is the request type for the DeleteVoiceTemplate API operation.

func (DeleteVoiceTemplateRequest) Send added in v0.17.0 

func (r DeleteVoiceTemplateRequest) Send(ctx context.Context) (*DeleteVoiceTemplateResponse, error)

Send marshals and sends the DeleteVoiceTemplate API request.

type DeleteVoiceTemplateResponse added in v0.17.0 

type DeleteVoiceTemplateResponse struct {
	*DeleteVoiceTemplateOutput
	// contains filtered or unexported fields
}

DeleteVoiceTemplateResponse is the response type for the DeleteVoiceTemplate API operation.

func (*DeleteVoiceTemplateResponse) SDKResponseMetdata added in v0.17.0 

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

SDKResponseMetdata returns the response metadata for the DeleteVoiceTemplate request.

type DeliveryStatus 

type DeliveryStatus string
const (
	DeliveryStatusSuccessful       DeliveryStatus = "SUCCESSFUL"
	DeliveryStatusThrottled        DeliveryStatus = "THROTTLED"
	DeliveryStatusTemporaryFailure DeliveryStatus = "TEMPORARY_FAILURE"
	DeliveryStatusPermanentFailure DeliveryStatus = "PERMANENT_FAILURE"
	DeliveryStatusUnknownFailure   DeliveryStatus = "UNKNOWN_FAILURE"
	DeliveryStatusOptOut           DeliveryStatus = "OPT_OUT"
	DeliveryStatusDuplicate        DeliveryStatus = "DUPLICATE"
)

Enum values for DeliveryStatus

func (DeliveryStatus) MarshalValue added in v0.3.0 

func (enum DeliveryStatus) MarshalValue() (string, error)

func (DeliveryStatus) MarshalValueBuf added in v0.3.0 

func (enum DeliveryStatus) MarshalValueBuf(b []byte) ([]byte, error)

type DimensionType 

type DimensionType string
const (
	DimensionTypeInclusive DimensionType = "INCLUSIVE"
	DimensionTypeExclusive DimensionType = "EXCLUSIVE"
)

Enum values for DimensionType

func (DimensionType) MarshalValue added in v0.3.0 

func (enum DimensionType) MarshalValue() (string, error)

func (DimensionType) MarshalValueBuf added in v0.3.0 

func (enum DimensionType) MarshalValueBuf(b []byte) ([]byte, error)

type DirectMessageConfiguration 

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 for all channels.
	DefaultMessage *DefaultMessage `type:"structure"`

	// The default push notification message for all push notification 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 (DirectMessageConfiguration) MarshalFields added in v0.3.0 

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

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

func (DirectMessageConfiguration) String 

func (s DirectMessageConfiguration) String() string

String returns the string representation

type Duration 

type Duration string
const (
	DurationHr24  Duration = "HR_24"
	DurationDay7  Duration = "DAY_7"
	DurationDay14 Duration = "DAY_14"
	DurationDay30 Duration = "DAY_30"
)

Enum values for Duration

func (Duration) MarshalValue added in v0.3.0 

func (enum Duration) MarshalValue() (string, error)

func (Duration) MarshalValueBuf added in v0.3.0 

func (enum Duration) MarshalValueBuf(b []byte) ([]byte, error)

type EmailChannelRequest 

type EmailChannelRequest struct {

	// The Amazon SES configuration set (https://docs.aws.amazon.com/ses/latest/APIReference/API_ConfigurationSet.html)
	// that you want to apply to messages that you send through the channel.
	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 (EmailChannelRequest) MarshalFields added in v0.3.0 

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

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

func (EmailChannelRequest) String 

func (s EmailChannelRequest) String() string

String returns the string representation

func (*EmailChannelRequest) Validate added in v0.10.0 

func (s *EmailChannelRequest) Validate() error

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

type EmailChannelResponse 

type EmailChannelResponse struct {

	// The unique identifier for the application that the email channel applies
	// to.
	ApplicationId *string `type:"string"`

	// The Amazon SES configuration set (https://docs.aws.amazon.com/ses/latest/APIReference/API_ConfigurationSet.html)
	// that's applied to messages that are sent through the channel.
	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 email is sent 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's used 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 can be sent 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 (EmailChannelResponse) MarshalFields added in v0.3.0 

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

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

func (EmailChannelResponse) String 

func (s EmailChannelResponse) String() string

String returns the string representation

type EmailMessage 

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 (EmailMessage) MarshalFields added in v0.6.0 

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

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

func (EmailMessage) String 

func (s EmailMessage) String() string

String returns the string representation

type EmailMessageActivity added in v0.16.0 

type EmailMessageActivity struct {

	// Specifies the sender address for an email message that's sent to participants
	// in the journey.
	MessageConfig *JourneyEmailMessage `type:"structure"`

	// The unique identifier for the next activity to perform, after the message
	// is sent.
	NextActivity *string `type:"string"`

	// The name of the email message template to use for the message. If specified,
	// this value must match the name of an existing message template.
	TemplateName *string `type:"string"`

	// The unique identifier for the version of the email template to use for the
	// message. If specified, this value must match the identifier for an existing
	// template version. To retrieve a list of versions and version identifiers
	// for a template, use the Template Versions resource.
	//
	// If you don't specify a value for this property, Amazon Pinpoint uses the
	// active version of the template. The active version is typically the version
	// of a template that's been most recently reviewed and approved for use, depending
	// on your workflow. It isn't necessarily the latest version of a template.
	TemplateVersion *string `type:"string"`
	// contains filtered or unexported fields
}

Specifies the settings for an email activity in a journey. This type of activity sends an email message to participants.

func (EmailMessageActivity) MarshalFields added in v0.16.0 

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

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

func (EmailMessageActivity) String added in v0.16.0 

func (s EmailMessageActivity) String() string

String returns the string representation

type EmailTemplateRequest added in v0.14.0 

type EmailTemplateRequest struct {

	// A JSON object that specifies the default values to use for message variables
	// in the message template. This object is a set of key-value pairs. Each key
	// defines a message variable in the template. The corresponding value defines
	// the default value for that variable. When you create a message that's based
	// on the template, you can override these defaults with message-specific and
	// address-specific variables and values.
	DefaultSubstitutions *string `type:"string"`

	// The message body, in HTML format, to use in email messages that are based
	// on the message template. We recommend using HTML format for email clients
	// that render HTML content. You can include links, formatted text, and more
	// in an HTML message.
	HtmlPart *string `type:"string"`

	// The unique identifier for the recommender model to use for the message template.
	// Amazon Pinpoint uses this value to determine how to retrieve and process
	// data from a recommender model when it sends messages that use the template,
	// if the template contains message variables for recommendation data.
	RecommenderId *string `type:"string"`

	// The subject line, or title, to use in email messages that are based on the
	// message template.
	Subject *string `type:"string"`

	// A string-to-string map of key-value pairs that defines the tags to associate
	// with the message template. Each tag consists of a required tag key and an
	// associated tag value.
	Tags map[string]string `locationName:"tags" type:"map"`

	// A custom description of the message template.
	TemplateDescription *string `type:"string"`

	// The message body, in plain text format, to use in email messages that are
	// based on the message template. We recommend using plain text format for email
	// clients that don't render HTML content and clients that are connected to
	// high-latency networks, such as mobile devices.
	TextPart *string `type:"string"`
	// contains filtered or unexported fields
}

Specifies the content and settings for a message template that can be used in messages that are sent through the email channel.

func (EmailTemplateRequest) MarshalFields added in v0.14.0 

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

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

func (EmailTemplateRequest) String added in v0.14.0 

func (s EmailTemplateRequest) String() string

String returns the string representation

type EmailTemplateResponse added in v0.14.0 

type EmailTemplateResponse struct {

	// The Amazon Resource Name (ARN) of the message template.
	Arn *string `type:"string"`

	// The date, in ISO 8601 format, when the message template was created.
	//
	// CreationDate is a required field
	CreationDate *string `type:"string" required:"true"`

	// The JSON object that specifies the default values that are used for message
	// variables in the message template. This object is a set of key-value pairs.
	// Each key defines a message variable in the template. The corresponding value
	// defines the default value for that variable.
	DefaultSubstitutions *string `type:"string"`

	// The message body, in HTML format, that's used in email messages that are
	// based on the message template.
	HtmlPart *string `type:"string"`

	// The date, in ISO 8601 format, when the message template was last modified.
	//
	// LastModifiedDate is a required field
	LastModifiedDate *string `type:"string" required:"true"`

	// The unique identifier for the recommender model that's used by the message
	// template.
	RecommenderId *string `type:"string"`

	// The subject line, or title, that's used in email messages that are based
	// on the message template.
	Subject *string `type:"string"`

	// A string-to-string map of key-value pairs that identifies the tags that are
	// associated with the message template. 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 the message template.
	TemplateDescription *string `type:"string"`

	// The name of the message template.
	//
	// TemplateName is a required field
	TemplateName *string `type:"string" required:"true"`

	// The type of channel that the message template is designed for. For an email
	// template, this value is EMAIL.
	//
	// TemplateType is a required field
	TemplateType TemplateType `type:"string" required:"true" enum:"true"`

	// The message body, in plain text format, that's used in email messages that
	// are based on the message template.
	TextPart *string `type:"string"`

	// The unique identifier, as an integer, for the active version of the message
	// template, or the version of the template that you specified by using the
	// version parameter in your request.
	Version *string `type:"string"`
	// contains filtered or unexported fields
}

Provides information about the content and settings for a message template that can be used in messages that are sent through the email channel.

func (EmailTemplateResponse) MarshalFields added in v0.14.0 

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

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

func (EmailTemplateResponse) String added in v0.14.0 

func (s EmailTemplateResponse) String() string

String returns the string representation

type EndpointBatchItem 

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. Attribute names are
	// case sensitive.
	//
	// An attribute name can contain up to 50 characters. An attribute value can
	// contain up to 100 characters. 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 restriction 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 ChannelType `type:"string" enum:"true"`

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

	// Specifies whether to send messages or push notifications to the endpoint.
	// Valid values are: ACTIVE, messages are sent to the endpoint; and, INACTIVE,
	// messages aren’t sent to the endpoint.
	//
	// Amazon Pinpoint automatically sets this value to ACTIVE when you create an
	// endpoint or update an existing endpoint. Amazon Pinpoint automatically sets
	// this value to INACTIVE if you update another endpoint that has the same address
	// specified by the Address property.
	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 attributes that describe 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 (EndpointBatchItem) MarshalFields added in v0.3.0 

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

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

func (EndpointBatchItem) String 

func (s EndpointBatchItem) String() string

String returns the string representation

type EndpointBatchRequest 

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 (EndpointBatchRequest) MarshalFields added in v0.3.0 

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

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

func (EndpointBatchRequest) String 

func (s EndpointBatchRequest) String() string

String returns the string representation

func (*EndpointBatchRequest) Validate added in v0.10.0 

func (s *EndpointBatchRequest) Validate() error

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

type EndpointDemographic 

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 or SM-G900F.
	Model *string `type:"string"`

	// The model version of the endpoint device.
	ModelVersion *string `type:"string"`

	// The platform of the endpoint device, such as ios.
	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 (EndpointDemographic) MarshalFields added in v0.3.0 

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

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

func (EndpointDemographic) String 

func (s EndpointDemographic) String() string

String returns the string representation

type EndpointItemResponse added in v0.5.0 

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 (EndpointItemResponse) MarshalFields added in v0.5.0 

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

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

func (EndpointItemResponse) String added in v0.5.0 

func (s EndpointItemResponse) String() string

String returns the string representation

type EndpointLocation 

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 (EndpointLocation) MarshalFields added in v0.3.0 

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

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

func (EndpointLocation) String 

func (s EndpointLocation) String() string

String returns the string representation

type EndpointMessageResult 

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 won't
	//    attempt to send the message again.
	//
	//    * 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 DeliveryStatus `type:"string" required:"true" enum:"true"`

	// 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 endpoint's device registration 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 (EndpointMessageResult) MarshalFields added in v0.3.0 

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

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

func (EndpointMessageResult) String 

func (s EndpointMessageResult) String() string

String returns the string representation

type EndpointRequest 

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. Attribute names are
	// case sensitive.
	//
	// An attribute name can contain up to 50 characters. An attribute value can
	// contain up to 100 characters. 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 restriction 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 ChannelType `type:"string" enum:"true"`

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

	// Specifies whether to send messages or push notifications to the endpoint.
	// Valid values are: ACTIVE, messages are sent to the endpoint; and, INACTIVE,
	// messages aren’t sent to the endpoint.
	//
	// Amazon Pinpoint automatically sets this value to ACTIVE when you create an
	// endpoint or update an existing endpoint. Amazon Pinpoint automatically sets
	// this value to INACTIVE if you update another endpoint that has the same address
	// specified by the Address property.
	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 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 (EndpointRequest) MarshalFields added in v0.3.0 

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

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

func (EndpointRequest) String 

func (s EndpointRequest) String() string

String returns the string representation

type EndpointResponse 

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 ChannelType `type:"string" enum:"true"`

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

	// Specifies whether messages or push notifications are sent to the endpoint.
	// Possible values are: ACTIVE, messages are sent to the endpoint; and, INACTIVE,
	// messages aren’t sent to the endpoint.
	//
	// Amazon Pinpoint automatically sets this value to ACTIVE when you create an
	// endpoint or update an existing endpoint. Amazon Pinpoint automatically sets
	// this value to INACTIVE if you update another endpoint that has the same address
	// specified by the Address property.
	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 (EndpointResponse) MarshalFields added in v0.3.0 

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

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

func (EndpointResponse) String 

func (s EndpointResponse) String() string

String returns the string representation

type EndpointSendConfiguration 

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. Attribute
	// names are case sensitive.
	//
	// 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 all other values for 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 (EndpointSendConfiguration) MarshalFields added in v0.3.0 

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

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

func (EndpointSendConfiguration) String 

func (s EndpointSendConfiguration) String() string

String returns the string representation

type EndpointTypesElement added in v0.22.0 

type EndpointTypesElement string
const (
	EndpointTypesElementPush            EndpointTypesElement = "PUSH"
	EndpointTypesElementGcm             EndpointTypesElement = "GCM"
	EndpointTypesElementApns            EndpointTypesElement = "APNS"
	EndpointTypesElementApnsSandbox     EndpointTypesElement = "APNS_SANDBOX"
	EndpointTypesElementApnsVoip        EndpointTypesElement = "APNS_VOIP"
	EndpointTypesElementApnsVoipSandbox EndpointTypesElement = "APNS_VOIP_SANDBOX"
	EndpointTypesElementAdm             EndpointTypesElement = "ADM"
	EndpointTypesElementSms             EndpointTypesElement = "SMS"
	EndpointTypesElementVoice           EndpointTypesElement = "VOICE"
	EndpointTypesElementEmail           EndpointTypesElement = "EMAIL"
	EndpointTypesElementBaidu           EndpointTypesElement = "BAIDU"
	EndpointTypesElementCustom          EndpointTypesElement = "CUSTOM"
)

Enum values for EndpointTypesElement

func (EndpointTypesElement) MarshalValue added in v0.22.0 

func (enum EndpointTypesElement) MarshalValue() (string, error)

func (EndpointTypesElement) MarshalValueBuf added in v0.22.0 

func (enum EndpointTypesElement) MarshalValueBuf(b []byte) ([]byte, error)

type EndpointUser 

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. Attribute names are case sensitive.
	//
	// An attribute name can contain up to 50 characters. An attribute value can
	// contain up to 100 characters. 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 restriction 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 (EndpointUser) MarshalFields added in v0.3.0 

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

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

func (EndpointUser) String 

func (s EndpointUser) String() string

String returns the string representation

type EndpointsResponse added in v0.5.0 

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 (EndpointsResponse) MarshalFields added in v0.5.0 

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

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

func (EndpointsResponse) String added in v0.5.0 

func (s EndpointsResponse) String() string

String returns the string representation

type Event added in v0.5.0 

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 (Event) MarshalFields added in v0.5.0 

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

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

func (Event) String added in v0.5.0 

func (s Event) String() string

String returns the string representation

func (*Event) Validate added in v0.10.0 

func (s *Event) Validate() error

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

type EventCondition added in v0.16.0 

type EventCondition struct {

	// The dimensions for the event filter to use for the activity.
	//
	// Dimensions is a required field
	Dimensions *EventDimensions `type:"structure" required:"true"`

	// The message identifier (message_id) for the message to use when determining
	// whether message events meet the condition.
	MessageActivity *string `type:"string"`
	// contains filtered or unexported fields
}

Specifies the conditions to evaluate for an event that applies to an activity in a journey.

func (EventCondition) MarshalFields added in v0.16.0 

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

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

func (EventCondition) String added in v0.16.0 

func (s EventCondition) String() string

String returns the string representation

func (*EventCondition) Validate added in v0.16.0 

func (s *EventCondition) Validate() error

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

type EventDimensions added in v0.6.0 

type EventDimensions struct {

	// One or more custom attributes that your application 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 or the journey
	// activity to be performed. This can be a standard event that Amazon Pinpoint
	// generates, such as _email.delivered. For campaigns, this can also be a custom
	// event that's specific to your application. For information about standard
	// events, see Streaming Amazon Pinpoint Events (https://docs.aws.amazon.com/pinpoint/latest/developerguide/event-streams.html)
	// in the Amazon Pinpoint Developer Guide.
	EventType *SetDimension `type:"structure"`

	// One or more custom metrics that your application 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 or a journey activity is performed.

func (EventDimensions) MarshalFields added in v0.6.0 

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

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

func (EventDimensions) String added in v0.6.0 

func (s EventDimensions) String() string

String returns the string representation

func (*EventDimensions) Validate added in v0.10.0 

func (s *EventDimensions) Validate() error

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

type EventItemResponse added in v0.5.0 

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 (EventItemResponse) MarshalFields added in v0.5.0 

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

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

func (EventItemResponse) String added in v0.5.0 

func (s EventItemResponse) String() string

String returns the string representation

type EventStream 

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 (EventStream) MarshalFields added in v0.3.0 

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

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

func (EventStream) String 

func (s EventStream) String() string

String returns the string representation

type EventsBatch added in v0.5.0 

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 (EventsBatch) MarshalFields added in v0.5.0 

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

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

func (EventsBatch) String added in v0.5.0 

func (s EventsBatch) String() string

String returns the string representation

func (*EventsBatch) Validate added in v0.10.0 

func (s *EventsBatch) Validate() error

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

type EventsRequest added in v0.5.0 

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 (EventsRequest) MarshalFields added in v0.5.0 

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

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

func (EventsRequest) String added in v0.5.0 

func (s EventsRequest) String() string

String returns the string representation

func (*EventsRequest) Validate added in v0.10.0 

func (s *EventsRequest) Validate() error

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

type EventsResponse added in v0.5.0 

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 (EventsResponse) MarshalFields added in v0.5.0 

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

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

func (EventsResponse) String added in v0.5.0 

func (s EventsResponse) String() string

String returns the string representation

type ExportJobRequest added in v0.4.0 

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 (ExportJobRequest) MarshalFields added in v0.4.0 

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

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

func (ExportJobRequest) String added in v0.4.0 

func (s ExportJobRequest) String() string

String returns the string representation

func (*ExportJobRequest) Validate added in v0.10.0 

func (s *ExportJobRequest) Validate() error

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

type ExportJobResource added in v0.4.0 

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 (ExportJobResource) MarshalFields added in v0.4.0 

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

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

func (ExportJobResource) String added in v0.4.0 

func (s ExportJobResource) String() string

String returns the string representation

type ExportJobResponse added in v0.4.0 

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 JobStatus `type:"string" required:"true" enum:"true"`

	// 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 (ExportJobResponse) MarshalFields added in v0.4.0 

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

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

func (ExportJobResponse) String added in v0.4.0 

func (s ExportJobResponse) String() string

String returns the string representation

type ExportJobsResponse added in v0.4.0 

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 (ExportJobsResponse) MarshalFields added in v0.4.0 

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

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

func (ExportJobsResponse) String added in v0.4.0 

func (s ExportJobsResponse) String() string

String returns the string representation

type FilterType added in v0.6.0 

type FilterType string
const (
	FilterTypeSystem   FilterType = "SYSTEM"
	FilterTypeEndpoint FilterType = "ENDPOINT"
)

Enum values for FilterType

func (FilterType) MarshalValue added in v0.6.0 

func (enum FilterType) MarshalValue() (string, error)

func (FilterType) MarshalValueBuf added in v0.6.0 

func (enum FilterType) MarshalValueBuf(b []byte) ([]byte, error)

type Format 

type Format string
const (
	FormatCsv  Format = "CSV"
	FormatJson Format = "JSON"
)

Enum values for Format

func (Format) MarshalValue added in v0.3.0 

func (enum Format) MarshalValue() (string, error)

func (Format) MarshalValueBuf added in v0.3.0 

func (enum Format) MarshalValueBuf(b []byte) ([]byte, error)

type Frequency 

type Frequency string
const (
	FrequencyOnce    Frequency = "ONCE"
	FrequencyHourly  Frequency = "HOURLY"
	FrequencyDaily   Frequency = "DAILY"
	FrequencyWeekly  Frequency = "WEEKLY"
	FrequencyMonthly Frequency = "MONTHLY"
	FrequencyEvent   Frequency = "EVENT"
)

Enum values for Frequency

func (Frequency) MarshalValue added in v0.3.0 

func (enum Frequency) MarshalValue() (string, error)

func (Frequency) MarshalValueBuf added in v0.3.0 

func (enum Frequency) MarshalValueBuf(b []byte) ([]byte, error)

type GCMChannelRequest 

type GCMChannelRequest struct {

	// The Web API Key, also referred to as an API_KEY or 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 (GCMChannelRequest) MarshalFields added in v0.3.0 

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

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

func (GCMChannelRequest) String 

func (s GCMChannelRequest) String() string

String returns the string representation

func (*GCMChannelRequest) Validate added in v0.10.0 

func (s *GCMChannelRequest) Validate() error

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

type GCMChannelResponse 

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 Web API Key, also referred to as an API_KEY or 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 (GCMChannelResponse) MarshalFields added in v0.3.0 

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

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

func (GCMChannelResponse) String 

func (s GCMChannelResponse) String() string

String returns the string representation

type GCMMessage 

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 Action `type:"string" enum:"true"`

	// 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. If specified, this value overrides all other content for 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 (GCMMessage) MarshalFields added in v0.3.0 

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

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

func (GCMMessage) String 

func (s GCMMessage) String() string

String returns the string representation

type GPSCoordinates added in v0.5.0 

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 (GPSCoordinates) MarshalFields added in v0.5.0 

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

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

func (GPSCoordinates) String added in v0.5.0 

func (s GPSCoordinates) String() string

String returns the string representation

func (*GPSCoordinates) Validate added in v0.10.0 

func (s *GPSCoordinates) Validate() error

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

type GPSPointDimension added in v0.5.0 

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 (GPSPointDimension) MarshalFields added in v0.5.0 

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

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

func (GPSPointDimension) String added in v0.5.0 

func (s GPSPointDimension) String() string

String returns the string representation

func (*GPSPointDimension) Validate added in v0.10.0 

func (s *GPSPointDimension) Validate() error

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

type GetAdmChannelInput 

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 (GetAdmChannelInput) MarshalFields added in v0.3.0 

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

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

func (GetAdmChannelInput) String 

func (s GetAdmChannelInput) String() string

String returns the string representation

func (*GetAdmChannelInput) Validate 

func (s *GetAdmChannelInput) Validate() error

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

type GetAdmChannelOutput 

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 (GetAdmChannelOutput) MarshalFields added in v0.3.0 

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

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

func (GetAdmChannelOutput) String 

func (s GetAdmChannelOutput) String() string

String returns the string representation

type GetAdmChannelRequest 

type GetAdmChannelRequest struct {
	*aws.Request
	Input *GetAdmChannelInput
	Copy  func(*GetAdmChannelInput) GetAdmChannelRequest
}

GetAdmChannelRequest is the request type for the GetAdmChannel API operation.

func (GetAdmChannelRequest) Send 

func (r GetAdmChannelRequest) Send(ctx context.Context) (*GetAdmChannelResponse, error)

Send marshals and sends the GetAdmChannel API request.

type GetAdmChannelResponse added in v0.9.0 

type GetAdmChannelResponse struct {
	*GetAdmChannelOutput
	// contains filtered or unexported fields
}

GetAdmChannelResponse is the response type for the GetAdmChannel API operation.

func (*GetAdmChannelResponse) SDKResponseMetdata added in v0.9.0 

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

SDKResponseMetdata returns the response metadata for the GetAdmChannel request.

type GetApnsChannelInput 

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 (GetApnsChannelInput) MarshalFields added in v0.3.0 

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

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

func (GetApnsChannelInput) String 

func (s GetApnsChannelInput) String() string

String returns the string representation

func (*GetApnsChannelInput) Validate 

func (s *GetApnsChannelInput) Validate() error

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

type GetApnsChannelOutput 

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 (GetApnsChannelOutput) MarshalFields added in v0.3.0 

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

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

func (GetApnsChannelOutput) String 

func (s GetApnsChannelOutput) String() string

String returns the string representation

type GetApnsChannelRequest 

type GetApnsChannelRequest struct {
	*aws.Request
	Input *GetApnsChannelInput
	Copy  func(*GetApnsChannelInput) GetApnsChannelRequest
}

GetApnsChannelRequest is the request type for the GetApnsChannel API operation.

func (GetApnsChannelRequest) Send 

func (r GetApnsChannelRequest) Send(ctx context.Context) (*GetApnsChannelResponse, error)

Send marshals and sends the GetApnsChannel API request.

type GetApnsChannelResponse added in v0.9.0 

type GetApnsChannelResponse struct {
	*GetApnsChannelOutput
	// contains filtered or unexported fields
}

GetApnsChannelResponse is the response type for the GetApnsChannel API operation.

func (*GetApnsChannelResponse) SDKResponseMetdata added in v0.9.0 

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

SDKResponseMetdata returns the response metadata for the GetApnsChannel request.

type GetApnsSandboxChannelInput 

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 (GetApnsSandboxChannelInput) MarshalFields added in v0.3.0 

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

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

func (GetApnsSandboxChannelInput) String 

func (s GetApnsSandboxChannelInput) String() string

String returns the string representation

func (*GetApnsSandboxChannelInput) Validate 

func (s *GetApnsSandboxChannelInput) Validate() error

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

type GetApnsSandboxChannelOutput 

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 (GetApnsSandboxChannelOutput) MarshalFields added in v0.3.0 

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

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

func (GetApnsSandboxChannelOutput) String 

func (s GetApnsSandboxChannelOutput) String() string

String returns the string representation

type GetApnsSandboxChannelRequest 

type GetApnsSandboxChannelRequest struct {
	*aws.Request
	Input *GetApnsSandboxChannelInput
	Copy  func(*GetApnsSandboxChannelInput) GetApnsSandboxChannelRequest
}

GetApnsSandboxChannelRequest is the request type for the GetApnsSandboxChannel API operation.

func (GetApnsSandboxChannelRequest) Send 

func (r GetApnsSandboxChannelRequest) Send(ctx context.Context) (*GetApnsSandboxChannelResponse, error)

Send marshals and sends the GetApnsSandboxChannel API request.

type GetApnsSandboxChannelResponse added in v0.9.0 

type GetApnsSandboxChannelResponse struct {
	*GetApnsSandboxChannelOutput
	// contains filtered or unexported fields
}

GetApnsSandboxChannelResponse is the response type for the GetApnsSandboxChannel API operation.

func (*GetApnsSandboxChannelResponse) SDKResponseMetdata added in v0.9.0 

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

SDKResponseMetdata returns the response metadata for the GetApnsSandboxChannel request.

type GetApnsVoipChannelInput added in v0.2.0 

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 (GetApnsVoipChannelInput) MarshalFields added in v0.3.0 

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

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

func (GetApnsVoipChannelInput) String added in v0.2.0 

func (s GetApnsVoipChannelInput) String() string

String returns the string representation

func (*GetApnsVoipChannelInput) Validate added in v0.2.0 

func (s *GetApnsVoipChannelInput) Validate() error

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

type GetApnsVoipChannelOutput added in v0.2.0 

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 (GetApnsVoipChannelOutput) MarshalFields added in v0.3.0 

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

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

func (GetApnsVoipChannelOutput) String added in v0.2.0 

func (s GetApnsVoipChannelOutput) String() string

String returns the string representation

type GetApnsVoipChannelRequest added in v0.2.0 

type GetApnsVoipChannelRequest struct {
	*aws.Request
	Input *GetApnsVoipChannelInput
	Copy  func(*GetApnsVoipChannelInput) GetApnsVoipChannelRequest
}

GetApnsVoipChannelRequest is the request type for the GetApnsVoipChannel API operation.

func (GetApnsVoipChannelRequest) Send added in v0.2.0 

func (r GetApnsVoipChannelRequest) Send(ctx context.Context) (*GetApnsVoipChannelResponse, error)

Send marshals and sends the GetApnsVoipChannel API request.

type GetApnsVoipChannelResponse added in v0.9.0 

type GetApnsVoipChannelResponse struct {
	*GetApnsVoipChannelOutput
	// contains filtered or unexported fields
}

GetApnsVoipChannelResponse is the response type for the GetApnsVoipChannel API operation.

func (*GetApnsVoipChannelResponse) SDKResponseMetdata added in v0.9.0 

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

SDKResponseMetdata returns the response metadata for the GetApnsVoipChannel request.

type GetApnsVoipSandboxChannelInput added in v0.2.0 

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 (GetApnsVoipSandboxChannelInput) MarshalFields added in v0.3.0 

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

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

func (GetApnsVoipSandboxChannelInput) String added in v0.2.0 

func (s GetApnsVoipSandboxChannelInput) String() string

String returns the string representation

func (*GetApnsVoipSandboxChannelInput) Validate added in v0.2.0 

func (s *GetApnsVoipSandboxChannelInput) Validate() error

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

type GetApnsVoipSandboxChannelOutput added in v0.2.0 

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 (GetApnsVoipSandboxChannelOutput) MarshalFields added in v0.3.0 

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

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

func (GetApnsVoipSandboxChannelOutput) String added in v0.2.0 

func (s GetApnsVoipSandboxChannelOutput) String() string

String returns the string representation

type GetApnsVoipSandboxChannelRequest added in v0.2.0 

type GetApnsVoipSandboxChannelRequest struct {
	*aws.Request
	Input *GetApnsVoipSandboxChannelInput
	Copy  func(*GetApnsVoipSandboxChannelInput) GetApnsVoipSandboxChannelRequest
}

GetApnsVoipSandboxChannelRequest is the request type for the GetApnsVoipSandboxChannel API operation.

func (GetApnsVoipSandboxChannelRequest) Send added in v0.2.0 

func (r GetApnsVoipSandboxChannelRequest) Send(ctx context.Context) (*GetApnsVoipSandboxChannelResponse, error)

Send marshals and sends the GetApnsVoipSandboxChannel API request.

type GetApnsVoipSandboxChannelResponse added in v0.9.0 

type GetApnsVoipSandboxChannelResponse struct {
	*GetApnsVoipSandboxChannelOutput
	// contains filtered or unexported fields
}

GetApnsVoipSandboxChannelResponse is the response type for the GetApnsVoipSandboxChannel API operation.

func (*GetApnsVoipSandboxChannelResponse) SDKResponseMetdata added in v0.9.0 

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

SDKResponseMetdata returns the response metadata for the GetApnsVoipSandboxChannel request.

type GetAppInput 

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 (GetAppInput) MarshalFields added in v0.3.0 

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

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

func (GetAppInput) String 

func (s GetAppInput) String() string

String returns the string representation

func (*GetAppInput) Validate 

func (s *GetAppInput) Validate() error

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

type GetAppOutput 

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 (GetAppOutput) MarshalFields added in v0.3.0 

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

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

func (GetAppOutput) String 

func (s GetAppOutput) String() string

String returns the string representation

type GetAppRequest 

type GetAppRequest struct {
	*aws.Request
	Input *GetAppInput
	Copy  func(*GetAppInput) GetAppRequest
}

GetAppRequest is the request type for the GetApp API operation.

func (GetAppRequest) Send 

func (r GetAppRequest) Send(ctx context.Context) (*GetAppResponse, error)

Send marshals and sends the GetApp API request.

type GetAppResponse added in v0.9.0 

type GetAppResponse struct {
	*GetAppOutput
	// contains filtered or unexported fields
}

GetAppResponse is the response type for the GetApp API operation.

func (*GetAppResponse) SDKResponseMetdata added in v0.9.0 

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

SDKResponseMetdata returns the response metadata for the GetApp request.

type GetApplicationDateRangeKpiInput added in v0.10.0 

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 (GetApplicationDateRangeKpiInput) MarshalFields added in v0.10.0 

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

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

func (GetApplicationDateRangeKpiInput) String added in v0.10.0 

func (s GetApplicationDateRangeKpiInput) String() string

String returns the string representation

func (*GetApplicationDateRangeKpiInput) Validate added in v0.10.0 

func (s *GetApplicationDateRangeKpiInput) Validate() error

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

type GetApplicationDateRangeKpiOutput added in v0.10.0 

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 (GetApplicationDateRangeKpiOutput) MarshalFields added in v0.10.0 

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

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

func (GetApplicationDateRangeKpiOutput) String added in v0.10.0 

func (s GetApplicationDateRangeKpiOutput) String() string

String returns the string representation

type GetApplicationDateRangeKpiRequest added in v0.10.0 

type GetApplicationDateRangeKpiRequest struct {
	*aws.Request
	Input *GetApplicationDateRangeKpiInput
	Copy  func(*GetApplicationDateRangeKpiInput) GetApplicationDateRangeKpiRequest
}

GetApplicationDateRangeKpiRequest is the request type for the GetApplicationDateRangeKpi API operation.

func (GetApplicationDateRangeKpiRequest) Send added in v0.10.0 

func (r GetApplicationDateRangeKpiRequest) Send(ctx context.Context) (*GetApplicationDateRangeKpiResponse, error)

Send marshals and sends the GetApplicationDateRangeKpi API request.

type GetApplicationDateRangeKpiResponse added in v0.10.0 

type GetApplicationDateRangeKpiResponse struct {
	*GetApplicationDateRangeKpiOutput
	// contains filtered or unexported fields
}

GetApplicationDateRangeKpiResponse is the response type for the GetApplicationDateRangeKpi API operation.

func (*GetApplicationDateRangeKpiResponse) SDKResponseMetdata added in v0.10.0 

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

SDKResponseMetdata returns the response metadata for the GetApplicationDateRangeKpi request.

type GetApplicationSettingsInput 

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 (GetApplicationSettingsInput) MarshalFields added in v0.3.0 

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

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

func (GetApplicationSettingsInput) String 

func (s GetApplicationSettingsInput) String() string

String returns the string representation

func (*GetApplicationSettingsInput) Validate 

func (s *GetApplicationSettingsInput) Validate() error

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

type GetApplicationSettingsOutput 

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 (GetApplicationSettingsOutput) MarshalFields added in v0.3.0 

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

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

func (GetApplicationSettingsOutput) String 

func (s GetApplicationSettingsOutput) String() string

String returns the string representation

type GetApplicationSettingsRequest 

type GetApplicationSettingsRequest struct {
	*aws.Request
	Input *GetApplicationSettingsInput
	Copy  func(*GetApplicationSettingsInput) GetApplicationSettingsRequest
}

GetApplicationSettingsRequest is the request type for the GetApplicationSettings API operation.

func (GetApplicationSettingsRequest) Send 

func (r GetApplicationSettingsRequest) Send(ctx context.Context) (*GetApplicationSettingsResponse, error)

Send marshals and sends the GetApplicationSettings API request.

type GetApplicationSettingsResponse added in v0.9.0 

type GetApplicationSettingsResponse struct {
	*GetApplicationSettingsOutput
	// contains filtered or unexported fields
}

GetApplicationSettingsResponse is the response type for the GetApplicationSettings API operation.

func (*GetApplicationSettingsResponse) SDKResponseMetdata added in v0.9.0 

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

SDKResponseMetdata returns the response metadata for the GetApplicationSettings request.

type GetAppsInput 

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 (GetAppsInput) MarshalFields added in v0.3.0 

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

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

func (GetAppsInput) String 

func (s GetAppsInput) String() string

String returns the string representation

type GetAppsOutput 

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 (GetAppsOutput) MarshalFields added in v0.3.0 

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

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

func (GetAppsOutput) String 

func (s GetAppsOutput) String() string

String returns the string representation

type GetAppsRequest 

type GetAppsRequest struct {
	*aws.Request
	Input *GetAppsInput
	Copy  func(*GetAppsInput) GetAppsRequest
}

GetAppsRequest is the request type for the GetApps API operation.

func (GetAppsRequest) Send 

func (r GetAppsRequest) Send(ctx context.Context) (*GetAppsResponse, error)

Send marshals and sends the GetApps API request.

type GetAppsResponse added in v0.9.0 

type GetAppsResponse struct {
	*GetAppsOutput
	// contains filtered or unexported fields
}

GetAppsResponse is the response type for the GetApps API operation.

func (*GetAppsResponse) SDKResponseMetdata added in v0.9.0 

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

SDKResponseMetdata returns the response metadata for the GetApps request.

type GetBaiduChannelInput 

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 (GetBaiduChannelInput) MarshalFields added in v0.3.0 

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

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

func (GetBaiduChannelInput) String 

func (s GetBaiduChannelInput) String() string

String returns the string representation

func (*GetBaiduChannelInput) Validate 

func (s *GetBaiduChannelInput) Validate() error

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

type GetBaiduChannelOutput 

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 (GetBaiduChannelOutput) MarshalFields added in v0.3.0 

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

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

func (GetBaiduChannelOutput) String 

func (s GetBaiduChannelOutput) String() string

String returns the string representation

type GetBaiduChannelRequest 

type GetBaiduChannelRequest struct {
	*aws.Request
	Input *GetBaiduChannelInput
	Copy  func(*GetBaiduChannelInput) GetBaiduChannelRequest
}

GetBaiduChannelRequest is the request type for the GetBaiduChannel API operation.

func (GetBaiduChannelRequest) Send 

func (r GetBaiduChannelRequest) Send(ctx context.Context) (*GetBaiduChannelResponse, error)

Send marshals and sends the GetBaiduChannel API request.

type GetBaiduChannelResponse added in v0.9.0 

type GetBaiduChannelResponse struct {
	*GetBaiduChannelOutput
	// contains filtered or unexported fields
}

GetBaiduChannelResponse is the response type for the GetBaiduChannel API operation.

func (*GetBaiduChannelResponse) SDKResponseMetdata added in v0.9.0 

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

SDKResponseMetdata returns the response metadata for the GetBaiduChannel request.

type GetCampaignActivitiesInput 

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 (GetCampaignActivitiesInput) MarshalFields added in v0.3.0 

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

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

func (GetCampaignActivitiesInput) String 

func (s GetCampaignActivitiesInput) String() string

String returns the string representation

func (*GetCampaignActivitiesInput) Validate 

func (s *GetCampaignActivitiesInput) Validate() error

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

type GetCampaignActivitiesOutput 

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 (GetCampaignActivitiesOutput) MarshalFields added in v0.3.0 

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

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

func (GetCampaignActivitiesOutput) String 

func (s GetCampaignActivitiesOutput) String() string

String returns the string representation

type GetCampaignActivitiesRequest 

type GetCampaignActivitiesRequest struct {
	*aws.Request
	Input *GetCampaignActivitiesInput
	Copy  func(*GetCampaignActivitiesInput) GetCampaignActivitiesRequest
}

GetCampaignActivitiesRequest is the request type for the GetCampaignActivities API operation.

func (GetCampaignActivitiesRequest) Send 

func (r GetCampaignActivitiesRequest) Send(ctx context.Context) (*GetCampaignActivitiesResponse, error)

Send marshals and sends the GetCampaignActivities API request.

type GetCampaignActivitiesResponse added in v0.9.0 

type GetCampaignActivitiesResponse struct {
	*GetCampaignActivitiesOutput
	// contains filtered or unexported fields
}

GetCampaignActivitiesResponse is the response type for the GetCampaignActivities API operation.

func (*GetCampaignActivitiesResponse) SDKResponseMetdata added in v0.9.0 

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

SDKResponseMetdata returns the response metadata for the GetCampaignActivities request.

type GetCampaignDateRangeKpiInput added in v0.10.0 

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 (GetCampaignDateRangeKpiInput) MarshalFields added in v0.10.0 

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

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

func (GetCampaignDateRangeKpiInput) String added in v0.10.0 

func (s GetCampaignDateRangeKpiInput) String() string

String returns the string representation

func (*GetCampaignDateRangeKpiInput) Validate added in v0.10.0 

func (s *GetCampaignDateRangeKpiInput) Validate() error

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

type GetCampaignDateRangeKpiOutput added in v0.10.0 

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 (GetCampaignDateRangeKpiOutput) MarshalFields added in v0.10.0 

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

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

func (GetCampaignDateRangeKpiOutput) String added in v0.10.0 

func (s GetCampaignDateRangeKpiOutput) String() string

String returns the string representation

type GetCampaignDateRangeKpiRequest added in v0.10.0 

type GetCampaignDateRangeKpiRequest struct {
	*aws.Request
	Input *GetCampaignDateRangeKpiInput
	Copy  func(*GetCampaignDateRangeKpiInput) GetCampaignDateRangeKpiRequest
}

GetCampaignDateRangeKpiRequest is the request type for the GetCampaignDateRangeKpi API operation.

func (GetCampaignDateRangeKpiRequest) Send added in v0.10.0 

func (r GetCampaignDateRangeKpiRequest) Send(ctx context.Context) (*GetCampaignDateRangeKpiResponse, error)

Send marshals and sends the GetCampaignDateRangeKpi API request.

type GetCampaignDateRangeKpiResponse added in v0.10.0 

type GetCampaignDateRangeKpiResponse struct {
	*GetCampaignDateRangeKpiOutput
	// contains filtered or unexported fields
}

GetCampaignDateRangeKpiResponse is the response type for the GetCampaignDateRangeKpi API operation.

func (*GetCampaignDateRangeKpiResponse) SDKResponseMetdata added in v0.10.0 

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

SDKResponseMetdata returns the response metadata for the GetCampaignDateRangeKpi request.

type GetCampaignInput 

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 (GetCampaignInput) MarshalFields added in v0.3.0 

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

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

func (GetCampaignInput) String 

func (s GetCampaignInput) String() string

String returns the string representation

func (*GetCampaignInput) Validate 

func (s *GetCampaignInput) Validate() error

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

type GetCampaignOutput 

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 (GetCampaignOutput) MarshalFields added in v0.3.0 

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

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

func (GetCampaignOutput) String 

func (s GetCampaignOutput) String() string

String returns the string representation

type GetCampaignRequest 

type GetCampaignRequest struct {
	*aws.Request
	Input *GetCampaignInput
	Copy  func(*GetCampaignInput) GetCampaignRequest
}

GetCampaignRequest is the request type for the GetCampaign API operation.

func (GetCampaignRequest) Send 

func (r GetCampaignRequest) Send(ctx context.Context) (*GetCampaignResponse, error)

Send marshals and sends the GetCampaign API request.

type GetCampaignResponse added in v0.9.0 

type GetCampaignResponse struct {
	*GetCampaignOutput
	// contains filtered or unexported fields
}

GetCampaignResponse is the response type for the GetCampaign API operation.

func (*GetCampaignResponse) SDKResponseMetdata added in v0.9.0 

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

SDKResponseMetdata returns the response metadata for the GetCampaign request.

type GetCampaignVersionInput 

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 (GetCampaignVersionInput) MarshalFields added in v0.3.0 

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

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

func (GetCampaignVersionInput) String 

func (s GetCampaignVersionInput) String() string

String returns the string representation

func (*GetCampaignVersionInput) Validate 

func (s *GetCampaignVersionInput) Validate() error

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

type GetCampaignVersionOutput 

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 (GetCampaignVersionOutput) MarshalFields added in v0.3.0 

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

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

func (GetCampaignVersionOutput) String 

func (s GetCampaignVersionOutput) String() string

String returns the string representation

type GetCampaignVersionRequest 

type GetCampaignVersionRequest struct {
	*aws.Request
	Input *GetCampaignVersionInput
	Copy  func(*GetCampaignVersionInput) GetCampaignVersionRequest
}

GetCampaignVersionRequest is the request type for the GetCampaignVersion API operation.

func (GetCampaignVersionRequest) Send 

func (r GetCampaignVersionRequest) Send(ctx context.Context) (*GetCampaignVersionResponse, error)

Send marshals and sends the GetCampaignVersion API request.

type GetCampaignVersionResponse added in v0.9.0 

type GetCampaignVersionResponse struct {
	*GetCampaignVersionOutput
	// contains filtered or unexported fields
}

GetCampaignVersionResponse is the response type for the GetCampaignVersion API operation.

func (*GetCampaignVersionResponse) SDKResponseMetdata added in v0.9.0 

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

SDKResponseMetdata returns the response metadata for the GetCampaignVersion request.

type GetCampaignVersionsInput 

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 (GetCampaignVersionsInput) MarshalFields added in v0.3.0 

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

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

func (GetCampaignVersionsInput) String 

func (s GetCampaignVersionsInput) String() string

String returns the string representation

func (*GetCampaignVersionsInput) Validate 

func (s *GetCampaignVersionsInput) Validate() error

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

type GetCampaignVersionsOutput 

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 (GetCampaignVersionsOutput) MarshalFields added in v0.3.0 

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

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

func (GetCampaignVersionsOutput) String 

func (s GetCampaignVersionsOutput) String() string

String returns the string representation

type GetCampaignVersionsRequest 

type GetCampaignVersionsRequest struct {
	*aws.Request
	Input *GetCampaignVersionsInput
	Copy  func(*GetCampaignVersionsInput) GetCampaignVersionsRequest
}

GetCampaignVersionsRequest is the request type for the GetCampaignVersions API operation.

func (GetCampaignVersionsRequest) Send 

func (r GetCampaignVersionsRequest) Send(ctx context.Context) (*GetCampaignVersionsResponse, error)

Send marshals and sends the GetCampaignVersions API request.

type GetCampaignVersionsResponse added in v0.9.0 

type GetCampaignVersionsResponse struct {
	*GetCampaignVersionsOutput
	// contains filtered or unexported fields
}

GetCampaignVersionsResponse is the response type for the GetCampaignVersions API operation.

func (*GetCampaignVersionsResponse) SDKResponseMetdata added in v0.9.0 

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

SDKResponseMetdata returns the response metadata for the GetCampaignVersions request.

type GetCampaignsInput 

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 (GetCampaignsInput) MarshalFields added in v0.3.0 

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

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

func (GetCampaignsInput) String 

func (s GetCampaignsInput) String() string

String returns the string representation

func (*GetCampaignsInput) Validate 

func (s *GetCampaignsInput) Validate() error

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

type GetCampaignsOutput 

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 (GetCampaignsOutput) MarshalFields added in v0.3.0 

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

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

func (GetCampaignsOutput) String 

func (s GetCampaignsOutput) String() string

String returns the string representation

type GetCampaignsRequest 

type GetCampaignsRequest struct {
	*aws.Request
	Input *GetCampaignsInput
	Copy  func(*GetCampaignsInput) GetCampaignsRequest
}

GetCampaignsRequest is the request type for the GetCampaigns API operation.

func (GetCampaignsRequest) Send 

func (r GetCampaignsRequest) Send(ctx context.Context) (*GetCampaignsResponse, error)

Send marshals and sends the GetCampaigns API request.

type GetCampaignsResponse added in v0.9.0 

type GetCampaignsResponse struct {
	*GetCampaignsOutput
	// contains filtered or unexported fields
}

GetCampaignsResponse is the response type for the GetCampaigns API operation.

func (*GetCampaignsResponse) SDKResponseMetdata added in v0.9.0 

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

SDKResponseMetdata returns the response metadata for the GetCampaigns request.

type GetChannelsInput added in v0.5.0 

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 (GetChannelsInput) MarshalFields added in v0.5.0 

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

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

func (GetChannelsInput) String added in v0.5.0 

func (s GetChannelsInput) String() string

String returns the string representation

func (*GetChannelsInput) Validate added in v0.5.0 

func (s *GetChannelsInput) Validate() error

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

type GetChannelsOutput added in v0.5.0 

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 (GetChannelsOutput) MarshalFields added in v0.5.0 

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

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

func (GetChannelsOutput) String added in v0.5.0 

func (s GetChannelsOutput) String() string

String returns the string representation

type GetChannelsRequest added in v0.5.0 

type GetChannelsRequest struct {
	*aws.Request
	Input *GetChannelsInput
	Copy  func(*GetChannelsInput) GetChannelsRequest
}

GetChannelsRequest is the request type for the GetChannels API operation.

func (GetChannelsRequest) Send added in v0.5.0 

func (r GetChannelsRequest) Send(ctx context.Context) (*GetChannelsResponse, error)

Send marshals and sends the GetChannels API request.

type GetChannelsResponse added in v0.9.0 

type GetChannelsResponse struct {
	*GetChannelsOutput
	// contains filtered or unexported fields
}

GetChannelsResponse is the response type for the GetChannels API operation.

func (*GetChannelsResponse) SDKResponseMetdata added in v0.9.0 

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

SDKResponseMetdata returns the response metadata for the GetChannels request.

type GetEmailChannelInput 

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 (GetEmailChannelInput) MarshalFields added in v0.3.0 

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

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

func (GetEmailChannelInput) String 

func (s GetEmailChannelInput) String() string

String returns the string representation

func (*GetEmailChannelInput) Validate 

func (s *GetEmailChannelInput) Validate() error

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

type GetEmailChannelOutput 

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 (GetEmailChannelOutput) MarshalFields added in v0.3.0 

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

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

func (GetEmailChannelOutput) String 

func (s GetEmailChannelOutput) String() string

String returns the string representation

type GetEmailChannelRequest 

type GetEmailChannelRequest struct {
	*aws.Request
	Input *GetEmailChannelInput
	Copy  func(*GetEmailChannelInput) GetEmailChannelRequest
}

GetEmailChannelRequest is the request type for the GetEmailChannel API operation.

func (GetEmailChannelRequest) Send 

func (r GetEmailChannelRequest) Send(ctx context.Context) (*GetEmailChannelResponse, error)

Send marshals and sends the GetEmailChannel API request.

type GetEmailChannelResponse added in v0.9.0 

type GetEmailChannelResponse struct {
	*GetEmailChannelOutput
	// contains filtered or unexported fields
}

GetEmailChannelResponse is the response type for the GetEmailChannel API operation.

func (*GetEmailChannelResponse) SDKResponseMetdata added in v0.9.0 

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

SDKResponseMetdata returns the response metadata for the GetEmailChannel request.

type GetEmailTemplateInput added in v0.14.0 

type GetEmailTemplateInput struct {

	// TemplateName is a required field
	TemplateName *string `location:"uri" locationName:"template-name" type:"string" required:"true"`

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

func (GetEmailTemplateInput) MarshalFields added in v0.14.0 

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

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

func (GetEmailTemplateInput) String added in v0.14.0 

func (s GetEmailTemplateInput) String() string

String returns the string representation

func (*GetEmailTemplateInput) Validate added in v0.14.0 

func (s *GetEmailTemplateInput) Validate() error

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

type GetEmailTemplateOutput added in v0.14.0 

type GetEmailTemplateOutput struct {

	// Provides information about the content and settings for a message template
	// that can be used in messages that are sent through the email channel.
	//
	// EmailTemplateResponse is a required field
	EmailTemplateResponse *EmailTemplateResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (GetEmailTemplateOutput) MarshalFields added in v0.14.0 

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

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

func (GetEmailTemplateOutput) String added in v0.14.0 

func (s GetEmailTemplateOutput) String() string

String returns the string representation

type GetEmailTemplateRequest added in v0.14.0 

type GetEmailTemplateRequest struct {
	*aws.Request
	Input *GetEmailTemplateInput
	Copy  func(*GetEmailTemplateInput) GetEmailTemplateRequest
}

GetEmailTemplateRequest is the request type for the GetEmailTemplate API operation.

func (GetEmailTemplateRequest) Send added in v0.14.0 

func (r GetEmailTemplateRequest) Send(ctx context.Context) (*GetEmailTemplateResponse, error)

Send marshals and sends the GetEmailTemplate API request.

type GetEmailTemplateResponse added in v0.14.0 

type GetEmailTemplateResponse struct {
	*GetEmailTemplateOutput
	// contains filtered or unexported fields
}

GetEmailTemplateResponse is the response type for the GetEmailTemplate API operation.

func (*GetEmailTemplateResponse) SDKResponseMetdata added in v0.14.0 

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

SDKResponseMetdata returns the response metadata for the GetEmailTemplate request.

type GetEndpointInput 

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 (GetEndpointInput) MarshalFields added in v0.3.0 

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

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

func (GetEndpointInput) String 

func (s GetEndpointInput) String() string

String returns the string representation

func (*GetEndpointInput) Validate 

func (s *GetEndpointInput) Validate() error

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

type GetEndpointOutput 

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 (GetEndpointOutput) MarshalFields added in v0.3.0 

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

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

func (GetEndpointOutput) String 

func (s GetEndpointOutput) String() string

String returns the string representation

type GetEndpointRequest 

type GetEndpointRequest struct {
	*aws.Request
	Input *GetEndpointInput
	Copy  func(*GetEndpointInput) GetEndpointRequest
}

GetEndpointRequest is the request type for the GetEndpoint API operation.

func (GetEndpointRequest) Send 

func (r GetEndpointRequest) Send(ctx context.Context) (*GetEndpointResponse, error)

Send marshals and sends the GetEndpoint API request.

type GetEndpointResponse added in v0.9.0 

type GetEndpointResponse struct {
	*GetEndpointOutput
	// contains filtered or unexported fields
}

GetEndpointResponse is the response type for the GetEndpoint API operation.

func (*GetEndpointResponse) SDKResponseMetdata added in v0.9.0 

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

SDKResponseMetdata returns the response metadata for the GetEndpoint request.

type GetEventStreamInput 

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 (GetEventStreamInput) MarshalFields added in v0.3.0 

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

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

func (GetEventStreamInput) String 

func (s GetEventStreamInput) String() string

String returns the string representation

func (*GetEventStreamInput) Validate 

func (s *GetEventStreamInput) Validate() error

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

type GetEventStreamOutput 

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 (GetEventStreamOutput) MarshalFields added in v0.3.0 

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

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

func (GetEventStreamOutput) String 

func (s GetEventStreamOutput) String() string

String returns the string representation

type GetEventStreamRequest 

type GetEventStreamRequest struct {
	*aws.Request
	Input *GetEventStreamInput
	Copy  func(*GetEventStreamInput) GetEventStreamRequest
}

GetEventStreamRequest is the request type for the GetEventStream API operation.

func (GetEventStreamRequest) Send 

func (r GetEventStreamRequest) Send(ctx context.Context) (*GetEventStreamResponse, error)

Send marshals and sends the GetEventStream API request.

type GetEventStreamResponse added in v0.9.0 

type GetEventStreamResponse struct {
	*GetEventStreamOutput
	// contains filtered or unexported fields
}

GetEventStreamResponse is the response type for the GetEventStream API operation.

func (*GetEventStreamResponse) SDKResponseMetdata added in v0.9.0 

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

SDKResponseMetdata returns the response metadata for the GetEventStream request.

type GetExportJobInput added in v0.4.0 

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 (GetExportJobInput) MarshalFields added in v0.4.0 

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

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

func (GetExportJobInput) String added in v0.4.0 

func (s GetExportJobInput) String() string

String returns the string representation

func (*GetExportJobInput) Validate added in v0.4.0 

func (s *GetExportJobInput) Validate() error

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

type GetExportJobOutput added in v0.4.0 

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 (GetExportJobOutput) MarshalFields added in v0.4.0 

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

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

func (GetExportJobOutput) String added in v0.4.0 

func (s GetExportJobOutput) String() string

String returns the string representation

type GetExportJobRequest added in v0.4.0 

type GetExportJobRequest struct {
	*aws.Request
	Input *GetExportJobInput
	Copy  func(*GetExportJobInput) GetExportJobRequest
}

GetExportJobRequest is the request type for the GetExportJob API operation.

func (GetExportJobRequest) Send added in v0.4.0 

func (r GetExportJobRequest) Send(ctx context.Context) (*GetExportJobResponse, error)

Send marshals and sends the GetExportJob API request.

type GetExportJobResponse added in v0.9.0 

type GetExportJobResponse struct {
	*GetExportJobOutput
	// contains filtered or unexported fields
}

GetExportJobResponse is the response type for the GetExportJob API operation.

func (*GetExportJobResponse) SDKResponseMetdata added in v0.9.0 

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

SDKResponseMetdata returns the response metadata for the GetExportJob request.

type GetExportJobsInput added in v0.4.0 

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 (GetExportJobsInput) MarshalFields added in v0.4.0 

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

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

func (GetExportJobsInput) String added in v0.4.0 

func (s GetExportJobsInput) String() string

String returns the string representation

func (*GetExportJobsInput) Validate added in v0.4.0 

func (s *GetExportJobsInput) Validate() error

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

type GetExportJobsOutput added in v0.4.0 

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 (GetExportJobsOutput) MarshalFields added in v0.4.0 

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

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

func (GetExportJobsOutput) String added in v0.4.0 

func (s GetExportJobsOutput) String() string

String returns the string representation

type GetExportJobsRequest added in v0.4.0 

type GetExportJobsRequest struct {
	*aws.Request
	Input *GetExportJobsInput
	Copy  func(*GetExportJobsInput) GetExportJobsRequest
}

GetExportJobsRequest is the request type for the GetExportJobs API operation.

func (GetExportJobsRequest) Send added in v0.4.0 

func (r GetExportJobsRequest) Send(ctx context.Context) (*GetExportJobsResponse, error)

Send marshals and sends the GetExportJobs API request.

type GetExportJobsResponse added in v0.9.0 

type GetExportJobsResponse struct {
	*GetExportJobsOutput
	// contains filtered or unexported fields
}

GetExportJobsResponse is the response type for the GetExportJobs API operation.

func (*GetExportJobsResponse) SDKResponseMetdata added in v0.9.0 

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

SDKResponseMetdata returns the response metadata for the GetExportJobs request.

type GetGcmChannelInput 

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 (GetGcmChannelInput) MarshalFields added in v0.3.0 

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

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

func (GetGcmChannelInput) String 

func (s GetGcmChannelInput) String() string

String returns the string representation

func (*GetGcmChannelInput) Validate 

func (s *GetGcmChannelInput) Validate() error

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

type GetGcmChannelOutput 

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 (GetGcmChannelOutput) MarshalFields added in v0.3.0 

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

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

func (GetGcmChannelOutput) String 

func (s GetGcmChannelOutput) String() string

String returns the string representation

type GetGcmChannelRequest 

type GetGcmChannelRequest struct {
	*aws.Request
	Input *GetGcmChannelInput
	Copy  func(*GetGcmChannelInput) GetGcmChannelRequest
}

GetGcmChannelRequest is the request type for the GetGcmChannel API operation.

func (GetGcmChannelRequest) Send 

func (r GetGcmChannelRequest) Send(ctx context.Context) (*GetGcmChannelResponse, error)

Send marshals and sends the GetGcmChannel API request.

type GetGcmChannelResponse added in v0.9.0 

type GetGcmChannelResponse struct {
	*GetGcmChannelOutput
	// contains filtered or unexported fields
}

GetGcmChannelResponse is the response type for the GetGcmChannel API operation.

func (*GetGcmChannelResponse) SDKResponseMetdata added in v0.9.0 

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

SDKResponseMetdata returns the response metadata for the GetGcmChannel request.

type GetImportJobInput 

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 (GetImportJobInput) MarshalFields added in v0.3.0 

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

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

func (GetImportJobInput) String 

func (s GetImportJobInput) String() string

String returns the string representation

func (*GetImportJobInput) Validate 

func (s *GetImportJobInput) Validate() error

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

type GetImportJobOutput 

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 (GetImportJobOutput) MarshalFields added in v0.3.0 

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

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

func (GetImportJobOutput) String 

func (s GetImportJobOutput) String() string

String returns the string representation

type GetImportJobRequest 

type GetImportJobRequest struct {
	*aws.Request
	Input *GetImportJobInput
	Copy  func(*GetImportJobInput) GetImportJobRequest
}

GetImportJobRequest is the request type for the GetImportJob API operation.

func (GetImportJobRequest) Send 

func (r GetImportJobRequest) Send(ctx context.Context) (*GetImportJobResponse, error)

Send marshals and sends the GetImportJob API request.

type GetImportJobResponse added in v0.9.0 

type GetImportJobResponse struct {
	*GetImportJobOutput
	// contains filtered or unexported fields
}

GetImportJobResponse is the response type for the GetImportJob API operation.

func (*GetImportJobResponse) SDKResponseMetdata added in v0.9.0 

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

SDKResponseMetdata returns the response metadata for the GetImportJob request.

type GetImportJobsInput 

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 (GetImportJobsInput) MarshalFields added in v0.3.0 

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

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

func (GetImportJobsInput) String 

func (s GetImportJobsInput) String() string

String returns the string representation

func (*GetImportJobsInput) Validate 

func (s *GetImportJobsInput) Validate() error

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

type GetImportJobsOutput 

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 (GetImportJobsOutput) MarshalFields added in v0.3.0 

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

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

func (GetImportJobsOutput) String 

func (s GetImportJobsOutput) String() string

String returns the string representation

type GetImportJobsRequest 

type GetImportJobsRequest struct {
	*aws.Request
	Input *GetImportJobsInput
	Copy  func(*GetImportJobsInput) GetImportJobsRequest
}

GetImportJobsRequest is the request type for the GetImportJobs API operation.

func (GetImportJobsRequest) Send 

func (r GetImportJobsRequest) Send(ctx context.Context) (*GetImportJobsResponse, error)

Send marshals and sends the GetImportJobs API request.

type GetImportJobsResponse added in v0.9.0 

type GetImportJobsResponse struct {
	*GetImportJobsOutput
	// contains filtered or unexported fields
}

GetImportJobsResponse is the response type for the GetImportJobs API operation.

func (*GetImportJobsResponse) SDKResponseMetdata added in v0.9.0 

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

SDKResponseMetdata returns the response metadata for the GetImportJobs request.

type GetJourneyDateRangeKpiInput added in v0.16.0 

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

	// JourneyId is a required field
	JourneyId *string `location:"uri" locationName:"journey-id" type:"string" required:"true"`

	// 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 (GetJourneyDateRangeKpiInput) MarshalFields added in v0.16.0 

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

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

func (GetJourneyDateRangeKpiInput) String added in v0.16.0 

func (s GetJourneyDateRangeKpiInput) String() string

String returns the string representation

func (*GetJourneyDateRangeKpiInput) Validate added in v0.16.0 

func (s *GetJourneyDateRangeKpiInput) Validate() error

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

type GetJourneyDateRangeKpiOutput added in v0.16.0 

type GetJourneyDateRangeKpiOutput struct {

	// Provides the results of a query that retrieved the data for a standard engagement
	// metric that applies to a journey, and provides information about that query.
	//
	// JourneyDateRangeKpiResponse is a required field
	JourneyDateRangeKpiResponse *JourneyDateRangeKpiResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (GetJourneyDateRangeKpiOutput) MarshalFields added in v0.16.0 

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

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

func (GetJourneyDateRangeKpiOutput) String added in v0.16.0 

func (s GetJourneyDateRangeKpiOutput) String() string

String returns the string representation

type GetJourneyDateRangeKpiRequest added in v0.16.0 

type GetJourneyDateRangeKpiRequest struct {
	*aws.Request
	Input *GetJourneyDateRangeKpiInput
	Copy  func(*GetJourneyDateRangeKpiInput) GetJourneyDateRangeKpiRequest
}

GetJourneyDateRangeKpiRequest is the request type for the GetJourneyDateRangeKpi API operation.

func (GetJourneyDateRangeKpiRequest) Send added in v0.16.0 

func (r GetJourneyDateRangeKpiRequest) Send(ctx context.Context) (*GetJourneyDateRangeKpiResponse, error)

Send marshals and sends the GetJourneyDateRangeKpi API request.

type GetJourneyDateRangeKpiResponse added in v0.16.0 

type GetJourneyDateRangeKpiResponse struct {
	*GetJourneyDateRangeKpiOutput
	// contains filtered or unexported fields
}

GetJourneyDateRangeKpiResponse is the response type for the GetJourneyDateRangeKpi API operation.

func (*GetJourneyDateRangeKpiResponse) SDKResponseMetdata added in v0.16.0 

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

SDKResponseMetdata returns the response metadata for the GetJourneyDateRangeKpi request.

type GetJourneyExecutionActivityMetricsInput added in v0.16.0 

type GetJourneyExecutionActivityMetricsInput struct {

	// ApplicationId is a required field
	ApplicationId *string `location:"uri" locationName:"application-id" type:"string" required:"true"`

	// JourneyActivityId is a required field
	JourneyActivityId *string `location:"uri" locationName:"journey-activity-id" type:"string" required:"true"`

	// JourneyId is a required field
	JourneyId *string `location:"uri" locationName:"journey-id" type:"string" required:"true"`

	NextToken *string `location:"querystring" locationName:"next-token" type:"string"`

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

func (GetJourneyExecutionActivityMetricsInput) MarshalFields added in v0.16.0 

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

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

func (GetJourneyExecutionActivityMetricsInput) String added in v0.16.0 

func (s GetJourneyExecutionActivityMetricsInput) String() string

String returns the string representation

func (*GetJourneyExecutionActivityMetricsInput) Validate added in v0.16.0 

func (s *GetJourneyExecutionActivityMetricsInput) Validate() error

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

type GetJourneyExecutionActivityMetricsOutput added in v0.16.0 

type GetJourneyExecutionActivityMetricsOutput struct {

	// Provides the results of a query that retrieved the data for a standard execution
	// metric that applies to a journey activity, and provides information about
	// that query.
	//
	// JourneyExecutionActivityMetricsResponse is a required field
	JourneyExecutionActivityMetricsResponse *JourneyExecutionActivityMetricsResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (GetJourneyExecutionActivityMetricsOutput) MarshalFields added in v0.16.0 

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

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

func (GetJourneyExecutionActivityMetricsOutput) String added in v0.16.0 

func (s GetJourneyExecutionActivityMetricsOutput) String() string

String returns the string representation

type GetJourneyExecutionActivityMetricsRequest added in v0.16.0 

type GetJourneyExecutionActivityMetricsRequest struct {
	*aws.Request
	Input *GetJourneyExecutionActivityMetricsInput
	Copy  func(*GetJourneyExecutionActivityMetricsInput) GetJourneyExecutionActivityMetricsRequest
}

GetJourneyExecutionActivityMetricsRequest is the request type for the GetJourneyExecutionActivityMetrics API operation.

func (GetJourneyExecutionActivityMetricsRequest) Send added in v0.16.0 

func (r GetJourneyExecutionActivityMetricsRequest) Send(ctx context.Context) (*GetJourneyExecutionActivityMetricsResponse, error)

Send marshals and sends the GetJourneyExecutionActivityMetrics API request.

type GetJourneyExecutionActivityMetricsResponse added in v0.16.0 

type GetJourneyExecutionActivityMetricsResponse struct {
	*GetJourneyExecutionActivityMetricsOutput
	// contains filtered or unexported fields
}

GetJourneyExecutionActivityMetricsResponse is the response type for the GetJourneyExecutionActivityMetrics API operation.

func (*GetJourneyExecutionActivityMetricsResponse) SDKResponseMetdata added in v0.16.0 

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

SDKResponseMetdata returns the response metadata for the GetJourneyExecutionActivityMetrics request.

type GetJourneyExecutionMetricsInput added in v0.16.0 

type GetJourneyExecutionMetricsInput struct {

	// ApplicationId is a required field
	ApplicationId *string `location:"uri" locationName:"application-id" type:"string" required:"true"`

	// JourneyId is a required field
	JourneyId *string `location:"uri" locationName:"journey-id" type:"string" required:"true"`

	NextToken *string `location:"querystring" locationName:"next-token" type:"string"`

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

func (GetJourneyExecutionMetricsInput) MarshalFields added in v0.16.0 

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

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

func (GetJourneyExecutionMetricsInput) String added in v0.16.0 

func (s GetJourneyExecutionMetricsInput) String() string

String returns the string representation

func (*GetJourneyExecutionMetricsInput) Validate added in v0.16.0 

func (s *GetJourneyExecutionMetricsInput) Validate() error

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

type GetJourneyExecutionMetricsOutput added in v0.16.0 

type GetJourneyExecutionMetricsOutput struct {

	// Provides the results of a query that retrieved the data for a standard execution
	// metric that applies to a journey, and provides information about that query.
	//
	// JourneyExecutionMetricsResponse is a required field
	JourneyExecutionMetricsResponse *JourneyExecutionMetricsResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (GetJourneyExecutionMetricsOutput) MarshalFields added in v0.16.0 

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

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

func (GetJourneyExecutionMetricsOutput) String added in v0.16.0 

func (s GetJourneyExecutionMetricsOutput) String() string

String returns the string representation

type GetJourneyExecutionMetricsRequest added in v0.16.0 

type GetJourneyExecutionMetricsRequest struct {
	*aws.Request
	Input *GetJourneyExecutionMetricsInput
	Copy  func(*GetJourneyExecutionMetricsInput) GetJourneyExecutionMetricsRequest
}

GetJourneyExecutionMetricsRequest is the request type for the GetJourneyExecutionMetrics API operation.

func (GetJourneyExecutionMetricsRequest) Send added in v0.16.0 

func (r GetJourneyExecutionMetricsRequest) Send(ctx context.Context) (*GetJourneyExecutionMetricsResponse, error)

Send marshals and sends the GetJourneyExecutionMetrics API request.

type GetJourneyExecutionMetricsResponse added in v0.16.0 

type GetJourneyExecutionMetricsResponse struct {
	*GetJourneyExecutionMetricsOutput
	// contains filtered or unexported fields
}

GetJourneyExecutionMetricsResponse is the response type for the GetJourneyExecutionMetrics API operation.

func (*GetJourneyExecutionMetricsResponse) SDKResponseMetdata added in v0.16.0 

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

SDKResponseMetdata returns the response metadata for the GetJourneyExecutionMetrics request.

type GetJourneyInput added in v0.16.0 

type GetJourneyInput struct {

	// ApplicationId is a required field
	ApplicationId *string `location:"uri" locationName:"application-id" type:"string" required:"true"`

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

func (GetJourneyInput) MarshalFields added in v0.16.0 

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

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

func (GetJourneyInput) String added in v0.16.0 

func (s GetJourneyInput) String() string

String returns the string representation

func (*GetJourneyInput) Validate added in v0.16.0 

func (s *GetJourneyInput) Validate() error

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

type GetJourneyOutput added in v0.16.0 

type GetJourneyOutput struct {

	// Provides information about the status, configuration, and other settings
	// for a journey.
	//
	// JourneyResponse is a required field
	JourneyResponse *JourneyResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (GetJourneyOutput) MarshalFields added in v0.16.0 

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

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

func (GetJourneyOutput) String added in v0.16.0 

func (s GetJourneyOutput) String() string

String returns the string representation

type GetJourneyRequest added in v0.16.0 

type GetJourneyRequest struct {
	*aws.Request
	Input *GetJourneyInput
	Copy  func(*GetJourneyInput) GetJourneyRequest
}

GetJourneyRequest is the request type for the GetJourney API operation.

func (GetJourneyRequest) Send added in v0.16.0 

func (r GetJourneyRequest) Send(ctx context.Context) (*GetJourneyResponse, error)

Send marshals and sends the GetJourney API request.

type GetJourneyResponse added in v0.16.0 

type GetJourneyResponse struct {
	*GetJourneyOutput
	// contains filtered or unexported fields
}

GetJourneyResponse is the response type for the GetJourney API operation.

func (*GetJourneyResponse) SDKResponseMetdata added in v0.16.0 

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

SDKResponseMetdata returns the response metadata for the GetJourney request.

type GetPushTemplateInput added in v0.14.0 

type GetPushTemplateInput struct {

	// TemplateName is a required field
	TemplateName *string `location:"uri" locationName:"template-name" type:"string" required:"true"`

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

func (GetPushTemplateInput) MarshalFields added in v0.14.0 

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

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

func (GetPushTemplateInput) String added in v0.14.0 

func (s GetPushTemplateInput) String() string

String returns the string representation

func (*GetPushTemplateInput) Validate added in v0.14.0 

func (s *GetPushTemplateInput) Validate() error

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

type GetPushTemplateOutput added in v0.14.0 

type GetPushTemplateOutput struct {

	// Provides information about the content and settings for a message template
	// that can be used in messages that are sent through a push notification channel.
	//
	// PushNotificationTemplateResponse is a required field
	PushNotificationTemplateResponse *PushNotificationTemplateResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (GetPushTemplateOutput) MarshalFields added in v0.14.0 

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

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

func (GetPushTemplateOutput) String added in v0.14.0 

func (s GetPushTemplateOutput) String() string

String returns the string representation

type GetPushTemplateRequest added in v0.14.0 

type GetPushTemplateRequest struct {
	*aws.Request
	Input *GetPushTemplateInput
	Copy  func(*GetPushTemplateInput) GetPushTemplateRequest
}

GetPushTemplateRequest is the request type for the GetPushTemplate API operation.

func (GetPushTemplateRequest) Send added in v0.14.0 

func (r GetPushTemplateRequest) Send(ctx context.Context) (*GetPushTemplateResponse, error)

Send marshals and sends the GetPushTemplate API request.

type GetPushTemplateResponse added in v0.14.0 

type GetPushTemplateResponse struct {
	*GetPushTemplateOutput
	// contains filtered or unexported fields
}

GetPushTemplateResponse is the response type for the GetPushTemplate API operation.

func (*GetPushTemplateResponse) SDKResponseMetdata added in v0.14.0 

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

SDKResponseMetdata returns the response metadata for the GetPushTemplate request.

type GetRecommenderConfigurationInput added in v0.20.0 

type GetRecommenderConfigurationInput struct {

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

func (GetRecommenderConfigurationInput) MarshalFields added in v0.20.0 

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

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

func (GetRecommenderConfigurationInput) String added in v0.20.0 

func (s GetRecommenderConfigurationInput) String() string

String returns the string representation

func (*GetRecommenderConfigurationInput) Validate added in v0.20.0 

func (s *GetRecommenderConfigurationInput) Validate() error

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

type GetRecommenderConfigurationOutput added in v0.20.0 

type GetRecommenderConfigurationOutput struct {

	// Provides information about Amazon Pinpoint configuration settings for retrieving
	// and processing data from a recommender model.
	//
	// RecommenderConfigurationResponse is a required field
	RecommenderConfigurationResponse *RecommenderConfigurationResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (GetRecommenderConfigurationOutput) MarshalFields added in v0.20.0 

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

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

func (GetRecommenderConfigurationOutput) String added in v0.20.0 

func (s GetRecommenderConfigurationOutput) String() string

String returns the string representation

type GetRecommenderConfigurationRequest added in v0.20.0 

type GetRecommenderConfigurationRequest struct {
	*aws.Request
	Input *GetRecommenderConfigurationInput
	Copy  func(*GetRecommenderConfigurationInput) GetRecommenderConfigurationRequest
}

GetRecommenderConfigurationRequest is the request type for the GetRecommenderConfiguration API operation.

func (GetRecommenderConfigurationRequest) Send added in v0.20.0 

func (r GetRecommenderConfigurationRequest) Send(ctx context.Context) (*GetRecommenderConfigurationResponse, error)

Send marshals and sends the GetRecommenderConfiguration API request.

type GetRecommenderConfigurationResponse added in v0.20.0 

type GetRecommenderConfigurationResponse struct {
	*GetRecommenderConfigurationOutput
	// contains filtered or unexported fields
}

GetRecommenderConfigurationResponse is the response type for the GetRecommenderConfiguration API operation.

func (*GetRecommenderConfigurationResponse) SDKResponseMetdata added in v0.20.0 

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

SDKResponseMetdata returns the response metadata for the GetRecommenderConfiguration request.

type GetRecommenderConfigurationsInput added in v0.20.0 

type GetRecommenderConfigurationsInput struct {
	PageSize *string `location:"querystring" locationName:"page-size" type:"string"`

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

func (GetRecommenderConfigurationsInput) MarshalFields added in v0.20.0 

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

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

func (GetRecommenderConfigurationsInput) String added in v0.20.0 

func (s GetRecommenderConfigurationsInput) String() string

String returns the string representation

type GetRecommenderConfigurationsOutput added in v0.20.0 

type GetRecommenderConfigurationsOutput struct {

	// Provides information about all the recommender model configurations that
	// are associated with your Amazon Pinpoint account.
	//
	// ListRecommenderConfigurationsResponse is a required field
	ListRecommenderConfigurationsResponse *ListRecommenderConfigurationsResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (GetRecommenderConfigurationsOutput) MarshalFields added in v0.20.0 

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

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

func (GetRecommenderConfigurationsOutput) String added in v0.20.0 

func (s GetRecommenderConfigurationsOutput) String() string

String returns the string representation

type GetRecommenderConfigurationsRequest added in v0.20.0 

type GetRecommenderConfigurationsRequest struct {
	*aws.Request
	Input *GetRecommenderConfigurationsInput
	Copy  func(*GetRecommenderConfigurationsInput) GetRecommenderConfigurationsRequest
}

GetRecommenderConfigurationsRequest is the request type for the GetRecommenderConfigurations API operation.

func (GetRecommenderConfigurationsRequest) Send added in v0.20.0 

func (r GetRecommenderConfigurationsRequest) Send(ctx context.Context) (*GetRecommenderConfigurationsResponse, error)

Send marshals and sends the GetRecommenderConfigurations API request.

type GetRecommenderConfigurationsResponse added in v0.20.0 

type GetRecommenderConfigurationsResponse struct {
	*GetRecommenderConfigurationsOutput
	// contains filtered or unexported fields
}

GetRecommenderConfigurationsResponse is the response type for the GetRecommenderConfigurations API operation.

func (*GetRecommenderConfigurationsResponse) SDKResponseMetdata added in v0.20.0 

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

SDKResponseMetdata returns the response metadata for the GetRecommenderConfigurations request.

type GetSegmentExportJobsInput added in v0.4.0 

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 (GetSegmentExportJobsInput) MarshalFields added in v0.4.0 

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

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

func (GetSegmentExportJobsInput) String added in v0.4.0 

func (s GetSegmentExportJobsInput) String() string

String returns the string representation

func (*GetSegmentExportJobsInput) Validate added in v0.4.0 

func (s *GetSegmentExportJobsInput) Validate() error

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

type GetSegmentExportJobsOutput added in v0.4.0 

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 (GetSegmentExportJobsOutput) MarshalFields added in v0.4.0 

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

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

func (GetSegmentExportJobsOutput) String added in v0.4.0 

func (s GetSegmentExportJobsOutput) String() string

String returns the string representation

type GetSegmentExportJobsRequest added in v0.4.0 

type GetSegmentExportJobsRequest struct {
	*aws.Request
	Input *GetSegmentExportJobsInput
	Copy  func(*GetSegmentExportJobsInput) GetSegmentExportJobsRequest
}

GetSegmentExportJobsRequest is the request type for the GetSegmentExportJobs API operation.

func (GetSegmentExportJobsRequest) Send added in v0.4.0 

func (r GetSegmentExportJobsRequest) Send(ctx context.Context) (*GetSegmentExportJobsResponse, error)

Send marshals and sends the GetSegmentExportJobs API request.

type GetSegmentExportJobsResponse added in v0.9.0 

type GetSegmentExportJobsResponse struct {
	*GetSegmentExportJobsOutput
	// contains filtered or unexported fields
}

GetSegmentExportJobsResponse is the response type for the GetSegmentExportJobs API operation.

func (*GetSegmentExportJobsResponse) SDKResponseMetdata added in v0.9.0 

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

SDKResponseMetdata returns the response metadata for the GetSegmentExportJobs request.

type GetSegmentImportJobsInput 

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 (GetSegmentImportJobsInput) MarshalFields added in v0.3.0 

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

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

func (GetSegmentImportJobsInput) String 

func (s GetSegmentImportJobsInput) String() string

String returns the string representation

func (*GetSegmentImportJobsInput) Validate 

func (s *GetSegmentImportJobsInput) Validate() error

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

type GetSegmentImportJobsOutput 

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 (GetSegmentImportJobsOutput) MarshalFields added in v0.3.0 

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

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

func (GetSegmentImportJobsOutput) String 

func (s GetSegmentImportJobsOutput) String() string

String returns the string representation

type GetSegmentImportJobsRequest 

type GetSegmentImportJobsRequest struct {
	*aws.Request
	Input *GetSegmentImportJobsInput
	Copy  func(*GetSegmentImportJobsInput) GetSegmentImportJobsRequest
}

GetSegmentImportJobsRequest is the request type for the GetSegmentImportJobs API operation.

func (GetSegmentImportJobsRequest) Send 

func (r GetSegmentImportJobsRequest) Send(ctx context.Context) (*GetSegmentImportJobsResponse, error)

Send marshals and sends the GetSegmentImportJobs API request.

type GetSegmentImportJobsResponse added in v0.9.0 

type GetSegmentImportJobsResponse struct {
	*GetSegmentImportJobsOutput
	// contains filtered or unexported fields
}

GetSegmentImportJobsResponse is the response type for the GetSegmentImportJobs API operation.

func (*GetSegmentImportJobsResponse) SDKResponseMetdata added in v0.9.0 

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

SDKResponseMetdata returns the response metadata for the GetSegmentImportJobs request.

type GetSegmentInput 

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 (GetSegmentInput) MarshalFields added in v0.3.0 

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

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

func (GetSegmentInput) String 

func (s GetSegmentInput) String() string

String returns the string representation

func (*GetSegmentInput) Validate 

func (s *GetSegmentInput) Validate() error

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

type GetSegmentOutput 

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 (GetSegmentOutput) MarshalFields added in v0.3.0 

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

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

func (GetSegmentOutput) String 

func (s GetSegmentOutput) String() string

String returns the string representation

type GetSegmentRequest 

type GetSegmentRequest struct {
	*aws.Request
	Input *GetSegmentInput
	Copy  func(*GetSegmentInput) GetSegmentRequest
}

GetSegmentRequest is the request type for the GetSegment API operation.

func (GetSegmentRequest) Send 

func (r GetSegmentRequest) Send(ctx context.Context) (*GetSegmentResponse, error)

Send marshals and sends the GetSegment API request.

type GetSegmentResponse added in v0.9.0 

type GetSegmentResponse struct {
	*GetSegmentOutput
	// contains filtered or unexported fields
}

GetSegmentResponse is the response type for the GetSegment API operation.

func (*GetSegmentResponse) SDKResponseMetdata added in v0.9.0 

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

SDKResponseMetdata returns the response metadata for the GetSegment request.

type GetSegmentVersionInput 

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 (GetSegmentVersionInput) MarshalFields added in v0.3.0 

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

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

func (GetSegmentVersionInput) String 

func (s GetSegmentVersionInput) String() string

String returns the string representation

func (*GetSegmentVersionInput) Validate 

func (s *GetSegmentVersionInput) Validate() error

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

type GetSegmentVersionOutput 

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 (GetSegmentVersionOutput) MarshalFields added in v0.3.0 

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

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

func (GetSegmentVersionOutput) String 

func (s GetSegmentVersionOutput) String() string

String returns the string representation

type GetSegmentVersionRequest 

type GetSegmentVersionRequest struct {
	*aws.Request
	Input *GetSegmentVersionInput
	Copy  func(*GetSegmentVersionInput) GetSegmentVersionRequest
}

GetSegmentVersionRequest is the request type for the GetSegmentVersion API operation.

func (GetSegmentVersionRequest) Send 

func (r GetSegmentVersionRequest) Send(ctx context.Context) (*GetSegmentVersionResponse, error)

Send marshals and sends the GetSegmentVersion API request.

type GetSegmentVersionResponse added in v0.9.0 

type GetSegmentVersionResponse struct {
	*GetSegmentVersionOutput
	// contains filtered or unexported fields
}

GetSegmentVersionResponse is the response type for the GetSegmentVersion API operation.

func (*GetSegmentVersionResponse) SDKResponseMetdata added in v0.9.0 

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

SDKResponseMetdata returns the response metadata for the GetSegmentVersion request.

type GetSegmentVersionsInput 

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 (GetSegmentVersionsInput) MarshalFields added in v0.3.0 

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

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

func (GetSegmentVersionsInput) String 

func (s GetSegmentVersionsInput) String() string

String returns the string representation

func (*GetSegmentVersionsInput) Validate 

func (s *GetSegmentVersionsInput) Validate() error

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

type GetSegmentVersionsOutput 

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 (GetSegmentVersionsOutput) MarshalFields added in v0.3.0 

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

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

func (GetSegmentVersionsOutput) String 

func (s GetSegmentVersionsOutput) String() string

String returns the string representation

type GetSegmentVersionsRequest 

type GetSegmentVersionsRequest struct {
	*aws.Request
	Input *GetSegmentVersionsInput
	Copy  func(*GetSegmentVersionsInput) GetSegmentVersionsRequest
}

GetSegmentVersionsRequest is the request type for the GetSegmentVersions API operation.

func (GetSegmentVersionsRequest) Send 

func (r GetSegmentVersionsRequest) Send(ctx context.Context) (*GetSegmentVersionsResponse, error)

Send marshals and sends the GetSegmentVersions API request.

type GetSegmentVersionsResponse added in v0.9.0 

type GetSegmentVersionsResponse struct {
	*GetSegmentVersionsOutput
	// contains filtered or unexported fields
}

GetSegmentVersionsResponse is the response type for the GetSegmentVersions API operation.

func (*GetSegmentVersionsResponse) SDKResponseMetdata added in v0.9.0 

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

SDKResponseMetdata returns the response metadata for the GetSegmentVersions request.

type GetSegmentsInput 

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 (GetSegmentsInput) MarshalFields added in v0.3.0 

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

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

func (GetSegmentsInput) String 

func (s GetSegmentsInput) String() string

String returns the string representation

func (*GetSegmentsInput) Validate 

func (s *GetSegmentsInput) Validate() error

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

type GetSegmentsOutput 

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 (GetSegmentsOutput) MarshalFields added in v0.3.0 

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

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

func (GetSegmentsOutput) String 

func (s GetSegmentsOutput) String() string

String returns the string representation

type GetSegmentsRequest 

type GetSegmentsRequest struct {
	*aws.Request
	Input *GetSegmentsInput
	Copy  func(*GetSegmentsInput) GetSegmentsRequest
}

GetSegmentsRequest is the request type for the GetSegments API operation.

func (GetSegmentsRequest) Send 

func (r GetSegmentsRequest) Send(ctx context.Context) (*GetSegmentsResponse, error)

Send marshals and sends the GetSegments API request.

type GetSegmentsResponse added in v0.9.0 

type GetSegmentsResponse struct {
	*GetSegmentsOutput
	// contains filtered or unexported fields
}

GetSegmentsResponse is the response type for the GetSegments API operation.

func (*GetSegmentsResponse) SDKResponseMetdata added in v0.9.0 

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

SDKResponseMetdata returns the response metadata for the GetSegments request.

type GetSmsChannelInput 

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 (GetSmsChannelInput) MarshalFields added in v0.3.0 

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

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

func (GetSmsChannelInput) String 

func (s GetSmsChannelInput) String() string

String returns the string representation

func (*GetSmsChannelInput) Validate 

func (s *GetSmsChannelInput) Validate() error

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

type GetSmsChannelOutput 

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 (GetSmsChannelOutput) MarshalFields added in v0.3.0 

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

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

func (GetSmsChannelOutput) String 

func (s GetSmsChannelOutput) String() string

String returns the string representation

type GetSmsChannelRequest 

type GetSmsChannelRequest struct {
	*aws.Request
	Input *GetSmsChannelInput
	Copy  func(*GetSmsChannelInput) GetSmsChannelRequest
}

GetSmsChannelRequest is the request type for the GetSmsChannel API operation.

func (GetSmsChannelRequest) Send 

func (r GetSmsChannelRequest) Send(ctx context.Context) (*GetSmsChannelResponse, error)

Send marshals and sends the GetSmsChannel API request.

type GetSmsChannelResponse added in v0.9.0 

type GetSmsChannelResponse struct {
	*GetSmsChannelOutput
	// contains filtered or unexported fields
}

GetSmsChannelResponse is the response type for the GetSmsChannel API operation.

func (*GetSmsChannelResponse) SDKResponseMetdata added in v0.9.0 

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

SDKResponseMetdata returns the response metadata for the GetSmsChannel request.

type GetSmsTemplateInput added in v0.14.0 

type GetSmsTemplateInput struct {

	// TemplateName is a required field
	TemplateName *string `location:"uri" locationName:"template-name" type:"string" required:"true"`

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

func (GetSmsTemplateInput) MarshalFields added in v0.14.0 

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

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

func (GetSmsTemplateInput) String added in v0.14.0 

func (s GetSmsTemplateInput) String() string

String returns the string representation

func (*GetSmsTemplateInput) Validate added in v0.14.0 

func (s *GetSmsTemplateInput) Validate() error

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

type GetSmsTemplateOutput added in v0.14.0 

type GetSmsTemplateOutput struct {

	// Provides information about the content and settings for a message template
	// that can be used in text messages that are sent through the SMS channel.
	//
	// SMSTemplateResponse is a required field
	SMSTemplateResponse *SMSTemplateResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (GetSmsTemplateOutput) MarshalFields added in v0.14.0 

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

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

func (GetSmsTemplateOutput) String added in v0.14.0 

func (s GetSmsTemplateOutput) String() string

String returns the string representation

type GetSmsTemplateRequest added in v0.14.0 

type GetSmsTemplateRequest struct {
	*aws.Request
	Input *GetSmsTemplateInput
	Copy  func(*GetSmsTemplateInput) GetSmsTemplateRequest
}

GetSmsTemplateRequest is the request type for the GetSmsTemplate API operation.

func (GetSmsTemplateRequest) Send added in v0.14.0 

func (r GetSmsTemplateRequest) Send(ctx context.Context) (*GetSmsTemplateResponse, error)

Send marshals and sends the GetSmsTemplate API request.

type GetSmsTemplateResponse added in v0.14.0 

type GetSmsTemplateResponse struct {
	*GetSmsTemplateOutput
	// contains filtered or unexported fields
}

GetSmsTemplateResponse is the response type for the GetSmsTemplate API operation.

func (*GetSmsTemplateResponse) SDKResponseMetdata added in v0.14.0 

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

SDKResponseMetdata returns the response metadata for the GetSmsTemplate request.

type GetUserEndpointsInput added in v0.5.0 

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 (GetUserEndpointsInput) MarshalFields added in v0.5.0 

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

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

func (GetUserEndpointsInput) String added in v0.5.0 

func (s GetUserEndpointsInput) String() string

String returns the string representation

func (*GetUserEndpointsInput) Validate added in v0.5.0 

func (s *GetUserEndpointsInput) Validate() error

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

type GetUserEndpointsOutput added in v0.5.0 

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 (GetUserEndpointsOutput) MarshalFields added in v0.5.0 

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

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

func (GetUserEndpointsOutput) String added in v0.5.0 

func (s GetUserEndpointsOutput) String() string

String returns the string representation

type GetUserEndpointsRequest added in v0.5.0 

type GetUserEndpointsRequest struct {
	*aws.Request
	Input *GetUserEndpointsInput
	Copy  func(*GetUserEndpointsInput) GetUserEndpointsRequest
}

GetUserEndpointsRequest is the request type for the GetUserEndpoints API operation.

func (GetUserEndpointsRequest) Send added in v0.5.0 

func (r GetUserEndpointsRequest) Send(ctx context.Context) (*GetUserEndpointsResponse, error)

Send marshals and sends the GetUserEndpoints API request.

type GetUserEndpointsResponse added in v0.9.0 

type GetUserEndpointsResponse struct {
	*GetUserEndpointsOutput
	// contains filtered or unexported fields
}

GetUserEndpointsResponse is the response type for the GetUserEndpoints API operation.

func (*GetUserEndpointsResponse) SDKResponseMetdata added in v0.9.0 

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

SDKResponseMetdata returns the response metadata for the GetUserEndpoints request.

type GetVoiceChannelInput added in v0.6.0 

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 (GetVoiceChannelInput) MarshalFields added in v0.6.0 

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

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

func (GetVoiceChannelInput) String added in v0.6.0 

func (s GetVoiceChannelInput) String() string

String returns the string representation

func (*GetVoiceChannelInput) Validate added in v0.6.0 

func (s *GetVoiceChannelInput) Validate() error

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

type GetVoiceChannelOutput added in v0.6.0 

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 (GetVoiceChannelOutput) MarshalFields added in v0.6.0 

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

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

func (GetVoiceChannelOutput) String added in v0.6.0 

func (s GetVoiceChannelOutput) String() string

String returns the string representation

type GetVoiceChannelRequest added in v0.6.0 

type GetVoiceChannelRequest struct {
	*aws.Request
	Input *GetVoiceChannelInput
	Copy  func(*GetVoiceChannelInput) GetVoiceChannelRequest
}

GetVoiceChannelRequest is the request type for the GetVoiceChannel API operation.

func (GetVoiceChannelRequest) Send added in v0.6.0 

func (r GetVoiceChannelRequest) Send(ctx context.Context) (*GetVoiceChannelResponse, error)

Send marshals and sends the GetVoiceChannel API request.

type GetVoiceChannelResponse added in v0.9.0 

type GetVoiceChannelResponse struct {
	*GetVoiceChannelOutput
	// contains filtered or unexported fields
}

GetVoiceChannelResponse is the response type for the GetVoiceChannel API operation.

func (*GetVoiceChannelResponse) SDKResponseMetdata added in v0.9.0 

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

SDKResponseMetdata returns the response metadata for the GetVoiceChannel request.

type GetVoiceTemplateInput added in v0.17.0 

type GetVoiceTemplateInput struct {

	// TemplateName is a required field
	TemplateName *string `location:"uri" locationName:"template-name" type:"string" required:"true"`

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

func (GetVoiceTemplateInput) MarshalFields added in v0.17.0 

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

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

func (GetVoiceTemplateInput) String added in v0.17.0 

func (s GetVoiceTemplateInput) String() string

String returns the string representation

func (*GetVoiceTemplateInput) Validate added in v0.17.0 

func (s *GetVoiceTemplateInput) Validate() error

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

type GetVoiceTemplateOutput added in v0.17.0 

type GetVoiceTemplateOutput struct {

	// Provides information about the content and settings for a message template
	// that can be used in messages that are sent through the voice channel.
	//
	// VoiceTemplateResponse is a required field
	VoiceTemplateResponse *VoiceTemplateResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (GetVoiceTemplateOutput) MarshalFields added in v0.17.0 

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

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

func (GetVoiceTemplateOutput) String added in v0.17.0 

func (s GetVoiceTemplateOutput) String() string

String returns the string representation

type GetVoiceTemplateRequest added in v0.17.0 

type GetVoiceTemplateRequest struct {
	*aws.Request
	Input *GetVoiceTemplateInput
	Copy  func(*GetVoiceTemplateInput) GetVoiceTemplateRequest
}

GetVoiceTemplateRequest is the request type for the GetVoiceTemplate API operation.

func (GetVoiceTemplateRequest) Send added in v0.17.0 

func (r GetVoiceTemplateRequest) Send(ctx context.Context) (*GetVoiceTemplateResponse, error)

Send marshals and sends the GetVoiceTemplate API request.

type GetVoiceTemplateResponse added in v0.17.0 

type GetVoiceTemplateResponse struct {
	*GetVoiceTemplateOutput
	// contains filtered or unexported fields
}

GetVoiceTemplateResponse is the response type for the GetVoiceTemplate API operation.

func (*GetVoiceTemplateResponse) SDKResponseMetdata added in v0.17.0 

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

SDKResponseMetdata returns the response metadata for the GetVoiceTemplate request.

type HoldoutActivity added in v0.16.0 

type HoldoutActivity struct {

	// The unique identifier for the next activity to perform, after performing
	// the holdout activity.
	NextActivity *string `type:"string"`

	// The percentage of participants who shouldn't continue the journey.
	//
	// To determine which participants are held out, Amazon Pinpoint applies a probability-based
	// algorithm to the percentage that you specify. Therefore, the actual percentage
	// of participants who are held out may not be equal to the percentage that
	// you specify.
	//
	// Percentage is a required field
	Percentage *int64 `type:"integer" required:"true"`
	// contains filtered or unexported fields
}

Specifies the settings for a holdout activity in a journey. This type of activity stops a journey for a specified percentage of participants.

func (HoldoutActivity) MarshalFields added in v0.16.0 

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

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

func (HoldoutActivity) String added in v0.16.0 

func (s HoldoutActivity) String() string

String returns the string representation

func (*HoldoutActivity) Validate added in v0.16.0 

func (s *HoldoutActivity) Validate() error

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

type ImportJobRequest 

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 Format `type:"string" required:"true" enum:"true"`

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

	// A 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 (ImportJobRequest) MarshalFields added in v0.3.0 

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

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

func (ImportJobRequest) String 

func (s ImportJobRequest) String() string

String returns the string representation

func (*ImportJobRequest) Validate added in v0.10.0 

func (s *ImportJobRequest) Validate() error

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

type ImportJobResource 

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 Format `type:"string" required:"true" enum:"true"`

	// 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 (ImportJobResource) MarshalFields added in v0.3.0 

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

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

func (ImportJobResource) String 

func (s ImportJobResource) String() string

String returns the string representation

type ImportJobResponse 

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 JobStatus `type:"string" required:"true" enum:"true"`

	// 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 (ImportJobResponse) MarshalFields added in v0.3.0 

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

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

func (ImportJobResponse) String 

func (s ImportJobResponse) String() string

String returns the string representation

type ImportJobsResponse 

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 (ImportJobsResponse) MarshalFields added in v0.3.0 

func (s ImportJobsResponse) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ImportJobsResponse) String 

func (s ImportJobsResponse) String() string

String returns the string representation

type Include added in v0.5.0 

type Include string
const (
	IncludeAll  Include = "ALL"
	IncludeAny  Include = "ANY"
	IncludeNone Include = "NONE"
)

Enum values for Include

func (Include) MarshalValue added in v0.5.0 

func (enum Include) MarshalValue() (string, error)

func (Include) MarshalValueBuf added in v0.5.0 

func (enum Include) MarshalValueBuf(b []byte) ([]byte, error)

type ItemResponse added in v0.5.0 

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 (ItemResponse) MarshalFields added in v0.5.0 

func (s ItemResponse) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ItemResponse) String added in v0.5.0 

func (s ItemResponse) String() string

String returns the string representation

type JobStatus 

type JobStatus string
const (
	JobStatusCreated                    JobStatus = "CREATED"
	JobStatusPreparingForInitialization JobStatus = "PREPARING_FOR_INITIALIZATION"
	JobStatusInitializing               JobStatus = "INITIALIZING"
	JobStatusProcessing                 JobStatus = "PROCESSING"
	JobStatusPendingJob                 JobStatus = "PENDING_JOB"
	JobStatusCompleting                 JobStatus = "COMPLETING"
	JobStatusCompleted                  JobStatus = "COMPLETED"
	JobStatusFailing                    JobStatus = "FAILING"
	JobStatusFailed                     JobStatus = "FAILED"
)

Enum values for JobStatus

func (JobStatus) MarshalValue added in v0.3.0 

func (enum JobStatus) MarshalValue() (string, error)

func (JobStatus) MarshalValueBuf added in v0.3.0 

func (enum JobStatus) MarshalValueBuf(b []byte) ([]byte, error)

type JourneyCustomMessage added in v0.24.0 

type JourneyCustomMessage struct {

	// The message content that's passed to an AWS Lambda function or to a web hook.
	Data *string `type:"string"`
	// contains filtered or unexported fields
}

Specifies the message content for a custom channel message that's sent to participants in a journey.

func (JourneyCustomMessage) MarshalFields added in v0.24.0 

func (s JourneyCustomMessage) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (JourneyCustomMessage) String added in v0.24.0 

func (s JourneyCustomMessage) String() string

String returns the string representation

type JourneyDateRangeKpiResponse added in v0.16.0 

type JourneyDateRangeKpiResponse 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 unique identifier for the journey that the metric applies to.
	//
	// JourneyId is a required field
	JourneyId *string `type:"string" 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 possible values, see the
	// Amazon Pinpoint Developer Guide (https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.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 Journey Engagement Metrics
	// resource because the 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 engagement metric that applies to a journey, and provides information about that query.

func (JourneyDateRangeKpiResponse) MarshalFields added in v0.16.0 

func (s JourneyDateRangeKpiResponse) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (JourneyDateRangeKpiResponse) String added in v0.16.0 

func (s JourneyDateRangeKpiResponse) String() string

String returns the string representation

type JourneyEmailMessage added in v0.16.0 

type JourneyEmailMessage struct {

	// The verified email address to send the email message from. The default address
	// is the FromAddress specified for the email channel for the application.
	FromAddress *string `type:"string"`
	// contains filtered or unexported fields
}

Specifies the "From" address for an email message that's sent to participants in a journey.

func (JourneyEmailMessage) MarshalFields added in v0.16.0 

func (s JourneyEmailMessage) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (JourneyEmailMessage) String added in v0.16.0 

func (s JourneyEmailMessage) String() string

String returns the string representation

type JourneyExecutionActivityMetricsResponse added in v0.16.0 

type JourneyExecutionActivityMetricsResponse struct {

	// The type of activity that the metric applies to. Possible values are:
	//
	//    * CONDITIONAL_SPLIT - For a yes/no split activity, which is an activity
	//    that sends participants down one of two paths in a journey.
	//
	//    * HOLDOUT - For a holdout activity, which is an activity that stops a
	//    journey for a specified percentage of participants.
	//
	//    * MESSAGE - For an email activity, which is an activity that sends an
	//    email message to participants.
	//
	//    * MULTI_CONDITIONAL_SPLIT - For a multivariate split activity, which is
	//    an activity that sends participants down one of as many as five paths
	//    in a journey.
	//
	//    * RANDOM_SPLIT - For a random split activity, which is an activity that
	//    sends specified percentages of participants down one of as many as five
	//    paths in a journey.
	//
	//    * WAIT - For a wait activity, which is an activity that waits for a certain
	//    amount of time or until a specific date and time before moving participants
	//    to the next activity in a journey.
	//
	// ActivityType is a required field
	ActivityType *string `type:"string" required:"true"`

	// 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 activity that the metric applies to.
	//
	// JourneyActivityId is a required field
	JourneyActivityId *string `type:"string" required:"true"`

	// The unique identifier for the journey that the metric applies to.
	//
	// JourneyId is a required field
	JourneyId *string `type:"string" required:"true"`

	// The date and time, in ISO 8601 format, when Amazon Pinpoint last evaluated
	// the execution status of the activity and updated the data for the metric.
	//
	// LastEvaluatedTime is a required field
	LastEvaluatedTime *string `type:"string" required:"true"`

	// A JSON object that contains the results of the query. The results vary depending
	// on the type of activity (ActivityType). For information about the structure
	// and contents of the results, see the Amazon Pinpoint Developer Guide (https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html).
	//
	// Metrics is a required field
	Metrics map[string]string `type:"map" required:"true"`
	// contains filtered or unexported fields
}

Provides the results of a query that retrieved the data for a standard execution metric that applies to a journey activity, and provides information about that query.

func (JourneyExecutionActivityMetricsResponse) MarshalFields added in v0.16.0 

func (s JourneyExecutionActivityMetricsResponse) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (JourneyExecutionActivityMetricsResponse) String added in v0.16.0 

func (s JourneyExecutionActivityMetricsResponse) String() string

String returns the string representation

type JourneyExecutionMetricsResponse added in v0.16.0 

type JourneyExecutionMetricsResponse 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 journey that the metric applies to.
	//
	// JourneyId is a required field
	JourneyId *string `type:"string" required:"true"`

	// The date and time, in ISO 8601 format, when Amazon Pinpoint last evaluated
	// the journey and updated the data for the metric.
	//
	// LastEvaluatedTime is a required field
	LastEvaluatedTime *string `type:"string" required:"true"`

	// A JSON object that contains the results of the query. For information about
	// the structure and contents of the results, see the Amazon Pinpoint Developer
	// Guide (https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html).
	//
	// Metrics is a required field
	Metrics map[string]string `type:"map" required:"true"`
	// contains filtered or unexported fields
}

Provides the results of a query that retrieved the data for a standard execution metric that applies to a journey, and provides information about that query.

func (JourneyExecutionMetricsResponse) MarshalFields added in v0.16.0 

func (s JourneyExecutionMetricsResponse) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (JourneyExecutionMetricsResponse) String added in v0.16.0 

func (s JourneyExecutionMetricsResponse) String() string

String returns the string representation

type JourneyLimits added in v0.16.0 

type JourneyLimits struct {

	// The maximum number of messages that the journey can send to a single participant
	// during a 24-hour period. The maximum value is 100.
	DailyCap *int64 `type:"integer"`

	// The maximum number of times that a participant can enter the journey. The
	// maximum value is 100. To allow participants to enter the journey an unlimited
	// number of times, set this value to 0.
	EndpointReentryCap *int64 `type:"integer"`

	// The maximum number of messages that the journey can send each second.
	MessagesPerSecond *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Specifies limits on the messages that a journey can send and the number of times participants can enter a journey.

func (JourneyLimits) MarshalFields added in v0.16.0 

func (s JourneyLimits) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (JourneyLimits) String added in v0.16.0 

func (s JourneyLimits) String() string

String returns the string representation

type JourneyPushMessage added in v0.24.0 

type JourneyPushMessage struct {

	// 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 *string `type:"string"`
	// contains filtered or unexported fields
}

Specifies the message configuration for a push notification that's sent to participants in a journey.

func (JourneyPushMessage) MarshalFields added in v0.24.0 

func (s JourneyPushMessage) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (JourneyPushMessage) String added in v0.24.0 

func (s JourneyPushMessage) String() string

String returns the string representation

type JourneyResponse added in v0.16.0 

type JourneyResponse struct {

	// A map that contains a set of Activity objects, one object for each activity
	// in the journey. For each Activity object, the key is the unique identifier
	// (string) for an activity and the value is the settings for the activity.
	Activities map[string]Activity `type:"map"`

	// The unique identifier for the application that the journey applies to.
	//
	// ApplicationId is a required field
	ApplicationId *string `type:"string" required:"true"`

	// The date, in ISO 8601 format, when the journey was created.
	CreationDate *string `type:"string"`

	// The unique identifier for the journey.
	//
	// Id is a required field
	Id *string `type:"string" required:"true"`

	// The date, in ISO 8601 format, when the journey was last modified.
	LastModifiedDate *string `type:"string"`

	// The messaging and entry limits for the journey.
	Limits *JourneyLimits `type:"structure"`

	// Specifies whether the journey's scheduled start and end times use each participant's
	// local time. If this value is true, the schedule uses each participant's local
	// time.
	LocalTime *bool `type:"boolean"`

	// The name of the journey.
	//
	// Name is a required field
	Name *string `type:"string" required:"true"`

	// The quiet time settings for the journey. Quiet time is a specific time range
	// when a journey doesn't send messages to participants, if all the following
	// conditions are met:
	//
	//    * The EndpointDemographic.Timezone property of the endpoint for the participant
	//    is set to a valid value.
	//
	//    * The current time in the participant's time zone is later than or equal
	//    to the time specified by the QuietTime.Start property for the journey.
	//
	//    * The current time in the participant's time zone is earlier than or equal
	//    to the time specified by the QuietTime.End property for the journey.
	//
	// If any of the preceding conditions isn't met, the participant will receive
	// messages from the journey, even if quiet time is enabled.
	QuietTime *QuietTime `type:"structure"`

	// The frequency with which Amazon Pinpoint evaluates segment and event data
	// for the journey, as a duration in ISO 8601 format.
	RefreshFrequency *string `type:"string"`

	// The schedule settings for the journey.
	Schedule *JourneySchedule `type:"structure"`

	// The unique identifier for the first activity in the journey.
	StartActivity *string `type:"string"`

	// The segment that defines which users are participants in the journey.
	StartCondition *StartCondition `type:"structure"`

	// The current status of the journey. Possible values are:
	//
	//    * DRAFT - The journey is being developed and hasn't been published yet.
	//
	//    * ACTIVE - The journey has been developed and published. Depending on
	//    the journey's schedule, the journey may currently be running or scheduled
	//    to start running at a later time. If a journey's status is ACTIVE, you
	//    can't add, change, or remove activities from it.
	//
	//    * COMPLETED - The journey has been published and has finished running.
	//    All participants have entered the journey and no participants are waiting
	//    to complete the journey or any activities in the journey.
	//
	//    * CANCELLED - The journey has been stopped. If a journey's status is CANCELLED,
	//    you can't add, change, or remove activities or segment settings from the
	//    journey.
	//
	//    * CLOSED - The journey has been published and has started running. It
	//    may have also passed its scheduled end time, or passed its scheduled start
	//    time and a refresh frequency hasn't been specified for it. If a journey's
	//    status is CLOSED, you can't add participants to it, and no existing participants
	//    can enter the journey for the first time. However, any existing participants
	//    who are currently waiting to start an activity may continue the journey.
	State State `type:"string" enum:"true"`

	// This object is not used or supported.
	Tags map[string]string `locationName:"tags" type:"map"`
	// contains filtered or unexported fields
}

Provides information about the status, configuration, and other settings for a journey.

func (JourneyResponse) MarshalFields added in v0.16.0 

func (s JourneyResponse) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (JourneyResponse) String added in v0.16.0 

func (s JourneyResponse) String() string

String returns the string representation

type JourneySMSMessage added in v0.24.0 

type JourneySMSMessage struct {

	// The SMS message type. Valid values are TRANSACTIONAL (for messages that are
	// critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL
	// (for messsages that aren't critical or time-sensitive, such as marketing
	// messages).
	MessageType MessageType `type:"string" enum:"true"`

	// The sender ID to display as the sender of the message on a recipient's device.
	// Support for sender IDs varies by country or region. For more information,
	// see Supported Countries and Regions (https://docs.aws.amazon.com.amazon.com/pinpoint/latest/userguide/channels-sms-countries.html)
	// in the Amazon Pinpoint User Guide.
	SenderId *string `type:"string"`
	// contains filtered or unexported fields
}

Specifies the sender ID and message type for an SMS message that's sent to participants in a journey.

func (JourneySMSMessage) MarshalFields added in v0.24.0 

func (s JourneySMSMessage) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (JourneySMSMessage) String added in v0.24.0 

func (s JourneySMSMessage) String() string

String returns the string representation

type JourneySchedule added in v0.16.0 

type JourneySchedule struct {
	EndTime *time.Time `type:"timestamp" timestampFormat:"iso8601"`

	StartTime *time.Time `type:"timestamp" timestampFormat:"iso8601"`

	// The starting UTC offset for the journey schedule, if the value of the journey's
	// LocalTime property is true. Valid values are: UTC, UTC+01, UTC+02, UTC+03,
	// UTC+03:30, UTC+04, UTC+04:30, UTC+05, UTC+05:30, UTC+05:45, UTC+06, UTC+06:30,
	// UTC+07, UTC+08, UTC+08:45, UTC+09, UTC+09:30, UTC+10, UTC+10:30, UTC+11,
	// UTC+12, UTC+12:45, UTC+13, UTC+13:45, UTC-02, UTC-02:30, UTC-03, UTC-03:30,
	// UTC-04, UTC-05, UTC-06, UTC-07, UTC-08, UTC-09, UTC-09:30, UTC-10, and UTC-11.
	Timezone *string `type:"string"`
	// contains filtered or unexported fields
}

Specifies the schedule settings for a journey.

func (JourneySchedule) MarshalFields added in v0.16.0 

func (s JourneySchedule) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (JourneySchedule) String added in v0.16.0 

func (s JourneySchedule) String() string

String returns the string representation

type JourneyStateRequest added in v0.16.0 

type JourneyStateRequest struct {

	// The status of the journey. Currently, the only supported value is CANCELLED.
	//
	// If you cancel a journey, Amazon Pinpoint continues to perform activities
	// that are currently in progress, until those activities are complete. Amazon
	// Pinpoint also continues to collect and aggregate analytics data for those
	// activities, until they are complete, and any activities that were complete
	// when you cancelled the journey.
	//
	// After you cancel a journey, you can't add, change, or remove any activities
	// from the journey. In addition, Amazon Pinpoint stops evaluating the journey
	// and doesn't perform any activities that haven't started.
	State State `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

Changes the status of a journey.

func (JourneyStateRequest) MarshalFields added in v0.16.0 

func (s JourneyStateRequest) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (JourneyStateRequest) String added in v0.16.0 

func (s JourneyStateRequest) String() string

String returns the string representation

type JourneysResponse added in v0.16.0 

type JourneysResponse struct {

	// An array of responses, one for each journey that's associated with the application.
	//
	// Item is a required field
	Item []JourneyResponse `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, configuration, and other settings for all the journeys that are associated with an application.

func (JourneysResponse) MarshalFields added in v0.16.0 

func (s JourneysResponse) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (JourneysResponse) String added in v0.16.0 

func (s JourneysResponse) String() string

String returns the string representation

type ListJourneysInput added in v0.16.0 

type ListJourneysInput 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 (ListJourneysInput) MarshalFields added in v0.16.0 

func (s ListJourneysInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListJourneysInput) String added in v0.16.0 

func (s ListJourneysInput) String() string

String returns the string representation

func (*ListJourneysInput) Validate added in v0.16.0 

func (s *ListJourneysInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListJourneysOutput added in v0.16.0 

type ListJourneysOutput struct {

	// Provides information about the status, configuration, and other settings
	// for all the journeys that are associated with an application.
	//
	// JourneysResponse is a required field
	JourneysResponse *JourneysResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (ListJourneysOutput) MarshalFields added in v0.16.0 

func (s ListJourneysOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListJourneysOutput) String added in v0.16.0 

func (s ListJourneysOutput) String() string

String returns the string representation

type ListJourneysRequest added in v0.16.0 

type ListJourneysRequest struct {
	*aws.Request
	Input *ListJourneysInput
	Copy  func(*ListJourneysInput) ListJourneysRequest
}

ListJourneysRequest is the request type for the ListJourneys API operation.

func (ListJourneysRequest) Send added in v0.16.0 

func (r ListJourneysRequest) Send(ctx context.Context) (*ListJourneysResponse, error)

Send marshals and sends the ListJourneys API request.

type ListJourneysResponse added in v0.16.0 

type ListJourneysResponse struct {
	*ListJourneysOutput
	// contains filtered or unexported fields
}

ListJourneysResponse is the response type for the ListJourneys API operation.

func (*ListJourneysResponse) SDKResponseMetdata added in v0.16.0 

func (r *ListJourneysResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListJourneys request.

type ListRecommenderConfigurationsResponse added in v0.20.0 

type ListRecommenderConfigurationsResponse struct {

	// An array of responses, one for each recommender model configuration that's
	// associated with your Amazon Pinpoint account.
	//
	// Item is a required field
	Item []RecommenderConfigurationResponse `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 recommender model configurations that are associated with your Amazon Pinpoint account.

func (ListRecommenderConfigurationsResponse) MarshalFields added in v0.20.0 

func (s ListRecommenderConfigurationsResponse) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListRecommenderConfigurationsResponse) String added in v0.20.0 

func (s ListRecommenderConfigurationsResponse) String() string

String returns the string representation

type ListTagsForResourceInput added in v0.8.0 

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 (ListTagsForResourceInput) MarshalFields added in v0.8.0 

func (s ListTagsForResourceInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListTagsForResourceInput) String added in v0.8.0 

func (s ListTagsForResourceInput) String() string

String returns the string representation

func (*ListTagsForResourceInput) Validate added in v0.8.0 

func (s *ListTagsForResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListTagsForResourceOutput added in v0.8.0 

type ListTagsForResourceOutput struct {

	// Specifies the tags (keys and values) for an application, campaign, message
	// template, or segment.
	//
	// TagsModel is a required field
	TagsModel *TagsModel `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceOutput) MarshalFields added in v0.8.0 

func (s ListTagsForResourceOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListTagsForResourceOutput) String added in v0.8.0 

func (s ListTagsForResourceOutput) String() string

String returns the string representation

type ListTagsForResourceRequest added in v0.8.0 

type ListTagsForResourceRequest struct {
	*aws.Request
	Input *ListTagsForResourceInput
	Copy  func(*ListTagsForResourceInput) ListTagsForResourceRequest
}

ListTagsForResourceRequest is the request type for the ListTagsForResource API operation.

func (ListTagsForResourceRequest) Send added in v0.8.0 

func (r ListTagsForResourceRequest) Send(ctx context.Context) (*ListTagsForResourceResponse, error)

Send marshals and sends the ListTagsForResource API request.

type ListTagsForResourceResponse added in v0.9.0 

type ListTagsForResourceResponse struct {
	*ListTagsForResourceOutput
	// contains filtered or unexported fields
}

ListTagsForResourceResponse is the response type for the ListTagsForResource API operation.

func (*ListTagsForResourceResponse) SDKResponseMetdata added in v0.9.0 

func (r *ListTagsForResourceResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListTagsForResource request.

type ListTemplateVersionsInput added in v0.19.0 

type ListTemplateVersionsInput struct {
	NextToken *string `location:"querystring" locationName:"next-token" type:"string"`

	PageSize *string `location:"querystring" locationName:"page-size" type:"string"`

	// TemplateName is a required field
	TemplateName *string `location:"uri" locationName:"template-name" type:"string" required:"true"`

	// TemplateType is a required field
	TemplateType *string `location:"uri" locationName:"template-type" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListTemplateVersionsInput) MarshalFields added in v0.19.0 

func (s ListTemplateVersionsInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListTemplateVersionsInput) String added in v0.19.0 

func (s ListTemplateVersionsInput) String() string

String returns the string representation

func (*ListTemplateVersionsInput) Validate added in v0.19.0 

func (s *ListTemplateVersionsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListTemplateVersionsOutput added in v0.19.0 

type ListTemplateVersionsOutput struct {

	// Provides information about all the versions of a specific message template.
	//
	// TemplateVersionsResponse is a required field
	TemplateVersionsResponse *TemplateVersionsResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (ListTemplateVersionsOutput) MarshalFields added in v0.19.0 

func (s ListTemplateVersionsOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListTemplateVersionsOutput) String added in v0.19.0 

func (s ListTemplateVersionsOutput) String() string

String returns the string representation

type ListTemplateVersionsRequest added in v0.19.0 

type ListTemplateVersionsRequest struct {
	*aws.Request
	Input *ListTemplateVersionsInput
	Copy  func(*ListTemplateVersionsInput) ListTemplateVersionsRequest
}

ListTemplateVersionsRequest is the request type for the ListTemplateVersions API operation.

func (ListTemplateVersionsRequest) Send added in v0.19.0 

func (r ListTemplateVersionsRequest) Send(ctx context.Context) (*ListTemplateVersionsResponse, error)

Send marshals and sends the ListTemplateVersions API request.

type ListTemplateVersionsResponse added in v0.19.0 

type ListTemplateVersionsResponse struct {
	*ListTemplateVersionsOutput
	// contains filtered or unexported fields
}

ListTemplateVersionsResponse is the response type for the ListTemplateVersions API operation.

func (*ListTemplateVersionsResponse) SDKResponseMetdata added in v0.19.0 

func (r *ListTemplateVersionsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListTemplateVersions request.

type ListTemplatesInput added in v0.14.0 

type ListTemplatesInput struct {
	NextToken *string `location:"querystring" locationName:"next-token" type:"string"`

	PageSize *string `location:"querystring" locationName:"page-size" type:"string"`

	Prefix *string `location:"querystring" locationName:"prefix" type:"string"`

	TemplateType *string `location:"querystring" locationName:"template-type" type:"string"`
	// contains filtered or unexported fields
}

func (ListTemplatesInput) MarshalFields added in v0.14.0 

func (s ListTemplatesInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListTemplatesInput) String added in v0.14.0 

func (s ListTemplatesInput) String() string

String returns the string representation

type ListTemplatesOutput added in v0.14.0 

type ListTemplatesOutput struct {

	// Provides information about all the message templates that are associated
	// with your Amazon Pinpoint account.
	//
	// TemplatesResponse is a required field
	TemplatesResponse *TemplatesResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (ListTemplatesOutput) MarshalFields added in v0.14.0 

func (s ListTemplatesOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListTemplatesOutput) String added in v0.14.0 

func (s ListTemplatesOutput) String() string

String returns the string representation

type ListTemplatesRequest added in v0.14.0 

type ListTemplatesRequest struct {
	*aws.Request
	Input *ListTemplatesInput
	Copy  func(*ListTemplatesInput) ListTemplatesRequest
}

ListTemplatesRequest is the request type for the ListTemplates API operation.

func (ListTemplatesRequest) Send added in v0.14.0 

func (r ListTemplatesRequest) Send(ctx context.Context) (*ListTemplatesResponse, error)

Send marshals and sends the ListTemplates API request.

type ListTemplatesResponse added in v0.14.0 

type ListTemplatesResponse struct {
	*ListTemplatesOutput
	// contains filtered or unexported fields
}

ListTemplatesResponse is the response type for the ListTemplates API operation.

func (*ListTemplatesResponse) SDKResponseMetdata added in v0.14.0 

func (r *ListTemplatesResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListTemplates request.

type Message 

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 Action `type:"string" enum:"true"`

	// 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. If specified, this value overrides all other content 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 (Message) MarshalFields added in v0.3.0 

func (s Message) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (Message) String 

func (s Message) String() string

String returns the string representation

type MessageBody 

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 (MessageBody) MarshalFields added in v0.3.0 

func (s MessageBody) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (MessageBody) String 

func (s MessageBody) String() string

String returns the string representation

type MessageConfiguration 

type MessageConfiguration struct {

	// The message that the campaign sends through the ADM (Amazon Device Messaging)
	// channel. If specified, this message overrides the default message.
	ADMMessage *Message `type:"structure"`

	// The message that the campaign sends through the APNs (Apple Push Notification
	// service) channel. If specified, this message overrides the default message.
	APNSMessage *Message `type:"structure"`

	// The message that the campaign sends through the Baidu (Baidu Cloud Push)
	// channel. If specified, this message overrides the default message.
	BaiduMessage *Message `type:"structure"`

	// The message that the campaign sends through a custom channel, as specified
	// by the delivery configuration (CustomDeliveryConfiguration) settings for
	// the campaign. If specified, this message overrides the default message.
	CustomMessage *CampaignCustomMessage `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. If specified,
	// this message overrides the default message.
	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. If specified, this
	// message overrides the default message.
	GCMMessage *Message `type:"structure"`

	// The message that the campaign sends through the SMS channel. If specified,
	// this message overrides the default message.
	SMSMessage *CampaignSmsMessage `type:"structure"`
	// contains filtered or unexported fields
}

Specifies the message configuration settings for a campaign.

func (MessageConfiguration) MarshalFields added in v0.3.0 

func (s MessageConfiguration) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (MessageConfiguration) String 

func (s MessageConfiguration) String() string

String returns the string representation

type MessageRequest 

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 settings and content for the default message and any default messages
	// that you defined for specific channels.
	//
	// MessageConfiguration is a required field
	MessageConfiguration *DirectMessageConfiguration `type:"structure" required:"true"`

	// The message template to use for the message.
	TemplateConfiguration *TemplateConfiguration `type:"structure"`

	// 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 configuration and other settings for a message.

func (MessageRequest) MarshalFields added in v0.3.0 

func (s MessageRequest) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (MessageRequest) String 

func (s MessageRequest) String() string

String returns the string representation

func (*MessageRequest) Validate added in v0.10.0 

func (s *MessageRequest) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type MessageResponse 

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 (MessageResponse) MarshalFields added in v0.3.0 

func (s MessageResponse) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (MessageResponse) String 

func (s MessageResponse) String() string

String returns the string representation

type MessageResult 

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 won't
	//    attempt to send the message again.
	//
	//    * 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 DeliveryStatus `type:"string" required:"true" enum:"true"`

	// 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 endpoint's device registration 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 (MessageResult) MarshalFields added in v0.3.0 

func (s MessageResult) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (MessageResult) String 

func (s MessageResult) String() string

String returns the string representation

type MessageType 

type MessageType string
const (
	MessageTypeTransactional MessageType = "TRANSACTIONAL"
	MessageTypePromotional   MessageType = "PROMOTIONAL"
)

Enum values for MessageType

func (MessageType) MarshalValue added in v0.3.0 

func (enum MessageType) MarshalValue() (string, error)

func (MessageType) MarshalValueBuf added in v0.3.0 

func (enum MessageType) MarshalValueBuf(b []byte) ([]byte, error)

type MetricDimension added in v0.5.0 

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 (MetricDimension) MarshalFields added in v0.5.0 

func (s MetricDimension) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (MetricDimension) String added in v0.5.0 

func (s MetricDimension) String() string

String returns the string representation

func (*MetricDimension) Validate added in v0.10.0 

func (s *MetricDimension) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type Mode added in v0.4.0 

type Mode string
const (
	ModeDelivery Mode = "DELIVERY"
	ModeFilter   Mode = "FILTER"
)

Enum values for Mode

func (Mode) MarshalValue added in v0.4.0 

func (enum Mode) MarshalValue() (string, error)

func (Mode) MarshalValueBuf added in v0.4.0 

func (enum Mode) MarshalValueBuf(b []byte) ([]byte, error)

type MultiConditionalBranch added in v0.16.0 

type MultiConditionalBranch struct {

	// The condition to evaluate for the activity path.
	Condition *SimpleCondition `type:"structure"`

	// The unique identifier for the next activity to perform, after completing
	// the activity for the path.
	NextActivity *string `type:"string"`
	// contains filtered or unexported fields
}

Specifies a condition to evaluate for an activity path in a journey.

func (MultiConditionalBranch) MarshalFields added in v0.16.0 

func (s MultiConditionalBranch) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (MultiConditionalBranch) String added in v0.16.0 

func (s MultiConditionalBranch) String() string

String returns the string representation

func (*MultiConditionalBranch) Validate added in v0.16.0 

func (s *MultiConditionalBranch) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type MultiConditionalSplitActivity added in v0.16.0 

type MultiConditionalSplitActivity struct {

	// The paths for the activity, including the conditions for entering each path
	// and the activity to perform for each path.
	Branches []MultiConditionalBranch `type:"list"`

	// The unique identifier for the activity to perform for participants who don't
	// meet any of the conditions specified for other paths in the activity.
	DefaultActivity *string `type:"string"`

	// The amount of time to wait or the date and time when Amazon Pinpoint determines
	// whether the conditions are met.
	EvaluationWaitTime *WaitTime `type:"structure"`
	// contains filtered or unexported fields
}

Specifies the settings for a multivariate split activity in a journey. This type of activity sends participants down one of as many as five paths (including a default Else path) in a journey, based on conditions that you specify.

func (MultiConditionalSplitActivity) MarshalFields added in v0.16.0 

func (s MultiConditionalSplitActivity) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (MultiConditionalSplitActivity) String added in v0.16.0 

func (s MultiConditionalSplitActivity) String() string

String returns the string representation

func (*MultiConditionalSplitActivity) Validate added in v0.16.0 

func (s *MultiConditionalSplitActivity) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type NumberValidateRequest added in v0.5.0 

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 (NumberValidateRequest) MarshalFields added in v0.5.0 

func (s NumberValidateRequest) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (NumberValidateRequest) String added in v0.5.0 

func (s NumberValidateRequest) String() string

String returns the string representation

type NumberValidateResponse added in v0.5.0 

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 (NumberValidateResponse) MarshalFields added in v0.5.0 

func (s NumberValidateResponse) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (NumberValidateResponse) String added in v0.5.0 

func (s NumberValidateResponse) String() string

String returns the string representation

type Operator added in v0.16.0 

type Operator string
const (
	OperatorAll Operator = "ALL"
	OperatorAny Operator = "ANY"
)

Enum values for Operator

func (Operator) MarshalValue added in v0.16.0 

func (enum Operator) MarshalValue() (string, error)

func (Operator) MarshalValueBuf added in v0.16.0 

func (enum Operator) MarshalValueBuf(b []byte) ([]byte, error)

type PhoneNumberValidateInput added in v0.5.0 

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 (PhoneNumberValidateInput) MarshalFields added in v0.5.0 

func (s PhoneNumberValidateInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PhoneNumberValidateInput) String added in v0.5.0 

func (s PhoneNumberValidateInput) String() string

String returns the string representation

func (*PhoneNumberValidateInput) Validate added in v0.5.0 

func (s *PhoneNumberValidateInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PhoneNumberValidateOutput added in v0.5.0 

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 (PhoneNumberValidateOutput) MarshalFields added in v0.5.0 

func (s PhoneNumberValidateOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PhoneNumberValidateOutput) String added in v0.5.0 

func (s PhoneNumberValidateOutput) String() string

String returns the string representation

type PhoneNumberValidateRequest added in v0.5.0 

type PhoneNumberValidateRequest struct {
	*aws.Request
	Input *PhoneNumberValidateInput
	Copy  func(*PhoneNumberValidateInput) PhoneNumberValidateRequest
}

PhoneNumberValidateRequest is the request type for the PhoneNumberValidate API operation.

func (PhoneNumberValidateRequest) Send added in v0.5.0 

func (r PhoneNumberValidateRequest) Send(ctx context.Context) (*PhoneNumberValidateResponse, error)

Send marshals and sends the PhoneNumberValidate API request.

type PhoneNumberValidateResponse added in v0.9.0 

type PhoneNumberValidateResponse struct {
	*PhoneNumberValidateOutput
	// contains filtered or unexported fields
}

PhoneNumberValidateResponse is the response type for the PhoneNumberValidate API operation.

func (*PhoneNumberValidateResponse) SDKResponseMetdata added in v0.9.0 

func (r *PhoneNumberValidateResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the PhoneNumberValidate request.

type PublicEndpoint added in v0.5.0 

type PublicEndpoint struct {

	// The unique identifier for the recipient, such as a device token, email address,
	// or mobile phone number.
	Address *string `type:"string"`

	// One or more custom attributes that describe the endpoint by associating a
	// name with an array of values. 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 ChannelType `type:"string" enum:"true"`

	// 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"`

	// Specifies whether to send messages or push notifications to the endpoint.
	// Valid values are: ACTIVE, messages are sent to the endpoint; and, INACTIVE,
	// messages aren’t sent to the endpoint.
	//
	// Amazon Pinpoint automatically sets this value to ACTIVE when you create an
	// endpoint or update an existing endpoint. Amazon Pinpoint automatically sets
	// this value to INACTIVE if you update another endpoint that has the same address
	// specified by the Address property.
	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"`

	// A unique identifier that's generated each time the endpoint is updated.
	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 the properties and attributes of an endpoint that's associated with an event.

func (PublicEndpoint) MarshalFields added in v0.5.0 

func (s PublicEndpoint) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PublicEndpoint) String added in v0.5.0 

func (s PublicEndpoint) String() string

String returns the string representation

type PushMessageActivity added in v0.24.0 

type PushMessageActivity struct {

	// Specifies the time to live (TTL) value for push notifications that are sent
	// to participants in a journey.
	MessageConfig *JourneyPushMessage `type:"structure"`

	// The unique identifier for the next activity to perform, after the message
	// is sent.
	NextActivity *string `type:"string"`

	// The name of the push notification template to use for the message. If specified,
	// this value must match the name of an existing message template.
	TemplateName *string `type:"string"`

	// The unique identifier for the version of the push notification template to
	// use for the message. If specified, this value must match the identifier for
	// an existing template version. To retrieve a list of versions and version
	// identifiers for a template, use the Template Versions resource.
	//
	// If you don't specify a value for this property, Amazon Pinpoint uses the
	// active version of the template. The active version is typically the version
	// of a template that's been most recently reviewed and approved for use, depending
	// on your workflow. It isn't necessarily the latest version of a template.
	TemplateVersion *string `type:"string"`
	// contains filtered or unexported fields
}

Specifies the settings for a push notification activity in a journey. This type of activity sends a push notification to participants.

func (PushMessageActivity) MarshalFields added in v0.24.0 

func (s PushMessageActivity) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PushMessageActivity) String added in v0.24.0 

func (s PushMessageActivity) String() string

String returns the string representation

type PushNotificationTemplateRequest added in v0.14.0 

type PushNotificationTemplateRequest struct {

	// The message template to use for the ADM (Amazon Device Messaging) channel.
	// This message template overrides the default template for push notification
	// channels (DefaultPushNotificationTemplate).
	ADM *AndroidPushNotificationTemplate `type:"structure"`

	// The message template to use for the APNs (Apple Push Notification service)
	// channel. This message template overrides the default template for push notification
	// channels (DefaultPushNotificationTemplate).
	APNS *APNSPushNotificationTemplate `type:"structure"`

	// The message template to use for the Baidu (Baidu Cloud Push) channel. This
	// message template overrides the default template for push notification channels
	// (DefaultPushNotificationTemplate).
	Baidu *AndroidPushNotificationTemplate `type:"structure"`

	// The default message template to use for push notification channels.
	Default *DefaultPushNotificationTemplate `type:"structure"`

	// A JSON object that specifies the default values to use for message variables
	// in the message template. This object is a set of key-value pairs. Each key
	// defines a message variable in the template. The corresponding value defines
	// the default value for that variable. When you create a message that's based
	// on the template, you can override these defaults with message-specific and
	// address-specific variables and values.
	DefaultSubstitutions *string `type:"string"`

	// The message template to use for the GCM channel, which is used to send notifications
	// through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging
	// (GCM), service. This message template overrides the default template for
	// push notification channels (DefaultPushNotificationTemplate).
	GCM *AndroidPushNotificationTemplate `type:"structure"`

	// The unique identifier for the recommender model to use for the message template.
	// Amazon Pinpoint uses this value to determine how to retrieve and process
	// data from a recommender model when it sends messages that use the template,
	// if the template contains message variables for recommendation data.
	RecommenderId *string `type:"string"`

	// A string-to-string map of key-value pairs that defines the tags to associate
	// with the message template. Each tag consists of a required tag key and an
	// associated tag value.
	Tags map[string]string `locationName:"tags" type:"map"`

	// A custom description of the message template.
	TemplateDescription *string `type:"string"`
	// contains filtered or unexported fields
}

Specifies the content and settings for a message template that can be used in messages that are sent through a push notification channel.

func (PushNotificationTemplateRequest) MarshalFields added in v0.14.0 

func (s PushNotificationTemplateRequest) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PushNotificationTemplateRequest) String added in v0.14.0 

func (s PushNotificationTemplateRequest) String() string

String returns the string representation

type PushNotificationTemplateResponse added in v0.14.0 

type PushNotificationTemplateResponse struct {

	// The message template that's used for the ADM (Amazon Device Messaging) channel.
	// This message template overrides the default template for push notification
	// channels (DefaultPushNotificationTemplate).
	ADM *AndroidPushNotificationTemplate `type:"structure"`

	// The message template that's used for the APNs (Apple Push Notification service)
	// channel. This message template overrides the default template for push notification
	// channels (DefaultPushNotificationTemplate).
	APNS *APNSPushNotificationTemplate `type:"structure"`

	// The Amazon Resource Name (ARN) of the message template.
	Arn *string `type:"string"`

	// The message template that's used for the Baidu (Baidu Cloud Push) channel.
	// This message template overrides the default template for push notification
	// channels (DefaultPushNotificationTemplate).
	Baidu *AndroidPushNotificationTemplate `type:"structure"`

	// The date, in ISO 8601 format, when the message template was created.
	//
	// CreationDate is a required field
	CreationDate *string `type:"string" required:"true"`

	// The default message template that's used for push notification channels.
	Default *DefaultPushNotificationTemplate `type:"structure"`

	// The JSON object that specifies the default values that are used for message
	// variables in the message template. This object is a set of key-value pairs.
	// Each key defines a message variable in the template. The corresponding value
	// defines the default value for that variable.
	DefaultSubstitutions *string `type:"string"`

	// The message template that's used for the GCM channel, which is used to send
	// notifications through the Firebase Cloud Messaging (FCM), formerly Google
	// Cloud Messaging (GCM), service. This message template overrides the default
	// template for push notification channels (DefaultPushNotificationTemplate).
	GCM *AndroidPushNotificationTemplate `type:"structure"`

	// The date, in ISO 8601 format, when the message template was last modified.
	//
	// LastModifiedDate is a required field
	LastModifiedDate *string `type:"string" required:"true"`

	// The unique identifier for the recommender model that's used by the message
	// template.
	RecommenderId *string `type:"string"`

	// A string-to-string map of key-value pairs that identifies the tags that are
	// associated with the message template. 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 the message template.
	TemplateDescription *string `type:"string"`

	// The name of the message template.
	//
	// TemplateName is a required field
	TemplateName *string `type:"string" required:"true"`

	// The type of channel that the message template is designed for. For a push
	// notification template, this value is PUSH.
	//
	// TemplateType is a required field
	TemplateType TemplateType `type:"string" required:"true" enum:"true"`

	// The unique identifier, as an integer, for the active version of the message
	// template, or the version of the template that you specified by using the
	// version parameter in your request.
	Version *string `type:"string"`
	// contains filtered or unexported fields
}

Provides information about the content and settings for a message template that can be used in messages that are sent through a push notification channel.

func (PushNotificationTemplateResponse) MarshalFields added in v0.14.0 

func (s PushNotificationTemplateResponse) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PushNotificationTemplateResponse) String added in v0.14.0 

func (s PushNotificationTemplateResponse) String() string

String returns the string representation

type PutEventStreamInput 

type PutEventStreamInput struct {

	// ApplicationId is a required field
	ApplicationId *string `location:"uri" locationName:"application-id" type:"string" required:"true"`

	// Specifies the Amazon Resource Name (ARN) of an event stream to publish events
	// to and the AWS Identity and Access Management (IAM) role to use when publishing
	// those events.
	//
	// WriteEventStream is a required field
	WriteEventStream *WriteEventStream `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (PutEventStreamInput) MarshalFields added in v0.3.0 

func (s PutEventStreamInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PutEventStreamInput) String 

func (s PutEventStreamInput) String() string

String returns the string representation

func (*PutEventStreamInput) Validate 

func (s *PutEventStreamInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PutEventStreamOutput 

type PutEventStreamOutput 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 (PutEventStreamOutput) MarshalFields added in v0.3.0 

func (s PutEventStreamOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PutEventStreamOutput) String 

func (s PutEventStreamOutput) String() string

String returns the string representation

type PutEventStreamRequest 

type PutEventStreamRequest struct {
	*aws.Request
	Input *PutEventStreamInput
	Copy  func(*PutEventStreamInput) PutEventStreamRequest
}

PutEventStreamRequest is the request type for the PutEventStream API operation.

func (PutEventStreamRequest) Send 

func (r PutEventStreamRequest) Send(ctx context.Context) (*PutEventStreamResponse, error)

Send marshals and sends the PutEventStream API request.

type PutEventStreamResponse added in v0.9.0 

type PutEventStreamResponse struct {
	*PutEventStreamOutput
	// contains filtered or unexported fields
}

PutEventStreamResponse is the response type for the PutEventStream API operation.

func (*PutEventStreamResponse) SDKResponseMetdata added in v0.9.0 

func (r *PutEventStreamResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the PutEventStream request.

type PutEventsInput added in v0.5.0 

type PutEventsInput struct {

	// ApplicationId is a required field
	ApplicationId *string `location:"uri" locationName:"application-id" type:"string" required:"true"`

	// Specifies a batch of events to process.
	//
	// EventsRequest is a required field
	EventsRequest *EventsRequest `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (PutEventsInput) MarshalFields added in v0.5.0 

func (s PutEventsInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PutEventsInput) String added in v0.5.0 

func (s PutEventsInput) String() string

String returns the string representation

func (*PutEventsInput) Validate added in v0.5.0 

func (s *PutEventsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PutEventsOutput added in v0.5.0 

type PutEventsOutput struct {

	// Provides information about endpoints and the events that they're associated
	// with.
	//
	// EventsResponse is a required field
	EventsResponse *EventsResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (PutEventsOutput) MarshalFields added in v0.5.0 

func (s PutEventsOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PutEventsOutput) String added in v0.5.0 

func (s PutEventsOutput) String() string

String returns the string representation

type PutEventsRequest added in v0.5.0 

type PutEventsRequest struct {
	*aws.Request
	Input *PutEventsInput
	Copy  func(*PutEventsInput) PutEventsRequest
}

PutEventsRequest is the request type for the PutEvents API operation.

func (PutEventsRequest) Send added in v0.5.0 

func (r PutEventsRequest) Send(ctx context.Context) (*PutEventsResponse, error)

Send marshals and sends the PutEvents API request.

type PutEventsResponse added in v0.9.0 

type PutEventsResponse struct {
	*PutEventsOutput
	// contains filtered or unexported fields
}

PutEventsResponse is the response type for the PutEvents API operation.

func (*PutEventsResponse) SDKResponseMetdata added in v0.9.0 

func (r *PutEventsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the PutEvents request.

type QuietTime 

type QuietTime struct {

	// The specific time when quiet time ends. This value has to use 24-hour notation
	// and be in HH:MM format, where HH is the hour (with a leading zero, if applicable)
	// and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30
	// to represent 2:30 PM.
	End *string `type:"string"`

	// The specific time when quiet time begins. This value has to use 24-hour notation
	// and be in HH:MM format, where HH is the hour (with a leading zero, if applicable)
	// and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30
	// to represent 2:30 PM.
	Start *string `type:"string"`
	// contains filtered or unexported fields
}

Specifies the start and end times that define a time range when messages aren't sent to endpoints.

func (QuietTime) MarshalFields added in v0.3.0 

func (s QuietTime) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (QuietTime) String 

func (s QuietTime) String() string

String returns the string representation

type RandomSplitActivity added in v0.16.0 

type RandomSplitActivity struct {

	// The paths for the activity, including the percentage of participants to enter
	// each path and the activity to perform for each path.
	Branches []RandomSplitEntry `type:"list"`
	// contains filtered or unexported fields
}

Specifies the settings for a random split activity in a journey. This type of activity randomly sends specified percentages of participants down one of as many as five paths in a journey, based on conditions that you specify.

func (RandomSplitActivity) MarshalFields added in v0.16.0 

func (s RandomSplitActivity) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (RandomSplitActivity) String added in v0.16.0 

func (s RandomSplitActivity) String() string

String returns the string representation

type RandomSplitEntry added in v0.16.0 

type RandomSplitEntry struct {

	// The unique identifier for the next activity to perform, after completing
	// the activity for the path.
	NextActivity *string `type:"string"`

	// The percentage of participants to send down the activity path.
	//
	// To determine which participants are sent down each path, Amazon Pinpoint
	// applies a probability-based algorithm to the percentages that you specify
	// for the paths. Therefore, the actual percentage of participants who are sent
	// down a path may not be equal to the percentage that you specify.
	Percentage *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Specifies the settings for a path in a random split activity in a journey.

func (RandomSplitEntry) MarshalFields added in v0.16.0 

func (s RandomSplitEntry) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (RandomSplitEntry) String added in v0.16.0 

func (s RandomSplitEntry) String() string

String returns the string representation

type RawEmail added in v0.6.0 

type RawEmail struct {

	// Data is automatically base64 encoded/decoded by the SDK.
	Data []byte `type:"blob"`
	// contains filtered or unexported fields
}

Specifies the contents of an email message, represented as a raw MIME message.

func (RawEmail) MarshalFields added in v0.6.0 

func (s RawEmail) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (RawEmail) String added in v0.6.0 

func (s RawEmail) String() string

String returns the string representation

type RecencyDimension 

type RecencyDimension struct {

	// The duration to use when determining whether an endpoint is active or inactive.
	//
	// Duration is a required field
	Duration Duration `type:"string" required:"true" enum:"true"`

	// The type of recency dimension to use for the segment. Valid values are: ACTIVE,
	// endpoints that were active within the specified duration are included in
	// the segment; and, INACTIVE, endpoints that weren't active within the specified
	// duration are included in the segment.
	//
	// RecencyType is a required field
	RecencyType RecencyType `type:"string" required:"true" enum:"true"`
	// contains filtered or unexported fields
}

Specifies criteria for including or excluding endpoints from a segment based on how recently an endpoint was active.

func (RecencyDimension) MarshalFields added in v0.3.0 

func (s RecencyDimension) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (RecencyDimension) String 

func (s RecencyDimension) String() string

String returns the string representation

func (*RecencyDimension) Validate added in v0.10.0 

func (s *RecencyDimension) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type RecencyType 

type RecencyType string
const (
	RecencyTypeActive   RecencyType = "ACTIVE"
	RecencyTypeInactive RecencyType = "INACTIVE"
)

Enum values for RecencyType

func (RecencyType) MarshalValue added in v0.3.0 

func (enum RecencyType) MarshalValue() (string, error)

func (RecencyType) MarshalValueBuf added in v0.3.0 

func (enum RecencyType) MarshalValueBuf(b []byte) ([]byte, error)

type RecommenderConfigurationResponse added in v0.20.0 

type RecommenderConfigurationResponse struct {

	// A map that defines 1-10 custom endpoint or user attributes, depending on
	// the value for the RecommendationProviderIdType property. Each of these attributes
	// temporarily stores a recommended item that's retrieved from the recommender
	// model and sent to an AWS Lambda function for additional processing. Each
	// attribute can be used as a message variable in a message template.
	//
	// This value is null if the configuration doesn't invoke an AWS Lambda function
	// (RecommendationTransformerUri) to perform additional processing of recommendation
	// data.
	Attributes map[string]string `type:"map"`

	// The date, in extended ISO 8601 format, when the configuration was created
	// for the recommender model.
	//
	// CreationDate is a required field
	CreationDate *string `type:"string" required:"true"`

	// The custom description of the configuration for the recommender model.
	Description *string `type:"string"`

	// The unique identifier for the recommender model configuration.
	//
	// Id is a required field
	Id *string `type:"string" required:"true"`

	// The date, in extended ISO 8601 format, when the configuration for the recommender
	// model was last modified.
	//
	// LastModifiedDate is a required field
	LastModifiedDate *string `type:"string" required:"true"`

	// The custom name of the configuration for the recommender model.
	Name *string `type:"string"`

	// The type of Amazon Pinpoint ID that's associated with unique user IDs in
	// the recommender model. This value enables the model to use attribute and
	// event data that’s specific to a particular endpoint or user in an Amazon
	// Pinpoint application. Possible values are:
	//
	//    * PINPOINT_ENDPOINT_ID - Each user in the model is associated with a particular
	//    endpoint in Amazon Pinpoint. The data is correlated based on endpoint
	//    IDs in Amazon Pinpoint. This is the default value.
	//
	//    * PINPOINT_USER_ID - Each user in the model is associated with a particular
	//    user and endpoint in Amazon Pinpoint. The data is correlated based on
	//    user IDs in Amazon Pinpoint. If this value is specified, an endpoint definition
	//    in Amazon Pinpoint has to specify both a user ID (UserId) and an endpoint
	//    ID. Otherwise, messages won’t be sent to the user's endpoint.
	RecommendationProviderIdType *string `type:"string"`

	// The Amazon Resource Name (ARN) of the AWS Identity and Access Management
	// (IAM) role that authorizes Amazon Pinpoint to retrieve recommendation data
	// from the recommender model.
	//
	// RecommendationProviderRoleArn is a required field
	RecommendationProviderRoleArn *string `type:"string" required:"true"`

	// The Amazon Resource Name (ARN) of the recommender model that Amazon Pinpoint
	// retrieves the recommendation data from. This value is the ARN of an Amazon
	// Personalize campaign.
	//
	// RecommendationProviderUri is a required field
	RecommendationProviderUri *string `type:"string" required:"true"`

	// The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon
	// Pinpoint invokes to perform additional processing of recommendation data
	// that it retrieves from the recommender model.
	RecommendationTransformerUri *string `type:"string"`

	// The custom display name for the standard endpoint or user attribute (RecommendationItems)
	// that temporarily stores recommended items for each endpoint or user, depending
	// on the value for the RecommendationProviderIdType property. This name appears
	// in the Attribute finder of the template editor on the Amazon Pinpoint console.
	//
	// This value is null if the configuration doesn't invoke an AWS Lambda function
	// (RecommendationTransformerUri) to perform additional processing of recommendation
	// data.
	RecommendationsDisplayName *string `type:"string"`

	// The number of recommended items that are retrieved from the model for each
	// endpoint or user, depending on the value for the RecommendationProviderIdType
	// property. This number determines how many recommended items are available
	// for use in message variables.
	RecommendationsPerMessage *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Provides information about Amazon Pinpoint configuration settings for retrieving and processing data from a recommender model.

func (RecommenderConfigurationResponse) MarshalFields added in v0.20.0 

func (s RecommenderConfigurationResponse) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (RecommenderConfigurationResponse) String added in v0.20.0 

func (s RecommenderConfigurationResponse) String() string

String returns the string representation

type RemoveAttributesInput added in v0.5.0 

type RemoveAttributesInput struct {

	// ApplicationId is a required field
	ApplicationId *string `location:"uri" locationName:"application-id" type:"string" required:"true"`

	// AttributeType is a required field
	AttributeType *string `location:"uri" locationName:"attribute-type" type:"string" required:"true"`

	// Specifies one or more attributes to remove from all the endpoints that are
	// associated with an application.
	//
	// UpdateAttributesRequest is a required field
	UpdateAttributesRequest *UpdateAttributesRequest `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (RemoveAttributesInput) MarshalFields added in v0.5.0 

func (s RemoveAttributesInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (RemoveAttributesInput) String added in v0.5.0 

func (s RemoveAttributesInput) String() string

String returns the string representation

func (*RemoveAttributesInput) Validate added in v0.5.0 

func (s *RemoveAttributesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type RemoveAttributesOutput added in v0.5.0 

type RemoveAttributesOutput struct {

	// Provides information about the type and the names of attributes that were
	// removed from all the endpoints that are associated with an application.
	//
	// AttributesResource is a required field
	AttributesResource *AttributesResource `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (RemoveAttributesOutput) MarshalFields added in v0.5.0 

func (s RemoveAttributesOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (RemoveAttributesOutput) String added in v0.5.0 

func (s RemoveAttributesOutput) String() string

String returns the string representation

type RemoveAttributesRequest added in v0.5.0 

type RemoveAttributesRequest struct {
	*aws.Request
	Input *RemoveAttributesInput
	Copy  func(*RemoveAttributesInput) RemoveAttributesRequest
}

RemoveAttributesRequest is the request type for the RemoveAttributes API operation.

func (RemoveAttributesRequest) Send added in v0.5.0 

func (r RemoveAttributesRequest) Send(ctx context.Context) (*RemoveAttributesResponse, error)

Send marshals and sends the RemoveAttributes API request.

type RemoveAttributesResponse added in v0.9.0 

type RemoveAttributesResponse struct {
	*RemoveAttributesOutput
	// contains filtered or unexported fields
}

RemoveAttributesResponse is the response type for the RemoveAttributes API operation.

func (*RemoveAttributesResponse) SDKResponseMetdata added in v0.9.0 

func (r *RemoveAttributesResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the RemoveAttributes request.

type ResultRow added in v0.10.0 

type ResultRow struct {

	// An array of objects that defines the field and field values that were used
	// to group data in a result set that contains multiple results. This value
	// is null if the data in a result set isn’t grouped.
	//
	// GroupedBys is a required field
	GroupedBys []ResultRowValue `type:"list" required:"true"`

	// An array of objects that provides pre-aggregated values for a standard metric
	// that applies to an application, campaign, or journey.
	//
	// Values is a required field
	Values []ResultRowValue `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, campaign, or journey.

func (ResultRow) MarshalFields added in v0.10.0 

func (s ResultRow) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ResultRow) String added in v0.10.0 

func (s ResultRow) String() string

String returns the string representation

type ResultRowValue added in v0.10.0 

type ResultRowValue struct {

	// The friendly name of the metric whose value is specified by the Value property.
	//
	// Key is a required field
	Key *string `type:"string" required:"true"`

	// The data type of the value specified by the Value property.
	//
	// Type is a required field
	Type *string `type:"string" required:"true"`

	// In a Values object, the value for the metric that the query retrieved data
	// for. In a GroupedBys object, the value for the field that was used to group
	// data in a result set that contains multiple results (Values objects).
	//
	// Value is a required field
	Value *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Provides a single value and metadata about that value as part of an array of query results for a standard metric that applies to an application, campaign, or journey.

func (ResultRowValue) MarshalFields added in v0.10.0 

func (s ResultRowValue) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ResultRowValue) String added in v0.10.0 

func (s ResultRowValue) String() string

String returns the string representation

type SMSChannelRequest 

type SMSChannelRequest struct {

	// Specifies whether to enable the SMS channel for the application.
	Enabled *bool `type:"boolean"`

	// The identity that you want to display on recipients' devices when they receive
	// messages from the SMS channel.
	SenderId *string `type:"string"`

	// The registered short code that you want to use when you send messages through
	// the SMS channel.
	ShortCode *string `type:"string"`
	// contains filtered or unexported fields
}

Specifies the status and settings of the SMS channel for an application.

func (SMSChannelRequest) MarshalFields added in v0.3.0 

func (s SMSChannelRequest) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (SMSChannelRequest) String 

func (s SMSChannelRequest) String() string

String returns the string representation

type SMSChannelResponse 

type SMSChannelResponse struct {

	// The unique identifier for the application that the SMS channel applies to.
	ApplicationId *string `type:"string"`

	// The date and time, in ISO 8601 format, when the SMS channel was enabled.
	CreationDate *string `type:"string"`

	// Specifies whether the SMS 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 SMS channel. This property is retained
	// only for backward compatibility.
	Id *string `type:"string"`

	// Specifies whether the SMS channel is archived.
	IsArchived *bool `type:"boolean"`

	// The user who last modified the SMS channel.
	LastModifiedBy *string `type:"string"`

	// The date and time, in ISO 8601 format, when the SMS channel was last modified.
	LastModifiedDate *string `type:"string"`

	// The type of messaging or notification platform for the channel. For the SMS
	// channel, this value is SMS.
	//
	// Platform is a required field
	Platform *string `type:"string" required:"true"`

	// The maximum number of promotional messages that you can send through the
	// SMS channel each second.
	PromotionalMessagesPerSecond *int64 `type:"integer"`

	// The identity that displays on recipients' devices when they receive messages
	// from the SMS channel.
	SenderId *string `type:"string"`

	// The registered short code to use when you send messages through the SMS channel.
	ShortCode *string `type:"string"`

	// The maximum number of transactional messages that you can send through the
	// SMS channel each second.
	TransactionalMessagesPerSecond *int64 `type:"integer"`

	// The current version of the SMS channel.
	Version *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Provides information about the status and settings of the SMS channel for an application.

func (SMSChannelResponse) MarshalFields added in v0.3.0 

func (s SMSChannelResponse) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (SMSChannelResponse) String 

func (s SMSChannelResponse) String() string

String returns the string representation

type SMSMessage 

type SMSMessage struct {

	// The body of the SMS message.
	Body *string `type:"string"`

	// The SMS program name that you provided to AWS Support when you requested
	// your dedicated number.
	Keyword *string `type:"string"`

	// The URL of an image or video to display in the SMS message.
	MediaUrl *string `type:"string"`

	// The SMS message type. Valid values are TRANSACTIONAL (for messages that are
	// critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL
	// (for messsages that aren't critical or time-sensitive, such as marketing
	// messages).
	MessageType MessageType `type:"string" enum:"true"`

	// The number to send the SMS message from. This value should be one of the
	// dedicated long or short codes that's assigned to your AWS account. If you
	// don't specify a long or short code, Amazon Pinpoint assigns a random long
	// code to the SMS message and sends the message from that code.
	OriginationNumber *string `type:"string"`

	// The sender ID to display as the sender of the message on a recipient's device.
	// Support for sender IDs varies by country or region.
	SenderId *string `type:"string"`

	// The message variables to use in the SMS 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 for a one-time SMS message that's sent directly to an endpoint.

func (SMSMessage) MarshalFields added in v0.3.0 

func (s SMSMessage) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (SMSMessage) String 

func (s SMSMessage) String() string

String returns the string representation

type SMSMessageActivity added in v0.24.0 

type SMSMessageActivity struct {

	// Specifies the sender ID and message type for an SMS message that's sent to
	// participants in a journey.
	MessageConfig *JourneySMSMessage `type:"structure"`

	// The unique identifier for the next activity to perform, after the message
	// is sent.
	NextActivity *string `type:"string"`

	// The name of the SMS message template to use for the message. If specified,
	// this value must match the name of an existing message template.
	TemplateName *string `type:"string"`

	// The unique identifier for the version of the SMS template to use for the
	// message. If specified, this value must match the identifier for an existing
	// template version. To retrieve a list of versions and version identifiers
	// for a template, use the Template Versions resource.
	//
	// If you don't specify a value for this property, Amazon Pinpoint uses the
	// active version of the template. The active version is typically the version
	// of a template that's been most recently reviewed and approved for use, depending
	// on your workflow. It isn't necessarily the latest version of a template.
	TemplateVersion *string `type:"string"`
	// contains filtered or unexported fields
}

Specifies the settings for an SMS activity in a journey. This type of activity sends a text message to participants.

func (SMSMessageActivity) MarshalFields added in v0.24.0 

func (s SMSMessageActivity) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (SMSMessageActivity) String added in v0.24.0 

func (s SMSMessageActivity) String() string

String returns the string representation

type SMSTemplateRequest added in v0.14.0 

type SMSTemplateRequest struct {

	// The message body to use in text messages that are based on the message template.
	Body *string `type:"string"`

	// A JSON object that specifies the default values to use for message variables
	// in the message template. This object is a set of key-value pairs. Each key
	// defines a message variable in the template. The corresponding value defines
	// the default value for that variable. When you create a message that's based
	// on the template, you can override these defaults with message-specific and
	// address-specific variables and values.
	DefaultSubstitutions *string `type:"string"`

	// The unique identifier for the recommender model to use for the message template.
	// Amazon Pinpoint uses this value to determine how to retrieve and process
	// data from a recommender model when it sends messages that use the template,
	// if the template contains message variables for recommendation data.
	RecommenderId *string `type:"string"`

	// A string-to-string map of key-value pairs that defines the tags to associate
	// with the message template. Each tag consists of a required tag key and an
	// associated tag value.
	Tags map[string]string `locationName:"tags" type:"map"`

	// A custom description of the message template.
	TemplateDescription *string `type:"string"`
	// contains filtered or unexported fields
}

Specifies the content and settings for a message template that can be used in text messages that are sent through the SMS channel.

func (SMSTemplateRequest) MarshalFields added in v0.14.0 

func (s SMSTemplateRequest) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (SMSTemplateRequest) String added in v0.14.0 

func (s SMSTemplateRequest) String() string

String returns the string representation

type SMSTemplateResponse added in v0.14.0 

type SMSTemplateResponse struct {

	// The Amazon Resource Name (ARN) of the message template.
	Arn *string `type:"string"`

	// The message body that's used in text messages that are based on the message
	// template.
	Body *string `type:"string"`

	// The date, in ISO 8601 format, when the message template was created.
	//
	// CreationDate is a required field
	CreationDate *string `type:"string" required:"true"`

	// The JSON object that specifies the default values that are used for message
	// variables in the message template. This object is a set of key-value pairs.
	// Each key defines a message variable in the template. The corresponding value
	// defines the default value for that variable.
	DefaultSubstitutions *string `type:"string"`

	// The date, in ISO 8601 format, when the message template was last modified.
	//
	// LastModifiedDate is a required field
	LastModifiedDate *string `type:"string" required:"true"`

	// The unique identifier for the recommender model that's used by the message
	// template.
	RecommenderId *string `type:"string"`

	// A string-to-string map of key-value pairs that identifies the tags that are
	// associated with the message template. 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 the message template.
	TemplateDescription *string `type:"string"`

	// The name of the message template.
	//
	// TemplateName is a required field
	TemplateName *string `type:"string" required:"true"`

	// The type of channel that the message template is designed for. For an SMS
	// template, this value is SMS.
	//
	// TemplateType is a required field
	TemplateType TemplateType `type:"string" required:"true" enum:"true"`

	// The unique identifier, as an integer, for the active version of the message
	// template, or the version of the template that you specified by using the
	// version parameter in your request.
	Version *string `type:"string"`
	// contains filtered or unexported fields
}

Provides information about the content and settings for a message template that can be used in text messages that are sent through the SMS channel.

func (SMSTemplateResponse) MarshalFields added in v0.14.0 

func (s SMSTemplateResponse) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (SMSTemplateResponse) String added in v0.14.0 

func (s SMSTemplateResponse) String() string

String returns the string representation

type Schedule 

type Schedule struct {

	// The scheduled time, in ISO 8601 format, when the campaign ended or will end.
	EndTime *string `type:"string"`

	// The type of event that causes the campaign to be sent, if the value of the
	// Frequency property is EVENT.
	EventFilter *CampaignEventFilter `type:"structure"`

	// Specifies how often the campaign is sent or whether the campaign is sent
	// in response to a specific event.
	Frequency Frequency `type:"string" enum:"true"`

	// Specifies whether the start and end times for the campaign schedule use each
	// recipient's local time. To base the schedule on each recipient's local time,
	// set this value to true.
	IsLocalTime *bool `type:"boolean"`

	// The default quiet time for the campaign. Quiet time is a specific time range
	// when a campaign doesn'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 campaign.
	//
	//    * 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 campaign.
	//
	// If any of the preceding conditions isn't met, the endpoint will receive messages
	// from the campaign, even if quiet time is enabled.
	QuietTime *QuietTime `type:"structure"`

	// The scheduled time when the campaign began or will begin. Valid values are:
	// IMMEDIATE, to start the campaign immediately; or, a specific time in ISO
	// 8601 format.
	//
	// StartTime is a required field
	StartTime *string `type:"string" required:"true"`

	// The starting UTC offset for the campaign schedule, if the value of the IsLocalTime
	// property is true. Valid values are: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30,
	// UTC+04, UTC+04:30, UTC+05, UTC+05:30, UTC+05:45, UTC+06, UTC+06:30, UTC+07,
	// UTC+08, UTC+09, UTC+09:30, UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+13, UTC-02,
	// UTC-03, UTC-04, UTC-05, UTC-06, UTC-07, UTC-08, UTC-09, UTC-10, and UTC-11.
	Timezone *string `type:"string"`
	// contains filtered or unexported fields
}

Specifies the schedule settings for a campaign.

func (Schedule) MarshalFields added in v0.3.0 

func (s Schedule) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (Schedule) String 

func (s Schedule) String() string

String returns the string representation

func (*Schedule) Validate added in v0.10.0 

func (s *Schedule) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type SegmentBehaviors 

type SegmentBehaviors struct {

	// The dimension settings that are based on how recently an endpoint was active.
	Recency *RecencyDimension `type:"structure"`
	// contains filtered or unexported fields
}

Specifies dimension settings for including or excluding endpoints from a segment based on how recently an endpoint was active.

func (SegmentBehaviors) MarshalFields added in v0.3.0 

func (s SegmentBehaviors) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (SegmentBehaviors) String 

func (s SegmentBehaviors) String() string

String returns the string representation

func (*SegmentBehaviors) Validate added in v0.10.0 

func (s *SegmentBehaviors) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type SegmentCondition added in v0.16.0 

type SegmentCondition struct {

	// The unique identifier for the segment to associate with the activity.
	//
	// SegmentId is a required field
	SegmentId *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Specifies a segment to associate with an activity in a journey.

func (SegmentCondition) MarshalFields added in v0.16.0 

func (s SegmentCondition) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (SegmentCondition) String added in v0.16.0 

func (s SegmentCondition) String() string

String returns the string representation

func (*SegmentCondition) Validate added in v0.16.0 

func (s *SegmentCondition) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type SegmentDemographics 

type SegmentDemographics struct {

	// The app version criteria for the segment.
	AppVersion *SetDimension `type:"structure"`

	// The channel criteria for the segment.
	Channel *SetDimension `type:"structure"`

	// The device type criteria for the segment.
	DeviceType *SetDimension `type:"structure"`

	// The device make criteria for the segment.
	Make *SetDimension `type:"structure"`

	// The device model criteria for the segment.
	Model *SetDimension `type:"structure"`

	// The device platform criteria for the segment.
	Platform *SetDimension `type:"structure"`
	// contains filtered or unexported fields
}

Specifies demographic-based dimension settings for including or excluding endpoints from a segment. These settings derive from characteristics of endpoint devices, such as platform, make, and model.

func (SegmentDemographics) MarshalFields added in v0.3.0 

func (s SegmentDemographics) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (SegmentDemographics) String 

func (s SegmentDemographics) String() string

String returns the string representation

func (*SegmentDemographics) Validate added in v0.10.0 

func (s *SegmentDemographics) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type SegmentDimensions 

type SegmentDimensions struct {

	// One or more custom attributes to use as criteria for the segment.
	Attributes map[string]AttributeDimension `type:"map"`

	// The behavior-based criteria, such as how recently users have used your app,
	// for the segment.
	Behavior *SegmentBehaviors `type:"structure"`

	// The demographic-based criteria, such as device platform, for the segment.
	Demographic *SegmentDemographics `type:"structure"`

	// The location-based criteria, such as region or GPS coordinates, for the segment.
	Location *SegmentLocation `type:"structure"`

	// One or more custom metrics to use as criteria for the segment.
	Metrics map[string]MetricDimension `type:"map"`

	// One or more custom user attributes to use as criteria for the segment.
	UserAttributes map[string]AttributeDimension `type:"map"`
	// contains filtered or unexported fields
}

Specifies the dimension settings for a segment.

func (SegmentDimensions) MarshalFields added in v0.3.0 

func (s SegmentDimensions) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (SegmentDimensions) String 

func (s SegmentDimensions) String() string

String returns the string representation

func (*SegmentDimensions) Validate added in v0.10.0 

func (s *SegmentDimensions) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type SegmentGroup added in v0.5.0 

type SegmentGroup struct {

	// An array that defines the dimensions for the segment.
	Dimensions []SegmentDimensions `type:"list"`

	// The base segment to build the segment on. A base segment, also referred to
	// as a source segment, defines the initial population of endpoints for a segment.
	// When you add dimensions to a segment, Amazon Pinpoint filters the base segment
	// by using the dimensions that you specify.
	//
	// You can specify more than one dimensional segment or only one imported segment.
	// If you specify an imported segment, the Amazon Pinpoint console displays
	// a segment size estimate that indicates the size of the imported segment without
	// any filters applied to it.
	SourceSegments []SegmentReference `type:"list"`

	// Specifies how to handle multiple base segments for the segment. For example,
	// if you specify three base segments for the segment, whether the resulting
	// segment is based on all, any, or none of the base segments.
	SourceType SourceType `type:"string" enum:"true"`

	// Specifies how to handle multiple dimensions for the segment. For example,
	// if you specify three dimensions for the segment, whether the resulting segment
	// includes endpoints that match all, any, or none of the dimensions.
	Type Type `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

Specifies the base segments and dimensions for a segment, and the relationships between these base segments and dimensions.

func (SegmentGroup) MarshalFields added in v0.5.0 

func (s SegmentGroup) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (SegmentGroup) String added in v0.5.0 

func (s SegmentGroup) String() string

String returns the string representation

func (*SegmentGroup) Validate added in v0.10.0 

func (s *SegmentGroup) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type SegmentGroupList added in v0.5.0 

type SegmentGroupList struct {

	// An array that defines the set of segment criteria to evaluate when handling
	// segment groups for the segment.
	Groups []SegmentGroup `type:"list"`

	// Specifies how to handle multiple segment groups for the segment. For example,
	// if the segment includes three segment groups, whether the resulting segment
	// includes endpoints that match all, any, or none of the segment groups.
	Include Include `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

Specifies the settings that define the relationships between segment groups for a segment.

func (SegmentGroupList) MarshalFields added in v0.5.0 

func (s SegmentGroupList) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (SegmentGroupList) String added in v0.5.0 

func (s SegmentGroupList) String() string

String returns the string representation

func (*SegmentGroupList) Validate added in v0.10.0 

func (s *SegmentGroupList) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type SegmentImportResource 

type SegmentImportResource struct {

	// The number of channel types in the endpoint definitions that were imported
	// to create the segment.
	ChannelCounts map[string]int64 `type:"map"`

	// (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 is a required field
	ExternalId *string `type:"string" required:"true"`

	// The format of the files that were imported to create the segment. Valid values
	// are: CSV, for comma-separated values format; and, JSON, for newline-delimited
	// JSON format.
	//
	// Format is a required field
	Format Format `type:"string" required:"true" enum:"true"`

	// The Amazon Resource Name (ARN) of the AWS Identity and Access Management
	// (IAM) role that authorized 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 the
	// endpoint definitions were imported from to create the segment.
	//
	// S3Url is a required field
	S3Url *string `type:"string" required:"true"`

	// The number of endpoint definitions that were imported successfully to create
	// the segment.
	//
	// Size is a required field
	Size *int64 `type:"integer" required:"true"`
	// contains filtered or unexported fields
}

Provides information about the import job that created a segment. An import job is a job that creates a user segment by importing endpoint definitions.

func (SegmentImportResource) MarshalFields added in v0.3.0 

func (s SegmentImportResource) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (SegmentImportResource) String 

func (s SegmentImportResource) String() string

String returns the string representation

type SegmentLocation 

type SegmentLocation struct {

	// The country or region code, in ISO 3166-1 alpha-2 format, for the segment.
	Country *SetDimension `type:"structure"`

	// The GPS location and range for the segment.
	GPSPoint *GPSPointDimension `type:"structure"`
	// contains filtered or unexported fields
}

Specifies geographical dimension settings for a segment.

func (SegmentLocation) MarshalFields added in v0.3.0 

func (s SegmentLocation) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (SegmentLocation) String 

func (s SegmentLocation) String() string

String returns the string representation

func (*SegmentLocation) Validate added in v0.10.0 

func (s *SegmentLocation) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type SegmentReference added in v0.5.0 

type SegmentReference struct {

	// The unique identifier for the segment.
	//
	// Id is a required field
	Id *string `type:"string" required:"true"`

	// The version number of the segment.
	Version *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Specifies the segment identifier and version of a segment.

func (SegmentReference) MarshalFields added in v0.5.0 

func (s SegmentReference) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (SegmentReference) String added in v0.5.0 

func (s SegmentReference) String() string

String returns the string representation

func (*SegmentReference) Validate added in v0.10.0 

func (s *SegmentReference) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type SegmentResponse 

type SegmentResponse struct {

	// The unique identifier for the application that the segment is associated
	// with.
	//
	// ApplicationId is a required field
	ApplicationId *string `type:"string" required:"true"`

	// The Amazon Resource Name (ARN) of the segment.
	//
	// Arn is a required field
	Arn *string `type:"string" required:"true"`

	// The date and time when the segment was created.
	//
	// CreationDate is a required field
	CreationDate *string `type:"string" required:"true"`

	// The dimension settings for the segment.
	Dimensions *SegmentDimensions `type:"structure"`

	// The unique identifier for the segment.
	//
	// Id is a required field
	Id *string `type:"string" required:"true"`

	// The settings for the import job that's associated with the segment.
	ImportDefinition *SegmentImportResource `type:"structure"`

	// The date and time when the segment was last modified.
	LastModifiedDate *string `type:"string"`

	// The name of the segment.
	Name *string `type:"string"`

	// A list of one or more segment groups that apply to the segment. Each segment
	// group consists of zero or more base segments and the dimensions that are
	// applied to those base segments.
	SegmentGroups *SegmentGroupList `type:"structure"`

	// The segment type. Valid values are:
	//
	//    * DIMENSIONAL - A dynamic segment, which is a segment that uses selection
	//    criteria that you specify and is based on endpoint data that's reported
	//    by your app. Dynamic segments can change over time.
	//
	//    * IMPORT - A static segment, which is a segment that uses selection criteria
	//    that you specify and is based on endpoint definitions that you import
	//    from a file. Imported segments are static; they don't change over time.
	//
	// SegmentType is a required field
	SegmentType SegmentType `type:"string" required:"true" enum:"true"`

	// A string-to-string map of key-value pairs that identifies the tags that are
	// associated with the segment. Each tag consists of a required tag key and
	// an associated tag value.
	Tags map[string]string `locationName:"tags" type:"map"`

	// The version number of the segment.
	Version *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Provides information about the configuration, dimension, and other settings for a segment.

func (SegmentResponse) MarshalFields added in v0.3.0 

func (s SegmentResponse) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (SegmentResponse) String 

func (s SegmentResponse) String() string

String returns the string representation

type SegmentType 

type SegmentType string
const (
	SegmentTypeDimensional SegmentType = "DIMENSIONAL"
	SegmentTypeImport      SegmentType = "IMPORT"
)

Enum values for SegmentType

func (SegmentType) MarshalValue added in v0.3.0 

func (enum SegmentType) MarshalValue() (string, error)

func (SegmentType) MarshalValueBuf added in v0.3.0 

func (enum SegmentType) MarshalValueBuf(b []byte) ([]byte, error)

type SegmentsResponse 

type SegmentsResponse struct {

	// An array of responses, one for each segment that's associated with the application
	// (Segments resource) or each version of a segment that's associated with the
	// application (Segment Versions resource).
	//
	// Item is a required field
	Item []SegmentResponse `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 segments that are associated with an application.

func (SegmentsResponse) MarshalFields added in v0.3.0 

func (s SegmentsResponse) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (SegmentsResponse) String 

func (s SegmentsResponse) String() string

String returns the string representation

type SendMessagesInput 

type SendMessagesInput 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 message.
	//
	// MessageRequest is a required field
	MessageRequest *MessageRequest `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (SendMessagesInput) MarshalFields added in v0.3.0 

func (s SendMessagesInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (SendMessagesInput) String 

func (s SendMessagesInput) String() string

String returns the string representation

func (*SendMessagesInput) Validate 

func (s *SendMessagesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type SendMessagesOutput 

type SendMessagesOutput struct {

	// Provides information about the results of a request to send a message to
	// an endpoint address.
	//
	// MessageResponse is a required field
	MessageResponse *MessageResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (SendMessagesOutput) MarshalFields added in v0.3.0 

func (s SendMessagesOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (SendMessagesOutput) String 

func (s SendMessagesOutput) String() string

String returns the string representation

type SendMessagesRequest 

type SendMessagesRequest struct {
	*aws.Request
	Input *SendMessagesInput
	Copy  func(*SendMessagesInput) SendMessagesRequest
}

SendMessagesRequest is the request type for the SendMessages API operation.

func (SendMessagesRequest) Send 

func (r SendMessagesRequest) Send(ctx context.Context) (*SendMessagesResponse, error)

Send marshals and sends the SendMessages API request.

type SendMessagesResponse added in v0.9.0 

type SendMessagesResponse struct {
	*SendMessagesOutput
	// contains filtered or unexported fields
}

SendMessagesResponse is the response type for the SendMessages API operation.

func (*SendMessagesResponse) SDKResponseMetdata added in v0.9.0 

func (r *SendMessagesResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the SendMessages request.

type SendUsersMessageRequest 

type SendUsersMessageRequest struct {

	// A map of custom attribute-value pairs. For a push notification, Amazon Pinpoint
	// adds these attributes to the data.pinpoint object in the body of the notification
	// payload. Amazon Pinpoint also provides these attributes in the events that
	// it generates for users-messages deliveries.
	Context map[string]string `type:"map"`

	// The settings and content for the default message and any default messages
	// that you defined for specific channels.
	//
	// MessageConfiguration is a required field
	MessageConfiguration *DirectMessageConfiguration `type:"structure" required:"true"`

	// The message template to use for the message.
	TemplateConfiguration *TemplateConfiguration `type:"structure"`

	// The unique identifier for tracing the message. This identifier is visible
	// to message recipients.
	TraceId *string `type:"string"`

	// A map that associates user IDs with EndpointSendConfiguration objects. You
	// can use an EndpointSendConfiguration object to tailor the message for a user
	// by specifying settings such as content overrides and message variables.
	//
	// Users is a required field
	Users map[string]EndpointSendConfiguration `type:"map" required:"true"`
	// contains filtered or unexported fields
}

Specifies the configuration and other settings for a message to send to all the endpoints that are associated with a list of users.

func (SendUsersMessageRequest) MarshalFields added in v0.3.0 

func (s SendUsersMessageRequest) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (SendUsersMessageRequest) String 

func (s SendUsersMessageRequest) String() string

String returns the string representation

func (*SendUsersMessageRequest) Validate added in v0.10.0 

func (s *SendUsersMessageRequest) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type SendUsersMessageResponse 

type SendUsersMessageResponse 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"`

	// The unique identifier that was assigned to the message request.
	RequestId *string `type:"string"`

	// An object that indicates which endpoints the message was sent to, for each
	// user. The object lists user IDs and, for each user ID, provides the endpoint
	// IDs that the message was sent to. For each endpoint ID, it provides an EndpointMessageResult
	// object.
	Result map[string]map[string]EndpointMessageResult `type:"map"`
	// contains filtered or unexported fields
}

Provides information about which users and endpoints a message was sent to.

func (SendUsersMessageResponse) MarshalFields added in v0.3.0 

func (s SendUsersMessageResponse) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (SendUsersMessageResponse) String 

func (s SendUsersMessageResponse) String() string

String returns the string representation

type SendUsersMessagesInput 

type SendUsersMessagesInput 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 message to send to all
	// the endpoints that are associated with a list of users.
	//
	// SendUsersMessageRequest is a required field
	SendUsersMessageRequest *SendUsersMessageRequest `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (SendUsersMessagesInput) MarshalFields added in v0.3.0 

func (s SendUsersMessagesInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (SendUsersMessagesInput) String 

func (s SendUsersMessagesInput) String() string

String returns the string representation

func (*SendUsersMessagesInput) Validate 

func (s *SendUsersMessagesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type SendUsersMessagesOutput 

type SendUsersMessagesOutput struct {

	// Provides information about which users and endpoints a message was sent to.
	//
	// SendUsersMessageResponse is a required field
	SendUsersMessageResponse *SendUsersMessageResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (SendUsersMessagesOutput) MarshalFields added in v0.3.0 

func (s SendUsersMessagesOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (SendUsersMessagesOutput) String 

func (s SendUsersMessagesOutput) String() string

String returns the string representation

type SendUsersMessagesRequest 

type SendUsersMessagesRequest struct {
	*aws.Request
	Input *SendUsersMessagesInput
	Copy  func(*SendUsersMessagesInput) SendUsersMessagesRequest
}

SendUsersMessagesRequest is the request type for the SendUsersMessages API operation.

func (SendUsersMessagesRequest) Send 

func (r SendUsersMessagesRequest) Send(ctx context.Context) (*SendUsersMessagesResponse, error)

Send marshals and sends the SendUsersMessages API request.

type SendUsersMessagesResponse added in v0.9.0 

type SendUsersMessagesResponse struct {
	*SendUsersMessagesOutput
	// contains filtered or unexported fields
}

SendUsersMessagesResponse is the response type for the SendUsersMessages API operation.

func (*SendUsersMessagesResponse) SDKResponseMetdata added in v0.9.0 

func (r *SendUsersMessagesResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the SendUsersMessages request.

type Session added in v0.5.0 

type Session struct {

	// The duration of the session, in milliseconds.
	Duration *int64 `type:"integer"`

	// The unique identifier for the session.
	//
	// Id is a required field
	Id *string `type:"string" required:"true"`

	// The date and time when the session began.
	//
	// StartTimestamp is a required field
	StartTimestamp *string `type:"string" required:"true"`

	// The date and time when the session ended.
	StopTimestamp *string `type:"string"`
	// contains filtered or unexported fields
}

Provides information about a session.

func (Session) MarshalFields added in v0.5.0 

func (s Session) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (Session) String added in v0.5.0 

func (s Session) String() string

String returns the string representation

func (*Session) Validate added in v0.10.0 

func (s *Session) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type SetDimension 

type SetDimension 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.
	DimensionType DimensionType `type:"string" enum:"true"`

	// The criteria values to use for the segment dimension. Depending on the value
	// of the DimensionType property, endpoints are included or excluded from the
	// segment if their values match the criteria values.
	//
	// Values is a required field
	Values []string `type:"list" required:"true"`
	// contains filtered or unexported fields
}

Specifies the dimension type and values for a segment dimension.

func (SetDimension) MarshalFields added in v0.3.0 

func (s SetDimension) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (SetDimension) String 

func (s SetDimension) String() string

String returns the string representation

func (*SetDimension) Validate added in v0.10.0 

func (s *SetDimension) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type SimpleCondition added in v0.16.0 

type SimpleCondition struct {

	// The dimension settings for the event that's associated with the activity.
	EventCondition *EventCondition `type:"structure"`

	// The segment that's associated with the activity.
	SegmentCondition *SegmentCondition `type:"structure"`

	// The dimension settings for the segment that's associated with the activity.
	SegmentDimensions *SegmentDimensions `locationName:"segmentDimensions" type:"structure"`
	// contains filtered or unexported fields
}

Specifies a condition to evaluate for an activity in a journey.

func (SimpleCondition) MarshalFields added in v0.16.0 

func (s SimpleCondition) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (SimpleCondition) String added in v0.16.0 

func (s SimpleCondition) String() string

String returns the string representation

func (*SimpleCondition) Validate added in v0.16.0 

func (s *SimpleCondition) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type SimpleEmail added in v0.6.0 

type SimpleEmail struct {

	// The body of the email message, in HTML format. We recommend using HTML format
	// for email clients that render HTML content. You can include links, formatted
	// text, and more in an HTML message.
	HtmlPart *SimpleEmailPart `type:"structure"`

	// The subject line, or title, of the email.
	Subject *SimpleEmailPart `type:"structure"`

	// The body of the email message, in plain text format. We recommend using plain
	// text format for email clients that don't render HTML content and clients
	// that are connected to high-latency networks, such as mobile devices.
	TextPart *SimpleEmailPart `type:"structure"`
	// contains filtered or unexported fields
}

Specifies the contents of an email message, composed of a subject, a text part, and an HTML part.

func (SimpleEmail) MarshalFields added in v0.6.0 

func (s SimpleEmail) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (SimpleEmail) String added in v0.6.0 

func (s SimpleEmail) String() string

String returns the string representation

type SimpleEmailPart added in v0.6.0 

type SimpleEmailPart struct {

	// The applicable character set for the message content.
	Charset *string `type:"string"`

	// The textual data of the message content.
	Data *string `type:"string"`
	// contains filtered or unexported fields
}

Specifies the subject or body of an email message, represented as textual email data and the applicable character set.

func (SimpleEmailPart) MarshalFields added in v0.6.0 

func (s SimpleEmailPart) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (SimpleEmailPart) String added in v0.6.0 

func (s SimpleEmailPart) String() string

String returns the string representation

type SourceType added in v0.5.0 

type SourceType string
const (
	SourceTypeAll  SourceType = "ALL"
	SourceTypeAny  SourceType = "ANY"
	SourceTypeNone SourceType = "NONE"
)

Enum values for SourceType

func (SourceType) MarshalValue added in v0.5.0 

func (enum SourceType) MarshalValue() (string, error)

func (SourceType) MarshalValueBuf added in v0.5.0 

func (enum SourceType) MarshalValueBuf(b []byte) ([]byte, error)

type StartCondition added in v0.16.0 

type StartCondition struct {

	// The custom description of the condition.
	Description *string `type:"string"`

	// The segment that's associated with the first activity in the journey. This
	// segment determines which users are participants in the journey.
	SegmentStartCondition *SegmentCondition `type:"structure"`
	// contains filtered or unexported fields
}

Specifies the conditions for the first activity in a journey. This activity and its conditions determine which users are participants in a journey.

func (StartCondition) MarshalFields added in v0.16.0 

func (s StartCondition) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (StartCondition) String added in v0.16.0 

func (s StartCondition) String() string

String returns the string representation

func (*StartCondition) Validate added in v0.16.0 

func (s *StartCondition) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type State added in v0.16.0 

type State string
const (
	StateDraft     State = "DRAFT"
	StateActive    State = "ACTIVE"
	StateCompleted State = "COMPLETED"
	StateCancelled State = "CANCELLED"
	StateClosed    State = "CLOSED"
)

Enum values for State

func (State) MarshalValue added in v0.16.0 

func (enum State) MarshalValue() (string, error)

func (State) MarshalValueBuf added in v0.16.0 

func (enum State) MarshalValueBuf(b []byte) ([]byte, error)

type TagResourceInput added in v0.8.0 

type TagResourceInput struct {

	// ResourceArn is a required field
	ResourceArn *string `location:"uri" locationName:"resource-arn" type:"string" required:"true"`

	// Specifies the tags (keys and values) for an application, campaign, message
	// template, or segment.
	//
	// TagsModel is a required field
	TagsModel *TagsModel `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (TagResourceInput) MarshalFields added in v0.8.0 

func (s TagResourceInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (TagResourceInput) String added in v0.8.0 

func (s TagResourceInput) String() string

String returns the string representation

func (*TagResourceInput) Validate added in v0.8.0 

func (s *TagResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TagResourceOutput added in v0.8.0 

type TagResourceOutput struct {
	// contains filtered or unexported fields
}

func (TagResourceOutput) MarshalFields added in v0.8.0 

func (s TagResourceOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (TagResourceOutput) String added in v0.8.0 

func (s TagResourceOutput) String() string

String returns the string representation

type TagResourceRequest added in v0.8.0 

type TagResourceRequest struct {
	*aws.Request
	Input *TagResourceInput
	Copy  func(*TagResourceInput) TagResourceRequest
}

TagResourceRequest is the request type for the TagResource API operation.

func (TagResourceRequest) Send added in v0.8.0 

func (r TagResourceRequest) Send(ctx context.Context) (*TagResourceResponse, error)

Send marshals and sends the TagResource API request.

type TagResourceResponse added in v0.9.0 

type TagResourceResponse struct {
	*TagResourceOutput
	// contains filtered or unexported fields
}

TagResourceResponse is the response type for the TagResource API operation.

func (*TagResourceResponse) SDKResponseMetdata added in v0.9.0 

func (r *TagResourceResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the TagResource request.

type TagsModel added in v0.8.0 

type TagsModel struct {

	// A string-to-string map of key-value pairs that defines the tags for an application,
	// campaign, message template, or segment. Each of these resources can have
	// a maximum of 50 tags.
	//
	// Each tag consists of a required tag key and an associated tag value. The
	// maximum length of a tag key is 128 characters. The maximum length of a tag
	// value is 256 characters.
	//
	// Tags is a required field
	Tags map[string]string `locationName:"tags" type:"map" required:"true"`
	// contains filtered or unexported fields
}

Specifies the tags (keys and values) for an application, campaign, message template, or segment.

func (TagsModel) MarshalFields added in v0.8.0 

func (s TagsModel) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (TagsModel) String added in v0.8.0 

func (s TagsModel) String() string

String returns the string representation

func (*TagsModel) Validate added in v0.8.0 

func (s *TagsModel) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type Template added in v0.14.0 

type Template struct {

	// The name of the message template to use for the message. If specified, this
	// value must match the name of an existing message template.
	Name *string `type:"string"`

	// The unique identifier for the version of the message template to use for
	// the message. If specified, this value must match the identifier for an existing
	// template version. To retrieve a list of versions and version identifiers
	// for a template, use the Template Versions resource.
	//
	// If you don't specify a value for this property, Amazon Pinpoint uses the
	// active version of the template. The active version is typically the version
	// of a template that's been most recently reviewed and approved for use, depending
	// on your workflow. It isn't necessarily the latest version of a template.
	Version *string `type:"string"`
	// contains filtered or unexported fields
}

Specifies the name and version of the message template to use for the message.

func (Template) MarshalFields added in v0.14.0 

func (s Template) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (Template) String added in v0.14.0 

func (s Template) String() string

String returns the string representation

type TemplateActiveVersionRequest added in v0.19.0 

type TemplateActiveVersionRequest struct {

	// The version of the message template to use as the active version of the template.
	// Valid values are: latest, for the most recent version of the template; or,
	// the unique identifier for any existing version of the template. If you specify
	// an identifier, the value must match the identifier for an existing template
	// version. To retrieve a list of versions and version identifiers for a template,
	// use the Template Versions resource.
	Version *string `type:"string"`
	// contains filtered or unexported fields
}

Specifies which version of a message template to use as the active version of the template.

func (TemplateActiveVersionRequest) MarshalFields added in v0.19.0 

func (s TemplateActiveVersionRequest) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (TemplateActiveVersionRequest) String added in v0.19.0 

func (s TemplateActiveVersionRequest) String() string

String returns the string representation

type TemplateConfiguration added in v0.14.0 

type TemplateConfiguration struct {

	// The email template to use for the message.
	EmailTemplate *Template `type:"structure"`

	// The push notification template to use for the message.
	PushTemplate *Template `type:"structure"`

	// The SMS template to use for the message.
	SMSTemplate *Template `type:"structure"`

	// The voice template to use for the message. This object isn't supported for
	// campaigns.
	VoiceTemplate *Template `type:"structure"`
	// contains filtered or unexported fields
}

Specifies the message template to use for the message, for each type of channel.

func (TemplateConfiguration) MarshalFields added in v0.14.0 

func (s TemplateConfiguration) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (TemplateConfiguration) String added in v0.14.0 

func (s TemplateConfiguration) String() string

String returns the string representation

type TemplateResponse added in v0.14.0 

type TemplateResponse struct {

	// The Amazon Resource Name (ARN) of the message template. This value isn't
	// included in a TemplateResponse object. To retrieve the ARN of a template,
	// use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate
	// operation, depending on the type of template that you want to retrieve the
	// ARN for.
	Arn *string `type:"string"`

	// The date, in ISO 8601 format, when the message template was created.
	//
	// CreationDate is a required field
	CreationDate *string `type:"string" required:"true"`

	// The JSON object that specifies the default values that are used for message
	// variables in the message template. This object isn't included in a TemplateResponse
	// object. To retrieve this object for a template, use the GetEmailTemplate,
	// GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending
	// on the type of template that you want to retrieve the object for.
	DefaultSubstitutions *string `type:"string"`

	// The date, in ISO 8601 format, when the message template was last modified.
	//
	// LastModifiedDate is a required field
	LastModifiedDate *string `type:"string" required:"true"`

	// A map of key-value pairs that identifies the tags that are associated with
	// the message template. This object isn't included in a TemplateResponse object.
	// To retrieve this object for a template, use the GetEmailTemplate, GetPushTemplate,
	// GetSmsTemplate, or GetVoiceTemplate operation, depending on the type of template
	// that you want to retrieve the object for.
	Tags map[string]string `locationName:"tags" type:"map"`

	// The custom description of the message template. This value isn't included
	// in a TemplateResponse object. To retrieve the description of a template,
	// use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate
	// operation, depending on the type of template that you want to retrieve the
	// description for.
	TemplateDescription *string `type:"string"`

	// The name of the message template.
	//
	// TemplateName is a required field
	TemplateName *string `type:"string" required:"true"`

	// The type of channel that the message template is designed for. Possible values
	// are: EMAIL, PUSH, SMS, and VOICE.
	//
	// TemplateType is a required field
	TemplateType TemplateType `type:"string" required:"true" enum:"true"`

	// The unique identifier, as an integer, for the active version of the message
	// template.
	Version *string `type:"string"`
	// contains filtered or unexported fields
}

Provides information about a message template that's associated with your Amazon Pinpoint account.

func (TemplateResponse) MarshalFields added in v0.14.0 

func (s TemplateResponse) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (TemplateResponse) String added in v0.14.0 

func (s TemplateResponse) String() string

String returns the string representation

type TemplateType added in v0.14.0 

type TemplateType string
const (
	TemplateTypeEmail TemplateType = "EMAIL"
	TemplateTypeSms   TemplateType = "SMS"
	TemplateTypeVoice TemplateType = "VOICE"
	TemplateTypePush  TemplateType = "PUSH"
)

Enum values for TemplateType

func (TemplateType) MarshalValue added in v0.14.0 

func (enum TemplateType) MarshalValue() (string, error)

func (TemplateType) MarshalValueBuf added in v0.14.0 

func (enum TemplateType) MarshalValueBuf(b []byte) ([]byte, error)

type TemplateVersionResponse added in v0.19.0 

type TemplateVersionResponse struct {

	// The date, in ISO 8601 format, when the version of the message template was
	// created.
	//
	// CreationDate is a required field
	CreationDate *string `type:"string" required:"true"`

	// A JSON object that specifies the default values that are used for message
	// variables in the version of the message template. This object is a set of
	// key-value pairs. Each key defines a message variable in the template. The
	// corresponding value defines the default value for that variable.
	DefaultSubstitutions *string `type:"string"`

	// The date, in ISO 8601 format, when the version of the message template was
	// last modified.
	//
	// LastModifiedDate is a required field
	LastModifiedDate *string `type:"string" required:"true"`

	// The custom description of the version of the message template.
	TemplateDescription *string `type:"string"`

	// The name of the message template.
	//
	// TemplateName is a required field
	TemplateName *string `type:"string" required:"true"`

	// The type of channel that the message template is designed for. Possible values
	// are: EMAIL, PUSH, SMS, and VOICE.
	//
	// TemplateType is a required field
	TemplateType *string `type:"string" required:"true"`

	// The unique identifier for the version of the message template. This value
	// is an integer that Amazon Pinpoint automatically increments and assigns to
	// each new version of a template.
	Version *string `type:"string"`
	// contains filtered or unexported fields
}

Provides information about a specific version of a message template.

func (TemplateVersionResponse) MarshalFields added in v0.19.0 

func (s TemplateVersionResponse) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (TemplateVersionResponse) String added in v0.19.0 

func (s TemplateVersionResponse) String() string

String returns the string representation

type TemplateVersionsResponse added in v0.19.0 

type TemplateVersionsResponse struct {

	// An array of responses, one for each version of the message template.
	//
	// Item is a required field
	Item []TemplateVersionResponse `type:"list" required:"true"`

	// The message that's returned from the API for the request to retrieve information
	// about all the versions of the message template.
	Message *string `type:"string"`

	// 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"`

	// The unique identifier for the request to retrieve information about all the
	// versions of the message template.
	RequestID *string `type:"string"`
	// contains filtered or unexported fields
}

Provides information about all the versions of a specific message template.

func (TemplateVersionsResponse) MarshalFields added in v0.19.0 

func (s TemplateVersionsResponse) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (TemplateVersionsResponse) String added in v0.19.0 

func (s TemplateVersionsResponse) String() string

String returns the string representation

type TemplatesResponse added in v0.14.0 

type TemplatesResponse struct {

	// An array of responses, one for each message template that's associated with
	// your Amazon Pinpoint account and meets any filter criteria that you specified
	// in the request.
	//
	// Item is a required field
	Item []TemplateResponse `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 message templates that are associated with your Amazon Pinpoint account.

func (TemplatesResponse) MarshalFields added in v0.14.0 

func (s TemplatesResponse) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (TemplatesResponse) String added in v0.14.0 

func (s TemplatesResponse) String() string

String returns the string representation

type TreatmentResource 

type TreatmentResource struct {

	// The delivery configuration settings for sending the treatment through a custom
	// channel. This object is required if the MessageConfiguration object for the
	// treatment specifies a CustomMessage object.
	CustomDeliveryConfiguration *CustomDeliveryConfiguration `type:"structure"`

	// The unique identifier for the treatment.
	//
	// Id is a required field
	Id *string `type:"string" required:"true"`

	// The message configuration settings for the treatment.
	MessageConfiguration *MessageConfiguration `type:"structure"`

	// The schedule settings for the treatment.
	Schedule *Schedule `type:"structure"`

	// The allocated percentage of users (segment members) that the treatment is
	// sent to.
	//
	// SizePercent is a required field
	SizePercent *int64 `type:"integer" required:"true"`

	// The current status of the treatment.
	State *CampaignState `type:"structure"`

	// The message template to use for the treatment.
	TemplateConfiguration *TemplateConfiguration `type:"structure"`

	// The custom description of the treatment.
	TreatmentDescription *string `type:"string"`

	// The custom name of the treatment.
	TreatmentName *string `type:"string"`
	// contains filtered or unexported fields
}

Specifies the settings for a campaign treatment. A treatment is a variation of a campaign that's used for A/B testing of a campaign.

func (TreatmentResource) MarshalFields added in v0.3.0 

func (s TreatmentResource) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (TreatmentResource) String 

func (s TreatmentResource) String() string

String returns the string representation

type Type added in v0.5.0 

type Type string
const (
	TypeAll  Type = "ALL"
	TypeAny  Type = "ANY"
	TypeNone Type = "NONE"
)

Enum values for Type

func (Type) MarshalValue added in v0.5.0 

func (enum Type) MarshalValue() (string, error)

func (Type) MarshalValueBuf added in v0.5.0 

func (enum Type) MarshalValueBuf(b []byte) ([]byte, error)

type UntagResourceInput added in v0.8.0 

type UntagResourceInput struct {

	// ResourceArn is a required field
	ResourceArn *string `location:"uri" locationName:"resource-arn" type:"string" required:"true"`

	// TagKeys is a required field
	TagKeys []string `location:"querystring" locationName:"tagKeys" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (UntagResourceInput) MarshalFields added in v0.8.0 

func (s UntagResourceInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UntagResourceInput) String added in v0.8.0 

func (s UntagResourceInput) String() string

String returns the string representation

func (*UntagResourceInput) Validate added in v0.8.0 

func (s *UntagResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UntagResourceOutput added in v0.8.0 

type UntagResourceOutput struct {
	// contains filtered or unexported fields
}

func (UntagResourceOutput) MarshalFields added in v0.8.0 

func (s UntagResourceOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UntagResourceOutput) String added in v0.8.0 

func (s UntagResourceOutput) String() string

String returns the string representation

type UntagResourceRequest added in v0.8.0 

type UntagResourceRequest struct {
	*aws.Request
	Input *UntagResourceInput
	Copy  func(*UntagResourceInput) UntagResourceRequest
}

UntagResourceRequest is the request type for the UntagResource API operation.

func (UntagResourceRequest) Send added in v0.8.0 

func (r UntagResourceRequest) Send(ctx context.Context) (*UntagResourceResponse, error)

Send marshals and sends the UntagResource API request.

type UntagResourceResponse added in v0.9.0 

type UntagResourceResponse struct {
	*UntagResourceOutput
	// contains filtered or unexported fields
}

UntagResourceResponse is the response type for the UntagResource API operation.

func (*UntagResourceResponse) SDKResponseMetdata added in v0.9.0 

func (r *UntagResourceResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UntagResource request.

type UpdateAdmChannelInput 

type UpdateAdmChannelInput struct {

	// Specifies the status and settings of the ADM (Amazon Device Messaging) channel
	// for an application.
	//
	// ADMChannelRequest is a required field
	ADMChannelRequest *ADMChannelRequest `type:"structure" required:"true"`

	// ApplicationId is a required field
	ApplicationId *string `location:"uri" locationName:"application-id" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateAdmChannelInput) MarshalFields added in v0.3.0 

func (s UpdateAdmChannelInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateAdmChannelInput) String 

func (s UpdateAdmChannelInput) String() string

String returns the string representation

func (*UpdateAdmChannelInput) Validate 

func (s *UpdateAdmChannelInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateAdmChannelOutput 

type UpdateAdmChannelOutput 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 (UpdateAdmChannelOutput) MarshalFields added in v0.3.0 

func (s UpdateAdmChannelOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateAdmChannelOutput) String 

func (s UpdateAdmChannelOutput) String() string

String returns the string representation

type UpdateAdmChannelRequest 

type UpdateAdmChannelRequest struct {
	*aws.Request
	Input *UpdateAdmChannelInput
	Copy  func(*UpdateAdmChannelInput) UpdateAdmChannelRequest
}

UpdateAdmChannelRequest is the request type for the UpdateAdmChannel API operation.

func (UpdateAdmChannelRequest) Send 

func (r UpdateAdmChannelRequest) Send(ctx context.Context) (*UpdateAdmChannelResponse, error)

Send marshals and sends the UpdateAdmChannel API request.

type UpdateAdmChannelResponse added in v0.9.0 

type UpdateAdmChannelResponse struct {
	*UpdateAdmChannelOutput
	// contains filtered or unexported fields
}

UpdateAdmChannelResponse is the response type for the UpdateAdmChannel API operation.

func (*UpdateAdmChannelResponse) SDKResponseMetdata added in v0.9.0 

func (r *UpdateAdmChannelResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UpdateAdmChannel request.

type UpdateApnsChannelInput 

type UpdateApnsChannelInput struct {

	// Specifies the status and settings of the APNs (Apple Push Notification service)
	// channel for an application.
	//
	// APNSChannelRequest is a required field
	APNSChannelRequest *APNSChannelRequest `type:"structure" required:"true"`

	// ApplicationId is a required field
	ApplicationId *string `location:"uri" locationName:"application-id" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateApnsChannelInput) MarshalFields added in v0.3.0 

func (s UpdateApnsChannelInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateApnsChannelInput) String 

func (s UpdateApnsChannelInput) String() string

String returns the string representation

func (*UpdateApnsChannelInput) Validate 

func (s *UpdateApnsChannelInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateApnsChannelOutput 

type UpdateApnsChannelOutput 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 (UpdateApnsChannelOutput) MarshalFields added in v0.3.0 

func (s UpdateApnsChannelOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateApnsChannelOutput) String 

func (s UpdateApnsChannelOutput) String() string

String returns the string representation

type UpdateApnsChannelRequest 

type UpdateApnsChannelRequest struct {
	*aws.Request
	Input *UpdateApnsChannelInput
	Copy  func(*UpdateApnsChannelInput) UpdateApnsChannelRequest
}

UpdateApnsChannelRequest is the request type for the UpdateApnsChannel API operation.

func (UpdateApnsChannelRequest) Send 

func (r UpdateApnsChannelRequest) Send(ctx context.Context) (*UpdateApnsChannelResponse, error)

Send marshals and sends the UpdateApnsChannel API request.

type UpdateApnsChannelResponse added in v0.9.0 

type UpdateApnsChannelResponse struct {
	*UpdateApnsChannelOutput
	// contains filtered or unexported fields
}

UpdateApnsChannelResponse is the response type for the UpdateApnsChannel API operation.

func (*UpdateApnsChannelResponse) SDKResponseMetdata added in v0.9.0 

func (r *UpdateApnsChannelResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UpdateApnsChannel request.

type UpdateApnsSandboxChannelInput 

type UpdateApnsSandboxChannelInput struct {

	// Specifies the status and settings of the APNs (Apple Push Notification service)
	// sandbox channel for an application.
	//
	// APNSSandboxChannelRequest is a required field
	APNSSandboxChannelRequest *APNSSandboxChannelRequest `type:"structure" required:"true"`

	// ApplicationId is a required field
	ApplicationId *string `location:"uri" locationName:"application-id" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateApnsSandboxChannelInput) MarshalFields added in v0.3.0 

func (s UpdateApnsSandboxChannelInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateApnsSandboxChannelInput) String 

func (s UpdateApnsSandboxChannelInput) String() string

String returns the string representation

func (*UpdateApnsSandboxChannelInput) Validate 

func (s *UpdateApnsSandboxChannelInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateApnsSandboxChannelOutput 

type UpdateApnsSandboxChannelOutput 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 (UpdateApnsSandboxChannelOutput) MarshalFields added in v0.3.0 

func (s UpdateApnsSandboxChannelOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateApnsSandboxChannelOutput) String 

func (s UpdateApnsSandboxChannelOutput) String() string

String returns the string representation

type UpdateApnsSandboxChannelRequest 

type UpdateApnsSandboxChannelRequest struct {
	*aws.Request
	Input *UpdateApnsSandboxChannelInput
	Copy  func(*UpdateApnsSandboxChannelInput) UpdateApnsSandboxChannelRequest
}

UpdateApnsSandboxChannelRequest is the request type for the UpdateApnsSandboxChannel API operation.

func (UpdateApnsSandboxChannelRequest) Send 

func (r UpdateApnsSandboxChannelRequest) Send(ctx context.Context) (*UpdateApnsSandboxChannelResponse, error)

Send marshals and sends the UpdateApnsSandboxChannel API request.

type UpdateApnsSandboxChannelResponse added in v0.9.0 

type UpdateApnsSandboxChannelResponse struct {
	*UpdateApnsSandboxChannelOutput
	// contains filtered or unexported fields
}

UpdateApnsSandboxChannelResponse is the response type for the UpdateApnsSandboxChannel API operation.

func (*UpdateApnsSandboxChannelResponse) SDKResponseMetdata added in v0.9.0 

func (r *UpdateApnsSandboxChannelResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UpdateApnsSandboxChannel request.

type UpdateApnsVoipChannelInput added in v0.2.0 

type UpdateApnsVoipChannelInput struct {

	// Specifies the status and settings of the APNs (Apple Push Notification service)
	// VoIP channel for an application.
	//
	// APNSVoipChannelRequest is a required field
	APNSVoipChannelRequest *APNSVoipChannelRequest `type:"structure" required:"true"`

	// ApplicationId is a required field
	ApplicationId *string `location:"uri" locationName:"application-id" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateApnsVoipChannelInput) MarshalFields added in v0.3.0 

func (s UpdateApnsVoipChannelInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateApnsVoipChannelInput) String added in v0.2.0 

func (s UpdateApnsVoipChannelInput) String() string

String returns the string representation

func (*UpdateApnsVoipChannelInput) Validate added in v0.2.0 

func (s *UpdateApnsVoipChannelInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateApnsVoipChannelOutput added in v0.2.0 

type UpdateApnsVoipChannelOutput 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 (UpdateApnsVoipChannelOutput) MarshalFields added in v0.3.0 

func (s UpdateApnsVoipChannelOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateApnsVoipChannelOutput) String added in v0.2.0 

func (s UpdateApnsVoipChannelOutput) String() string

String returns the string representation

type UpdateApnsVoipChannelRequest added in v0.2.0 

type UpdateApnsVoipChannelRequest struct {
	*aws.Request
	Input *UpdateApnsVoipChannelInput
	Copy  func(*UpdateApnsVoipChannelInput) UpdateApnsVoipChannelRequest
}

UpdateApnsVoipChannelRequest is the request type for the UpdateApnsVoipChannel API operation.

func (UpdateApnsVoipChannelRequest) Send added in v0.2.0 

func (r UpdateApnsVoipChannelRequest) Send(ctx context.Context) (*UpdateApnsVoipChannelResponse, error)

Send marshals and sends the UpdateApnsVoipChannel API request.

type UpdateApnsVoipChannelResponse added in v0.9.0 

type UpdateApnsVoipChannelResponse struct {
	*UpdateApnsVoipChannelOutput
	// contains filtered or unexported fields
}

UpdateApnsVoipChannelResponse is the response type for the UpdateApnsVoipChannel API operation.

func (*UpdateApnsVoipChannelResponse) SDKResponseMetdata added in v0.9.0 

func (r *UpdateApnsVoipChannelResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UpdateApnsVoipChannel request.

type UpdateApnsVoipSandboxChannelInput added in v0.2.0 

type UpdateApnsVoipSandboxChannelInput struct {

	// Specifies the status and settings of the APNs (Apple Push Notification service)
	// VoIP sandbox channel for an application.
	//
	// APNSVoipSandboxChannelRequest is a required field
	APNSVoipSandboxChannelRequest *APNSVoipSandboxChannelRequest `type:"structure" required:"true"`

	// ApplicationId is a required field
	ApplicationId *string `location:"uri" locationName:"application-id" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateApnsVoipSandboxChannelInput) MarshalFields added in v0.3.0 

func (s UpdateApnsVoipSandboxChannelInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateApnsVoipSandboxChannelInput) String added in v0.2.0 

func (s UpdateApnsVoipSandboxChannelInput) String() string

String returns the string representation

func (*UpdateApnsVoipSandboxChannelInput) Validate added in v0.2.0 

func (s *UpdateApnsVoipSandboxChannelInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateApnsVoipSandboxChannelOutput added in v0.2.0 

type UpdateApnsVoipSandboxChannelOutput 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 (UpdateApnsVoipSandboxChannelOutput) MarshalFields added in v0.3.0 

func (s UpdateApnsVoipSandboxChannelOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateApnsVoipSandboxChannelOutput) String added in v0.2.0 

func (s UpdateApnsVoipSandboxChannelOutput) String() string

String returns the string representation

type UpdateApnsVoipSandboxChannelRequest added in v0.2.0 

type UpdateApnsVoipSandboxChannelRequest struct {
	*aws.Request
	Input *UpdateApnsVoipSandboxChannelInput
	Copy  func(*UpdateApnsVoipSandboxChannelInput) UpdateApnsVoipSandboxChannelRequest
}

UpdateApnsVoipSandboxChannelRequest is the request type for the UpdateApnsVoipSandboxChannel API operation.

func (UpdateApnsVoipSandboxChannelRequest) Send added in v0.2.0 

func (r UpdateApnsVoipSandboxChannelRequest) Send(ctx context.Context) (*UpdateApnsVoipSandboxChannelResponse, error)

Send marshals and sends the UpdateApnsVoipSandboxChannel API request.

type UpdateApnsVoipSandboxChannelResponse added in v0.9.0 

type UpdateApnsVoipSandboxChannelResponse struct {
	*UpdateApnsVoipSandboxChannelOutput
	// contains filtered or unexported fields
}

UpdateApnsVoipSandboxChannelResponse is the response type for the UpdateApnsVoipSandboxChannel API operation.

func (*UpdateApnsVoipSandboxChannelResponse) SDKResponseMetdata added in v0.9.0 

func (r *UpdateApnsVoipSandboxChannelResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UpdateApnsVoipSandboxChannel request.

type UpdateApplicationSettingsInput 

type UpdateApplicationSettingsInput struct {

	// ApplicationId is a required field
	ApplicationId *string `location:"uri" locationName:"application-id" type:"string" required:"true"`

	// Specifies the default settings for an application.
	//
	// WriteApplicationSettingsRequest is a required field
	WriteApplicationSettingsRequest *WriteApplicationSettingsRequest `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateApplicationSettingsInput) MarshalFields added in v0.3.0 

func (s UpdateApplicationSettingsInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateApplicationSettingsInput) String 

func (s UpdateApplicationSettingsInput) String() string

String returns the string representation

func (*UpdateApplicationSettingsInput) Validate 

func (s *UpdateApplicationSettingsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateApplicationSettingsOutput 

type UpdateApplicationSettingsOutput 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 (UpdateApplicationSettingsOutput) MarshalFields added in v0.3.0 

func (s UpdateApplicationSettingsOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateApplicationSettingsOutput) String 

func (s UpdateApplicationSettingsOutput) String() string

String returns the string representation

type UpdateApplicationSettingsRequest 

type UpdateApplicationSettingsRequest struct {
	*aws.Request
	Input *UpdateApplicationSettingsInput
	Copy  func(*UpdateApplicationSettingsInput) UpdateApplicationSettingsRequest
}

UpdateApplicationSettingsRequest is the request type for the UpdateApplicationSettings API operation.

func (UpdateApplicationSettingsRequest) Send 

func (r UpdateApplicationSettingsRequest) Send(ctx context.Context) (*UpdateApplicationSettingsResponse, error)

Send marshals and sends the UpdateApplicationSettings API request.

type UpdateApplicationSettingsResponse added in v0.9.0 

type UpdateApplicationSettingsResponse struct {
	*UpdateApplicationSettingsOutput
	// contains filtered or unexported fields
}

UpdateApplicationSettingsResponse is the response type for the UpdateApplicationSettings API operation.

func (*UpdateApplicationSettingsResponse) SDKResponseMetdata added in v0.9.0 

func (r *UpdateApplicationSettingsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UpdateApplicationSettings request.

type UpdateAttributesRequest added in v0.5.0 

type UpdateAttributesRequest struct {

	// An array of the attributes to remove from all the endpoints that are associated
	// with the application. The array can specify the complete, exact name of each
	// attribute to remove or it can specify a glob pattern that an attribute name
	// must match in order for the attribute to be removed.
	Blacklist []string `type:"list"`
	// contains filtered or unexported fields
}

Specifies one or more attributes to remove from all the endpoints that are associated with an application.

func (UpdateAttributesRequest) MarshalFields added in v0.5.0 

func (s UpdateAttributesRequest) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateAttributesRequest) String added in v0.5.0 

func (s UpdateAttributesRequest) String() string

String returns the string representation

type UpdateBaiduChannelInput 

type UpdateBaiduChannelInput struct {

	// ApplicationId is a required field
	ApplicationId *string `location:"uri" locationName:"application-id" type:"string" required:"true"`

	// Specifies the status and settings of the Baidu (Baidu Cloud Push) channel
	// for an application.
	//
	// BaiduChannelRequest is a required field
	BaiduChannelRequest *BaiduChannelRequest `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateBaiduChannelInput) MarshalFields added in v0.3.0 

func (s UpdateBaiduChannelInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateBaiduChannelInput) String 

func (s UpdateBaiduChannelInput) String() string

String returns the string representation

func (*UpdateBaiduChannelInput) Validate 

func (s *UpdateBaiduChannelInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateBaiduChannelOutput 

type UpdateBaiduChannelOutput 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 (UpdateBaiduChannelOutput) MarshalFields added in v0.3.0 

func (s UpdateBaiduChannelOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateBaiduChannelOutput) String 

func (s UpdateBaiduChannelOutput) String() string

String returns the string representation

type UpdateBaiduChannelRequest 

type UpdateBaiduChannelRequest struct {
	*aws.Request
	Input *UpdateBaiduChannelInput
	Copy  func(*UpdateBaiduChannelInput) UpdateBaiduChannelRequest
}

UpdateBaiduChannelRequest is the request type for the UpdateBaiduChannel API operation.

func (UpdateBaiduChannelRequest) Send 

func (r UpdateBaiduChannelRequest) Send(ctx context.Context) (*UpdateBaiduChannelResponse, error)

Send marshals and sends the UpdateBaiduChannel API request.

type UpdateBaiduChannelResponse added in v0.9.0 

type UpdateBaiduChannelResponse struct {
	*UpdateBaiduChannelOutput
	// contains filtered or unexported fields
}

UpdateBaiduChannelResponse is the response type for the UpdateBaiduChannel API operation.

func (*UpdateBaiduChannelResponse) SDKResponseMetdata added in v0.9.0 

func (r *UpdateBaiduChannelResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UpdateBaiduChannel request.

type UpdateCampaignInput 

type UpdateCampaignInput 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"`

	// 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 (UpdateCampaignInput) MarshalFields added in v0.3.0 

func (s UpdateCampaignInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateCampaignInput) String 

func (s UpdateCampaignInput) String() string

String returns the string representation

func (*UpdateCampaignInput) Validate 

func (s *UpdateCampaignInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateCampaignOutput 

type UpdateCampaignOutput 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 (UpdateCampaignOutput) MarshalFields added in v0.3.0 

func (s UpdateCampaignOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateCampaignOutput) String 

func (s UpdateCampaignOutput) String() string

String returns the string representation

type UpdateCampaignRequest 

type UpdateCampaignRequest struct {
	*aws.Request
	Input *UpdateCampaignInput
	Copy  func(*UpdateCampaignInput) UpdateCampaignRequest
}

UpdateCampaignRequest is the request type for the UpdateCampaign API operation.

func (UpdateCampaignRequest) Send 

func (r UpdateCampaignRequest) Send(ctx context.Context) (*UpdateCampaignResponse, error)

Send marshals and sends the UpdateCampaign API request.

type UpdateCampaignResponse added in v0.9.0 

type UpdateCampaignResponse struct {
	*UpdateCampaignOutput
	// contains filtered or unexported fields
}

UpdateCampaignResponse is the response type for the UpdateCampaign API operation.

func (*UpdateCampaignResponse) SDKResponseMetdata added in v0.9.0 

func (r *UpdateCampaignResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UpdateCampaign request.

type UpdateEmailChannelInput 

type UpdateEmailChannelInput struct {

	// ApplicationId is a required field
	ApplicationId *string `location:"uri" locationName:"application-id" type:"string" required:"true"`

	// Specifies the status and settings of the email channel for an application.
	//
	// EmailChannelRequest is a required field
	EmailChannelRequest *EmailChannelRequest `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateEmailChannelInput) MarshalFields added in v0.3.0 

func (s UpdateEmailChannelInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateEmailChannelInput) String 

func (s UpdateEmailChannelInput) String() string

String returns the string representation

func (*UpdateEmailChannelInput) Validate 

func (s *UpdateEmailChannelInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateEmailChannelOutput 

type UpdateEmailChannelOutput 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 (UpdateEmailChannelOutput) MarshalFields added in v0.3.0 

func (s UpdateEmailChannelOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateEmailChannelOutput) String 

func (s UpdateEmailChannelOutput) String() string

String returns the string representation

type UpdateEmailChannelRequest 

type UpdateEmailChannelRequest struct {
	*aws.Request
	Input *UpdateEmailChannelInput
	Copy  func(*UpdateEmailChannelInput) UpdateEmailChannelRequest
}

UpdateEmailChannelRequest is the request type for the UpdateEmailChannel API operation.

func (UpdateEmailChannelRequest) Send 

func (r UpdateEmailChannelRequest) Send(ctx context.Context) (*UpdateEmailChannelResponse, error)

Send marshals and sends the UpdateEmailChannel API request.

type UpdateEmailChannelResponse added in v0.9.0 

type UpdateEmailChannelResponse struct {
	*UpdateEmailChannelOutput
	// contains filtered or unexported fields
}

UpdateEmailChannelResponse is the response type for the UpdateEmailChannel API operation.

func (*UpdateEmailChannelResponse) SDKResponseMetdata added in v0.9.0 

func (r *UpdateEmailChannelResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UpdateEmailChannel request.

type UpdateEmailTemplateInput added in v0.14.0 

type UpdateEmailTemplateInput struct {
	CreateNewVersion *bool `location:"querystring" locationName:"create-new-version" type:"boolean"`

	// Specifies the content and settings for a message template that can be used
	// in messages that are sent through the email channel.
	//
	// EmailTemplateRequest is a required field
	EmailTemplateRequest *EmailTemplateRequest `type:"structure" required:"true"`

	// TemplateName is a required field
	TemplateName *string `location:"uri" locationName:"template-name" type:"string" required:"true"`

	Version *string `location:"querystring" locationName:"version" type:"string"`
	// contains filtered or unexported fields
}

func (UpdateEmailTemplateInput) MarshalFields added in v0.14.0 

func (s UpdateEmailTemplateInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateEmailTemplateInput) String added in v0.14.0 

func (s UpdateEmailTemplateInput) String() string

String returns the string representation

func (*UpdateEmailTemplateInput) Validate added in v0.14.0 

func (s *UpdateEmailTemplateInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateEmailTemplateOutput added in v0.14.0 

type UpdateEmailTemplateOutput struct {

	// Provides information about an API request or response.
	//
	// MessageBody is a required field
	MessageBody *MessageBody `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateEmailTemplateOutput) MarshalFields added in v0.14.0 

func (s UpdateEmailTemplateOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateEmailTemplateOutput) String added in v0.14.0 

func (s UpdateEmailTemplateOutput) String() string

String returns the string representation

type UpdateEmailTemplateRequest added in v0.14.0 

type UpdateEmailTemplateRequest struct {
	*aws.Request
	Input *UpdateEmailTemplateInput
	Copy  func(*UpdateEmailTemplateInput) UpdateEmailTemplateRequest
}

UpdateEmailTemplateRequest is the request type for the UpdateEmailTemplate API operation.

func (UpdateEmailTemplateRequest) Send added in v0.14.0 

func (r UpdateEmailTemplateRequest) Send(ctx context.Context) (*UpdateEmailTemplateResponse, error)

Send marshals and sends the UpdateEmailTemplate API request.

type UpdateEmailTemplateResponse added in v0.14.0 

type UpdateEmailTemplateResponse struct {
	*UpdateEmailTemplateOutput
	// contains filtered or unexported fields
}

UpdateEmailTemplateResponse is the response type for the UpdateEmailTemplate API operation.

func (*UpdateEmailTemplateResponse) SDKResponseMetdata added in v0.14.0 

func (r *UpdateEmailTemplateResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UpdateEmailTemplate request.

type UpdateEndpointInput 

type UpdateEndpointInput 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"`

	// Specifies the channel type and other settings for an endpoint.
	//
	// EndpointRequest is a required field
	EndpointRequest *EndpointRequest `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateEndpointInput) MarshalFields added in v0.3.0 

func (s UpdateEndpointInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateEndpointInput) String 

func (s UpdateEndpointInput) String() string

String returns the string representation

func (*UpdateEndpointInput) Validate 

func (s *UpdateEndpointInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateEndpointOutput 

type UpdateEndpointOutput struct {

	// Provides information about an API request or response.
	//
	// MessageBody is a required field
	MessageBody *MessageBody `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateEndpointOutput) MarshalFields added in v0.3.0 

func (s UpdateEndpointOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateEndpointOutput) String 

func (s UpdateEndpointOutput) String() string

String returns the string representation

type UpdateEndpointRequest 

type UpdateEndpointRequest struct {
	*aws.Request
	Input *UpdateEndpointInput
	Copy  func(*UpdateEndpointInput) UpdateEndpointRequest
}

UpdateEndpointRequest is the request type for the UpdateEndpoint API operation.

func (UpdateEndpointRequest) Send 

func (r UpdateEndpointRequest) Send(ctx context.Context) (*UpdateEndpointResponse, error)

Send marshals and sends the UpdateEndpoint API request.

type UpdateEndpointResponse added in v0.9.0 

type UpdateEndpointResponse struct {
	*UpdateEndpointOutput
	// contains filtered or unexported fields
}

UpdateEndpointResponse is the response type for the UpdateEndpoint API operation.

func (*UpdateEndpointResponse) SDKResponseMetdata added in v0.9.0 

func (r *UpdateEndpointResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UpdateEndpoint request.

type UpdateEndpointsBatchInput 

type UpdateEndpointsBatchInput struct {

	// ApplicationId is a required field
	ApplicationId *string `location:"uri" locationName:"application-id" type:"string" required:"true"`

	// Specifies a batch of endpoints to create or update and the settings and attributes
	// to set or change for each endpoint.
	//
	// EndpointBatchRequest is a required field
	EndpointBatchRequest *EndpointBatchRequest `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateEndpointsBatchInput) MarshalFields added in v0.3.0 

func (s UpdateEndpointsBatchInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateEndpointsBatchInput) String 

func (s UpdateEndpointsBatchInput) String() string

String returns the string representation

func (*UpdateEndpointsBatchInput) Validate 

func (s *UpdateEndpointsBatchInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateEndpointsBatchOutput 

type UpdateEndpointsBatchOutput struct {

	// Provides information about an API request or response.
	//
	// MessageBody is a required field
	MessageBody *MessageBody `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateEndpointsBatchOutput) MarshalFields added in v0.3.0 

func (s UpdateEndpointsBatchOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateEndpointsBatchOutput) String 

func (s UpdateEndpointsBatchOutput) String() string

String returns the string representation

type UpdateEndpointsBatchRequest 

type UpdateEndpointsBatchRequest struct {
	*aws.Request
	Input *UpdateEndpointsBatchInput
	Copy  func(*UpdateEndpointsBatchInput) UpdateEndpointsBatchRequest
}

UpdateEndpointsBatchRequest is the request type for the UpdateEndpointsBatch API operation.

func (UpdateEndpointsBatchRequest) Send 

func (r UpdateEndpointsBatchRequest) Send(ctx context.Context) (*UpdateEndpointsBatchResponse, error)

Send marshals and sends the UpdateEndpointsBatch API request.

type UpdateEndpointsBatchResponse added in v0.9.0 

type UpdateEndpointsBatchResponse struct {
	*UpdateEndpointsBatchOutput
	// contains filtered or unexported fields
}

UpdateEndpointsBatchResponse is the response type for the UpdateEndpointsBatch API operation.

func (*UpdateEndpointsBatchResponse) SDKResponseMetdata added in v0.9.0 

func (r *UpdateEndpointsBatchResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UpdateEndpointsBatch request.

type UpdateGcmChannelInput 

type UpdateGcmChannelInput struct {

	// ApplicationId is a required field
	ApplicationId *string `location:"uri" locationName:"application-id" type:"string" required:"true"`

	// 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.
	//
	// GCMChannelRequest is a required field
	GCMChannelRequest *GCMChannelRequest `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateGcmChannelInput) MarshalFields added in v0.3.0 

func (s UpdateGcmChannelInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateGcmChannelInput) String 

func (s UpdateGcmChannelInput) String() string

String returns the string representation

func (*UpdateGcmChannelInput) Validate 

func (s *UpdateGcmChannelInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateGcmChannelOutput 

type UpdateGcmChannelOutput 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 (UpdateGcmChannelOutput) MarshalFields added in v0.3.0 

func (s UpdateGcmChannelOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateGcmChannelOutput) String 

func (s UpdateGcmChannelOutput) String() string

String returns the string representation

type UpdateGcmChannelRequest 

type UpdateGcmChannelRequest struct {
	*aws.Request
	Input *UpdateGcmChannelInput
	Copy  func(*UpdateGcmChannelInput) UpdateGcmChannelRequest
}

UpdateGcmChannelRequest is the request type for the UpdateGcmChannel API operation.

func (UpdateGcmChannelRequest) Send 

func (r UpdateGcmChannelRequest) Send(ctx context.Context) (*UpdateGcmChannelResponse, error)

Send marshals and sends the UpdateGcmChannel API request.

type UpdateGcmChannelResponse added in v0.9.0 

type UpdateGcmChannelResponse struct {
	*UpdateGcmChannelOutput
	// contains filtered or unexported fields
}

UpdateGcmChannelResponse is the response type for the UpdateGcmChannel API operation.

func (*UpdateGcmChannelResponse) SDKResponseMetdata added in v0.9.0 

func (r *UpdateGcmChannelResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UpdateGcmChannel request.

type UpdateJourneyInput added in v0.16.0 

type UpdateJourneyInput struct {

	// ApplicationId is a required field
	ApplicationId *string `location:"uri" locationName:"application-id" type:"string" required:"true"`

	// JourneyId is a required field
	JourneyId *string `location:"uri" locationName:"journey-id" type:"string" required:"true"`

	// Specifies the configuration and other settings for a journey.
	//
	// WriteJourneyRequest is a required field
	WriteJourneyRequest *WriteJourneyRequest `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateJourneyInput) MarshalFields added in v0.16.0 

func (s UpdateJourneyInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateJourneyInput) String added in v0.16.0 

func (s UpdateJourneyInput) String() string

String returns the string representation

func (*UpdateJourneyInput) Validate added in v0.16.0 

func (s *UpdateJourneyInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateJourneyOutput added in v0.16.0 

type UpdateJourneyOutput struct {

	// Provides information about the status, configuration, and other settings
	// for a journey.
	//
	// JourneyResponse is a required field
	JourneyResponse *JourneyResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateJourneyOutput) MarshalFields added in v0.16.0 

func (s UpdateJourneyOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateJourneyOutput) String added in v0.16.0 

func (s UpdateJourneyOutput) String() string

String returns the string representation

type UpdateJourneyRequest added in v0.16.0 

type UpdateJourneyRequest struct {
	*aws.Request
	Input *UpdateJourneyInput
	Copy  func(*UpdateJourneyInput) UpdateJourneyRequest
}

UpdateJourneyRequest is the request type for the UpdateJourney API operation.

func (UpdateJourneyRequest) Send added in v0.16.0 

func (r UpdateJourneyRequest) Send(ctx context.Context) (*UpdateJourneyResponse, error)

Send marshals and sends the UpdateJourney API request.

type UpdateJourneyResponse added in v0.16.0 

type UpdateJourneyResponse struct {
	*UpdateJourneyOutput
	// contains filtered or unexported fields
}

UpdateJourneyResponse is the response type for the UpdateJourney API operation.

func (*UpdateJourneyResponse) SDKResponseMetdata added in v0.16.0 

func (r *UpdateJourneyResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UpdateJourney request.

type UpdateJourneyStateInput added in v0.16.0 

type UpdateJourneyStateInput struct {

	// ApplicationId is a required field
	ApplicationId *string `location:"uri" locationName:"application-id" type:"string" required:"true"`

	// JourneyId is a required field
	JourneyId *string `location:"uri" locationName:"journey-id" type:"string" required:"true"`

	// Changes the status of a journey.
	//
	// JourneyStateRequest is a required field
	JourneyStateRequest *JourneyStateRequest `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateJourneyStateInput) MarshalFields added in v0.16.0 

func (s UpdateJourneyStateInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateJourneyStateInput) String added in v0.16.0 

func (s UpdateJourneyStateInput) String() string

String returns the string representation

func (*UpdateJourneyStateInput) Validate added in v0.16.0 

func (s *UpdateJourneyStateInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateJourneyStateOutput added in v0.16.0 

type UpdateJourneyStateOutput struct {

	// Provides information about the status, configuration, and other settings
	// for a journey.
	//
	// JourneyResponse is a required field
	JourneyResponse *JourneyResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateJourneyStateOutput) MarshalFields added in v0.16.0 

func (s UpdateJourneyStateOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateJourneyStateOutput) String added in v0.16.0 

func (s UpdateJourneyStateOutput) String() string

String returns the string representation

type UpdateJourneyStateRequest added in v0.16.0 

type UpdateJourneyStateRequest struct {
	*aws.Request
	Input *UpdateJourneyStateInput
	Copy  func(*UpdateJourneyStateInput) UpdateJourneyStateRequest
}

UpdateJourneyStateRequest is the request type for the UpdateJourneyState API operation.

func (UpdateJourneyStateRequest) Send added in v0.16.0 

func (r UpdateJourneyStateRequest) Send(ctx context.Context) (*UpdateJourneyStateResponse, error)

Send marshals and sends the UpdateJourneyState API request.

type UpdateJourneyStateResponse added in v0.16.0 

type UpdateJourneyStateResponse struct {
	*UpdateJourneyStateOutput
	// contains filtered or unexported fields
}

UpdateJourneyStateResponse is the response type for the UpdateJourneyState API operation.

func (*UpdateJourneyStateResponse) SDKResponseMetdata added in v0.16.0 

func (r *UpdateJourneyStateResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UpdateJourneyState request.

type UpdatePushTemplateInput added in v0.14.0 

type UpdatePushTemplateInput struct {
	CreateNewVersion *bool `location:"querystring" locationName:"create-new-version" type:"boolean"`

	// Specifies the content and settings for a message template that can be used
	// in messages that are sent through a push notification channel.
	//
	// PushNotificationTemplateRequest is a required field
	PushNotificationTemplateRequest *PushNotificationTemplateRequest `type:"structure" required:"true"`

	// TemplateName is a required field
	TemplateName *string `location:"uri" locationName:"template-name" type:"string" required:"true"`

	Version *string `location:"querystring" locationName:"version" type:"string"`
	// contains filtered or unexported fields
}

func (UpdatePushTemplateInput) MarshalFields added in v0.14.0 

func (s UpdatePushTemplateInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdatePushTemplateInput) String added in v0.14.0 

func (s UpdatePushTemplateInput) String() string

String returns the string representation

func (*UpdatePushTemplateInput) Validate added in v0.14.0 

func (s *UpdatePushTemplateInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdatePushTemplateOutput added in v0.14.0 

type UpdatePushTemplateOutput struct {

	// Provides information about an API request or response.
	//
	// MessageBody is a required field
	MessageBody *MessageBody `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (UpdatePushTemplateOutput) MarshalFields added in v0.14.0 

func (s UpdatePushTemplateOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdatePushTemplateOutput) String added in v0.14.0 

func (s UpdatePushTemplateOutput) String() string

String returns the string representation

type UpdatePushTemplateRequest added in v0.14.0 

type UpdatePushTemplateRequest struct {
	*aws.Request
	Input *UpdatePushTemplateInput
	Copy  func(*UpdatePushTemplateInput) UpdatePushTemplateRequest
}

UpdatePushTemplateRequest is the request type for the UpdatePushTemplate API operation.

func (UpdatePushTemplateRequest) Send added in v0.14.0 

func (r UpdatePushTemplateRequest) Send(ctx context.Context) (*UpdatePushTemplateResponse, error)

Send marshals and sends the UpdatePushTemplate API request.

type UpdatePushTemplateResponse added in v0.14.0 

type UpdatePushTemplateResponse struct {
	*UpdatePushTemplateOutput
	// contains filtered or unexported fields
}

UpdatePushTemplateResponse is the response type for the UpdatePushTemplate API operation.

func (*UpdatePushTemplateResponse) SDKResponseMetdata added in v0.14.0 

func (r *UpdatePushTemplateResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UpdatePushTemplate request.

type UpdateRecommenderConfiguration added in v0.20.0 

type UpdateRecommenderConfiguration struct {

	// A map of key-value pairs that defines 1-10 custom endpoint or user attributes,
	// depending on the value for the RecommendationProviderIdType property. Each
	// of these attributes temporarily stores a recommended item that's retrieved
	// from the recommender model and sent to an AWS Lambda function for additional
	// processing. Each attribute can be used as a message variable in a message
	// template.
	//
	// In the map, the key is the name of a custom attribute and the value is a
	// custom display name for that attribute. The display name appears in the Attribute
	// finder of the template editor on the Amazon Pinpoint console. The following
	// restrictions apply to these names:
	//
	//    * An attribute name must start with a letter or number and it can contain
	//    up to 50 characters. The characters can be letters, numbers, underscores
	//    (_), or hyphens (-). Attribute names are case sensitive and must be unique.
	//
	//    * An attribute display name must start with a letter or number and it
	//    can contain up to 25 characters. The characters can be letters, numbers,
	//    spaces, underscores (_), or hyphens (-).
	//
	// This object is required if the configuration invokes an AWS Lambda function
	// (RecommendationTransformerUri) to process recommendation data. Otherwise,
	// don't include this object in your request.
	Attributes map[string]string `type:"map"`

	// A custom description of the configuration for the recommender model. The
	// description can contain up to 128 characters. The characters can be letters,
	// numbers, spaces, or the following symbols: _ ; () , ‐.
	Description *string `type:"string"`

	// A custom name of the configuration for the recommender model. The name must
	// start with a letter or number and it can contain up to 128 characters. The
	// characters can be letters, numbers, spaces, underscores (_), or hyphens (-).
	Name *string `type:"string"`

	// The type of Amazon Pinpoint ID to associate with unique user IDs in the recommender
	// model. This value enables the model to use attribute and event data that’s
	// specific to a particular endpoint or user in an Amazon Pinpoint application.
	// Valid values are:
	//
	//    * PINPOINT_ENDPOINT_ID - Associate each user in the model with a particular
	//    endpoint in Amazon Pinpoint. The data is correlated based on endpoint
	//    IDs in Amazon Pinpoint. This is the default value.
	//
	//    * PINPOINT_USER_ID - Associate each user in the model with a particular
	//    user and endpoint in Amazon Pinpoint. The data is correlated based on
	//    user IDs in Amazon Pinpoint. If you specify this value, an endpoint definition
	//    in Amazon Pinpoint has to specify both a user ID (UserId) and an endpoint
	//    ID. Otherwise, messages won’t be sent to the user's endpoint.
	RecommendationProviderIdType *string `type:"string"`

	// The Amazon Resource Name (ARN) of the AWS Identity and Access Management
	// (IAM) role that authorizes Amazon Pinpoint to retrieve recommendation data
	// from the recommender model.
	//
	// RecommendationProviderRoleArn is a required field
	RecommendationProviderRoleArn *string `type:"string" required:"true"`

	// The Amazon Resource Name (ARN) of the recommender model to retrieve recommendation
	// data from. This value must match the ARN of an Amazon Personalize campaign.
	//
	// RecommendationProviderUri is a required field
	RecommendationProviderUri *string `type:"string" required:"true"`

	// The name or Amazon Resource Name (ARN) of the AWS Lambda function to invoke
	// for additional processing of recommendation data that's retrieved from the
	// recommender model.
	RecommendationTransformerUri *string `type:"string"`

	// A custom display name for the standard endpoint or user attribute (RecommendationItems)
	// that temporarily stores recommended items for each endpoint or user, depending
	// on the value for the RecommendationProviderIdType property. This value is
	// required if the configuration doesn't invoke an AWS Lambda function (RecommendationTransformerUri)
	// to perform additional processing of recommendation data.
	//
	// This name appears in the Attribute finder of the template editor on the Amazon
	// Pinpoint console. The name can contain up to 25 characters. The characters
	// can be letters, numbers, spaces, underscores (_), or hyphens (-). These restrictions
	// don't apply to attribute values.
	RecommendationsDisplayName *string `type:"string"`

	// The number of recommended items to retrieve from the model for each endpoint
	// or user, depending on the value for the RecommendationProviderIdType property.
	// This number determines how many recommended items are available for use in
	// message variables. The minimum value is 1. The maximum value is 5. The default
	// value is 5.
	//
	// To use multiple recommended items and custom attributes with message variables,
	// you have to use an AWS Lambda function (RecommendationTransformerUri) to
	// perform additional processing of recommendation data.
	RecommendationsPerMessage *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Specifies Amazon Pinpoint configuration settings for retrieving and processing recommendation data from a recommender model.

func (UpdateRecommenderConfiguration) MarshalFields added in v0.20.0 

func (s UpdateRecommenderConfiguration) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateRecommenderConfiguration) String added in v0.20.0 

func (s UpdateRecommenderConfiguration) String() string

String returns the string representation

func (*UpdateRecommenderConfiguration) Validate added in v0.20.0 

func (s *UpdateRecommenderConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateRecommenderConfigurationInput added in v0.20.0 

type UpdateRecommenderConfigurationInput struct {

	// RecommenderId is a required field
	RecommenderId *string `location:"uri" locationName:"recommender-id" type:"string" required:"true"`

	// Specifies Amazon Pinpoint configuration settings for retrieving and processing
	// recommendation data from a recommender model.
	//
	// UpdateRecommenderConfiguration is a required field
	UpdateRecommenderConfiguration *UpdateRecommenderConfiguration `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateRecommenderConfigurationInput) MarshalFields added in v0.20.0 

func (s UpdateRecommenderConfigurationInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateRecommenderConfigurationInput) String added in v0.20.0 

func (s UpdateRecommenderConfigurationInput) String() string

String returns the string representation

func (*UpdateRecommenderConfigurationInput) Validate added in v0.20.0 

func (s *UpdateRecommenderConfigurationInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateRecommenderConfigurationOutput added in v0.20.0 

type UpdateRecommenderConfigurationOutput struct {

	// Provides information about Amazon Pinpoint configuration settings for retrieving
	// and processing data from a recommender model.
	//
	// RecommenderConfigurationResponse is a required field
	RecommenderConfigurationResponse *RecommenderConfigurationResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateRecommenderConfigurationOutput) MarshalFields added in v0.20.0 

func (s UpdateRecommenderConfigurationOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateRecommenderConfigurationOutput) String added in v0.20.0 

func (s UpdateRecommenderConfigurationOutput) String() string

String returns the string representation

type UpdateRecommenderConfigurationRequest added in v0.20.0 

type UpdateRecommenderConfigurationRequest struct {
	*aws.Request
	Input *UpdateRecommenderConfigurationInput
	Copy  func(*UpdateRecommenderConfigurationInput) UpdateRecommenderConfigurationRequest
}

UpdateRecommenderConfigurationRequest is the request type for the UpdateRecommenderConfiguration API operation.

func (UpdateRecommenderConfigurationRequest) Send added in v0.20.0 

func (r UpdateRecommenderConfigurationRequest) Send(ctx context.Context) (*UpdateRecommenderConfigurationResponse, error)

Send marshals and sends the UpdateRecommenderConfiguration API request.

type UpdateRecommenderConfigurationResponse added in v0.20.0 

type UpdateRecommenderConfigurationResponse struct {
	*UpdateRecommenderConfigurationOutput
	// contains filtered or unexported fields
}

UpdateRecommenderConfigurationResponse is the response type for the UpdateRecommenderConfiguration API operation.

func (*UpdateRecommenderConfigurationResponse) SDKResponseMetdata added in v0.20.0 

func (r *UpdateRecommenderConfigurationResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UpdateRecommenderConfiguration request.

type UpdateSegmentInput 

type UpdateSegmentInput 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"`

	// 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 (UpdateSegmentInput) MarshalFields added in v0.3.0 

func (s UpdateSegmentInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateSegmentInput) String 

func (s UpdateSegmentInput) String() string

String returns the string representation

func (*UpdateSegmentInput) Validate 

func (s *UpdateSegmentInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateSegmentOutput 

type UpdateSegmentOutput 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 (UpdateSegmentOutput) MarshalFields added in v0.3.0 

func (s UpdateSegmentOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateSegmentOutput) String 

func (s UpdateSegmentOutput) String() string

String returns the string representation

type UpdateSegmentRequest 

type UpdateSegmentRequest struct {
	*aws.Request
	Input *UpdateSegmentInput
	Copy  func(*UpdateSegmentInput) UpdateSegmentRequest
}

UpdateSegmentRequest is the request type for the UpdateSegment API operation.

func (UpdateSegmentRequest) Send 

func (r UpdateSegmentRequest) Send(ctx context.Context) (*UpdateSegmentResponse, error)

Send marshals and sends the UpdateSegment API request.

type UpdateSegmentResponse added in v0.9.0 

type UpdateSegmentResponse struct {
	*UpdateSegmentOutput
	// contains filtered or unexported fields
}

UpdateSegmentResponse is the response type for the UpdateSegment API operation.

func (*UpdateSegmentResponse) SDKResponseMetdata added in v0.9.0 

func (r *UpdateSegmentResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UpdateSegment request.

type UpdateSmsChannelInput 

type UpdateSmsChannelInput struct {

	// ApplicationId is a required field
	ApplicationId *string `location:"uri" locationName:"application-id" type:"string" required:"true"`

	// Specifies the status and settings of the SMS channel for an application.
	//
	// SMSChannelRequest is a required field
	SMSChannelRequest *SMSChannelRequest `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateSmsChannelInput) MarshalFields added in v0.3.0 

func (s UpdateSmsChannelInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateSmsChannelInput) String 

func (s UpdateSmsChannelInput) String() string

String returns the string representation

func (*UpdateSmsChannelInput) Validate 

func (s *UpdateSmsChannelInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateSmsChannelOutput 

type UpdateSmsChannelOutput 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 (UpdateSmsChannelOutput) MarshalFields added in v0.3.0 

func (s UpdateSmsChannelOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateSmsChannelOutput) String 

func (s UpdateSmsChannelOutput) String() string

String returns the string representation

type UpdateSmsChannelRequest 

type UpdateSmsChannelRequest struct {
	*aws.Request
	Input *UpdateSmsChannelInput
	Copy  func(*UpdateSmsChannelInput) UpdateSmsChannelRequest
}

UpdateSmsChannelRequest is the request type for the UpdateSmsChannel API operation.

func (UpdateSmsChannelRequest) Send 

func (r UpdateSmsChannelRequest) Send(ctx context.Context) (*UpdateSmsChannelResponse, error)

Send marshals and sends the UpdateSmsChannel API request.

type UpdateSmsChannelResponse added in v0.9.0 

type UpdateSmsChannelResponse struct {
	*UpdateSmsChannelOutput
	// contains filtered or unexported fields
}

UpdateSmsChannelResponse is the response type for the UpdateSmsChannel API operation.

func (*UpdateSmsChannelResponse) SDKResponseMetdata added in v0.9.0 

func (r *UpdateSmsChannelResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UpdateSmsChannel request.

type UpdateSmsTemplateInput added in v0.14.0 

type UpdateSmsTemplateInput struct {
	CreateNewVersion *bool `location:"querystring" locationName:"create-new-version" type:"boolean"`

	// Specifies the content and settings for a message template that can be used
	// in text messages that are sent through the SMS channel.
	//
	// SMSTemplateRequest is a required field
	SMSTemplateRequest *SMSTemplateRequest `type:"structure" required:"true"`

	// TemplateName is a required field
	TemplateName *string `location:"uri" locationName:"template-name" type:"string" required:"true"`

	Version *string `location:"querystring" locationName:"version" type:"string"`
	// contains filtered or unexported fields
}

func (UpdateSmsTemplateInput) MarshalFields added in v0.14.0 

func (s UpdateSmsTemplateInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateSmsTemplateInput) String added in v0.14.0 

func (s UpdateSmsTemplateInput) String() string

String returns the string representation

func (*UpdateSmsTemplateInput) Validate added in v0.14.0 

func (s *UpdateSmsTemplateInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateSmsTemplateOutput added in v0.14.0 

type UpdateSmsTemplateOutput struct {

	// Provides information about an API request or response.
	//
	// MessageBody is a required field
	MessageBody *MessageBody `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateSmsTemplateOutput) MarshalFields added in v0.14.0 

func (s UpdateSmsTemplateOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateSmsTemplateOutput) String added in v0.14.0 

func (s UpdateSmsTemplateOutput) String() string

String returns the string representation

type UpdateSmsTemplateRequest added in v0.14.0 

type UpdateSmsTemplateRequest struct {
	*aws.Request
	Input *UpdateSmsTemplateInput
	Copy  func(*UpdateSmsTemplateInput) UpdateSmsTemplateRequest
}

UpdateSmsTemplateRequest is the request type for the UpdateSmsTemplate API operation.

func (UpdateSmsTemplateRequest) Send added in v0.14.0 

func (r UpdateSmsTemplateRequest) Send(ctx context.Context) (*UpdateSmsTemplateResponse, error)

Send marshals and sends the UpdateSmsTemplate API request.

type UpdateSmsTemplateResponse added in v0.14.0 

type UpdateSmsTemplateResponse struct {
	*UpdateSmsTemplateOutput
	// contains filtered or unexported fields
}

UpdateSmsTemplateResponse is the response type for the UpdateSmsTemplate API operation.

func (*UpdateSmsTemplateResponse) SDKResponseMetdata added in v0.14.0 

func (r *UpdateSmsTemplateResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UpdateSmsTemplate request.

type UpdateTemplateActiveVersionInput added in v0.19.0 

type UpdateTemplateActiveVersionInput struct {

	// Specifies which version of a message template to use as the active version
	// of the template.
	//
	// TemplateActiveVersionRequest is a required field
	TemplateActiveVersionRequest *TemplateActiveVersionRequest `type:"structure" required:"true"`

	// TemplateName is a required field
	TemplateName *string `location:"uri" locationName:"template-name" type:"string" required:"true"`

	// TemplateType is a required field
	TemplateType *string `location:"uri" locationName:"template-type" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateTemplateActiveVersionInput) MarshalFields added in v0.19.0 

func (s UpdateTemplateActiveVersionInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateTemplateActiveVersionInput) String added in v0.19.0 

func (s UpdateTemplateActiveVersionInput) String() string

String returns the string representation

func (*UpdateTemplateActiveVersionInput) Validate added in v0.19.0 

func (s *UpdateTemplateActiveVersionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateTemplateActiveVersionOutput added in v0.19.0 

type UpdateTemplateActiveVersionOutput struct {

	// Provides information about an API request or response.
	//
	// MessageBody is a required field
	MessageBody *MessageBody `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateTemplateActiveVersionOutput) MarshalFields added in v0.19.0 

func (s UpdateTemplateActiveVersionOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateTemplateActiveVersionOutput) String added in v0.19.0 

func (s UpdateTemplateActiveVersionOutput) String() string

String returns the string representation

type UpdateTemplateActiveVersionRequest added in v0.19.0 

type UpdateTemplateActiveVersionRequest struct {
	*aws.Request
	Input *UpdateTemplateActiveVersionInput
	Copy  func(*UpdateTemplateActiveVersionInput) UpdateTemplateActiveVersionRequest
}

UpdateTemplateActiveVersionRequest is the request type for the UpdateTemplateActiveVersion API operation.

func (UpdateTemplateActiveVersionRequest) Send added in v0.19.0 

func (r UpdateTemplateActiveVersionRequest) Send(ctx context.Context) (*UpdateTemplateActiveVersionResponse, error)

Send marshals and sends the UpdateTemplateActiveVersion API request.

type UpdateTemplateActiveVersionResponse added in v0.19.0 

type UpdateTemplateActiveVersionResponse struct {
	*UpdateTemplateActiveVersionOutput
	// contains filtered or unexported fields
}

UpdateTemplateActiveVersionResponse is the response type for the UpdateTemplateActiveVersion API operation.

func (*UpdateTemplateActiveVersionResponse) SDKResponseMetdata added in v0.19.0 

func (r *UpdateTemplateActiveVersionResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UpdateTemplateActiveVersion request.

type UpdateVoiceChannelInput added in v0.6.0 

type UpdateVoiceChannelInput struct {

	// ApplicationId is a required field
	ApplicationId *string `location:"uri" locationName:"application-id" type:"string" required:"true"`

	// Specifies the status and settings of the voice channel for an application.
	//
	// VoiceChannelRequest is a required field
	VoiceChannelRequest *VoiceChannelRequest `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateVoiceChannelInput) MarshalFields added in v0.6.0 

func (s UpdateVoiceChannelInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateVoiceChannelInput) String added in v0.6.0 

func (s UpdateVoiceChannelInput) String() string

String returns the string representation

func (*UpdateVoiceChannelInput) Validate added in v0.6.0 

func (s *UpdateVoiceChannelInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateVoiceChannelOutput added in v0.6.0 

type UpdateVoiceChannelOutput 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 (UpdateVoiceChannelOutput) MarshalFields added in v0.6.0 

func (s UpdateVoiceChannelOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateVoiceChannelOutput) String added in v0.6.0 

func (s UpdateVoiceChannelOutput) String() string

String returns the string representation

type UpdateVoiceChannelRequest added in v0.6.0 

type UpdateVoiceChannelRequest struct {
	*aws.Request
	Input *UpdateVoiceChannelInput
	Copy  func(*UpdateVoiceChannelInput) UpdateVoiceChannelRequest
}

UpdateVoiceChannelRequest is the request type for the UpdateVoiceChannel API operation.

func (UpdateVoiceChannelRequest) Send added in v0.6.0 

func (r UpdateVoiceChannelRequest) Send(ctx context.Context) (*UpdateVoiceChannelResponse, error)

Send marshals and sends the UpdateVoiceChannel API request.

type UpdateVoiceChannelResponse added in v0.9.0 

type UpdateVoiceChannelResponse struct {
	*UpdateVoiceChannelOutput
	// contains filtered or unexported fields
}

UpdateVoiceChannelResponse is the response type for the UpdateVoiceChannel API operation.

func (*UpdateVoiceChannelResponse) SDKResponseMetdata added in v0.9.0 

func (r *UpdateVoiceChannelResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UpdateVoiceChannel request.

type UpdateVoiceTemplateInput added in v0.17.0 

type UpdateVoiceTemplateInput struct {
	CreateNewVersion *bool `location:"querystring" locationName:"create-new-version" type:"boolean"`

	// TemplateName is a required field
	TemplateName *string `location:"uri" locationName:"template-name" type:"string" required:"true"`

	Version *string `location:"querystring" locationName:"version" type:"string"`

	// Specifies the content and settings for a message template that can be used
	// in messages that are sent through the voice channel.
	//
	// VoiceTemplateRequest is a required field
	VoiceTemplateRequest *VoiceTemplateRequest `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateVoiceTemplateInput) MarshalFields added in v0.17.0 

func (s UpdateVoiceTemplateInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateVoiceTemplateInput) String added in v0.17.0 

func (s UpdateVoiceTemplateInput) String() string

String returns the string representation

func (*UpdateVoiceTemplateInput) Validate added in v0.17.0 

func (s *UpdateVoiceTemplateInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateVoiceTemplateOutput added in v0.17.0 

type UpdateVoiceTemplateOutput struct {

	// Provides information about an API request or response.
	//
	// MessageBody is a required field
	MessageBody *MessageBody `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateVoiceTemplateOutput) MarshalFields added in v0.17.0 

func (s UpdateVoiceTemplateOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateVoiceTemplateOutput) String added in v0.17.0 

func (s UpdateVoiceTemplateOutput) String() string

String returns the string representation

type UpdateVoiceTemplateRequest added in v0.17.0 

type UpdateVoiceTemplateRequest struct {
	*aws.Request
	Input *UpdateVoiceTemplateInput
	Copy  func(*UpdateVoiceTemplateInput) UpdateVoiceTemplateRequest
}

UpdateVoiceTemplateRequest is the request type for the UpdateVoiceTemplate API operation.

func (UpdateVoiceTemplateRequest) Send added in v0.17.0 

func (r UpdateVoiceTemplateRequest) Send(ctx context.Context) (*UpdateVoiceTemplateResponse, error)

Send marshals and sends the UpdateVoiceTemplate API request.

type UpdateVoiceTemplateResponse added in v0.17.0 

type UpdateVoiceTemplateResponse struct {
	*UpdateVoiceTemplateOutput
	// contains filtered or unexported fields
}

UpdateVoiceTemplateResponse is the response type for the UpdateVoiceTemplate API operation.

func (*UpdateVoiceTemplateResponse) SDKResponseMetdata added in v0.17.0 

func (r *UpdateVoiceTemplateResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UpdateVoiceTemplate request.

type VoiceChannelRequest added in v0.6.0 

type VoiceChannelRequest struct {

	// Specifies whether to enable the voice channel for the application.
	Enabled *bool `type:"boolean"`
	// contains filtered or unexported fields
}

Specifies the status and settings of the voice channel for an application.

func (VoiceChannelRequest) MarshalFields added in v0.6.0 

func (s VoiceChannelRequest) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (VoiceChannelRequest) String added in v0.6.0 

func (s VoiceChannelRequest) String() string

String returns the string representation

type VoiceChannelResponse added in v0.6.0 

type VoiceChannelResponse struct {

	// The unique identifier for the application that the voice channel applies
	// to.
	ApplicationId *string `type:"string"`

	// The date and time, in ISO 8601 format, when the voice channel was enabled.
	CreationDate *string `type:"string"`

	// Specifies whether the voice 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 voice channel. This property is retained
	// only for backward compatibility.
	Id *string `type:"string"`

	// Specifies whether the voice channel is archived.
	IsArchived *bool `type:"boolean"`

	// The user who last modified the voice channel.
	LastModifiedBy *string `type:"string"`

	// The date and time, in ISO 8601 format, when the voice channel was last modified.
	LastModifiedDate *string `type:"string"`

	// The type of messaging or notification platform for the channel. For the voice
	// channel, this value is VOICE.
	//
	// Platform is a required field
	Platform *string `type:"string" required:"true"`

	// The current version of the voice channel.
	Version *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Provides information about the status and settings of the voice channel for an application.

func (VoiceChannelResponse) MarshalFields added in v0.6.0 

func (s VoiceChannelResponse) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (VoiceChannelResponse) String added in v0.6.0 

func (s VoiceChannelResponse) String() string

String returns the string representation

type VoiceMessage added in v0.6.0 

type VoiceMessage struct {

	// The text of the script to use for the voice message.
	Body *string `type:"string"`

	// The code for the language to use when synthesizing the text of the message
	// script. For a list of supported languages and the code for each one, see
	// the Amazon Polly Developer Guide (https://docs.aws.amazon.com/polly/latest/dg/what-is.html).
	LanguageCode *string `type:"string"`

	// The long code to send the voice message from. This value should be one of
	// the dedicated long codes that's assigned to your AWS account. Although it
	// isn't required, we recommend that you specify the long code in E.164 format,
	// for example +12065550100, to ensure prompt and accurate delivery of the message.
	OriginationNumber *string `type:"string"`

	// The default message variables to use in the voice message. You can override
	// the default variables with individual address variables.
	Substitutions map[string][]string `type:"map"`

	// The name of the voice to use when delivering the message. For a list of supported
	// voices, see the Amazon Polly Developer Guide (https://docs.aws.amazon.com/polly/latest/dg/what-is.html).
	VoiceId *string `type:"string"`
	// contains filtered or unexported fields
}

Specifies the settings for a one-time voice message that's sent directly to an endpoint through the voice channel.

func (VoiceMessage) MarshalFields added in v0.6.0 

func (s VoiceMessage) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (VoiceMessage) String added in v0.6.0 

func (s VoiceMessage) String() string

String returns the string representation

type VoiceTemplateRequest added in v0.17.0 

type VoiceTemplateRequest struct {

	// The text of the script to use in messages that are based on the message template,
	// in plain text format.
	Body *string `type:"string"`

	// A JSON object that specifies the default values to use for message variables
	// in the message template. This object is a set of key-value pairs. Each key
	// defines a message variable in the template. The corresponding value defines
	// the default value for that variable. When you create a message that's based
	// on the template, you can override these defaults with message-specific and
	// address-specific variables and values.
	DefaultSubstitutions *string `type:"string"`

	// The code for the language to use when synthesizing the text of the script
	// in messages that are based on the message template. For a list of supported
	// languages and the code for each one, see the Amazon Polly Developer Guide
	// (https://docs.aws.amazon.com/polly/latest/dg/what-is.html).
	LanguageCode *string `type:"string"`

	// A string-to-string map of key-value pairs that defines the tags to associate
	// with the message template. Each tag consists of a required tag key and an
	// associated tag value.
	Tags map[string]string `locationName:"tags" type:"map"`

	// A custom description of the message template.
	TemplateDescription *string `type:"string"`

	// The name of the voice to use when delivering messages that are based on the
	// message template. For a list of supported voices, see the Amazon Polly Developer
	// Guide (https://docs.aws.amazon.com/polly/latest/dg/what-is.html).
	VoiceId *string `type:"string"`
	// contains filtered or unexported fields
}

Specifies the content and settings for a message template that can be used in messages that are sent through the voice channel.

func (VoiceTemplateRequest) MarshalFields added in v0.17.0 

func (s VoiceTemplateRequest) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (VoiceTemplateRequest) String added in v0.17.0 

func (s VoiceTemplateRequest) String() string

String returns the string representation

type VoiceTemplateResponse added in v0.17.0 

type VoiceTemplateResponse struct {

	// The Amazon Resource Name (ARN) of the message template.
	Arn *string `type:"string"`

	// The text of the script that's used in messages that are based on the message
	// template, in plain text format.
	Body *string `type:"string"`

	// The date, in ISO 8601 format, when the message template was created.
	//
	// CreationDate is a required field
	CreationDate *string `type:"string" required:"true"`

	// The JSON object that specifies the default values that are used for message
	// variables in the message template. This object is a set of key-value pairs.
	// Each key defines a message variable in the template. The corresponding value
	// defines the default value for that variable.
	DefaultSubstitutions *string `type:"string"`

	// The code for the language that's used when synthesizing the text of the script
	// in messages that are based on the message template. For a list of supported
	// languages and the code for each one, see the Amazon Polly Developer Guide
	// (https://docs.aws.amazon.com/polly/latest/dg/what-is.html).
	LanguageCode *string `type:"string"`

	// The date, in ISO 8601 format, when the message template was last modified.
	//
	// LastModifiedDate is a required field
	LastModifiedDate *string `type:"string" required:"true"`

	// A string-to-string map of key-value pairs that identifies the tags that are
	// associated with the message template. 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 the message template.
	TemplateDescription *string `type:"string"`

	// The name of the message template.
	//
	// TemplateName is a required field
	TemplateName *string `type:"string" required:"true"`

	// The type of channel that the message template is designed for. For a voice
	// template, this value is VOICE.
	//
	// TemplateType is a required field
	TemplateType TemplateType `type:"string" required:"true" enum:"true"`

	// The unique identifier, as an integer, for the active version of the message
	// template, or the version of the template that you specified by using the
	// version parameter in your request.
	Version *string `type:"string"`

	// The name of the voice that's used when delivering messages that are based
	// on the message template. For a list of supported voices, see the Amazon Polly
	// Developer Guide (https://docs.aws.amazon.com/polly/latest/dg/what-is.html).
	VoiceId *string `type:"string"`
	// contains filtered or unexported fields
}

Provides information about the content and settings for a message template that can be used in messages that are sent through the voice channel.

func (VoiceTemplateResponse) MarshalFields added in v0.17.0 

func (s VoiceTemplateResponse) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (VoiceTemplateResponse) String added in v0.17.0 

func (s VoiceTemplateResponse) String() string

String returns the string representation

type WaitActivity added in v0.16.0 

type WaitActivity struct {

	// The unique identifier for the next activity to perform, after performing
	// the wait activity.
	NextActivity *string `type:"string"`

	// The amount of time to wait or the date and time when the activity moves participants
	// to the next activity in the journey.
	WaitTime *WaitTime `type:"structure"`
	// contains filtered or unexported fields
}

Specifies the settings for a wait activity in a journey. This type of activity waits for a certain amount of time or until a specific date and time before moving participants to the next activity in a journey.

func (WaitActivity) MarshalFields added in v0.16.0 

func (s WaitActivity) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (WaitActivity) String added in v0.16.0 

func (s WaitActivity) String() string

String returns the string representation

type WaitTime added in v0.16.0 

type WaitTime struct {

	// The amount of time to wait, as a duration in ISO 8601 format, before determining
	// whether the activity's conditions have been met or moving participants to
	// the next activity in the journey.
	WaitFor *string `type:"string"`

	// The date and time, in ISO 8601 format, when Amazon Pinpoint determines whether
	// the activity's conditions have been met or the activity moves participants
	// to the next activity in the journey.
	WaitUntil *string `type:"string"`
	// contains filtered or unexported fields
}

Specifies a duration or a date and time that indicates when Amazon Pinpoint determines whether an activity's conditions have been met or an activity moves participants to the next activity in a journey.

func (WaitTime) MarshalFields added in v0.16.0 

func (s WaitTime) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (WaitTime) String added in v0.16.0 

func (s WaitTime) String() string

String returns the string representation

type WriteApplicationSettingsRequest 

type WriteApplicationSettingsRequest struct {

	// The settings for the AWS Lambda function to invoke by default as a code hook
	// for campaigns in the application. You can use this hook to customize segments
	// that are used by campaigns in the application.
	//
	// To override these settings and define custom settings for a specific campaign,
	// use the CampaignHook object of the Campaign resource.
	CampaignHook *CampaignHook `type:"structure"`

	// Specifies whether to enable application-related alarms in Amazon CloudWatch.
	CloudWatchMetricsEnabled *bool `type:"boolean"`

	// The default sending limits for campaigns and journeys in the application.
	// To override these limits and define custom limits for a specific campaign
	// or journey, use the Campaign resource or the Journey resource, respectively.
	Limits *CampaignLimits `type:"structure"`

	// The default quiet time for campaigns and journeys in the application. Quiet
	// time is a specific time range when messages aren't sent 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 or journey 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 or journey that has custom quiet time settings).
	//
	// If any of the preceding conditions isn't met, the endpoint will receive messages
	// from a campaign or journey, even if quiet time is enabled.
	//
	// To override the default quiet time settings for a specific campaign or journey,
	// use the Campaign resource or the Journey resource to define a custom quiet
	// time for the campaign or journey.
	QuietTime *QuietTime `type:"structure"`
	// contains filtered or unexported fields
}

Specifies the default settings for an application.

func (WriteApplicationSettingsRequest) MarshalFields added in v0.3.0 

func (s WriteApplicationSettingsRequest) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (WriteApplicationSettingsRequest) String 

func (s WriteApplicationSettingsRequest) String() string

String returns the string representation

type WriteCampaignRequest 

type WriteCampaignRequest struct {

	// An array of requests that defines additional treatments for the campaign,
	// in addition to the default treatment for the campaign.
	AdditionalTreatments []WriteTreatmentResource `type:"list"`

	// The delivery configuration settings for sending the campaign through a custom
	// channel. This object is required if the MessageConfiguration object for the
	// campaign specifies a CustomMessage object.
	CustomDeliveryConfiguration *CustomDeliveryConfiguration `type:"structure"`

	// A 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 invoke as a code hook for the
	// campaign. You can use this hook to customize the segment that's used by the
	// campaign.
	Hook *CampaignHook `type:"structure"`

	// Specifies whether to pause the campaign. A paused campaign doesn't run unless
	// you resume it by changing this value to false.
	IsPaused *bool `type:"boolean"`

	// The messaging limits for the campaign.
	Limits *CampaignLimits `type:"structure"`

	// The message configuration settings for the campaign.
	MessageConfiguration *MessageConfiguration `type:"structure"`

	// A custom name for the campaign.
	Name *string `type:"string"`

	// The schedule settings for the campaign.
	Schedule *Schedule `type:"structure"`

	// The unique identifier for the segment to associate with the campaign.
	SegmentId *string `type:"string"`

	// The version of the segment to associate with the campaign.
	SegmentVersion *int64 `type:"integer"`

	// A string-to-string map of key-value pairs that defines the tags to associate
	// 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 message template to use for the campaign.
	TemplateConfiguration *TemplateConfiguration `type:"structure"`

	// A custom description of the default treatment for the campaign.
	TreatmentDescription *string `type:"string"`

	// A custom name of the default treatment for the campaign, if the campaign
	// has multiple treatments. A treatment is a variation of a campaign that's
	// used for A/B testing.
	TreatmentName *string `type:"string"`
	// contains filtered or unexported fields
}

Specifies the configuration and other settings for a campaign.

func (WriteCampaignRequest) MarshalFields added in v0.3.0 

func (s WriteCampaignRequest) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (WriteCampaignRequest) String 

func (s WriteCampaignRequest) String() string

String returns the string representation

func (*WriteCampaignRequest) Validate added in v0.10.0 

func (s *WriteCampaignRequest) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type WriteEventStream 

type WriteEventStream struct {

	// The Amazon Resource Name (ARN) of the Amazon Kinesis data stream or Amazon
	// Kinesis Data Firehose delivery stream that you want 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"`

	// 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 the Amazon Resource Name (ARN) of an event stream to publish events to and the AWS Identity and Access Management (IAM) role to use when publishing those events.

func (WriteEventStream) MarshalFields added in v0.3.0 

func (s WriteEventStream) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (WriteEventStream) String 

func (s WriteEventStream) String() string

String returns the string representation

func (*WriteEventStream) Validate added in v0.10.0 

func (s *WriteEventStream) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type WriteJourneyRequest added in v0.16.0 

type WriteJourneyRequest struct {

	// A map that contains a set of Activity objects, one object for each activity
	// in the journey. For each Activity object, the key is the unique identifier
	// (string) for an activity and the value is the settings for the activity.
	// An activity identifier can contain a maximum of 100 characters. The characters
	// must be alphanumeric characters.
	Activities map[string]Activity `type:"map"`

	// The date, in ISO 8601 format, when the journey was created.
	CreationDate *string `type:"string"`

	// The date, in ISO 8601 format, when the journey was last modified.
	LastModifiedDate *string `type:"string"`

	// The messaging and entry limits for the journey.
	Limits *JourneyLimits `type:"structure"`

	// Specifies whether the journey's scheduled start and end times use each participant's
	// local time. To base the schedule on each participant's local time, set this
	// value to true.
	LocalTime *bool `type:"boolean"`

	// The name of the journey. A journey name can contain a maximum of 150 characters.
	// The characters can be alphanumeric characters or symbols, such as underscores
	// (_) or hyphens (-). A journey name can't contain any spaces.
	//
	// Name is a required field
	Name *string `type:"string" required:"true"`

	// The quiet time settings for the journey. Quiet time is a specific time range
	// when a journey doesn't send messages to participants, if all the following
	// conditions are met:
	//
	//    * The EndpointDemographic.Timezone property of the endpoint for the participant
	//    is set to a valid value.
	//
	//    * The current time in the participant's time zone is later than or equal
	//    to the time specified by the QuietTime.Start property for the journey.
	//
	//    * The current time in the participant's time zone is earlier than or equal
	//    to the time specified by the QuietTime.End property for the journey.
	//
	// If any of the preceding conditions isn't met, the participant will receive
	// messages from the journey, even if quiet time is enabled.
	QuietTime *QuietTime `type:"structure"`

	// The frequency with which Amazon Pinpoint evaluates segment and event data
	// for the journey, as a duration in ISO 8601 format.
	RefreshFrequency *string `type:"string"`

	// The schedule settings for the journey.
	Schedule *JourneySchedule `type:"structure"`

	// The unique identifier for the first activity in the journey. The identifier
	// for this activity can contain a maximum of 128 characters. The characters
	// must be alphanumeric characters.
	StartActivity *string `type:"string"`

	// The segment that defines which users are participants in the journey.
	StartCondition *StartCondition `type:"structure"`

	// The status of the journey. Valid values are:
	//
	//    * DRAFT - Saves the journey and doesn't publish it.
	//
	//    * ACTIVE - Saves and publishes the journey. Depending on the journey's
	//    schedule, the journey starts running immediately or at the scheduled start
	//    time. If a journey's status is ACTIVE, you can't add, change, or remove
	//    activities from it.
	//
	// The CANCELLED, COMPLETED, and CLOSED values are not supported in requests
	// to create or update a journey. To cancel a journey, use the Journey State
	// resource.
	State State `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

Specifies the configuration and other settings for a journey.

func (WriteJourneyRequest) MarshalFields added in v0.16.0 

func (s WriteJourneyRequest) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (WriteJourneyRequest) String added in v0.16.0 

func (s WriteJourneyRequest) String() string

String returns the string representation

func (*WriteJourneyRequest) Validate added in v0.16.0 

func (s *WriteJourneyRequest) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type WriteSegmentRequest 

type WriteSegmentRequest struct {

	// The criteria that define the dimensions for the segment.
	Dimensions *SegmentDimensions `type:"structure"`

	// The name of the segment.
	Name *string `type:"string"`

	// The segment group to use and the dimensions to apply to the group's base
	// segments in order to build the segment. A segment group can consist of zero
	// or more base segments. Your request can include only one segment group.
	SegmentGroups *SegmentGroupList `type:"structure"`

	// A string-to-string map of key-value pairs that defines the tags to associate
	// with the segment. 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 configuration, dimension, and other settings for a segment. A WriteSegmentRequest object can include a Dimensions object or a SegmentGroups object, but not both.

func (WriteSegmentRequest) MarshalFields added in v0.3.0 

func (s WriteSegmentRequest) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (WriteSegmentRequest) String 

func (s WriteSegmentRequest) String() string

String returns the string representation

func (*WriteSegmentRequest) Validate added in v0.10.0 

func (s *WriteSegmentRequest) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type WriteTreatmentResource 

type WriteTreatmentResource struct {

	// The delivery configuration settings for sending the treatment through a custom
	// channel. This object is required if the MessageConfiguration object for the
	// treatment specifies a CustomMessage object.
	CustomDeliveryConfiguration *CustomDeliveryConfiguration `type:"structure"`

	// The message configuration settings for the treatment.
	MessageConfiguration *MessageConfiguration `type:"structure"`

	// The schedule settings for the treatment.
	Schedule *Schedule `type:"structure"`

	// The allocated percentage of users (segment members) to send the treatment
	// to.
	//
	// SizePercent is a required field
	SizePercent *int64 `type:"integer" required:"true"`

	// The message template to use for the treatment.
	TemplateConfiguration *TemplateConfiguration `type:"structure"`

	// A custom description of the treatment.
	TreatmentDescription *string `type:"string"`

	// A custom name for the treatment.
	TreatmentName *string `type:"string"`
	// contains filtered or unexported fields
}

Specifies the settings for a campaign treatment. A treatment is a variation of a campaign that's used for A/B testing of a campaign.

func (WriteTreatmentResource) MarshalFields added in v0.3.0 

func (s WriteTreatmentResource) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (WriteTreatmentResource) String 

func (s WriteTreatmentResource) String() string

String returns the string representation

func (*WriteTreatmentResource) Validate added in v0.10.0 

func (s *WriteTreatmentResource) Validate() error

Validate inspects the fields of the type to determine if they are valid.

Source Files

View all Source files

Directories

Path Synopsis
Package pinpointiface provides an interface to enable mocking the Amazon Pinpoint service client for testing your code.
 Package pinpointiface provides an interface to enable mocking the Amazon Pinpoint service client for testing your code.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.