pinpoint

package
v1.13.55 Latest Latest
Warning

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

Go to latest
Published: May 24, 2018 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Overview

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

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 contact 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 Pinpoint 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 (
	// ActionOpenApp is a Action enum value
	ActionOpenApp = "OPEN_APP"

	// ActionDeepLink is a Action enum value
	ActionDeepLink = "DEEP_LINK"

	// ActionUrl is a Action enum value
	ActionUrl = "URL"
)
View Source
const (
	// AttributeTypeInclusive is a AttributeType enum value
	AttributeTypeInclusive = "INCLUSIVE"

	// AttributeTypeExclusive is a AttributeType enum value
	AttributeTypeExclusive = "EXCLUSIVE"
)
View Source
const (
	// CampaignStatusScheduled is a CampaignStatus enum value
	CampaignStatusScheduled = "SCHEDULED"

	// CampaignStatusExecuting is a CampaignStatus enum value
	CampaignStatusExecuting = "EXECUTING"

	// CampaignStatusPendingNextRun is a CampaignStatus enum value
	CampaignStatusPendingNextRun = "PENDING_NEXT_RUN"

	// CampaignStatusCompleted is a CampaignStatus enum value
	CampaignStatusCompleted = "COMPLETED"

	// CampaignStatusPaused is a CampaignStatus enum value
	CampaignStatusPaused = "PAUSED"
)
View Source
const (
	// ChannelTypeGcm is a ChannelType enum value
	ChannelTypeGcm = "GCM"

	// ChannelTypeApns is a ChannelType enum value
	ChannelTypeApns = "APNS"

	// ChannelTypeApnsSandbox is a ChannelType enum value
	ChannelTypeApnsSandbox = "APNS_SANDBOX"

	// ChannelTypeApnsVoip is a ChannelType enum value
	ChannelTypeApnsVoip = "APNS_VOIP"

	// ChannelTypeApnsVoipSandbox is a ChannelType enum value
	ChannelTypeApnsVoipSandbox = "APNS_VOIP_SANDBOX"

	// ChannelTypeAdm is a ChannelType enum value
	ChannelTypeAdm = "ADM"

	// ChannelTypeSms is a ChannelType enum value
	ChannelTypeSms = "SMS"

	// ChannelTypeEmail is a ChannelType enum value
	ChannelTypeEmail = "EMAIL"

	// ChannelTypeBaidu is a ChannelType enum value
	ChannelTypeBaidu = "BAIDU"

	// ChannelTypeCustom is a ChannelType enum value
	ChannelTypeCustom = "CUSTOM"
)
View Source
const (
	// DeliveryStatusSuccessful is a DeliveryStatus enum value
	DeliveryStatusSuccessful = "SUCCESSFUL"

	// DeliveryStatusThrottled is a DeliveryStatus enum value
	DeliveryStatusThrottled = "THROTTLED"

	// DeliveryStatusTemporaryFailure is a DeliveryStatus enum value
	DeliveryStatusTemporaryFailure = "TEMPORARY_FAILURE"

	// DeliveryStatusPermanentFailure is a DeliveryStatus enum value
	DeliveryStatusPermanentFailure = "PERMANENT_FAILURE"

	// DeliveryStatusUnknownFailure is a DeliveryStatus enum value
	DeliveryStatusUnknownFailure = "UNKNOWN_FAILURE"

	// DeliveryStatusOptOut is a DeliveryStatus enum value
	DeliveryStatusOptOut = "OPT_OUT"

	// DeliveryStatusDuplicate is a DeliveryStatus enum value
	DeliveryStatusDuplicate = "DUPLICATE"
)
View Source
const (
	// DimensionTypeInclusive is a DimensionType enum value
	DimensionTypeInclusive = "INCLUSIVE"

	// DimensionTypeExclusive is a DimensionType enum value
	DimensionTypeExclusive = "EXCLUSIVE"
)
View Source
const (
	// DurationHr24 is a Duration enum value
	DurationHr24 = "HR_24"

	// DurationDay7 is a Duration enum value
	DurationDay7 = "DAY_7"

	// DurationDay14 is a Duration enum value
	DurationDay14 = "DAY_14"

	// DurationDay30 is a Duration enum value
	DurationDay30 = "DAY_30"
)
View Source
const (
	// FormatCsv is a Format enum value
	FormatCsv = "CSV"

	// FormatJson is a Format enum value
	FormatJson = "JSON"
)
View Source
const (
	// FrequencyOnce is a Frequency enum value
	FrequencyOnce = "ONCE"

	// FrequencyHourly is a Frequency enum value
	FrequencyHourly = "HOURLY"

	// FrequencyDaily is a Frequency enum value
	FrequencyDaily = "DAILY"

	// FrequencyWeekly is a Frequency enum value
	FrequencyWeekly = "WEEKLY"

	// FrequencyMonthly is a Frequency enum value
	FrequencyMonthly = "MONTHLY"
)
View Source
const (
	// JobStatusCreated is a JobStatus enum value
	JobStatusCreated = "CREATED"

	// JobStatusInitializing is a JobStatus enum value
	JobStatusInitializing = "INITIALIZING"

	// JobStatusProcessing is a JobStatus enum value
	JobStatusProcessing = "PROCESSING"

	// JobStatusCompleting is a JobStatus enum value
	JobStatusCompleting = "COMPLETING"

	// JobStatusCompleted is a JobStatus enum value
	JobStatusCompleted = "COMPLETED"

	// JobStatusFailing is a JobStatus enum value
	JobStatusFailing = "FAILING"

	// JobStatusFailed is a JobStatus enum value
	JobStatusFailed = "FAILED"
)
View Source
const (
	// MessageTypeTransactional is a MessageType enum value
	MessageTypeTransactional = "TRANSACTIONAL"

	// MessageTypePromotional is a MessageType enum value
	MessageTypePromotional = "PROMOTIONAL"
)
View Source
const (
	// ModeDelivery is a Mode enum value
	ModeDelivery = "DELIVERY"

	// ModeFilter is a Mode enum value
	ModeFilter = "FILTER"
)
View Source
const (
	// RecencyTypeActive is a RecencyType enum value
	RecencyTypeActive = "ACTIVE"

	// RecencyTypeInactive is a RecencyType enum value
	RecencyTypeInactive = "INACTIVE"
)
View Source
const (
	// SegmentTypeDimensional is a SegmentType enum value
	SegmentTypeDimensional = "DIMENSIONAL"

	// SegmentTypeImport is a SegmentType enum value
	SegmentTypeImport = "IMPORT"
)
View Source
const (

	// ErrCodeBadRequestException for service response error code
	// "BadRequestException".
	ErrCodeBadRequestException = "BadRequestException"

	// ErrCodeForbiddenException for service response error code
	// "ForbiddenException".
	ErrCodeForbiddenException = "ForbiddenException"

	// ErrCodeInternalServerErrorException for service response error code
	// "InternalServerErrorException".
	ErrCodeInternalServerErrorException = "InternalServerErrorException"

	// ErrCodeMethodNotAllowedException for service response error code
	// "MethodNotAllowedException".
	ErrCodeMethodNotAllowedException = "MethodNotAllowedException"

	// ErrCodeNotFoundException for service response error code
	// "NotFoundException".
	ErrCodeNotFoundException = "NotFoundException"

	// ErrCodeTooManyRequestsException for service response error code
	// "TooManyRequestsException".
	ErrCodeTooManyRequestsException = "TooManyRequestsException"
)
View Source
const (
	ServiceName = "pinpoint"  // Service endpoint prefix API calls made to.
	EndpointsID = ServiceName // Service ID for Regions and Endpoints metadata.
)

Service information constants

Variables

This section is empty.

Functions

This section is empty.

Types

type ADMChannelRequest added in v1.12.1

type ADMChannelRequest struct {

	// Client ID as gotten from Amazon
	ClientId *string `type:"string"`

	// Client secret as gotten from Amazon
	ClientSecret *string `type:"string"`

	// If the channel is enabled for sending messages.
	Enabled *bool `type:"boolean"`
	// contains filtered or unexported fields
}

Amazon Device Messaging channel definition.

func (ADMChannelRequest) GoString added in v1.12.1

func (s ADMChannelRequest) GoString() string

GoString returns the string representation

func (*ADMChannelRequest) SetClientId added in v1.12.1

func (s *ADMChannelRequest) SetClientId(v string) *ADMChannelRequest

SetClientId sets the ClientId field's value.

func (*ADMChannelRequest) SetClientSecret added in v1.12.1

func (s *ADMChannelRequest) SetClientSecret(v string) *ADMChannelRequest

SetClientSecret sets the ClientSecret field's value.

func (*ADMChannelRequest) SetEnabled added in v1.12.1

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

SetEnabled sets the Enabled field's value.

func (ADMChannelRequest) String added in v1.12.1

func (s ADMChannelRequest) String() string

String returns the string representation

type ADMChannelResponse added in v1.12.1

type ADMChannelResponse struct {

	// The ID of the application to which the channel applies.
	ApplicationId *string `type:"string"`

	// When was this segment created
	CreationDate *string `type:"string"`

	// If the channel is enabled for sending messages.
	Enabled *bool `type:"boolean"`

	// Indicates whether the channel is configured with ADM credentials. Amazon
	// Pinpoint uses your credentials to authenticate push notifications with ADM.
	// Provide your credentials by setting the ClientId and ClientSecret attributes.
	HasCredential *bool `type:"boolean"`

	// Channel ID. Not used, only for backwards compatibility.
	Id *string `type:"string"`

	// Is this channel archived
	IsArchived *bool `type:"boolean"`

	// Who last updated this entry
	LastModifiedBy *string `type:"string"`

	// Last date this was updated
	LastModifiedDate *string `type:"string"`

	// Platform type. Will be "ADM"
	Platform *string `type:"string"`

	// Version of channel
	Version *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Amazon Device Messaging channel definition.

func (ADMChannelResponse) GoString added in v1.12.1

func (s ADMChannelResponse) GoString() string

GoString returns the string representation

func (*ADMChannelResponse) SetApplicationId added in v1.12.1

func (s *ADMChannelResponse) SetApplicationId(v string) *ADMChannelResponse

SetApplicationId sets the ApplicationId field's value.

func (*ADMChannelResponse) SetCreationDate added in v1.12.1

func (s *ADMChannelResponse) SetCreationDate(v string) *ADMChannelResponse

SetCreationDate sets the CreationDate field's value.

func (*ADMChannelResponse) SetEnabled added in v1.12.1

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

SetEnabled sets the Enabled field's value.

func (*ADMChannelResponse) SetHasCredential added in v1.12.17

func (s *ADMChannelResponse) SetHasCredential(v bool) *ADMChannelResponse

SetHasCredential sets the HasCredential field's value.

func (*ADMChannelResponse) SetId added in v1.12.1

SetId sets the Id field's value.

func (*ADMChannelResponse) SetIsArchived added in v1.12.1

func (s *ADMChannelResponse) SetIsArchived(v bool) *ADMChannelResponse

SetIsArchived sets the IsArchived field's value.

func (*ADMChannelResponse) SetLastModifiedBy added in v1.12.1

func (s *ADMChannelResponse) SetLastModifiedBy(v string) *ADMChannelResponse

SetLastModifiedBy sets the LastModifiedBy field's value.

func (*ADMChannelResponse) SetLastModifiedDate added in v1.12.1

func (s *ADMChannelResponse) SetLastModifiedDate(v string) *ADMChannelResponse

SetLastModifiedDate sets the LastModifiedDate field's value.

func (*ADMChannelResponse) SetPlatform added in v1.12.1

func (s *ADMChannelResponse) SetPlatform(v string) *ADMChannelResponse

SetPlatform sets the Platform field's value.

func (*ADMChannelResponse) SetVersion added in v1.12.1

func (s *ADMChannelResponse) SetVersion(v int64) *ADMChannelResponse

SetVersion sets the Version field's value.

func (ADMChannelResponse) String added in v1.12.1

func (s ADMChannelResponse) String() string

String returns the string representation

type ADMMessage added in v1.12.1

type ADMMessage struct {

	// The action that occurs if the user taps a push notification delivered by
	// the campaign: OPEN_APP - Your app launches, or it becomes the foreground
	// app if it has been sent to the background. This is the default action. DEEP_LINK
	// - Uses deep linking features in iOS and Android to open your app and display
	// a designated user interface within the app. URL - The default mobile browser
	// on the user's device launches and opens a web page at the URL you specify.
	// Possible values include: OPEN_APP | DEEP_LINK | URL
	Action *string `type:"string" enum:"Action"`

	// The message body of the notification, the email body or the text message.
	Body *string `type:"string"`

	// Optional. Arbitrary string used to indicate multiple messages are logically
	// the same and that ADM is allowed to drop previously enqueued messages in
	// favor of this one.
	ConsolidationKey *string `type:"string"`

	// The data payload used for a silent push. This payload is added to the notifications'
	// data.pinpoint.jsonBody' object
	Data map[string]*string `type:"map"`

	// Optional. Number of seconds ADM should retain the message if the device is
	// offline
	ExpiresAfter *string `type:"string"`

	// The icon image name of the asset saved in your application.
	IconReference *string `type:"string"`

	// The URL that points to an image used as the large icon to the notification
	// content view.
	ImageIconUrl *string `type:"string"`

	// The URL that points to an image used in the push notification.
	ImageUrl *string `type:"string"`

	// Optional. Base-64-encoded MD5 checksum of the data parameter. Used to verify
	// data integrity
	MD5 *string `type:"string"`

	// The Raw JSON formatted string to be used as the payload. This value overrides
	// the message.
	RawContent *string `type:"string"`

	// Indicates if the message should display on the users device. Silent pushes
	// can be used for Remote Configuration and Phone Home use cases.
	SilentPush *bool `type:"boolean"`

	// The URL that points to an image used as the small icon for the notification
	// which will be used to represent the notification in the status bar and content
	// view
	SmallImageIconUrl *string `type:"string"`

	// Indicates a sound to play when the device receives the notification. Supports
	// default, or the filename of a sound resource bundled in the app. Android
	// sound files must reside in /res/raw/
	Sound *string `type:"string"`

	Substitutions map[string][]*string `type:"map"`

	// The message title that displays above the message on the user's device.
	Title *string `type:"string"`

	// The URL to open in the user's mobile browser. Used if the value for Action
	// is URL.
	Url *string `type:"string"`
	// contains filtered or unexported fields
}

ADM Message.

func (ADMMessage) GoString added in v1.12.1

func (s ADMMessage) GoString() string

GoString returns the string representation

func (*ADMMessage) SetAction added in v1.12.1

func (s *ADMMessage) SetAction(v string) *ADMMessage

SetAction sets the Action field's value.

func (*ADMMessage) SetBody added in v1.12.1

func (s *ADMMessage) SetBody(v string) *ADMMessage

SetBody sets the Body field's value.

func (*ADMMessage) SetConsolidationKey added in v1.12.1

func (s *ADMMessage) SetConsolidationKey(v string) *ADMMessage

SetConsolidationKey sets the ConsolidationKey field's value.

func (*ADMMessage) SetData added in v1.12.1

func (s *ADMMessage) SetData(v map[string]*string) *ADMMessage

SetData sets the Data field's value.

func (*ADMMessage) SetExpiresAfter added in v1.12.1

func (s *ADMMessage) SetExpiresAfter(v string) *ADMMessage

SetExpiresAfter sets the ExpiresAfter field's value.

func (*ADMMessage) SetIconReference added in v1.12.1

func (s *ADMMessage) SetIconReference(v string) *ADMMessage

SetIconReference sets the IconReference field's value.

func (*ADMMessage) SetImageIconUrl added in v1.12.1

func (s *ADMMessage) SetImageIconUrl(v string) *ADMMessage

SetImageIconUrl sets the ImageIconUrl field's value.

func (*ADMMessage) SetImageUrl added in v1.12.1

func (s *ADMMessage) SetImageUrl(v string) *ADMMessage

SetImageUrl sets the ImageUrl field's value.

func (*ADMMessage) SetMD5 added in v1.12.1

func (s *ADMMessage) SetMD5(v string) *ADMMessage

SetMD5 sets the MD5 field's value.

func (*ADMMessage) SetRawContent added in v1.12.1

func (s *ADMMessage) SetRawContent(v string) *ADMMessage

SetRawContent sets the RawContent field's value.

func (*ADMMessage) SetSilentPush added in v1.12.1

func (s *ADMMessage) SetSilentPush(v bool) *ADMMessage

SetSilentPush sets the SilentPush field's value.

func (*ADMMessage) SetSmallImageIconUrl added in v1.12.1

func (s *ADMMessage) SetSmallImageIconUrl(v string) *ADMMessage

SetSmallImageIconUrl sets the SmallImageIconUrl field's value.

func (*ADMMessage) SetSound added in v1.12.1

func (s *ADMMessage) SetSound(v string) *ADMMessage

SetSound sets the Sound field's value.

func (*ADMMessage) SetSubstitutions added in v1.12.1

func (s *ADMMessage) SetSubstitutions(v map[string][]*string) *ADMMessage

SetSubstitutions sets the Substitutions field's value.

func (*ADMMessage) SetTitle added in v1.12.1

func (s *ADMMessage) SetTitle(v string) *ADMMessage

SetTitle sets the Title field's value.

func (*ADMMessage) SetUrl added in v1.12.1

func (s *ADMMessage) SetUrl(v string) *ADMMessage

SetUrl sets the Url field's value.

func (ADMMessage) String added in v1.12.1

func (s ADMMessage) String() string

String returns the string representation

type APNSChannelRequest

type APNSChannelRequest struct {

	// The bundle id used for APNs Tokens.
	BundleId *string `type:"string"`

	// The distribution certificate from Apple.
	Certificate *string `type:"string"`

	// The default authentication method used for APNs.
	DefaultAuthenticationMethod *string `type:"string"`

	// If the channel is enabled for sending messages.
	Enabled *bool `type:"boolean"`

	// The certificate private key.
	PrivateKey *string `type:"string"`

	// The team id used for APNs Tokens.
	TeamId *string `type:"string"`

	// The token key used for APNs Tokens.
	TokenKey *string `type:"string"`

	// The token key used for APNs Tokens.
	TokenKeyId *string `type:"string"`
	// contains filtered or unexported fields
}

Apple Push Notification Service channel definition.

func (APNSChannelRequest) GoString

func (s APNSChannelRequest) GoString() string

GoString returns the string representation

func (*APNSChannelRequest) SetBundleId added in v1.12.1

func (s *APNSChannelRequest) SetBundleId(v string) *APNSChannelRequest

SetBundleId sets the BundleId field's value.

func (*APNSChannelRequest) SetCertificate

func (s *APNSChannelRequest) SetCertificate(v string) *APNSChannelRequest

SetCertificate sets the Certificate field's value.

func (*APNSChannelRequest) SetDefaultAuthenticationMethod added in v1.12.1

func (s *APNSChannelRequest) SetDefaultAuthenticationMethod(v string) *APNSChannelRequest

SetDefaultAuthenticationMethod sets the DefaultAuthenticationMethod field's value.

func (*APNSChannelRequest) SetEnabled added in v1.8.38

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

SetEnabled sets the Enabled field's value.

func (*APNSChannelRequest) SetPrivateKey

func (s *APNSChannelRequest) SetPrivateKey(v string) *APNSChannelRequest

SetPrivateKey sets the PrivateKey field's value.

func (*APNSChannelRequest) SetTeamId added in v1.12.1

func (s *APNSChannelRequest) SetTeamId(v string) *APNSChannelRequest

SetTeamId sets the TeamId field's value.

func (*APNSChannelRequest) SetTokenKey added in v1.12.1

func (s *APNSChannelRequest) SetTokenKey(v string) *APNSChannelRequest

SetTokenKey sets the TokenKey field's value.

func (*APNSChannelRequest) SetTokenKeyId added in v1.12.1

func (s *APNSChannelRequest) SetTokenKeyId(v string) *APNSChannelRequest

SetTokenKeyId sets the TokenKeyId field's value.

func (APNSChannelRequest) String

func (s APNSChannelRequest) String() string

String returns the string representation

type APNSChannelResponse

type APNSChannelResponse struct {

	// The ID of the application to which the channel applies.
	ApplicationId *string `type:"string"`

	// When was this segment created
	CreationDate *string `type:"string"`

	// The default authentication method used for APNs.
	DefaultAuthenticationMethod *string `type:"string"`

	// If the channel is enabled for sending messages.
	Enabled *bool `type:"boolean"`

	// Indicates whether the channel is configured with APNs credentials. Amazon
	// Pinpoint uses your credentials to authenticate push notifications with APNs.
	// To use APNs token authentication, set the BundleId, TeamId, TokenKey, and
	// TokenKeyId attributes. To use certificate authentication, set the Certificate
	// and PrivateKey attributes.
	HasCredential *bool `type:"boolean"`

	// Indicates whether the channel is configured with a key for APNs token authentication.
	// Provide a token key by setting the TokenKey attribute.
	HasTokenKey *bool `type:"boolean"`

	// Channel ID. Not used. Present only for backwards compatibility.
	Id *string `type:"string"`

	// Is this channel archived
	IsArchived *bool `type:"boolean"`

	// Who last updated this entry
	LastModifiedBy *string `type:"string"`

	// Last date this was updated
	LastModifiedDate *string `type:"string"`

	// The platform type. Will be APNS.
	Platform *string `type:"string"`

	// Version of channel
	Version *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Apple Distribution Push Notification Service channel definition.

func (APNSChannelResponse) GoString

func (s APNSChannelResponse) GoString() string

GoString returns the string representation

func (*APNSChannelResponse) SetApplicationId

func (s *APNSChannelResponse) SetApplicationId(v string) *APNSChannelResponse

SetApplicationId sets the ApplicationId field's value.

func (*APNSChannelResponse) SetCreationDate

func (s *APNSChannelResponse) SetCreationDate(v string) *APNSChannelResponse

SetCreationDate sets the CreationDate field's value.

func (*APNSChannelResponse) SetDefaultAuthenticationMethod added in v1.12.17

func (s *APNSChannelResponse) SetDefaultAuthenticationMethod(v string) *APNSChannelResponse

SetDefaultAuthenticationMethod sets the DefaultAuthenticationMethod field's value.

func (*APNSChannelResponse) SetEnabled added in v1.8.38

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

SetEnabled sets the Enabled field's value.

func (*APNSChannelResponse) SetHasCredential added in v1.12.17

func (s *APNSChannelResponse) SetHasCredential(v bool) *APNSChannelResponse

SetHasCredential sets the HasCredential field's value.

func (*APNSChannelResponse) SetHasTokenKey added in v1.12.17

func (s *APNSChannelResponse) SetHasTokenKey(v bool) *APNSChannelResponse

SetHasTokenKey sets the HasTokenKey field's value.

func (*APNSChannelResponse) SetId

SetId sets the Id field's value.

func (*APNSChannelResponse) SetIsArchived

func (s *APNSChannelResponse) SetIsArchived(v bool) *APNSChannelResponse

SetIsArchived sets the IsArchived field's value.

func (*APNSChannelResponse) SetLastModifiedBy

func (s *APNSChannelResponse) SetLastModifiedBy(v string) *APNSChannelResponse

SetLastModifiedBy sets the LastModifiedBy field's value.

func (*APNSChannelResponse) SetLastModifiedDate

func (s *APNSChannelResponse) SetLastModifiedDate(v string) *APNSChannelResponse

SetLastModifiedDate sets the LastModifiedDate field's value.

func (*APNSChannelResponse) SetPlatform

func (s *APNSChannelResponse) SetPlatform(v string) *APNSChannelResponse

SetPlatform sets the Platform field's value.

func (*APNSChannelResponse) SetVersion

func (s *APNSChannelResponse) SetVersion(v int64) *APNSChannelResponse

SetVersion sets the Version field's value.

func (APNSChannelResponse) String

func (s APNSChannelResponse) String() string

String returns the string representation

type APNSMessage added in v1.8.38

type APNSMessage struct {

	// The action that occurs if the user taps a push notification delivered by
	// the campaign: OPEN_APP - Your app launches, or it becomes the foreground
	// app if it has been sent to the background. This is the default action. DEEP_LINK
	// - Uses deep linking features in iOS and Android to open your app and display
	// a designated user interface within the app. URL - The default mobile browser
	// on the user's device launches and opens a web page at the URL you specify.
	// Possible values include: OPEN_APP | DEEP_LINK | URL
	Action *string `type:"string" enum:"Action"`

	// Include this key when you want the system to modify the badge of your app
	// icon. If this key is not included in the dictionary, the badge is not changed.
	// To remove the badge, set the value of this key to 0.
	Badge *int64 `type:"integer"`

	// The message body of the notification, the email body or the text message.
	Body *string `type:"string"`

	// Provide this key with a string value that represents the notification's type.
	// This value corresponds to the value in the identifier property of one of
	// your app's registered categories.
	Category *string `type:"string"`

	// An ID that, if assigned to multiple messages, causes APNs to coalesce the
	// messages into a single push notification instead of delivering each message
	// individually. The value must not exceed 64 bytes. Amazon Pinpoint uses this
	// value to set the apns-collapse-id request header when it sends the message
	// to APNs.
	CollapseId *string `type:"string"`

	// The data payload used for a silent push. This payload is added to the notifications'
	// data.pinpoint.jsonBody' object
	Data map[string]*string `type:"map"`

	// The URL that points to a video used in the push notification.
	MediaUrl *string `type:"string"`

	// The preferred authentication method, either "CERTIFICATE" or "TOKEN"
	PreferredAuthenticationMethod *string `type:"string"`

	// The message priority. Amazon Pinpoint uses this value to set the apns-priority
	// request header when it sends the message to APNs. Accepts the following values:"5"
	// - Low priority. Messages might be delayed, delivered in groups, and throttled."10"
	// - High priority. Messages are sent immediately. High priority messages must
	// cause an alert, sound, or badge on the receiving device.The default value
	// is "10".The equivalent values for FCM or GCM messages are "normal" and "high".
	// Amazon Pinpoint accepts these values for APNs messages and converts them.For
	// more information about the apns-priority parameter, see Communicating with
	// APNs in the APNs Local and Remote Notification Programming Guide.
	Priority *string `type:"string"`

	// The Raw JSON formatted string to be used as the payload. This value overrides
	// the message.
	RawContent *string `type:"string"`

	// Indicates if the message should display on the users device. Silent pushes
	// can be used for Remote Configuration and Phone Home use cases.
	SilentPush *bool `type:"boolean"`

	// Include this key when you want the system to play a sound. The value of this
	// key is the name of a sound file in your app's main bundle or in the Library/Sounds
	// folder of your app's data container. If the sound file cannot be found, or
	// if you specify defaultfor the value, the system plays the default alert sound.
	Sound *string `type:"string"`

	Substitutions map[string][]*string `type:"map"`

	// Provide this key with a string value that represents the app-specific identifier
	// for grouping notifications. If you provide a Notification Content app extension,
	// you can use this value to group your notifications together.
	ThreadId *string `type:"string"`

	// The length of time (in seconds) that APNs stores and attempts to deliver
	// the message. If the value is 0, APNs does not store the message or attempt
	// to deliver it more than once. Amazon Pinpoint uses this value to set the
	// apns-expiration request header when it sends the message to APNs.
	TimeToLive *int64 `type:"integer"`

	// The message title that displays above the message on the user's device.
	Title *string `type:"string"`

	// The URL to open in the user's mobile browser. Used if the value for Action
	// is URL.
	Url *string `type:"string"`
	// contains filtered or unexported fields
}

APNS Message.

func (APNSMessage) GoString added in v1.8.38

func (s APNSMessage) GoString() string

GoString returns the string representation

func (*APNSMessage) SetAction added in v1.8.38

func (s *APNSMessage) SetAction(v string) *APNSMessage

SetAction sets the Action field's value.

func (*APNSMessage) SetBadge added in v1.8.38

func (s *APNSMessage) SetBadge(v int64) *APNSMessage

SetBadge sets the Badge field's value.

func (*APNSMessage) SetBody added in v1.8.38

func (s *APNSMessage) SetBody(v string) *APNSMessage

SetBody sets the Body field's value.

func (*APNSMessage) SetCategory added in v1.8.38

func (s *APNSMessage) SetCategory(v string) *APNSMessage

SetCategory sets the Category field's value.

func (*APNSMessage) SetCollapseId added in v1.12.17

func (s *APNSMessage) SetCollapseId(v string) *APNSMessage

SetCollapseId sets the CollapseId field's value.

func (*APNSMessage) SetData added in v1.8.38

func (s *APNSMessage) SetData(v map[string]*string) *APNSMessage

SetData sets the Data field's value.

func (*APNSMessage) SetMediaUrl added in v1.8.38

func (s *APNSMessage) SetMediaUrl(v string) *APNSMessage

SetMediaUrl sets the MediaUrl field's value.

func (*APNSMessage) SetPreferredAuthenticationMethod added in v1.12.1

func (s *APNSMessage) SetPreferredAuthenticationMethod(v string) *APNSMessage

SetPreferredAuthenticationMethod sets the PreferredAuthenticationMethod field's value.

func (*APNSMessage) SetPriority added in v1.12.17

func (s *APNSMessage) SetPriority(v string) *APNSMessage

SetPriority sets the Priority field's value.

func (*APNSMessage) SetRawContent added in v1.8.38

func (s *APNSMessage) SetRawContent(v string) *APNSMessage

SetRawContent sets the RawContent field's value.

func (*APNSMessage) SetSilentPush added in v1.8.38

func (s *APNSMessage) SetSilentPush(v bool) *APNSMessage

SetSilentPush sets the SilentPush field's value.

func (*APNSMessage) SetSound added in v1.8.38

func (s *APNSMessage) SetSound(v string) *APNSMessage

SetSound sets the Sound field's value.

func (*APNSMessage) SetSubstitutions added in v1.8.38

func (s *APNSMessage) SetSubstitutions(v map[string][]*string) *APNSMessage

SetSubstitutions sets the Substitutions field's value.

func (*APNSMessage) SetThreadId added in v1.8.38

func (s *APNSMessage) SetThreadId(v string) *APNSMessage

SetThreadId sets the ThreadId field's value.

func (*APNSMessage) SetTimeToLive added in v1.12.17

func (s *APNSMessage) SetTimeToLive(v int64) *APNSMessage

SetTimeToLive sets the TimeToLive field's value.

func (*APNSMessage) SetTitle added in v1.8.38

func (s *APNSMessage) SetTitle(v string) *APNSMessage

SetTitle sets the Title field's value.

func (*APNSMessage) SetUrl added in v1.8.38

func (s *APNSMessage) SetUrl(v string) *APNSMessage

SetUrl sets the Url field's value.

func (APNSMessage) String added in v1.8.38

func (s APNSMessage) String() string

String returns the string representation

type APNSSandboxChannelRequest added in v1.8.38

type APNSSandboxChannelRequest struct {

	// The bundle id used for APNs Tokens.
	BundleId *string `type:"string"`

	// The distribution certificate from Apple.
	Certificate *string `type:"string"`

	// The default authentication method used for APNs.
	DefaultAuthenticationMethod *string `type:"string"`

	// If the channel is enabled for sending messages.
	Enabled *bool `type:"boolean"`

	// The certificate private key.
	PrivateKey *string `type:"string"`

	// The team id used for APNs Tokens.
	TeamId *string `type:"string"`

	// The token key used for APNs Tokens.
	TokenKey *string `type:"string"`

	// The token key used for APNs Tokens.
	TokenKeyId *string `type:"string"`
	// contains filtered or unexported fields
}

Apple Development Push Notification Service channel definition.

func (APNSSandboxChannelRequest) GoString added in v1.8.38

func (s APNSSandboxChannelRequest) GoString() string

GoString returns the string representation

func (*APNSSandboxChannelRequest) SetBundleId added in v1.12.1

SetBundleId sets the BundleId field's value.

func (*APNSSandboxChannelRequest) SetCertificate added in v1.8.38

SetCertificate sets the Certificate field's value.

func (*APNSSandboxChannelRequest) SetDefaultAuthenticationMethod added in v1.12.1

func (s *APNSSandboxChannelRequest) SetDefaultAuthenticationMethod(v string) *APNSSandboxChannelRequest

SetDefaultAuthenticationMethod sets the DefaultAuthenticationMethod field's value.

func (*APNSSandboxChannelRequest) SetEnabled added in v1.8.38

SetEnabled sets the Enabled field's value.

func (*APNSSandboxChannelRequest) SetPrivateKey added in v1.8.38

SetPrivateKey sets the PrivateKey field's value.

func (*APNSSandboxChannelRequest) SetTeamId added in v1.12.1

SetTeamId sets the TeamId field's value.

func (*APNSSandboxChannelRequest) SetTokenKey added in v1.12.1

SetTokenKey sets the TokenKey field's value.

func (*APNSSandboxChannelRequest) SetTokenKeyId added in v1.12.1

SetTokenKeyId sets the TokenKeyId field's value.

func (APNSSandboxChannelRequest) String added in v1.8.38

func (s APNSSandboxChannelRequest) String() string

String returns the string representation

type APNSSandboxChannelResponse added in v1.8.38

type APNSSandboxChannelResponse struct {

	// The ID of the application to which the channel applies.
	ApplicationId *string `type:"string"`

	// When was this segment created
	CreationDate *string `type:"string"`

	// The default authentication method used for APNs.
	DefaultAuthenticationMethod *string `type:"string"`

	// If the channel is enabled for sending messages.
	Enabled *bool `type:"boolean"`

	// Indicates whether the channel is configured with APNs credentials. Amazon
	// Pinpoint uses your credentials to authenticate push notifications with APNs.
	// To use APNs token authentication, set the BundleId, TeamId, TokenKey, and
	// TokenKeyId attributes. To use certificate authentication, set the Certificate
	// and PrivateKey attributes.
	HasCredential *bool `type:"boolean"`

	// Indicates whether the channel is configured with a key for APNs token authentication.
	// Provide a token key by setting the TokenKey attribute.
	HasTokenKey *bool `type:"boolean"`

	// Channel ID. Not used, only for backwards compatibility.
	Id *string `type:"string"`

	// Is this channel archived
	IsArchived *bool `type:"boolean"`

	// Who last updated this entry
	LastModifiedBy *string `type:"string"`

	// Last date this was updated
	LastModifiedDate *string `type:"string"`

	// The platform type. Will be APNS_SANDBOX.
	Platform *string `type:"string"`

	// Version of channel
	Version *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Apple Development Push Notification Service channel definition.

func (APNSSandboxChannelResponse) GoString added in v1.8.38

func (s APNSSandboxChannelResponse) GoString() string

GoString returns the string representation

func (*APNSSandboxChannelResponse) SetApplicationId added in v1.8.38

SetApplicationId sets the ApplicationId field's value.

func (*APNSSandboxChannelResponse) SetCreationDate added in v1.8.38

SetCreationDate sets the CreationDate field's value.

func (*APNSSandboxChannelResponse) SetDefaultAuthenticationMethod added in v1.12.17

func (s *APNSSandboxChannelResponse) SetDefaultAuthenticationMethod(v string) *APNSSandboxChannelResponse

SetDefaultAuthenticationMethod sets the DefaultAuthenticationMethod field's value.

func (*APNSSandboxChannelResponse) SetEnabled added in v1.8.38

SetEnabled sets the Enabled field's value.

func (*APNSSandboxChannelResponse) SetHasCredential added in v1.12.17

SetHasCredential sets the HasCredential field's value.

func (*APNSSandboxChannelResponse) SetHasTokenKey added in v1.12.17

SetHasTokenKey sets the HasTokenKey field's value.

func (*APNSSandboxChannelResponse) SetId added in v1.8.38

SetId sets the Id field's value.

func (*APNSSandboxChannelResponse) SetIsArchived added in v1.8.38

SetIsArchived sets the IsArchived field's value.

func (*APNSSandboxChannelResponse) SetLastModifiedBy added in v1.8.38

SetLastModifiedBy sets the LastModifiedBy field's value.

func (*APNSSandboxChannelResponse) SetLastModifiedDate added in v1.8.38

SetLastModifiedDate sets the LastModifiedDate field's value.

func (*APNSSandboxChannelResponse) SetPlatform added in v1.8.38

SetPlatform sets the Platform field's value.

func (*APNSSandboxChannelResponse) SetVersion added in v1.8.38

SetVersion sets the Version field's value.

func (APNSSandboxChannelResponse) String added in v1.8.38

String returns the string representation

type APNSVoipChannelRequest added in v1.12.17

type APNSVoipChannelRequest struct {

	// The bundle id used for APNs Tokens.
	BundleId *string `type:"string"`

	// The distribution certificate from Apple.
	Certificate *string `type:"string"`

	// The default authentication method used for APNs.
	DefaultAuthenticationMethod *string `type:"string"`

	// If the channel is enabled for sending messages.
	Enabled *bool `type:"boolean"`

	// The certificate private key.
	PrivateKey *string `type:"string"`

	// The team id used for APNs Tokens.
	TeamId *string `type:"string"`

	// The token key used for APNs Tokens.
	TokenKey *string `type:"string"`

	// The token key used for APNs Tokens.
	TokenKeyId *string `type:"string"`
	// contains filtered or unexported fields
}

Apple VoIP Push Notification Service channel definition.

func (APNSVoipChannelRequest) GoString added in v1.12.17

func (s APNSVoipChannelRequest) GoString() string

GoString returns the string representation

func (*APNSVoipChannelRequest) SetBundleId added in v1.12.17

SetBundleId sets the BundleId field's value.

func (*APNSVoipChannelRequest) SetCertificate added in v1.12.17

SetCertificate sets the Certificate field's value.

func (*APNSVoipChannelRequest) SetDefaultAuthenticationMethod added in v1.12.17

func (s *APNSVoipChannelRequest) SetDefaultAuthenticationMethod(v string) *APNSVoipChannelRequest

SetDefaultAuthenticationMethod sets the DefaultAuthenticationMethod field's value.

func (*APNSVoipChannelRequest) SetEnabled added in v1.12.17

SetEnabled sets the Enabled field's value.

func (*APNSVoipChannelRequest) SetPrivateKey added in v1.12.17

SetPrivateKey sets the PrivateKey field's value.

func (*APNSVoipChannelRequest) SetTeamId added in v1.12.17

SetTeamId sets the TeamId field's value.

func (*APNSVoipChannelRequest) SetTokenKey added in v1.12.17

SetTokenKey sets the TokenKey field's value.

func (*APNSVoipChannelRequest) SetTokenKeyId added in v1.12.17

SetTokenKeyId sets the TokenKeyId field's value.

func (APNSVoipChannelRequest) String added in v1.12.17

func (s APNSVoipChannelRequest) String() string

String returns the string representation

type APNSVoipChannelResponse added in v1.12.17

type APNSVoipChannelResponse struct {

	// Application id
	ApplicationId *string `type:"string"`

	// When was this segment created
	CreationDate *string `type:"string"`

	// The default authentication method used for APNs.
	DefaultAuthenticationMethod *string `type:"string"`

	// If the channel is enabled for sending messages.
	Enabled *bool `type:"boolean"`

	// If the channel is registered with a credential for authentication.
	HasCredential *bool `type:"boolean"`

	// If the channel is registered with a token key for authentication.
	HasTokenKey *bool `type:"boolean"`

	// Channel ID. Not used, only for backwards compatibility.
	Id *string `type:"string"`

	// Is this channel archived
	IsArchived *bool `type:"boolean"`

	// Who made the last change
	LastModifiedBy *string `type:"string"`

	// Last date this was updated
	LastModifiedDate *string `type:"string"`

	// The platform type. Will be APNS.
	Platform *string `type:"string"`

	// Version of channel
	Version *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Apple VoIP Push Notification Service channel definition.

func (APNSVoipChannelResponse) GoString added in v1.12.17

func (s APNSVoipChannelResponse) GoString() string

GoString returns the string representation

func (*APNSVoipChannelResponse) SetApplicationId added in v1.12.17

func (s *APNSVoipChannelResponse) SetApplicationId(v string) *APNSVoipChannelResponse

SetApplicationId sets the ApplicationId field's value.

func (*APNSVoipChannelResponse) SetCreationDate added in v1.12.17

SetCreationDate sets the CreationDate field's value.

func (*APNSVoipChannelResponse) SetDefaultAuthenticationMethod added in v1.12.17

func (s *APNSVoipChannelResponse) SetDefaultAuthenticationMethod(v string) *APNSVoipChannelResponse

SetDefaultAuthenticationMethod sets the DefaultAuthenticationMethod field's value.

func (*APNSVoipChannelResponse) SetEnabled added in v1.12.17

SetEnabled sets the Enabled field's value.

func (*APNSVoipChannelResponse) SetHasCredential added in v1.12.17

func (s *APNSVoipChannelResponse) SetHasCredential(v bool) *APNSVoipChannelResponse

SetHasCredential sets the HasCredential field's value.

func (*APNSVoipChannelResponse) SetHasTokenKey added in v1.12.17

SetHasTokenKey sets the HasTokenKey field's value.

func (*APNSVoipChannelResponse) SetId added in v1.12.17

SetId sets the Id field's value.

func (*APNSVoipChannelResponse) SetIsArchived added in v1.12.17

SetIsArchived sets the IsArchived field's value.

func (*APNSVoipChannelResponse) SetLastModifiedBy added in v1.12.17

func (s *APNSVoipChannelResponse) SetLastModifiedBy(v string) *APNSVoipChannelResponse

SetLastModifiedBy sets the LastModifiedBy field's value.

func (*APNSVoipChannelResponse) SetLastModifiedDate added in v1.12.17

func (s *APNSVoipChannelResponse) SetLastModifiedDate(v string) *APNSVoipChannelResponse

SetLastModifiedDate sets the LastModifiedDate field's value.

func (*APNSVoipChannelResponse) SetPlatform added in v1.12.17

SetPlatform sets the Platform field's value.

func (*APNSVoipChannelResponse) SetVersion added in v1.12.17

SetVersion sets the Version field's value.

func (APNSVoipChannelResponse) String added in v1.12.17

func (s APNSVoipChannelResponse) String() string

String returns the string representation

type APNSVoipSandboxChannelRequest added in v1.12.17

type APNSVoipSandboxChannelRequest struct {

	// The bundle id used for APNs Tokens.
	BundleId *string `type:"string"`

	// The distribution certificate from Apple.
	Certificate *string `type:"string"`

	// The default authentication method used for APNs.
	DefaultAuthenticationMethod *string `type:"string"`

	// If the channel is enabled for sending messages.
	Enabled *bool `type:"boolean"`

	// The certificate private key.
	PrivateKey *string `type:"string"`

	// The team id used for APNs Tokens.
	TeamId *string `type:"string"`

	// The token key used for APNs Tokens.
	TokenKey *string `type:"string"`

	// The token key used for APNs Tokens.
	TokenKeyId *string `type:"string"`
	// contains filtered or unexported fields
}

Apple VoIP Developer Push Notification Service channel definition.

func (APNSVoipSandboxChannelRequest) GoString added in v1.12.17

GoString returns the string representation

func (*APNSVoipSandboxChannelRequest) SetBundleId added in v1.12.17

SetBundleId sets the BundleId field's value.

func (*APNSVoipSandboxChannelRequest) SetCertificate added in v1.12.17

SetCertificate sets the Certificate field's value.

func (*APNSVoipSandboxChannelRequest) SetDefaultAuthenticationMethod added in v1.12.17

func (s *APNSVoipSandboxChannelRequest) SetDefaultAuthenticationMethod(v string) *APNSVoipSandboxChannelRequest

SetDefaultAuthenticationMethod sets the DefaultAuthenticationMethod field's value.

func (*APNSVoipSandboxChannelRequest) SetEnabled added in v1.12.17

SetEnabled sets the Enabled field's value.

func (*APNSVoipSandboxChannelRequest) SetPrivateKey added in v1.12.17

SetPrivateKey sets the PrivateKey field's value.

func (*APNSVoipSandboxChannelRequest) SetTeamId added in v1.12.17

SetTeamId sets the TeamId field's value.

func (*APNSVoipSandboxChannelRequest) SetTokenKey added in v1.12.17

SetTokenKey sets the TokenKey field's value.

func (*APNSVoipSandboxChannelRequest) SetTokenKeyId added in v1.12.17

SetTokenKeyId sets the TokenKeyId field's value.

func (APNSVoipSandboxChannelRequest) String added in v1.12.17

String returns the string representation

type APNSVoipSandboxChannelResponse added in v1.12.17

type APNSVoipSandboxChannelResponse struct {

	// Application id
	ApplicationId *string `type:"string"`

	// When was this segment created
	CreationDate *string `type:"string"`

	// The default authentication method used for APNs.
	DefaultAuthenticationMethod *string `type:"string"`

	// If the channel is enabled for sending messages.
	Enabled *bool `type:"boolean"`

	// If the channel is registered with a credential for authentication.
	HasCredential *bool `type:"boolean"`

	// If the channel is registered with a token key for authentication.
	HasTokenKey *bool `type:"boolean"`

	// Channel ID. Not used, only for backwards compatibility.
	Id *string `type:"string"`

	// Is this channel archived
	IsArchived *bool `type:"boolean"`

	// Who made the last change
	LastModifiedBy *string `type:"string"`

	// Last date this was updated
	LastModifiedDate *string `type:"string"`

	// The platform type. Will be APNS.
	Platform *string `type:"string"`

	// Version of channel
	Version *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Apple VoIP Developer Push Notification Service channel definition.

func (APNSVoipSandboxChannelResponse) GoString added in v1.12.17

GoString returns the string representation

func (*APNSVoipSandboxChannelResponse) SetApplicationId added in v1.12.17

SetApplicationId sets the ApplicationId field's value.

func (*APNSVoipSandboxChannelResponse) SetCreationDate added in v1.12.17

SetCreationDate sets the CreationDate field's value.

func (*APNSVoipSandboxChannelResponse) SetDefaultAuthenticationMethod added in v1.12.17

func (s *APNSVoipSandboxChannelResponse) SetDefaultAuthenticationMethod(v string) *APNSVoipSandboxChannelResponse

SetDefaultAuthenticationMethod sets the DefaultAuthenticationMethod field's value.

func (*APNSVoipSandboxChannelResponse) SetEnabled added in v1.12.17

SetEnabled sets the Enabled field's value.

func (*APNSVoipSandboxChannelResponse) SetHasCredential added in v1.12.17

SetHasCredential sets the HasCredential field's value.

func (*APNSVoipSandboxChannelResponse) SetHasTokenKey added in v1.12.17

SetHasTokenKey sets the HasTokenKey field's value.

func (*APNSVoipSandboxChannelResponse) SetId added in v1.12.17

SetId sets the Id field's value.

func (*APNSVoipSandboxChannelResponse) SetIsArchived added in v1.12.17

SetIsArchived sets the IsArchived field's value.

func (*APNSVoipSandboxChannelResponse) SetLastModifiedBy added in v1.12.17

SetLastModifiedBy sets the LastModifiedBy field's value.

func (*APNSVoipSandboxChannelResponse) SetLastModifiedDate added in v1.12.17

SetLastModifiedDate sets the LastModifiedDate field's value.

func (*APNSVoipSandboxChannelResponse) SetPlatform added in v1.12.17

SetPlatform sets the Platform field's value.

func (*APNSVoipSandboxChannelResponse) SetVersion added in v1.12.17

SetVersion sets the Version field's value.

func (APNSVoipSandboxChannelResponse) String added in v1.12.17

String returns the string representation

type ActivitiesResponse

type ActivitiesResponse struct {

	// List of campaign activities
	Item []*ActivityResponse `type:"list"`
	// contains filtered or unexported fields
}

Activities for campaign.

func (ActivitiesResponse) GoString

func (s ActivitiesResponse) GoString() string

GoString returns the string representation

func (*ActivitiesResponse) SetItem

SetItem sets the Item field's value.

func (ActivitiesResponse) String

func (s ActivitiesResponse) String() string

String returns the string representation

type ActivityResponse

type ActivityResponse struct {

	// The ID of the application to which the campaign applies.
	ApplicationId *string `type:"string"`

	// The ID of the campaign to which the activity applies.
	CampaignId *string `type:"string"`

	// The actual time the activity was marked CANCELLED or COMPLETED. Provided
	// in ISO 8601 format.
	End *string `type:"string"`

	// The unique activity ID.
	Id *string `type:"string"`

	// Indicates whether the activity succeeded.Valid values: SUCCESS, FAIL
	Result *string `type:"string"`

	// The scheduled start time for the activity in ISO 8601 format.
	ScheduledStart *string `type:"string"`

	// The actual start time of the activity in ISO 8601 format.
	Start *string `type:"string"`

	// The state of the activity.Valid values: PENDING, INITIALIZING, RUNNING, PAUSED,
	// CANCELLED, COMPLETED
	State *string `type:"string"`

	// The total number of endpoints to which the campaign successfully delivered
	// messages.
	SuccessfulEndpointCount *int64 `type:"integer"`

	// The total number of timezones completed.
	TimezonesCompletedCount *int64 `type:"integer"`

	// The total number of unique timezones present in the segment.
	TimezonesTotalCount *int64 `type:"integer"`

	// The total number of endpoints to which the campaign attempts to deliver messages.
	TotalEndpointCount *int64 `type:"integer"`

	// The ID of a variation of the campaign used for A/B testing.
	TreatmentId *string `type:"string"`
	// contains filtered or unexported fields
}

Activity definition

func (ActivityResponse) GoString

func (s ActivityResponse) GoString() string

GoString returns the string representation

func (*ActivityResponse) SetApplicationId

func (s *ActivityResponse) SetApplicationId(v string) *ActivityResponse

SetApplicationId sets the ApplicationId field's value.

func (*ActivityResponse) SetCampaignId

func (s *ActivityResponse) SetCampaignId(v string) *ActivityResponse

SetCampaignId sets the CampaignId field's value.

func (*ActivityResponse) SetEnd

SetEnd sets the End field's value.

func (*ActivityResponse) SetId

SetId sets the Id field's value.

func (*ActivityResponse) SetResult

func (s *ActivityResponse) SetResult(v string) *ActivityResponse

SetResult sets the Result field's value.

func (*ActivityResponse) SetScheduledStart

func (s *ActivityResponse) SetScheduledStart(v string) *ActivityResponse

SetScheduledStart sets the ScheduledStart field's value.

func (*ActivityResponse) SetStart

func (s *ActivityResponse) SetStart(v string) *ActivityResponse

SetStart sets the Start field's value.

func (*ActivityResponse) SetState

func (s *ActivityResponse) SetState(v string) *ActivityResponse

SetState sets the State field's value.

func (*ActivityResponse) SetSuccessfulEndpointCount

func (s *ActivityResponse) SetSuccessfulEndpointCount(v int64) *ActivityResponse

SetSuccessfulEndpointCount sets the SuccessfulEndpointCount field's value.

func (*ActivityResponse) SetTimezonesCompletedCount added in v1.8.0

func (s *ActivityResponse) SetTimezonesCompletedCount(v int64) *ActivityResponse

SetTimezonesCompletedCount sets the TimezonesCompletedCount field's value.

func (*ActivityResponse) SetTimezonesTotalCount added in v1.8.0

func (s *ActivityResponse) SetTimezonesTotalCount(v int64) *ActivityResponse

SetTimezonesTotalCount sets the TimezonesTotalCount field's value.

func (*ActivityResponse) SetTotalEndpointCount

func (s *ActivityResponse) SetTotalEndpointCount(v int64) *ActivityResponse

SetTotalEndpointCount sets the TotalEndpointCount field's value.

func (*ActivityResponse) SetTreatmentId

func (s *ActivityResponse) SetTreatmentId(v string) *ActivityResponse

SetTreatmentId sets the TreatmentId field's value.

func (ActivityResponse) String

func (s ActivityResponse) String() string

String returns the string representation

type AddressConfiguration added in v1.8.38

type AddressConfiguration struct {

	// Body override. If specified will override default body.
	BodyOverride *string `type:"string"`

	// The channel type.Valid values: GCM | APNS | APNS_SANDBOX | APNS_VOIP | APNS_VOIP_SANDBOX
	// | ADM | SMS | EMAIL | BAIDU
	ChannelType *string `type:"string" enum:"ChannelType"`

	// A map of custom attributes to attributes to be attached to the message for
	// this address. This payload is added to the push notification's 'data.pinpoint'
	// object or added to the email/sms delivery receipt event attributes.
	Context map[string]*string `type:"map"`

	// The Raw JSON formatted string to be used as the payload. This value overrides
	// the message.
	RawContent *string `type:"string"`

	Substitutions map[string][]*string `type:"map"`

	// Title override. If specified will override default title if applicable.
	TitleOverride *string `type:"string"`
	// contains filtered or unexported fields
}

Address configuration.

func (AddressConfiguration) GoString added in v1.8.38

func (s AddressConfiguration) GoString() string

GoString returns the string representation

func (*AddressConfiguration) SetBodyOverride added in v1.8.38

func (s *AddressConfiguration) SetBodyOverride(v string) *AddressConfiguration

SetBodyOverride sets the BodyOverride field's value.

func (*AddressConfiguration) SetChannelType added in v1.8.38

func (s *AddressConfiguration) SetChannelType(v string) *AddressConfiguration

SetChannelType sets the ChannelType field's value.

func (*AddressConfiguration) SetContext added in v1.8.38

func (s *AddressConfiguration) SetContext(v map[string]*string) *AddressConfiguration

SetContext sets the Context field's value.

func (*AddressConfiguration) SetRawContent added in v1.8.38

func (s *AddressConfiguration) SetRawContent(v string) *AddressConfiguration

SetRawContent sets the RawContent field's value.

func (*AddressConfiguration) SetSubstitutions added in v1.8.38

func (s *AddressConfiguration) SetSubstitutions(v map[string][]*string) *AddressConfiguration

SetSubstitutions sets the Substitutions field's value.

func (*AddressConfiguration) SetTitleOverride added in v1.8.38

func (s *AddressConfiguration) SetTitleOverride(v string) *AddressConfiguration

SetTitleOverride sets the TitleOverride field's value.

func (AddressConfiguration) String added in v1.8.38

func (s AddressConfiguration) String() string

String returns the string representation

type ApplicationResponse added in v1.10.20

type ApplicationResponse struct {

	// The unique application ID.
	Id *string `type:"string"`

	// The display name of the application.
	Name *string `type:"string"`
	// contains filtered or unexported fields
}

Application Response.

func (ApplicationResponse) GoString added in v1.10.20

func (s ApplicationResponse) GoString() string

GoString returns the string representation

func (*ApplicationResponse) SetId added in v1.10.20

SetId sets the Id field's value.

func (*ApplicationResponse) SetName added in v1.10.20

SetName sets the Name field's value.

func (ApplicationResponse) String added in v1.10.20

func (s ApplicationResponse) String() string

String returns the string representation

type ApplicationSettingsResource

type ApplicationSettingsResource struct {

	// The unique ID for the application.
	ApplicationId *string `type:"string"`

	// Default campaign hook.
	CampaignHook *CampaignHook `type:"structure"`

	// The date that the settings were last updated in ISO 8601 format.
	LastModifiedDate *string `type:"string"`

	// The default campaign limits for the app. These limits apply to each campaign
	// for the app, unless the campaign overrides the default with limits of its
	// own.
	Limits *CampaignLimits `type:"structure"`

	// The default quiet time for the app. Each campaign for this app sends no messages
	// during this time unless the campaign overrides the default with a quiet time
	// of its own.
	QuietTime *QuietTime `type:"structure"`
	// contains filtered or unexported fields
}

Application settings.

func (ApplicationSettingsResource) GoString

func (s ApplicationSettingsResource) GoString() string

GoString returns the string representation

func (*ApplicationSettingsResource) SetApplicationId

SetApplicationId sets the ApplicationId field's value.

func (*ApplicationSettingsResource) SetCampaignHook added in v1.13.11

SetCampaignHook sets the CampaignHook field's value.

func (*ApplicationSettingsResource) SetLastModifiedDate

SetLastModifiedDate sets the LastModifiedDate field's value.

func (*ApplicationSettingsResource) SetLimits

SetLimits sets the Limits field's value.

func (*ApplicationSettingsResource) SetQuietTime

SetQuietTime sets the QuietTime field's value.

func (ApplicationSettingsResource) String

String returns the string representation

type ApplicationsResponse added in v1.10.20

type ApplicationsResponse struct {

	// List of applications returned in this page.
	Item []*ApplicationResponse `type:"list"`

	// The string that you use in a subsequent request to get the next page of results
	// in a paginated response.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

Get Applications Result.

func (ApplicationsResponse) GoString added in v1.10.20

func (s ApplicationsResponse) GoString() string

GoString returns the string representation

func (*ApplicationsResponse) SetItem added in v1.10.20

SetItem sets the Item field's value.

func (*ApplicationsResponse) SetNextToken added in v1.10.20

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

SetNextToken sets the NextToken field's value.

func (ApplicationsResponse) String added in v1.10.20

func (s ApplicationsResponse) String() string

String returns the string representation

type AttributeDimension

type AttributeDimension struct {

	// The type of dimension:INCLUSIVE - Endpoints that match the criteria are included
	// in the segment.EXCLUSIVE - Endpoints that match the criteria are excluded
	// from the segment.
	AttributeType *string `type:"string" enum:"AttributeType"`

	Values []*string `type:"list"`
	// contains filtered or unexported fields
}

Custom attibute dimension

func (AttributeDimension) GoString

func (s AttributeDimension) GoString() string

GoString returns the string representation

func (*AttributeDimension) SetAttributeType

func (s *AttributeDimension) SetAttributeType(v string) *AttributeDimension

SetAttributeType sets the AttributeType field's value.

func (*AttributeDimension) SetValues

func (s *AttributeDimension) SetValues(v []*string) *AttributeDimension

SetValues sets the Values field's value.

func (AttributeDimension) String

func (s AttributeDimension) String() string

String returns the string representation

type BaiduChannelRequest added in v1.12.1

type BaiduChannelRequest struct {

	// Platform credential API key from Baidu.
	ApiKey *string `type:"string"`

	// If the channel is enabled for sending messages.
	Enabled *bool `type:"boolean"`

	// Platform credential Secret key from Baidu.
	SecretKey *string `type:"string"`
	// contains filtered or unexported fields
}

Baidu Cloud Push credentials

func (BaiduChannelRequest) GoString added in v1.12.1

func (s BaiduChannelRequest) GoString() string

GoString returns the string representation

func (*BaiduChannelRequest) SetApiKey added in v1.12.1

SetApiKey sets the ApiKey field's value.

func (*BaiduChannelRequest) SetEnabled added in v1.12.1

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

SetEnabled sets the Enabled field's value.

func (*BaiduChannelRequest) SetSecretKey added in v1.12.1

func (s *BaiduChannelRequest) SetSecretKey(v string) *BaiduChannelRequest

SetSecretKey sets the SecretKey field's value.

func (BaiduChannelRequest) String added in v1.12.1

func (s BaiduChannelRequest) String() string

String returns the string representation

type BaiduChannelResponse added in v1.12.1

type BaiduChannelResponse struct {

	// Application id
	ApplicationId *string `type:"string"`

	// When was this segment created
	CreationDate *string `type:"string"`

	// The Baidu API key from Baidu.
	Credential *string `type:"string"`

	// If the channel is enabled for sending messages.
	Enabled *bool `type:"boolean"`

	// Indicates whether the channel is configured with Baidu Cloud Push credentials.
	// Amazon Pinpoint uses your credentials to authenticate push notifications
	// with Baidu Cloud Push. Provide your credentials by setting the ApiKey and
	// SecretKey attributes.
	HasCredential *bool `type:"boolean"`

	// Channel ID. Not used, only for backwards compatibility.
	Id *string `type:"string"`

	// Is this channel archived
	IsArchived *bool `type:"boolean"`

	// Who made the last change
	LastModifiedBy *string `type:"string"`

	// Last date this was updated
	LastModifiedDate *string `type:"string"`

	// The platform type. Will be BAIDU
	Platform *string `type:"string"`

	// Version of channel
	Version *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Baidu Cloud Messaging channel definition

func (BaiduChannelResponse) GoString added in v1.12.1

func (s BaiduChannelResponse) GoString() string

GoString returns the string representation

func (*BaiduChannelResponse) SetApplicationId added in v1.12.1

func (s *BaiduChannelResponse) SetApplicationId(v string) *BaiduChannelResponse

SetApplicationId sets the ApplicationId field's value.

func (*BaiduChannelResponse) SetCreationDate added in v1.12.1

func (s *BaiduChannelResponse) SetCreationDate(v string) *BaiduChannelResponse

SetCreationDate sets the CreationDate field's value.

func (*BaiduChannelResponse) SetCredential added in v1.12.1

func (s *BaiduChannelResponse) SetCredential(v string) *BaiduChannelResponse

SetCredential sets the Credential field's value.

func (*BaiduChannelResponse) SetEnabled added in v1.12.1

SetEnabled sets the Enabled field's value.

func (*BaiduChannelResponse) SetHasCredential added in v1.12.17

func (s *BaiduChannelResponse) SetHasCredential(v bool) *BaiduChannelResponse

SetHasCredential sets the HasCredential field's value.

func (*BaiduChannelResponse) SetId added in v1.12.1

SetId sets the Id field's value.

func (*BaiduChannelResponse) SetIsArchived added in v1.12.1

func (s *BaiduChannelResponse) SetIsArchived(v bool) *BaiduChannelResponse

SetIsArchived sets the IsArchived field's value.

func (*BaiduChannelResponse) SetLastModifiedBy added in v1.12.1

func (s *BaiduChannelResponse) SetLastModifiedBy(v string) *BaiduChannelResponse

SetLastModifiedBy sets the LastModifiedBy field's value.

func (*BaiduChannelResponse) SetLastModifiedDate added in v1.12.1

func (s *BaiduChannelResponse) SetLastModifiedDate(v string) *BaiduChannelResponse

SetLastModifiedDate sets the LastModifiedDate field's value.

func (*BaiduChannelResponse) SetPlatform added in v1.12.1

SetPlatform sets the Platform field's value.

func (*BaiduChannelResponse) SetVersion added in v1.12.1

SetVersion sets the Version field's value.

func (BaiduChannelResponse) String added in v1.12.1

func (s BaiduChannelResponse) String() string

String returns the string representation

type BaiduMessage added in v1.12.1

type BaiduMessage struct {

	// The action that occurs if the user taps a push notification delivered by
	// the campaign: OPEN_APP - Your app launches, or it becomes the foreground
	// app if it has been sent to the background. This is the default action. DEEP_LINK
	// - Uses deep linking features in iOS and Android to open your app and display
	// a designated user interface within the app. URL - The default mobile browser
	// on the user's device launches and opens a web page at the URL you specify.
	// Possible values include: OPEN_APP | DEEP_LINK | URL
	Action *string `type:"string" enum:"Action"`

	// The message body of the notification, the email body or the text message.
	Body *string `type:"string"`

	// The data payload used for a silent push. This payload is added to the notifications'
	// data.pinpoint.jsonBody' object
	Data map[string]*string `type:"map"`

	// The icon image name of the asset saved in your application.
	IconReference *string `type:"string"`

	// The URL that points to an image used as the large icon to the notification
	// content view.
	ImageIconUrl *string `type:"string"`

	// The URL that points to an image used in the push notification.
	ImageUrl *string `type:"string"`

	// The Raw JSON formatted string to be used as the payload. This value overrides
	// the message.
	RawContent *string `type:"string"`

	// Indicates if the message should display on the users device. Silent pushes
	// can be used for Remote Configuration and Phone Home use cases.
	SilentPush *bool `type:"boolean"`

	// The URL that points to an image used as the small icon for the notification
	// which will be used to represent the notification in the status bar and content
	// view
	SmallImageIconUrl *string `type:"string"`

	// Indicates a sound to play when the device receives the notification. Supports
	// default, or the filename of a sound resource bundled in the app. Android
	// sound files must reside in /res/raw/
	Sound *string `type:"string"`

	Substitutions map[string][]*string `type:"map"`

	// The message title that displays above the message on the user's device.
	Title *string `type:"string"`

	// The URL to open in the user's mobile browser. Used if the value for Action
	// is URL.
	Url *string `type:"string"`
	// contains filtered or unexported fields
}

Baidu Message.

func (BaiduMessage) GoString added in v1.12.1

func (s BaiduMessage) GoString() string

GoString returns the string representation

func (*BaiduMessage) SetAction added in v1.12.1

func (s *BaiduMessage) SetAction(v string) *BaiduMessage

SetAction sets the Action field's value.

func (*BaiduMessage) SetBody added in v1.12.1

func (s *BaiduMessage) SetBody(v string) *BaiduMessage

SetBody sets the Body field's value.

func (*BaiduMessage) SetData added in v1.12.1

func (s *BaiduMessage) SetData(v map[string]*string) *BaiduMessage

SetData sets the Data field's value.

func (*BaiduMessage) SetIconReference added in v1.12.1

func (s *BaiduMessage) SetIconReference(v string) *BaiduMessage

SetIconReference sets the IconReference field's value.

func (*BaiduMessage) SetImageIconUrl added in v1.12.1

func (s *BaiduMessage) SetImageIconUrl(v string) *BaiduMessage

SetImageIconUrl sets the ImageIconUrl field's value.

func (*BaiduMessage) SetImageUrl added in v1.12.1

func (s *BaiduMessage) SetImageUrl(v string) *BaiduMessage

SetImageUrl sets the ImageUrl field's value.

func (*BaiduMessage) SetRawContent added in v1.12.1

func (s *BaiduMessage) SetRawContent(v string) *BaiduMessage

SetRawContent sets the RawContent field's value.

func (*BaiduMessage) SetSilentPush added in v1.12.1

func (s *BaiduMessage) SetSilentPush(v bool) *BaiduMessage

SetSilentPush sets the SilentPush field's value.

func (*BaiduMessage) SetSmallImageIconUrl added in v1.12.1

func (s *BaiduMessage) SetSmallImageIconUrl(v string) *BaiduMessage

SetSmallImageIconUrl sets the SmallImageIconUrl field's value.

func (*BaiduMessage) SetSound added in v1.12.1

func (s *BaiduMessage) SetSound(v string) *BaiduMessage

SetSound sets the Sound field's value.

func (*BaiduMessage) SetSubstitutions added in v1.12.1

func (s *BaiduMessage) SetSubstitutions(v map[string][]*string) *BaiduMessage

SetSubstitutions sets the Substitutions field's value.

func (*BaiduMessage) SetTitle added in v1.12.1

func (s *BaiduMessage) SetTitle(v string) *BaiduMessage

SetTitle sets the Title field's value.

func (*BaiduMessage) SetUrl added in v1.12.1

func (s *BaiduMessage) SetUrl(v string) *BaiduMessage

SetUrl sets the Url field's value.

func (BaiduMessage) String added in v1.12.1

func (s BaiduMessage) String() string

String returns the string representation

type CampaignEmailMessage added in v1.8.38

type CampaignEmailMessage struct {

	// The email text body.
	Body *string `type:"string"`

	// The email address used to send the email from. Defaults to use FromAddress
	// specified in the Email Channel.
	FromAddress *string `type:"string"`

	// The email html body.
	HtmlBody *string `type:"string"`

	// The email title (Or subject).
	Title *string `type:"string"`
	// contains filtered or unexported fields
}

The email message configuration.

func (CampaignEmailMessage) GoString added in v1.8.38

func (s CampaignEmailMessage) GoString() string

GoString returns the string representation

func (*CampaignEmailMessage) SetBody added in v1.8.38

SetBody sets the Body field's value.

func (*CampaignEmailMessage) SetFromAddress added in v1.10.20

func (s *CampaignEmailMessage) SetFromAddress(v string) *CampaignEmailMessage

SetFromAddress sets the FromAddress field's value.

func (*CampaignEmailMessage) SetHtmlBody added in v1.8.38

SetHtmlBody sets the HtmlBody field's value.

func (*CampaignEmailMessage) SetTitle added in v1.8.38

SetTitle sets the Title field's value.

func (CampaignEmailMessage) String added in v1.8.38

func (s CampaignEmailMessage) String() string

String returns the string representation

type CampaignHook added in v1.13.11

type CampaignHook struct {

	// Lambda function name or arn to be called for delivery
	LambdaFunctionName *string `type:"string"`

	// What mode Lambda should be invoked in.
	Mode *string `type:"string" enum:"Mode"`

	// Web URL to call for hook. If the URL has authentication specified it will
	// be added as authentication to the request
	WebUrl *string `type:"string"`
	// contains filtered or unexported fields
}

func (CampaignHook) GoString added in v1.13.11

func (s CampaignHook) GoString() string

GoString returns the string representation

func (*CampaignHook) SetLambdaFunctionName added in v1.13.11

func (s *CampaignHook) SetLambdaFunctionName(v string) *CampaignHook

SetLambdaFunctionName sets the LambdaFunctionName field's value.

func (*CampaignHook) SetMode added in v1.13.11

func (s *CampaignHook) SetMode(v string) *CampaignHook

SetMode sets the Mode field's value.

func (*CampaignHook) SetWebUrl added in v1.13.11

func (s *CampaignHook) SetWebUrl(v string) *CampaignHook

SetWebUrl sets the WebUrl field's value.

func (CampaignHook) String added in v1.13.11

func (s CampaignHook) String() string

String returns the string representation

type CampaignLimits

type CampaignLimits struct {

	// The maximum number of messages that the campaign can send daily.
	Daily *int64 `type:"integer"`

	// The length of time (in seconds) that the campaign can run before it ends
	// and message deliveries stop. This duration begins at the scheduled start
	// time for the campaign. The minimum value is 60.
	MaximumDuration *int64 `type:"integer"`

	// The number of messages that the campaign can send per second. The minimum
	// value is 50, and the maximum is 20000.
	MessagesPerSecond *int64 `type:"integer"`

	// The maximum total number of messages that the campaign can send.
	Total *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Campaign Limits are used to limit the number of messages that can be sent to a user.

func (CampaignLimits) GoString

func (s CampaignLimits) GoString() string

GoString returns the string representation

func (*CampaignLimits) SetDaily

func (s *CampaignLimits) SetDaily(v int64) *CampaignLimits

SetDaily sets the Daily field's value.

func (*CampaignLimits) SetMaximumDuration added in v1.12.1

func (s *CampaignLimits) SetMaximumDuration(v int64) *CampaignLimits

SetMaximumDuration sets the MaximumDuration field's value.

func (*CampaignLimits) SetMessagesPerSecond added in v1.12.1

func (s *CampaignLimits) SetMessagesPerSecond(v int64) *CampaignLimits

SetMessagesPerSecond sets the MessagesPerSecond field's value.

func (*CampaignLimits) SetTotal

func (s *CampaignLimits) SetTotal(v int64) *CampaignLimits

SetTotal sets the Total field's value.

func (CampaignLimits) String

func (s CampaignLimits) String() string

String returns the string representation

type CampaignResponse

type CampaignResponse struct {

	// Treatments that are defined in addition to the default treatment.
	AdditionalTreatments []*TreatmentResource `type:"list"`

	// The ID of the application to which the campaign applies.
	ApplicationId *string `type:"string"`

	// The date the campaign was created in ISO 8601 format.
	CreationDate *string `type:"string"`

	// The status of the campaign's default treatment. Only present for A/B test
	// campaigns.
	DefaultState *CampaignState `type:"structure"`

	// A description of the campaign.
	Description *string `type:"string"`

	// The allocated percentage of end users who will not receive messages from
	// this campaign.
	HoldoutPercent *int64 `type:"integer"`

	// Campaign hook information.
	Hook *CampaignHook `type:"structure"`

	// The unique campaign ID.
	Id *string `type:"string"`

	// Indicates whether the campaign is paused. A paused campaign does not send
	// messages unless you resume it by setting IsPaused to false.
	IsPaused *bool `type:"boolean"`

	// The date the campaign was last updated in ISO 8601 format.
	LastModifiedDate *string `type:"string"`

	// The campaign limits settings.
	Limits *CampaignLimits `type:"structure"`

	// The message configuration settings.
	MessageConfiguration *MessageConfiguration `type:"structure"`

	// The custom name of the campaign.
	Name *string `type:"string"`

	// The campaign schedule.
	Schedule *Schedule `type:"structure"`

	// The ID of the segment to which the campaign sends messages.
	SegmentId *string `type:"string"`

	// The version of the segment to which the campaign sends messages.
	SegmentVersion *int64 `type:"integer"`

	// The campaign status.An A/B test campaign will have a status of COMPLETED
	// only when all treatments have a status of COMPLETED.
	State *CampaignState `type:"structure"`

	// A custom description for the treatment.
	TreatmentDescription *string `type:"string"`

	// The custom name of a variation of the campaign used for A/B testing.
	TreatmentName *string `type:"string"`

	// The campaign version number.
	Version *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Campaign definition

func (CampaignResponse) GoString

func (s CampaignResponse) GoString() string

GoString returns the string representation

func (*CampaignResponse) SetAdditionalTreatments

func (s *CampaignResponse) SetAdditionalTreatments(v []*TreatmentResource) *CampaignResponse

SetAdditionalTreatments sets the AdditionalTreatments field's value.

func (*CampaignResponse) SetApplicationId

func (s *CampaignResponse) SetApplicationId(v string) *CampaignResponse

SetApplicationId sets the ApplicationId field's value.

func (*CampaignResponse) SetCreationDate

func (s *CampaignResponse) SetCreationDate(v string) *CampaignResponse

SetCreationDate sets the CreationDate field's value.

func (*CampaignResponse) SetDefaultState

func (s *CampaignResponse) SetDefaultState(v *CampaignState) *CampaignResponse

SetDefaultState sets the DefaultState field's value.

func (*CampaignResponse) SetDescription

func (s *CampaignResponse) SetDescription(v string) *CampaignResponse

SetDescription sets the Description field's value.

func (*CampaignResponse) SetHoldoutPercent

func (s *CampaignResponse) SetHoldoutPercent(v int64) *CampaignResponse

SetHoldoutPercent sets the HoldoutPercent field's value.

func (*CampaignResponse) SetHook added in v1.13.11

SetHook sets the Hook field's value.

func (*CampaignResponse) SetId

SetId sets the Id field's value.

func (*CampaignResponse) SetIsPaused

func (s *CampaignResponse) SetIsPaused(v bool) *CampaignResponse

SetIsPaused sets the IsPaused field's value.

func (*CampaignResponse) SetLastModifiedDate

func (s *CampaignResponse) SetLastModifiedDate(v string) *CampaignResponse

SetLastModifiedDate sets the LastModifiedDate field's value.

func (*CampaignResponse) SetLimits

SetLimits sets the Limits field's value.

func (*CampaignResponse) SetMessageConfiguration

func (s *CampaignResponse) SetMessageConfiguration(v *MessageConfiguration) *CampaignResponse

SetMessageConfiguration sets the MessageConfiguration field's value.

func (*CampaignResponse) SetName

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

SetName sets the Name field's value.

func (*CampaignResponse) SetSchedule

func (s *CampaignResponse) SetSchedule(v *Schedule) *CampaignResponse

SetSchedule sets the Schedule field's value.

func (*CampaignResponse) SetSegmentId

func (s *CampaignResponse) SetSegmentId(v string) *CampaignResponse

SetSegmentId sets the SegmentId field's value.

func (*CampaignResponse) SetSegmentVersion

func (s *CampaignResponse) SetSegmentVersion(v int64) *CampaignResponse

SetSegmentVersion sets the SegmentVersion field's value.

func (*CampaignResponse) SetState

SetState sets the State field's value.

func (*CampaignResponse) SetTreatmentDescription

func (s *CampaignResponse) SetTreatmentDescription(v string) *CampaignResponse

SetTreatmentDescription sets the TreatmentDescription field's value.

func (*CampaignResponse) SetTreatmentName

func (s *CampaignResponse) SetTreatmentName(v string) *CampaignResponse

SetTreatmentName sets the TreatmentName field's value.

func (*CampaignResponse) SetVersion

func (s *CampaignResponse) SetVersion(v int64) *CampaignResponse

SetVersion sets the Version field's value.

func (CampaignResponse) String

func (s CampaignResponse) String() string

String returns the string representation

type CampaignSmsMessage added in v1.8.38

type CampaignSmsMessage struct {

	// The SMS text body.
	Body *string `type:"string"`

	// Is this is a transactional SMS message, otherwise a promotional message.
	MessageType *string `type:"string" enum:"MessageType"`

	// Sender ID of sent message.
	SenderId *string `type:"string"`
	// contains filtered or unexported fields
}

SMS message configuration.

func (CampaignSmsMessage) GoString added in v1.8.38

func (s CampaignSmsMessage) GoString() string

GoString returns the string representation

func (*CampaignSmsMessage) SetBody added in v1.8.38

SetBody sets the Body field's value.

func (*CampaignSmsMessage) SetMessageType added in v1.8.38

func (s *CampaignSmsMessage) SetMessageType(v string) *CampaignSmsMessage

SetMessageType sets the MessageType field's value.

func (*CampaignSmsMessage) SetSenderId added in v1.8.38

func (s *CampaignSmsMessage) SetSenderId(v string) *CampaignSmsMessage

SetSenderId sets the SenderId field's value.

func (CampaignSmsMessage) String added in v1.8.38

func (s CampaignSmsMessage) String() string

String returns the string representation

type CampaignState

type CampaignState struct {

	// The status of the campaign, or the status of a treatment that belongs to
	// an A/B test campaign.Valid values: SCHEDULED, EXECUTING, PENDING_NEXT_RUN,
	// COMPLETED, PAUSED
	CampaignStatus *string `type:"string" enum:"CampaignStatus"`
	// contains filtered or unexported fields
}

State of the Campaign

func (CampaignState) GoString

func (s CampaignState) GoString() string

GoString returns the string representation

func (*CampaignState) SetCampaignStatus

func (s *CampaignState) SetCampaignStatus(v string) *CampaignState

SetCampaignStatus sets the CampaignStatus field's value.

func (CampaignState) String

func (s CampaignState) String() string

String returns the string representation

type CampaignsResponse

type CampaignsResponse struct {

	// A list of campaigns.
	Item []*CampaignResponse `type:"list"`

	// The string that you use in a subsequent request to get the next page of results
	// in a paginated response.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

List of available campaigns.

func (CampaignsResponse) GoString

func (s CampaignsResponse) GoString() string

GoString returns the string representation

func (*CampaignsResponse) SetItem

SetItem sets the Item field's value.

func (*CampaignsResponse) SetNextToken

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

SetNextToken sets the NextToken field's value.

func (CampaignsResponse) String

func (s CampaignsResponse) String() string

String returns the string representation

type CreateAppInput added in v1.10.20

type CreateAppInput struct {

	// Application Request.
	//
	// CreateApplicationRequest is a required field
	CreateApplicationRequest *CreateApplicationRequest `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (CreateAppInput) GoString added in v1.10.20

func (s CreateAppInput) GoString() string

GoString returns the string representation

func (*CreateAppInput) SetCreateApplicationRequest added in v1.10.20

func (s *CreateAppInput) SetCreateApplicationRequest(v *CreateApplicationRequest) *CreateAppInput

SetCreateApplicationRequest sets the CreateApplicationRequest field's value.

func (CreateAppInput) String added in v1.10.20

func (s CreateAppInput) String() string

String returns the string representation

func (*CreateAppInput) Validate added in v1.10.20

func (s *CreateAppInput) Validate() error

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

type CreateAppOutput added in v1.10.20

type CreateAppOutput struct {

	// Application Response.
	//
	// ApplicationResponse is a required field
	ApplicationResponse *ApplicationResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (CreateAppOutput) GoString added in v1.10.20

func (s CreateAppOutput) GoString() string

GoString returns the string representation

func (*CreateAppOutput) SetApplicationResponse added in v1.10.20

func (s *CreateAppOutput) SetApplicationResponse(v *ApplicationResponse) *CreateAppOutput

SetApplicationResponse sets the ApplicationResponse field's value.

func (CreateAppOutput) String added in v1.10.20

func (s CreateAppOutput) String() string

String returns the string representation

type CreateApplicationRequest added in v1.10.20

type CreateApplicationRequest struct {

	// The display name of the application. Used in the Amazon Pinpoint console.
	Name *string `type:"string"`
	// contains filtered or unexported fields
}

Application Request.

func (CreateApplicationRequest) GoString added in v1.10.20

func (s CreateApplicationRequest) GoString() string

GoString returns the string representation

func (*CreateApplicationRequest) SetName added in v1.10.20

SetName sets the Name field's value.

func (CreateApplicationRequest) String added in v1.10.20

func (s CreateApplicationRequest) String() string

String returns the string representation

type CreateCampaignInput

type CreateCampaignInput struct {

	// ApplicationId is a required field
	ApplicationId *string `location:"uri" locationName:"application-id" type:"string" required:"true"`

	// Used to create a campaign.
	//
	// WriteCampaignRequest is a required field
	WriteCampaignRequest *WriteCampaignRequest `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (CreateCampaignInput) GoString

func (s CreateCampaignInput) GoString() string

GoString returns the string representation

func (*CreateCampaignInput) SetApplicationId

func (s *CreateCampaignInput) SetApplicationId(v string) *CreateCampaignInput

SetApplicationId sets the ApplicationId field's value.

func (*CreateCampaignInput) SetWriteCampaignRequest

func (s *CreateCampaignInput) SetWriteCampaignRequest(v *WriteCampaignRequest) *CreateCampaignInput

SetWriteCampaignRequest sets the WriteCampaignRequest field's value.

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 {

	// Campaign definition
	//
	// CampaignResponse is a required field
	CampaignResponse *CampaignResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (CreateCampaignOutput) GoString

func (s CreateCampaignOutput) GoString() string

GoString returns the string representation

func (*CreateCampaignOutput) SetCampaignResponse

func (s *CreateCampaignOutput) SetCampaignResponse(v *CampaignResponse) *CreateCampaignOutput

SetCampaignResponse sets the CampaignResponse field's value.

func (CreateCampaignOutput) String

func (s CreateCampaignOutput) String() string

String returns the string representation

type CreateExportJobInput added in v1.13.11

type CreateExportJobInput struct {

	// ApplicationId is a required field
	ApplicationId *string `location:"uri" locationName:"application-id" type:"string" required:"true"`

	// ExportJobRequest is a required field
	ExportJobRequest *ExportJobRequest `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (CreateExportJobInput) GoString added in v1.13.11

func (s CreateExportJobInput) GoString() string

GoString returns the string representation

func (*CreateExportJobInput) SetApplicationId added in v1.13.11

func (s *CreateExportJobInput) SetApplicationId(v string) *CreateExportJobInput

SetApplicationId sets the ApplicationId field's value.

func (*CreateExportJobInput) SetExportJobRequest added in v1.13.11

func (s *CreateExportJobInput) SetExportJobRequest(v *ExportJobRequest) *CreateExportJobInput

SetExportJobRequest sets the ExportJobRequest field's value.

func (CreateExportJobInput) String added in v1.13.11

func (s CreateExportJobInput) String() string

String returns the string representation

func (*CreateExportJobInput) Validate added in v1.13.11

func (s *CreateExportJobInput) Validate() error

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

type CreateExportJobOutput added in v1.13.11

type CreateExportJobOutput struct {

	// ExportJobResponse is a required field
	ExportJobResponse *ExportJobResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (CreateExportJobOutput) GoString added in v1.13.11

func (s CreateExportJobOutput) GoString() string

GoString returns the string representation

func (*CreateExportJobOutput) SetExportJobResponse added in v1.13.11

func (s *CreateExportJobOutput) SetExportJobResponse(v *ExportJobResponse) *CreateExportJobOutput

SetExportJobResponse sets the ExportJobResponse field's value.

func (CreateExportJobOutput) String added in v1.13.11

func (s CreateExportJobOutput) String() string

String returns the string representation

type CreateImportJobInput

type CreateImportJobInput struct {

	// ApplicationId is a required field
	ApplicationId *string `location:"uri" locationName:"application-id" type:"string" required:"true"`

	// ImportJobRequest is a required field
	ImportJobRequest *ImportJobRequest `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (CreateImportJobInput) GoString

func (s CreateImportJobInput) GoString() string

GoString returns the string representation

func (*CreateImportJobInput) SetApplicationId

func (s *CreateImportJobInput) SetApplicationId(v string) *CreateImportJobInput

SetApplicationId sets the ApplicationId field's value.

func (*CreateImportJobInput) SetImportJobRequest

func (s *CreateImportJobInput) SetImportJobRequest(v *ImportJobRequest) *CreateImportJobInput

SetImportJobRequest sets the ImportJobRequest field's value.

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 {

	// ImportJobResponse is a required field
	ImportJobResponse *ImportJobResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (CreateImportJobOutput) GoString

func (s CreateImportJobOutput) GoString() string

GoString returns the string representation

func (*CreateImportJobOutput) SetImportJobResponse

func (s *CreateImportJobOutput) SetImportJobResponse(v *ImportJobResponse) *CreateImportJobOutput

SetImportJobResponse sets the ImportJobResponse field's value.

func (CreateImportJobOutput) String

func (s CreateImportJobOutput) String() string

String returns the string representation

type CreateSegmentInput

type CreateSegmentInput struct {

	// ApplicationId is a required field
	ApplicationId *string `location:"uri" locationName:"application-id" type:"string" required:"true"`

	// Segment definition.
	//
	// WriteSegmentRequest is a required field
	WriteSegmentRequest *WriteSegmentRequest `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (CreateSegmentInput) GoString

func (s CreateSegmentInput) GoString() string

GoString returns the string representation

func (*CreateSegmentInput) SetApplicationId

func (s *CreateSegmentInput) SetApplicationId(v string) *CreateSegmentInput

SetApplicationId sets the ApplicationId field's value.

func (*CreateSegmentInput) SetWriteSegmentRequest

func (s *CreateSegmentInput) SetWriteSegmentRequest(v *WriteSegmentRequest) *CreateSegmentInput

SetWriteSegmentRequest sets the WriteSegmentRequest field's value.

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 {

	// Segment definition.
	//
	// SegmentResponse is a required field
	SegmentResponse *SegmentResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (CreateSegmentOutput) GoString

func (s CreateSegmentOutput) GoString() string

GoString returns the string representation

func (*CreateSegmentOutput) SetSegmentResponse

func (s *CreateSegmentOutput) SetSegmentResponse(v *SegmentResponse) *CreateSegmentOutput

SetSegmentResponse sets the SegmentResponse field's value.

func (CreateSegmentOutput) String

func (s CreateSegmentOutput) String() string

String returns the string representation

type DefaultMessage added in v1.8.38

type DefaultMessage struct {

	// The message body of the notification, the email body or the text message.
	Body *string `type:"string"`

	Substitutions map[string][]*string `type:"map"`
	// contains filtered or unexported fields
}

Default Message across push notification, email, and sms.

func (DefaultMessage) GoString added in v1.8.38

func (s DefaultMessage) GoString() string

GoString returns the string representation

func (*DefaultMessage) SetBody added in v1.8.38

func (s *DefaultMessage) SetBody(v string) *DefaultMessage

SetBody sets the Body field's value.

func (*DefaultMessage) SetSubstitutions added in v1.8.38

func (s *DefaultMessage) SetSubstitutions(v map[string][]*string) *DefaultMessage

SetSubstitutions sets the Substitutions field's value.

func (DefaultMessage) String added in v1.8.38

func (s DefaultMessage) String() string

String returns the string representation

type DefaultPushNotificationMessage added in v1.8.38

type DefaultPushNotificationMessage struct {

	// The action that occurs if the user taps a push notification delivered by
	// the campaign: OPEN_APP - Your app launches, or it becomes the foreground
	// app if it has been sent to the background. This is the default action. DEEP_LINK
	// - Uses deep linking features in iOS and Android to open your app and display
	// a designated user interface within the app. URL - The default mobile browser
	// on the user's device launches and opens a web page at the URL you specify.
	// Possible values include: OPEN_APP | DEEP_LINK | URL
	Action *string `type:"string" enum:"Action"`

	// The message body of the notification, the email body or the text message.
	Body *string `type:"string"`

	// The data payload used for a silent push. This payload is added to the notifications'
	// data.pinpoint.jsonBody' object
	Data map[string]*string `type:"map"`

	// Indicates if the message should display on the users device. Silent pushes
	// can be used for Remote Configuration and Phone Home use cases.
	SilentPush *bool `type:"boolean"`

	Substitutions map[string][]*string `type:"map"`

	// The message title that displays above the message on the user's device.
	Title *string `type:"string"`

	// The URL to open in the user's mobile browser. Used if the value for Action
	// is URL.
	Url *string `type:"string"`
	// contains filtered or unexported fields
}

Default Push Notification Message.

func (DefaultPushNotificationMessage) GoString added in v1.8.38

GoString returns the string representation

func (*DefaultPushNotificationMessage) SetAction added in v1.8.38

SetAction sets the Action field's value.

func (*DefaultPushNotificationMessage) SetBody added in v1.8.38

SetBody sets the Body field's value.

func (*DefaultPushNotificationMessage) SetData added in v1.8.38

SetData sets the Data field's value.

func (*DefaultPushNotificationMessage) SetSilentPush added in v1.8.38

SetSilentPush sets the SilentPush field's value.

func (*DefaultPushNotificationMessage) SetSubstitutions added in v1.8.38

SetSubstitutions sets the Substitutions field's value.

func (*DefaultPushNotificationMessage) SetTitle added in v1.8.38

SetTitle sets the Title field's value.

func (*DefaultPushNotificationMessage) SetUrl added in v1.8.38

SetUrl sets the Url field's value.

func (DefaultPushNotificationMessage) String added in v1.8.38

String returns the string representation

type DeleteAdmChannelInput added in v1.12.1

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) GoString added in v1.12.1

func (s DeleteAdmChannelInput) GoString() string

GoString returns the string representation

func (*DeleteAdmChannelInput) SetApplicationId added in v1.12.1

func (s *DeleteAdmChannelInput) SetApplicationId(v string) *DeleteAdmChannelInput

SetApplicationId sets the ApplicationId field's value.

func (DeleteAdmChannelInput) String added in v1.12.1

func (s DeleteAdmChannelInput) String() string

String returns the string representation

func (*DeleteAdmChannelInput) Validate added in v1.12.1

func (s *DeleteAdmChannelInput) Validate() error

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

type DeleteAdmChannelOutput added in v1.12.1

type DeleteAdmChannelOutput struct {

	// Amazon Device Messaging channel definition.
	//
	// ADMChannelResponse is a required field
	ADMChannelResponse *ADMChannelResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteAdmChannelOutput) GoString added in v1.12.1

func (s DeleteAdmChannelOutput) GoString() string

GoString returns the string representation

func (*DeleteAdmChannelOutput) SetADMChannelResponse added in v1.12.1

SetADMChannelResponse sets the ADMChannelResponse field's value.

func (DeleteAdmChannelOutput) String added in v1.12.1

func (s DeleteAdmChannelOutput) String() string

String returns the string representation

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) GoString

func (s DeleteApnsChannelInput) GoString() string

GoString returns the string representation

func (*DeleteApnsChannelInput) SetApplicationId

func (s *DeleteApnsChannelInput) SetApplicationId(v string) *DeleteApnsChannelInput

SetApplicationId sets the ApplicationId field's value.

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 {

	// Apple Distribution Push Notification Service channel definition.
	//
	// APNSChannelResponse is a required field
	APNSChannelResponse *APNSChannelResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteApnsChannelOutput) GoString

func (s DeleteApnsChannelOutput) GoString() string

GoString returns the string representation

func (*DeleteApnsChannelOutput) SetAPNSChannelResponse

SetAPNSChannelResponse sets the APNSChannelResponse field's value.

func (DeleteApnsChannelOutput) String

func (s DeleteApnsChannelOutput) String() string

String returns the string representation

type DeleteApnsSandboxChannelInput added in v1.8.38

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) GoString added in v1.8.38

GoString returns the string representation

func (*DeleteApnsSandboxChannelInput) SetApplicationId added in v1.8.38

SetApplicationId sets the ApplicationId field's value.

func (DeleteApnsSandboxChannelInput) String added in v1.8.38

String returns the string representation

func (*DeleteApnsSandboxChannelInput) Validate added in v1.8.38

func (s *DeleteApnsSandboxChannelInput) Validate() error

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

type DeleteApnsSandboxChannelOutput added in v1.8.38

type DeleteApnsSandboxChannelOutput struct {

	// Apple Development Push Notification Service channel definition.
	//
	// APNSSandboxChannelResponse is a required field
	APNSSandboxChannelResponse *APNSSandboxChannelResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteApnsSandboxChannelOutput) GoString added in v1.8.38

GoString returns the string representation

func (*DeleteApnsSandboxChannelOutput) SetAPNSSandboxChannelResponse added in v1.8.38

SetAPNSSandboxChannelResponse sets the APNSSandboxChannelResponse field's value.

func (DeleteApnsSandboxChannelOutput) String added in v1.8.38

String returns the string representation

type DeleteApnsVoipChannelInput added in v1.12.17

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) GoString added in v1.12.17

func (s DeleteApnsVoipChannelInput) GoString() string

GoString returns the string representation

func (*DeleteApnsVoipChannelInput) SetApplicationId added in v1.12.17

SetApplicationId sets the ApplicationId field's value.

func (DeleteApnsVoipChannelInput) String added in v1.12.17

String returns the string representation

func (*DeleteApnsVoipChannelInput) Validate added in v1.12.17

func (s *DeleteApnsVoipChannelInput) Validate() error

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

type DeleteApnsVoipChannelOutput added in v1.12.17

type DeleteApnsVoipChannelOutput struct {

	// Apple VoIP Push Notification Service channel definition.
	//
	// APNSVoipChannelResponse is a required field
	APNSVoipChannelResponse *APNSVoipChannelResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteApnsVoipChannelOutput) GoString added in v1.12.17

func (s DeleteApnsVoipChannelOutput) GoString() string

GoString returns the string representation

func (*DeleteApnsVoipChannelOutput) SetAPNSVoipChannelResponse added in v1.12.17

SetAPNSVoipChannelResponse sets the APNSVoipChannelResponse field's value.

func (DeleteApnsVoipChannelOutput) String added in v1.12.17

String returns the string representation

type DeleteApnsVoipSandboxChannelInput added in v1.12.17

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) GoString added in v1.12.17

GoString returns the string representation

func (*DeleteApnsVoipSandboxChannelInput) SetApplicationId added in v1.12.17

SetApplicationId sets the ApplicationId field's value.

func (DeleteApnsVoipSandboxChannelInput) String added in v1.12.17

String returns the string representation

func (*DeleteApnsVoipSandboxChannelInput) Validate added in v1.12.17

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

type DeleteApnsVoipSandboxChannelOutput added in v1.12.17

type DeleteApnsVoipSandboxChannelOutput struct {

	// Apple VoIP Developer Push Notification Service channel definition.
	//
	// APNSVoipSandboxChannelResponse is a required field
	APNSVoipSandboxChannelResponse *APNSVoipSandboxChannelResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteApnsVoipSandboxChannelOutput) GoString added in v1.12.17

GoString returns the string representation

func (*DeleteApnsVoipSandboxChannelOutput) SetAPNSVoipSandboxChannelResponse added in v1.12.17

SetAPNSVoipSandboxChannelResponse sets the APNSVoipSandboxChannelResponse field's value.

func (DeleteApnsVoipSandboxChannelOutput) String added in v1.12.17

String returns the string representation

type DeleteAppInput added in v1.10.20

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) GoString added in v1.10.20

func (s DeleteAppInput) GoString() string

GoString returns the string representation

func (*DeleteAppInput) SetApplicationId added in v1.10.20

func (s *DeleteAppInput) SetApplicationId(v string) *DeleteAppInput

SetApplicationId sets the ApplicationId field's value.

func (DeleteAppInput) String added in v1.10.20

func (s DeleteAppInput) String() string

String returns the string representation

func (*DeleteAppInput) Validate added in v1.10.20

func (s *DeleteAppInput) Validate() error

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

type DeleteAppOutput added in v1.10.20

type DeleteAppOutput struct {

	// Application Response.
	//
	// ApplicationResponse is a required field
	ApplicationResponse *ApplicationResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteAppOutput) GoString added in v1.10.20

func (s DeleteAppOutput) GoString() string

GoString returns the string representation

func (*DeleteAppOutput) SetApplicationResponse added in v1.10.20

func (s *DeleteAppOutput) SetApplicationResponse(v *ApplicationResponse) *DeleteAppOutput

SetApplicationResponse sets the ApplicationResponse field's value.

func (DeleteAppOutput) String added in v1.10.20

func (s DeleteAppOutput) String() string

String returns the string representation

type DeleteBaiduChannelInput added in v1.12.1

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) GoString added in v1.12.1

func (s DeleteBaiduChannelInput) GoString() string

GoString returns the string representation

func (*DeleteBaiduChannelInput) SetApplicationId added in v1.12.1

func (s *DeleteBaiduChannelInput) SetApplicationId(v string) *DeleteBaiduChannelInput

SetApplicationId sets the ApplicationId field's value.

func (DeleteBaiduChannelInput) String added in v1.12.1

func (s DeleteBaiduChannelInput) String() string

String returns the string representation

func (*DeleteBaiduChannelInput) Validate added in v1.12.1

func (s *DeleteBaiduChannelInput) Validate() error

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

type DeleteBaiduChannelOutput added in v1.12.1

type DeleteBaiduChannelOutput struct {

	// Baidu Cloud Messaging channel definition
	//
	// BaiduChannelResponse is a required field
	BaiduChannelResponse *BaiduChannelResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteBaiduChannelOutput) GoString added in v1.12.1

func (s DeleteBaiduChannelOutput) GoString() string

GoString returns the string representation

func (*DeleteBaiduChannelOutput) SetBaiduChannelResponse added in v1.12.1

SetBaiduChannelResponse sets the BaiduChannelResponse field's value.

func (DeleteBaiduChannelOutput) String added in v1.12.1

func (s DeleteBaiduChannelOutput) String() string

String returns the string representation

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) GoString

func (s DeleteCampaignInput) GoString() string

GoString returns the string representation

func (*DeleteCampaignInput) SetApplicationId

func (s *DeleteCampaignInput) SetApplicationId(v string) *DeleteCampaignInput

SetApplicationId sets the ApplicationId field's value.

func (*DeleteCampaignInput) SetCampaignId

func (s *DeleteCampaignInput) SetCampaignId(v string) *DeleteCampaignInput

SetCampaignId sets the CampaignId field's value.

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 {

	// Campaign definition
	//
	// CampaignResponse is a required field
	CampaignResponse *CampaignResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteCampaignOutput) GoString

func (s DeleteCampaignOutput) GoString() string

GoString returns the string representation

func (*DeleteCampaignOutput) SetCampaignResponse

func (s *DeleteCampaignOutput) SetCampaignResponse(v *CampaignResponse) *DeleteCampaignOutput

SetCampaignResponse sets the CampaignResponse field's value.

func (DeleteCampaignOutput) String

func (s DeleteCampaignOutput) String() string

String returns the string representation

type DeleteEmailChannelInput added in v1.8.38

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) GoString added in v1.8.38

func (s DeleteEmailChannelInput) GoString() string

GoString returns the string representation

func (*DeleteEmailChannelInput) SetApplicationId added in v1.8.38

func (s *DeleteEmailChannelInput) SetApplicationId(v string) *DeleteEmailChannelInput

SetApplicationId sets the ApplicationId field's value.

func (DeleteEmailChannelInput) String added in v1.8.38

func (s DeleteEmailChannelInput) String() string

String returns the string representation

func (*DeleteEmailChannelInput) Validate added in v1.8.38

func (s *DeleteEmailChannelInput) Validate() error

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

type DeleteEmailChannelOutput added in v1.8.38

type DeleteEmailChannelOutput struct {

	// Email Channel Response.
	//
	// EmailChannelResponse is a required field
	EmailChannelResponse *EmailChannelResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteEmailChannelOutput) GoString added in v1.8.38

func (s DeleteEmailChannelOutput) GoString() string

GoString returns the string representation

func (*DeleteEmailChannelOutput) SetEmailChannelResponse added in v1.8.38

SetEmailChannelResponse sets the EmailChannelResponse field's value.

func (DeleteEmailChannelOutput) String added in v1.8.38

func (s DeleteEmailChannelOutput) String() string

String returns the string representation

type DeleteEndpointInput added in v1.13.15

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) GoString added in v1.13.15

func (s DeleteEndpointInput) GoString() string

GoString returns the string representation

func (*DeleteEndpointInput) SetApplicationId added in v1.13.15

func (s *DeleteEndpointInput) SetApplicationId(v string) *DeleteEndpointInput

SetApplicationId sets the ApplicationId field's value.

func (*DeleteEndpointInput) SetEndpointId added in v1.13.15

func (s *DeleteEndpointInput) SetEndpointId(v string) *DeleteEndpointInput

SetEndpointId sets the EndpointId field's value.

func (DeleteEndpointInput) String added in v1.13.15

func (s DeleteEndpointInput) String() string

String returns the string representation

func (*DeleteEndpointInput) Validate added in v1.13.15

func (s *DeleteEndpointInput) Validate() error

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

type DeleteEndpointOutput added in v1.13.15

type DeleteEndpointOutput struct {

	// Endpoint response
	//
	// EndpointResponse is a required field
	EndpointResponse *EndpointResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteEndpointOutput) GoString added in v1.13.15

func (s DeleteEndpointOutput) GoString() string

GoString returns the string representation

func (*DeleteEndpointOutput) SetEndpointResponse added in v1.13.15

func (s *DeleteEndpointOutput) SetEndpointResponse(v *EndpointResponse) *DeleteEndpointOutput

SetEndpointResponse sets the EndpointResponse field's value.

func (DeleteEndpointOutput) String added in v1.13.15

func (s DeleteEndpointOutput) String() string

String returns the string representation

type DeleteEventStreamInput added in v1.8.0

type DeleteEventStreamInput struct {

	// Application Id.
	//
	// ApplicationId is a required field
	ApplicationId *string `location:"uri" locationName:"application-id" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteEventStreamInput) GoString added in v1.8.0

func (s DeleteEventStreamInput) GoString() string

GoString returns the string representation

func (*DeleteEventStreamInput) SetApplicationId added in v1.8.0

func (s *DeleteEventStreamInput) SetApplicationId(v string) *DeleteEventStreamInput

SetApplicationId sets the ApplicationId field's value.

func (DeleteEventStreamInput) String added in v1.8.0

func (s DeleteEventStreamInput) String() string

String returns the string representation

func (*DeleteEventStreamInput) Validate added in v1.8.0

func (s *DeleteEventStreamInput) Validate() error

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

type DeleteEventStreamOutput added in v1.8.0

type DeleteEventStreamOutput struct {

	// Model for an event publishing subscription export.
	//
	// EventStream is a required field
	EventStream *EventStream `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteEventStreamOutput) GoString added in v1.8.0

func (s DeleteEventStreamOutput) GoString() string

GoString returns the string representation

func (*DeleteEventStreamOutput) SetEventStream added in v1.8.0

SetEventStream sets the EventStream field's value.

func (DeleteEventStreamOutput) String added in v1.8.0

func (s DeleteEventStreamOutput) String() string

String returns the string representation

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) GoString

func (s DeleteGcmChannelInput) GoString() string

GoString returns the string representation

func (*DeleteGcmChannelInput) SetApplicationId

func (s *DeleteGcmChannelInput) SetApplicationId(v string) *DeleteGcmChannelInput

SetApplicationId sets the ApplicationId field's value.

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 {

	// Google Cloud Messaging channel definition
	//
	// GCMChannelResponse is a required field
	GCMChannelResponse *GCMChannelResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteGcmChannelOutput) GoString

func (s DeleteGcmChannelOutput) GoString() string

GoString returns the string representation

func (*DeleteGcmChannelOutput) SetGCMChannelResponse

SetGCMChannelResponse sets the GCMChannelResponse field's value.

func (DeleteGcmChannelOutput) String

func (s DeleteGcmChannelOutput) String() string

String returns the string representation

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) GoString

func (s DeleteSegmentInput) GoString() string

GoString returns the string representation

func (*DeleteSegmentInput) SetApplicationId

func (s *DeleteSegmentInput) SetApplicationId(v string) *DeleteSegmentInput

SetApplicationId sets the ApplicationId field's value.

func (*DeleteSegmentInput) SetSegmentId

func (s *DeleteSegmentInput) SetSegmentId(v string) *DeleteSegmentInput

SetSegmentId sets the SegmentId field's value.

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 {

	// Segment definition.
	//
	// SegmentResponse is a required field
	SegmentResponse *SegmentResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteSegmentOutput) GoString

func (s DeleteSegmentOutput) GoString() string

GoString returns the string representation

func (*DeleteSegmentOutput) SetSegmentResponse

func (s *DeleteSegmentOutput) SetSegmentResponse(v *SegmentResponse) *DeleteSegmentOutput

SetSegmentResponse sets the SegmentResponse field's value.

func (DeleteSegmentOutput) String

func (s DeleteSegmentOutput) String() string

String returns the string representation

type DeleteSmsChannelInput added in v1.8.38

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) GoString added in v1.8.38

func (s DeleteSmsChannelInput) GoString() string

GoString returns the string representation

func (*DeleteSmsChannelInput) SetApplicationId added in v1.8.38

func (s *DeleteSmsChannelInput) SetApplicationId(v string) *DeleteSmsChannelInput

SetApplicationId sets the ApplicationId field's value.

func (DeleteSmsChannelInput) String added in v1.8.38

func (s DeleteSmsChannelInput) String() string

String returns the string representation

func (*DeleteSmsChannelInput) Validate added in v1.8.38

func (s *DeleteSmsChannelInput) Validate() error

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

type DeleteSmsChannelOutput added in v1.8.38

type DeleteSmsChannelOutput struct {

	// SMS Channel Response.
	//
	// SMSChannelResponse is a required field
	SMSChannelResponse *SMSChannelResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteSmsChannelOutput) GoString added in v1.8.38

func (s DeleteSmsChannelOutput) GoString() string

GoString returns the string representation

func (*DeleteSmsChannelOutput) SetSMSChannelResponse added in v1.8.38

SetSMSChannelResponse sets the SMSChannelResponse field's value.

func (DeleteSmsChannelOutput) String added in v1.8.38

func (s DeleteSmsChannelOutput) String() string

String returns the string representation

type DirectMessageConfiguration added in v1.8.38

type DirectMessageConfiguration struct {

	// The message to ADM channels. Overrides the default push notification message.
	ADMMessage *ADMMessage `type:"structure"`

	// The message to APNS channels. Overrides the default push notification message.
	APNSMessage *APNSMessage `type:"structure"`

	// The message to Baidu GCM channels. Overrides the default push notification
	// message.
	BaiduMessage *BaiduMessage `type:"structure"`

	// The default message for all channels.
	DefaultMessage *DefaultMessage `type:"structure"`

	// The default push notification message for all push channels.
	DefaultPushNotificationMessage *DefaultPushNotificationMessage `type:"structure"`

	// The message to GCM channels. Overrides the default push notification message.
	GCMMessage *GCMMessage `type:"structure"`

	// The message to SMS channels. Overrides the default message.
	SMSMessage *SMSMessage `type:"structure"`
	// contains filtered or unexported fields
}

The message configuration.

func (DirectMessageConfiguration) GoString added in v1.8.38

func (s DirectMessageConfiguration) GoString() string

GoString returns the string representation

func (*DirectMessageConfiguration) SetADMMessage added in v1.12.1

SetADMMessage sets the ADMMessage field's value.

func (*DirectMessageConfiguration) SetAPNSMessage added in v1.8.38

SetAPNSMessage sets the APNSMessage field's value.

func (*DirectMessageConfiguration) SetBaiduMessage added in v1.12.1

SetBaiduMessage sets the BaiduMessage field's value.

func (*DirectMessageConfiguration) SetDefaultMessage added in v1.8.38

SetDefaultMessage sets the DefaultMessage field's value.

func (*DirectMessageConfiguration) SetDefaultPushNotificationMessage added in v1.8.38

SetDefaultPushNotificationMessage sets the DefaultPushNotificationMessage field's value.

func (*DirectMessageConfiguration) SetGCMMessage added in v1.8.38

SetGCMMessage sets the GCMMessage field's value.

func (*DirectMessageConfiguration) SetSMSMessage added in v1.8.38

SetSMSMessage sets the SMSMessage field's value.

func (DirectMessageConfiguration) String added in v1.8.38

String returns the string representation

type EmailChannelRequest added in v1.8.38

type EmailChannelRequest struct {

	// If the channel is enabled for sending messages.
	Enabled *bool `type:"boolean"`

	// The email address used to send emails from.
	FromAddress *string `type:"string"`

	// The ARN of an identity verified with SES.
	Identity *string `type:"string"`

	// The ARN of an IAM Role used to submit events to Mobile Analytics' event ingestion
	// service
	RoleArn *string `type:"string"`
	// contains filtered or unexported fields
}

Email Channel Request

func (EmailChannelRequest) GoString added in v1.8.38

func (s EmailChannelRequest) GoString() string

GoString returns the string representation

func (*EmailChannelRequest) SetEnabled added in v1.8.38

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

SetEnabled sets the Enabled field's value.

func (*EmailChannelRequest) SetFromAddress added in v1.8.38

func (s *EmailChannelRequest) SetFromAddress(v string) *EmailChannelRequest

SetFromAddress sets the FromAddress field's value.

func (*EmailChannelRequest) SetIdentity added in v1.8.38

func (s *EmailChannelRequest) SetIdentity(v string) *EmailChannelRequest

SetIdentity sets the Identity field's value.

func (*EmailChannelRequest) SetRoleArn added in v1.8.38

SetRoleArn sets the RoleArn field's value.

func (EmailChannelRequest) String added in v1.8.38

func (s EmailChannelRequest) String() string

String returns the string representation

type EmailChannelResponse added in v1.8.38

type EmailChannelResponse struct {

	// The unique ID of the application to which the email channel belongs.
	ApplicationId *string `type:"string"`

	// The date that the settings were last updated in ISO 8601 format.
	CreationDate *string `type:"string"`

	// If the channel is enabled for sending messages.
	Enabled *bool `type:"boolean"`

	// The email address used to send emails from.
	FromAddress *string `type:"string"`

	// If the channel is registered with a credential for authentication.
	HasCredential *bool `type:"boolean"`

	// Channel ID. Not used, only for backwards compatibility.
	Id *string `type:"string"`

	// The ARN of an identity verified with SES.
	Identity *string `type:"string"`

	// Is this channel archived
	IsArchived *bool `type:"boolean"`

	// Who last updated this entry
	LastModifiedBy *string `type:"string"`

	// Last date this was updated
	LastModifiedDate *string `type:"string"`

	// Platform type. Will be "EMAIL"
	Platform *string `type:"string"`

	// The ARN of an IAM Role used to submit events to Mobile Analytics' event ingestion
	// service
	RoleArn *string `type:"string"`

	// Version of channel
	Version *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Email Channel Response.

func (EmailChannelResponse) GoString added in v1.8.38

func (s EmailChannelResponse) GoString() string

GoString returns the string representation

func (*EmailChannelResponse) SetApplicationId added in v1.8.38

func (s *EmailChannelResponse) SetApplicationId(v string) *EmailChannelResponse

SetApplicationId sets the ApplicationId field's value.

func (*EmailChannelResponse) SetCreationDate added in v1.8.38

func (s *EmailChannelResponse) SetCreationDate(v string) *EmailChannelResponse

SetCreationDate sets the CreationDate field's value.

func (*EmailChannelResponse) SetEnabled added in v1.8.38

SetEnabled sets the Enabled field's value.

func (*EmailChannelResponse) SetFromAddress added in v1.8.38

func (s *EmailChannelResponse) SetFromAddress(v string) *EmailChannelResponse

SetFromAddress sets the FromAddress field's value.

func (*EmailChannelResponse) SetHasCredential added in v1.12.17

func (s *EmailChannelResponse) SetHasCredential(v bool) *EmailChannelResponse

SetHasCredential sets the HasCredential field's value.

func (*EmailChannelResponse) SetId added in v1.8.38

SetId sets the Id field's value.

func (*EmailChannelResponse) SetIdentity added in v1.8.38

SetIdentity sets the Identity field's value.

func (*EmailChannelResponse) SetIsArchived added in v1.8.38

func (s *EmailChannelResponse) SetIsArchived(v bool) *EmailChannelResponse

SetIsArchived sets the IsArchived field's value.

func (*EmailChannelResponse) SetLastModifiedBy added in v1.8.38

func (s *EmailChannelResponse) SetLastModifiedBy(v string) *EmailChannelResponse

SetLastModifiedBy sets the LastModifiedBy field's value.

func (*EmailChannelResponse) SetLastModifiedDate added in v1.8.38

func (s *EmailChannelResponse) SetLastModifiedDate(v string) *EmailChannelResponse

SetLastModifiedDate sets the LastModifiedDate field's value.

func (*EmailChannelResponse) SetPlatform added in v1.8.38

SetPlatform sets the Platform field's value.

func (*EmailChannelResponse) SetRoleArn added in v1.8.38

SetRoleArn sets the RoleArn field's value.

func (*EmailChannelResponse) SetVersion added in v1.8.38

SetVersion sets the Version field's value.

func (EmailChannelResponse) String added in v1.8.38

func (s EmailChannelResponse) String() string

String returns the string representation

type EndpointBatchItem

type EndpointBatchItem struct {

	// The address or token of the endpoint as provided by your push provider (e.g.
	// DeviceToken or RegistrationId).
	Address *string `type:"string"`

	Attributes map[string][]*string `type:"map"`

	// The channel type.Valid values: GCM | APNS | APNS_SANDBOX | APNS_VOIP | APNS_VOIP_SANDBOX
	// | ADM | SMS | EMAIL | BAIDU
	ChannelType *string `type:"string" enum:"ChannelType"`

	// The endpoint demographic attributes.
	Demographic *EndpointDemographic `type:"structure"`

	// The last time the endpoint was updated. Provided in ISO 8601 format.
	EffectiveDate *string `type:"string"`

	// The endpoint status. Can be either ACTIVE or INACTIVE. Will be set to INACTIVE
	// if a delivery fails. Will be set to ACTIVE if the address is updated.
	EndpointStatus *string `type:"string"`

	// The unique Id for the Endpoint in the batch.
	Id *string `type:"string"`

	// The endpoint location attributes.
	Location *EndpointLocation `type:"structure"`

	// Custom metrics that your app reports to Amazon Pinpoint.
	Metrics map[string]*float64 `type:"map"`

	// Indicates whether a user has opted out of receiving messages with one of
	// the following values:ALL - User has opted out of all messages.NONE - Users
	// has not opted out and receives all messages.
	OptOut *string `type:"string"`

	// The unique ID for the most recent request to update the endpoint.
	RequestId *string `type:"string"`

	// Custom user-specific attributes that your app reports to Amazon Pinpoint.
	User *EndpointUser `type:"structure"`
	// contains filtered or unexported fields
}

Endpoint update request

func (EndpointBatchItem) GoString

func (s EndpointBatchItem) GoString() string

GoString returns the string representation

func (*EndpointBatchItem) SetAddress

func (s *EndpointBatchItem) SetAddress(v string) *EndpointBatchItem

SetAddress sets the Address field's value.

func (*EndpointBatchItem) SetAttributes

func (s *EndpointBatchItem) SetAttributes(v map[string][]*string) *EndpointBatchItem

SetAttributes sets the Attributes field's value.

func (*EndpointBatchItem) SetChannelType

func (s *EndpointBatchItem) SetChannelType(v string) *EndpointBatchItem

SetChannelType sets the ChannelType field's value.

func (*EndpointBatchItem) SetDemographic

SetDemographic sets the Demographic field's value.

func (*EndpointBatchItem) SetEffectiveDate

func (s *EndpointBatchItem) SetEffectiveDate(v string) *EndpointBatchItem

SetEffectiveDate sets the EffectiveDate field's value.

func (*EndpointBatchItem) SetEndpointStatus

func (s *EndpointBatchItem) SetEndpointStatus(v string) *EndpointBatchItem

SetEndpointStatus sets the EndpointStatus field's value.

func (*EndpointBatchItem) SetId

SetId sets the Id field's value.

func (*EndpointBatchItem) SetLocation

SetLocation sets the Location field's value.

func (*EndpointBatchItem) SetMetrics

func (s *EndpointBatchItem) SetMetrics(v map[string]*float64) *EndpointBatchItem

SetMetrics sets the Metrics field's value.

func (*EndpointBatchItem) SetOptOut

func (s *EndpointBatchItem) SetOptOut(v string) *EndpointBatchItem

SetOptOut sets the OptOut field's value.

func (*EndpointBatchItem) SetRequestId

func (s *EndpointBatchItem) SetRequestId(v string) *EndpointBatchItem

SetRequestId sets the RequestId field's value.

func (*EndpointBatchItem) SetUser

SetUser sets the User field's value.

func (EndpointBatchItem) String

func (s EndpointBatchItem) String() string

String returns the string representation

type EndpointBatchRequest

type EndpointBatchRequest struct {

	// List of items to update. Maximum 100 items
	Item []*EndpointBatchItem `type:"list"`
	// contains filtered or unexported fields
}

Endpoint batch update request.

func (EndpointBatchRequest) GoString

func (s EndpointBatchRequest) GoString() string

GoString returns the string representation

func (*EndpointBatchRequest) SetItem

SetItem sets the Item field's value.

func (EndpointBatchRequest) String

func (s EndpointBatchRequest) String() string

String returns the string representation

type EndpointDemographic

type EndpointDemographic struct {

	// The version of the application associated with the endpoint.
	AppVersion *string `type:"string"`

	// The endpoint locale in the following format: The ISO 639-1 alpha-2 code,
	// followed by an underscore, followed by an ISO 3166-1 alpha-2 value.
	Locale *string `type:"string"`

	// The endpoint make, such as such as Apple or Samsung.
	Make *string `type:"string"`

	// The endpoint model, such as iPhone.
	Model *string `type:"string"`

	// The endpoint model version.
	ModelVersion *string `type:"string"`

	// The endpoint platform, such as ios or android.
	Platform *string `type:"string"`

	// The endpoint platform version.
	PlatformVersion *string `type:"string"`

	// The timezone of the endpoint. Specified as a tz database value, such as Americas/Los_Angeles.
	Timezone *string `type:"string"`
	// contains filtered or unexported fields
}

Endpoint demographic data

func (EndpointDemographic) GoString

func (s EndpointDemographic) GoString() string

GoString returns the string representation

func (*EndpointDemographic) SetAppVersion

func (s *EndpointDemographic) SetAppVersion(v string) *EndpointDemographic

SetAppVersion sets the AppVersion field's value.

func (*EndpointDemographic) SetLocale

SetLocale sets the Locale field's value.

func (*EndpointDemographic) SetMake

SetMake sets the Make field's value.

func (*EndpointDemographic) SetModel

SetModel sets the Model field's value.

func (*EndpointDemographic) SetModelVersion

func (s *EndpointDemographic) SetModelVersion(v string) *EndpointDemographic

SetModelVersion sets the ModelVersion field's value.

func (*EndpointDemographic) SetPlatform

func (s *EndpointDemographic) SetPlatform(v string) *EndpointDemographic

SetPlatform sets the Platform field's value.

func (*EndpointDemographic) SetPlatformVersion

func (s *EndpointDemographic) SetPlatformVersion(v string) *EndpointDemographic

SetPlatformVersion sets the PlatformVersion field's value.

func (*EndpointDemographic) SetTimezone

func (s *EndpointDemographic) SetTimezone(v string) *EndpointDemographic

SetTimezone sets the Timezone field's value.

func (EndpointDemographic) String

func (s EndpointDemographic) String() string

String returns the string representation

type EndpointLocation

type EndpointLocation struct {

	// The city where the endpoint is located.
	City *string `type:"string"`

	// Country according to ISO 3166-1 Alpha-2 codes. For example, US.
	Country *string `type:"string"`

	// The latitude of the endpoint location. Rounded to one decimal (Roughly corresponding
	// to a mile).
	Latitude *float64 `type:"double"`

	// The longitude of the endpoint location. Rounded to one decimal (Roughly corresponding
	// to a mile).
	Longitude *float64 `type:"double"`

	// The postal code or zip code of the endpoint.
	PostalCode *string `type:"string"`

	// The region of the endpoint location. For example, corresponds to a state
	// in US.
	Region *string `type:"string"`
	// contains filtered or unexported fields
}

Endpoint location data

func (EndpointLocation) GoString

func (s EndpointLocation) GoString() string

GoString returns the string representation

func (*EndpointLocation) SetCity

func (s *EndpointLocation) SetCity(v string) *EndpointLocation

SetCity sets the City field's value.

func (*EndpointLocation) SetCountry

func (s *EndpointLocation) SetCountry(v string) *EndpointLocation

SetCountry sets the Country field's value.

func (*EndpointLocation) SetLatitude

func (s *EndpointLocation) SetLatitude(v float64) *EndpointLocation

SetLatitude sets the Latitude field's value.

func (*EndpointLocation) SetLongitude

func (s *EndpointLocation) SetLongitude(v float64) *EndpointLocation

SetLongitude sets the Longitude field's value.

func (*EndpointLocation) SetPostalCode

func (s *EndpointLocation) SetPostalCode(v string) *EndpointLocation

SetPostalCode sets the PostalCode field's value.

func (*EndpointLocation) SetRegion

func (s *EndpointLocation) SetRegion(v string) *EndpointLocation

SetRegion sets the Region field's value.

func (EndpointLocation) String

func (s EndpointLocation) String() string

String returns the string representation

type EndpointMessageResult added in v1.12.1

type EndpointMessageResult struct {

	// Address that endpoint message was delivered to.
	Address *string `type:"string"`

	// Delivery status of message.
	DeliveryStatus *string `type:"string" enum:"DeliveryStatus"`

	// Downstream service status code.
	StatusCode *int64 `type:"integer"`

	// Status message for message delivery.
	StatusMessage *string `type:"string"`

	// If token was updated as part of delivery. (This is GCM Specific)
	UpdatedToken *string `type:"string"`
	// contains filtered or unexported fields
}

The result from sending a message to an endpoint.

func (EndpointMessageResult) GoString added in v1.12.1

func (s EndpointMessageResult) GoString() string

GoString returns the string representation

func (*EndpointMessageResult) SetAddress added in v1.12.1

SetAddress sets the Address field's value.

func (*EndpointMessageResult) SetDeliveryStatus added in v1.12.1

func (s *EndpointMessageResult) SetDeliveryStatus(v string) *EndpointMessageResult

SetDeliveryStatus sets the DeliveryStatus field's value.

func (*EndpointMessageResult) SetStatusCode added in v1.12.1

func (s *EndpointMessageResult) SetStatusCode(v int64) *EndpointMessageResult

SetStatusCode sets the StatusCode field's value.

func (*EndpointMessageResult) SetStatusMessage added in v1.12.1

func (s *EndpointMessageResult) SetStatusMessage(v string) *EndpointMessageResult

SetStatusMessage sets the StatusMessage field's value.

func (*EndpointMessageResult) SetUpdatedToken added in v1.12.1

func (s *EndpointMessageResult) SetUpdatedToken(v string) *EndpointMessageResult

SetUpdatedToken sets the UpdatedToken field's value.

func (EndpointMessageResult) String added in v1.12.1

func (s EndpointMessageResult) String() string

String returns the string representation

type EndpointRequest

type EndpointRequest struct {

	// The address or token of the endpoint as provided by your push provider (e.g.
	// DeviceToken or RegistrationId).
	Address *string `type:"string"`

	Attributes map[string][]*string `type:"map"`

	// The channel type.Valid values: GCM | APNS | APNS_SANDBOX | APNS_VOIP | APNS_VOIP_SANDBOX
	// | ADM | SMS | EMAIL | BAIDU
	ChannelType *string `type:"string" enum:"ChannelType"`

	// The endpoint demographic attributes.
	Demographic *EndpointDemographic `type:"structure"`

	// The last time the endpoint was updated. Provided in ISO 8601 format.
	EffectiveDate *string `type:"string"`

	// The endpoint status. Can be either ACTIVE or INACTIVE. Will be set to INACTIVE
	// if a delivery fails. Will be set to ACTIVE if the address is updated.
	EndpointStatus *string `type:"string"`

	// The endpoint location attributes.
	Location *EndpointLocation `type:"structure"`

	// Custom metrics that your app reports to Amazon Pinpoint.
	Metrics map[string]*float64 `type:"map"`

	// Indicates whether a user has opted out of receiving messages with one of
	// the following values:ALL - User has opted out of all messages.NONE - Users
	// has not opted out and receives all messages.
	OptOut *string `type:"string"`

	// The unique ID for the most recent request to update the endpoint.
	RequestId *string `type:"string"`

	// Custom user-specific attributes that your app reports to Amazon Pinpoint.
	User *EndpointUser `type:"structure"`
	// contains filtered or unexported fields
}

Endpoint update request

func (EndpointRequest) GoString

func (s EndpointRequest) GoString() string

GoString returns the string representation

func (*EndpointRequest) SetAddress

func (s *EndpointRequest) SetAddress(v string) *EndpointRequest

SetAddress sets the Address field's value.

func (*EndpointRequest) SetAttributes

func (s *EndpointRequest) SetAttributes(v map[string][]*string) *EndpointRequest

SetAttributes sets the Attributes field's value.

func (*EndpointRequest) SetChannelType

func (s *EndpointRequest) SetChannelType(v string) *EndpointRequest

SetChannelType sets the ChannelType field's value.

func (*EndpointRequest) SetDemographic

func (s *EndpointRequest) SetDemographic(v *EndpointDemographic) *EndpointRequest

SetDemographic sets the Demographic field's value.

func (*EndpointRequest) SetEffectiveDate

func (s *EndpointRequest) SetEffectiveDate(v string) *EndpointRequest

SetEffectiveDate sets the EffectiveDate field's value.

func (*EndpointRequest) SetEndpointStatus

func (s *EndpointRequest) SetEndpointStatus(v string) *EndpointRequest

SetEndpointStatus sets the EndpointStatus field's value.

func (*EndpointRequest) SetLocation

func (s *EndpointRequest) SetLocation(v *EndpointLocation) *EndpointRequest

SetLocation sets the Location field's value.

func (*EndpointRequest) SetMetrics

func (s *EndpointRequest) SetMetrics(v map[string]*float64) *EndpointRequest

SetMetrics sets the Metrics field's value.

func (*EndpointRequest) SetOptOut

func (s *EndpointRequest) SetOptOut(v string) *EndpointRequest

SetOptOut sets the OptOut field's value.

func (*EndpointRequest) SetRequestId

func (s *EndpointRequest) SetRequestId(v string) *EndpointRequest

SetRequestId sets the RequestId field's value.

func (*EndpointRequest) SetUser

SetUser sets the User field's value.

func (EndpointRequest) String

func (s EndpointRequest) String() string

String returns the string representation

type EndpointResponse

type EndpointResponse struct {

	// The address or token of the endpoint as provided by your push provider (e.g.
	// DeviceToken or RegistrationId).
	Address *string `type:"string"`

	// The ID of the application associated with the endpoint.
	ApplicationId *string `type:"string"`

	Attributes map[string][]*string `type:"map"`

	// The channel type.Valid values: GCM | APNS | APNS_SANDBOX | APNS_VOIP | APNS_VOIP_SANDBOX
	// | ADM | SMS | EMAIL | BAIDU
	ChannelType *string `type:"string" enum:"ChannelType"`

	// A number from 0 - 99 that represents the cohort the endpoint is assigned
	// to. Endpoints are grouped into cohorts randomly, and each cohort contains
	// approximately 1 percent of the endpoints for an app. Amazon Pinpoint assigns
	// cohorts to the holdout or treatment allocations for a campaign.
	CohortId *string `type:"string"`

	// The last time the endpoint was created. Provided in ISO 8601 format.
	CreationDate *string `type:"string"`

	// The endpoint demographic attributes.
	Demographic *EndpointDemographic `type:"structure"`

	// The last time the endpoint was updated. Provided in ISO 8601 format.
	EffectiveDate *string `type:"string"`

	// The endpoint status. Can be either ACTIVE or INACTIVE. Will be set to INACTIVE
	// if a delivery fails. Will be set to ACTIVE if the address is updated.
	EndpointStatus *string `type:"string"`

	// The unique ID that you assigned to the endpoint. The ID should be a globally
	// unique identifier (GUID) to ensure that it is unique compared to all other
	// endpoints for the application.
	Id *string `type:"string"`

	// The endpoint location attributes.
	Location *EndpointLocation `type:"structure"`

	// Custom metrics that your app reports to Amazon Pinpoint.
	Metrics map[string]*float64 `type:"map"`

	// Indicates whether a user has opted out of receiving messages with one of
	// the following values:ALL - User has opted out of all messages.NONE - Users
	// has not opted out and receives all messages.
	OptOut *string `type:"string"`

	// The unique ID for the most recent request to update the endpoint.
	RequestId *string `type:"string"`

	// Custom user-specific attributes that your app reports to Amazon Pinpoint.
	User *EndpointUser `type:"structure"`
	// contains filtered or unexported fields
}

Endpoint response

func (EndpointResponse) GoString

func (s EndpointResponse) GoString() string

GoString returns the string representation

func (*EndpointResponse) SetAddress

func (s *EndpointResponse) SetAddress(v string) *EndpointResponse

SetAddress sets the Address field's value.

func (*EndpointResponse) SetApplicationId

func (s *EndpointResponse) SetApplicationId(v string) *EndpointResponse

SetApplicationId sets the ApplicationId field's value.

func (*EndpointResponse) SetAttributes

func (s *EndpointResponse) SetAttributes(v map[string][]*string) *EndpointResponse

SetAttributes sets the Attributes field's value.

func (*EndpointResponse) SetChannelType

func (s *EndpointResponse) SetChannelType(v string) *EndpointResponse

SetChannelType sets the ChannelType field's value.

func (*EndpointResponse) SetCohortId

func (s *EndpointResponse) SetCohortId(v string) *EndpointResponse

SetCohortId sets the CohortId field's value.

func (*EndpointResponse) SetCreationDate

func (s *EndpointResponse) SetCreationDate(v string) *EndpointResponse

SetCreationDate sets the CreationDate field's value.

func (*EndpointResponse) SetDemographic

func (s *EndpointResponse) SetDemographic(v *EndpointDemographic) *EndpointResponse

SetDemographic sets the Demographic field's value.

func (*EndpointResponse) SetEffectiveDate

func (s *EndpointResponse) SetEffectiveDate(v string) *EndpointResponse

SetEffectiveDate sets the EffectiveDate field's value.

func (*EndpointResponse) SetEndpointStatus

func (s *EndpointResponse) SetEndpointStatus(v string) *EndpointResponse

SetEndpointStatus sets the EndpointStatus field's value.

func (*EndpointResponse) SetId

SetId sets the Id field's value.

func (*EndpointResponse) SetLocation

SetLocation sets the Location field's value.

func (*EndpointResponse) SetMetrics

func (s *EndpointResponse) SetMetrics(v map[string]*float64) *EndpointResponse

SetMetrics sets the Metrics field's value.

func (*EndpointResponse) SetOptOut

func (s *EndpointResponse) SetOptOut(v string) *EndpointResponse

SetOptOut sets the OptOut field's value.

func (*EndpointResponse) SetRequestId

func (s *EndpointResponse) SetRequestId(v string) *EndpointResponse

SetRequestId sets the RequestId field's value.

func (*EndpointResponse) SetUser

SetUser sets the User field's value.

func (EndpointResponse) String

func (s EndpointResponse) String() string

String returns the string representation

type EndpointSendConfiguration added in v1.12.1

type EndpointSendConfiguration struct {

	// Body override. If specified will override default body.
	BodyOverride *string `type:"string"`

	// A map of custom attributes to attributes to be attached to the message for
	// this address. This payload is added to the push notification's 'data.pinpoint'
	// object or added to the email/sms delivery receipt event attributes.
	Context map[string]*string `type:"map"`

	// The Raw JSON formatted string to be used as the payload. This value overrides
	// the message.
	RawContent *string `type:"string"`

	Substitutions map[string][]*string `type:"map"`

	// Title override. If specified will override default title if applicable.
	TitleOverride *string `type:"string"`
	// contains filtered or unexported fields
}

Endpoint send configuration.

func (EndpointSendConfiguration) GoString added in v1.12.1

func (s EndpointSendConfiguration) GoString() string

GoString returns the string representation

func (*EndpointSendConfiguration) SetBodyOverride added in v1.12.1

SetBodyOverride sets the BodyOverride field's value.

func (*EndpointSendConfiguration) SetContext added in v1.12.1

SetContext sets the Context field's value.

func (*EndpointSendConfiguration) SetRawContent added in v1.12.1

SetRawContent sets the RawContent field's value.

func (*EndpointSendConfiguration) SetSubstitutions added in v1.12.1

func (s *EndpointSendConfiguration) SetSubstitutions(v map[string][]*string) *EndpointSendConfiguration

SetSubstitutions sets the Substitutions field's value.

func (*EndpointSendConfiguration) SetTitleOverride added in v1.12.1

SetTitleOverride sets the TitleOverride field's value.

func (EndpointSendConfiguration) String added in v1.12.1

func (s EndpointSendConfiguration) String() string

String returns the string representation

type EndpointUser

type EndpointUser struct {
	UserAttributes map[string][]*string `type:"map"`

	// The unique ID of the user.
	UserId *string `type:"string"`
	// contains filtered or unexported fields
}

Endpoint user specific custom userAttributes

func (EndpointUser) GoString

func (s EndpointUser) GoString() string

GoString returns the string representation

func (*EndpointUser) SetUserAttributes

func (s *EndpointUser) SetUserAttributes(v map[string][]*string) *EndpointUser

SetUserAttributes sets the UserAttributes field's value.

func (*EndpointUser) SetUserId

func (s *EndpointUser) SetUserId(v string) *EndpointUser

SetUserId sets the UserId field's value.

func (EndpointUser) String

func (s EndpointUser) String() string

String returns the string representation

type EventStream added in v1.8.0

type EventStream struct {

	// The ID of the application from which events should be published.
	ApplicationId *string `type:"string"`

	// The Amazon Resource Name (ARN) of the Amazon Kinesis stream or Firehose delivery
	// stream to which you want to publish events. Firehose ARN: arn:aws:firehose:REGION:ACCOUNT_ID:deliverystream/STREAM_NAME
	// Kinesis ARN: arn:aws:kinesis:REGION:ACCOUNT_ID:stream/STREAM_NAME
	DestinationStreamArn *string `type:"string"`

	// DEPRECATED. Your AWS account ID, which you assigned to the ExternalID key
	// in an IAM trust policy. Used by Amazon Pinpoint to assume an IAM role. This
	// requirement is removed, and external IDs are not recommended for IAM roles
	// assumed by Amazon Pinpoint.
	ExternalId *string `type:"string"`

	// The date the event stream was last updated in ISO 8601 format.
	LastModifiedDate *string `type:"string"`

	// The IAM user who last modified the event stream.
	LastUpdatedBy *string `type:"string"`

	// The IAM role that authorizes Amazon Pinpoint to publish events to the stream
	// in your account.
	RoleArn *string `type:"string"`
	// contains filtered or unexported fields
}

Model for an event publishing subscription export.

func (EventStream) GoString added in v1.8.0

func (s EventStream) GoString() string

GoString returns the string representation

func (*EventStream) SetApplicationId added in v1.8.0

func (s *EventStream) SetApplicationId(v string) *EventStream

SetApplicationId sets the ApplicationId field's value.

func (*EventStream) SetDestinationStreamArn added in v1.8.0

func (s *EventStream) SetDestinationStreamArn(v string) *EventStream

SetDestinationStreamArn sets the DestinationStreamArn field's value.

func (*EventStream) SetExternalId added in v1.8.0

func (s *EventStream) SetExternalId(v string) *EventStream

SetExternalId sets the ExternalId field's value.

func (*EventStream) SetLastModifiedDate added in v1.8.0

func (s *EventStream) SetLastModifiedDate(v string) *EventStream

SetLastModifiedDate sets the LastModifiedDate field's value.

func (*EventStream) SetLastUpdatedBy added in v1.8.0

func (s *EventStream) SetLastUpdatedBy(v string) *EventStream

SetLastUpdatedBy sets the LastUpdatedBy field's value.

func (*EventStream) SetRoleArn added in v1.8.0

func (s *EventStream) SetRoleArn(v string) *EventStream

SetRoleArn sets the RoleArn field's value.

func (EventStream) String added in v1.8.0

func (s EventStream) String() string

String returns the string representation

type ExportJobRequest added in v1.13.11

type ExportJobRequest struct {

	// The Amazon Resource Name (ARN) of an IAM role that grants Amazon Pinpoint
	// access to the Amazon S3 location that endpoints will be exported to.
	RoleArn *string `type:"string"`

	// A URL that points to the location within an Amazon S3 bucket that will receive
	// the export. The location is typically a folder with multiple files.The URL
	// should follow this format: s3://bucket-name/folder-name/Amazon Pinpoint will
	// export endpoints to this location.
	S3UrlPrefix *string `type:"string"`

	// The ID of the segment to export endpoints from. If not present, all endpoints
	// will be exported.
	SegmentId *string `type:"string"`
	// contains filtered or unexported fields
}

func (ExportJobRequest) GoString added in v1.13.11

func (s ExportJobRequest) GoString() string

GoString returns the string representation

func (*ExportJobRequest) SetRoleArn added in v1.13.11

func (s *ExportJobRequest) SetRoleArn(v string) *ExportJobRequest

SetRoleArn sets the RoleArn field's value.

func (*ExportJobRequest) SetS3UrlPrefix added in v1.13.11

func (s *ExportJobRequest) SetS3UrlPrefix(v string) *ExportJobRequest

SetS3UrlPrefix sets the S3UrlPrefix field's value.

func (*ExportJobRequest) SetSegmentId added in v1.13.11

func (s *ExportJobRequest) SetSegmentId(v string) *ExportJobRequest

SetSegmentId sets the SegmentId field's value.

func (ExportJobRequest) String added in v1.13.11

func (s ExportJobRequest) String() string

String returns the string representation

type ExportJobResource added in v1.13.11

type ExportJobResource struct {

	// The Amazon Resource Name (ARN) of an IAM role that grants Amazon Pinpoint
	// access to the Amazon S3 location that endpoints will be exported to.
	RoleArn *string `type:"string"`

	// A URL that points to the location within an Amazon S3 bucket that will receive
	// the export. The location is typically a folder with multiple files.The URL
	// should follow this format: s3://bucket-name/folder-name/Amazon Pinpoint will
	// export endpoints to this location.
	S3UrlPrefix *string `type:"string"`

	// The ID of the segment to export endpoints from. If not present all endpoints
	// will be exported.
	SegmentId *string `type:"string"`
	// contains filtered or unexported fields
}

func (ExportJobResource) GoString added in v1.13.11

func (s ExportJobResource) GoString() string

GoString returns the string representation

func (*ExportJobResource) SetRoleArn added in v1.13.11

func (s *ExportJobResource) SetRoleArn(v string) *ExportJobResource

SetRoleArn sets the RoleArn field's value.

func (*ExportJobResource) SetS3UrlPrefix added in v1.13.11

func (s *ExportJobResource) SetS3UrlPrefix(v string) *ExportJobResource

SetS3UrlPrefix sets the S3UrlPrefix field's value.

func (*ExportJobResource) SetSegmentId added in v1.13.11

func (s *ExportJobResource) SetSegmentId(v string) *ExportJobResource

SetSegmentId sets the SegmentId field's value.

func (ExportJobResource) String added in v1.13.11

func (s ExportJobResource) String() string

String returns the string representation

type ExportJobResponse added in v1.13.11

type ExportJobResponse struct {

	// The unique ID of the application to which the job applies.
	ApplicationId *string `type:"string"`

	// The number of pieces that have successfully completed as of the time of the
	// request.
	CompletedPieces *int64 `type:"integer"`

	// The date the job completed in ISO 8601 format.
	CompletionDate *string `type:"string"`

	// The date the job was created in ISO 8601 format.
	CreationDate *string `type:"string"`

	// The export job settings.
	Definition *ExportJobResource `type:"structure"`

	// The number of pieces that failed to be processed as of the time of the request.
	FailedPieces *int64 `type:"integer"`

	Failures []*string `type:"list"`

	// The unique ID of the job.
	Id *string `type:"string"`

	// The status of the export job.Valid values: CREATED, INITIALIZING, PROCESSING,
	// COMPLETING, COMPLETED, FAILING, FAILEDThe job status is FAILED if one or
	// more pieces failed.
	JobStatus *string `type:"string" enum:"JobStatus"`

	// The number of endpoints that were not processed; for example, because of
	// syntax errors.
	TotalFailures *int64 `type:"integer"`

	// The total number of pieces that must be processed to finish the job. Each
	// piece is an approximately equal portion of the endpoints.
	TotalPieces *int64 `type:"integer"`

	// The number of endpoints that were processed by the job.
	TotalProcessed *int64 `type:"integer"`

	// The job type. Will be 'EXPORT'.
	Type *string `type:"string"`
	// contains filtered or unexported fields
}

func (ExportJobResponse) GoString added in v1.13.11

func (s ExportJobResponse) GoString() string

GoString returns the string representation

func (*ExportJobResponse) SetApplicationId added in v1.13.11

func (s *ExportJobResponse) SetApplicationId(v string) *ExportJobResponse

SetApplicationId sets the ApplicationId field's value.

func (*ExportJobResponse) SetCompletedPieces added in v1.13.11

func (s *ExportJobResponse) SetCompletedPieces(v int64) *ExportJobResponse

SetCompletedPieces sets the CompletedPieces field's value.

func (*ExportJobResponse) SetCompletionDate added in v1.13.11

func (s *ExportJobResponse) SetCompletionDate(v string) *ExportJobResponse

SetCompletionDate sets the CompletionDate field's value.

func (*ExportJobResponse) SetCreationDate added in v1.13.11

func (s *ExportJobResponse) SetCreationDate(v string) *ExportJobResponse

SetCreationDate sets the CreationDate field's value.

func (*ExportJobResponse) SetDefinition added in v1.13.11

SetDefinition sets the Definition field's value.

func (*ExportJobResponse) SetFailedPieces added in v1.13.11

func (s *ExportJobResponse) SetFailedPieces(v int64) *ExportJobResponse

SetFailedPieces sets the FailedPieces field's value.

func (*ExportJobResponse) SetFailures added in v1.13.11

func (s *ExportJobResponse) SetFailures(v []*string) *ExportJobResponse

SetFailures sets the Failures field's value.

func (*ExportJobResponse) SetId added in v1.13.11

SetId sets the Id field's value.

func (*ExportJobResponse) SetJobStatus added in v1.13.11

func (s *ExportJobResponse) SetJobStatus(v string) *ExportJobResponse

SetJobStatus sets the JobStatus field's value.

func (*ExportJobResponse) SetTotalFailures added in v1.13.11

func (s *ExportJobResponse) SetTotalFailures(v int64) *ExportJobResponse

SetTotalFailures sets the TotalFailures field's value.

func (*ExportJobResponse) SetTotalPieces added in v1.13.11

func (s *ExportJobResponse) SetTotalPieces(v int64) *ExportJobResponse

SetTotalPieces sets the TotalPieces field's value.

func (*ExportJobResponse) SetTotalProcessed added in v1.13.11

func (s *ExportJobResponse) SetTotalProcessed(v int64) *ExportJobResponse

SetTotalProcessed sets the TotalProcessed field's value.

func (*ExportJobResponse) SetType added in v1.13.11

SetType sets the Type field's value.

func (ExportJobResponse) String added in v1.13.11

func (s ExportJobResponse) String() string

String returns the string representation

type ExportJobsResponse added in v1.13.11

type ExportJobsResponse struct {

	// A list of export jobs for the application.
	Item []*ExportJobResponse `type:"list"`

	// The string that you use in a subsequent request to get the next page of results
	// in a paginated response.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

Export job list.

func (ExportJobsResponse) GoString added in v1.13.11

func (s ExportJobsResponse) GoString() string

GoString returns the string representation

func (*ExportJobsResponse) SetItem added in v1.13.11

SetItem sets the Item field's value.

func (*ExportJobsResponse) SetNextToken added in v1.13.11

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

SetNextToken sets the NextToken field's value.

func (ExportJobsResponse) String added in v1.13.11

func (s ExportJobsResponse) String() string

String returns the string representation

type GCMChannelRequest

type GCMChannelRequest struct {

	// Platform credential API key from Google.
	ApiKey *string `type:"string"`

	// If the channel is enabled for sending messages.
	Enabled *bool `type:"boolean"`
	// contains filtered or unexported fields
}

Google Cloud Messaging credentials

func (GCMChannelRequest) GoString

func (s GCMChannelRequest) GoString() string

GoString returns the string representation

func (*GCMChannelRequest) SetApiKey

func (s *GCMChannelRequest) SetApiKey(v string) *GCMChannelRequest

SetApiKey sets the ApiKey field's value.

func (*GCMChannelRequest) SetEnabled added in v1.8.38

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

SetEnabled sets the Enabled field's value.

func (GCMChannelRequest) String

func (s GCMChannelRequest) String() string

String returns the string representation

type GCMChannelResponse

type GCMChannelResponse struct {

	// The ID of the application to which the channel applies.
	ApplicationId *string `type:"string"`

	// When was this segment created
	CreationDate *string `type:"string"`

	// The GCM API key from Google.
	Credential *string `type:"string"`

	// If the channel is enabled for sending messages.
	Enabled *bool `type:"boolean"`

	// Indicates whether the channel is configured with FCM or GCM credentials.
	// Amazon Pinpoint uses your credentials to authenticate push notifications
	// with FCM or GCM. Provide your credentials by setting the ApiKey attribute.
	HasCredential *bool `type:"boolean"`

	// Channel ID. Not used. Present only for backwards compatibility.
	Id *string `type:"string"`

	// Is this channel archived
	IsArchived *bool `type:"boolean"`

	// Who last updated this entry
	LastModifiedBy *string `type:"string"`

	// Last date this was updated
	LastModifiedDate *string `type:"string"`

	// The platform type. Will be GCM
	Platform *string `type:"string"`

	// Version of channel
	Version *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Google Cloud Messaging channel definition

func (GCMChannelResponse) GoString

func (s GCMChannelResponse) GoString() string

GoString returns the string representation

func (*GCMChannelResponse) SetApplicationId

func (s *GCMChannelResponse) SetApplicationId(v string) *GCMChannelResponse

SetApplicationId sets the ApplicationId field's value.

func (*GCMChannelResponse) SetCreationDate

func (s *GCMChannelResponse) SetCreationDate(v string) *GCMChannelResponse

SetCreationDate sets the CreationDate field's value.

func (*GCMChannelResponse) SetCredential

func (s *GCMChannelResponse) SetCredential(v string) *GCMChannelResponse

SetCredential sets the Credential field's value.

func (*GCMChannelResponse) SetEnabled added in v1.8.38

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

SetEnabled sets the Enabled field's value.

func (*GCMChannelResponse) SetHasCredential added in v1.12.17

func (s *GCMChannelResponse) SetHasCredential(v bool) *GCMChannelResponse

SetHasCredential sets the HasCredential field's value.

func (*GCMChannelResponse) SetId

SetId sets the Id field's value.

func (*GCMChannelResponse) SetIsArchived

func (s *GCMChannelResponse) SetIsArchived(v bool) *GCMChannelResponse

SetIsArchived sets the IsArchived field's value.

func (*GCMChannelResponse) SetLastModifiedBy

func (s *GCMChannelResponse) SetLastModifiedBy(v string) *GCMChannelResponse

SetLastModifiedBy sets the LastModifiedBy field's value.

func (*GCMChannelResponse) SetLastModifiedDate

func (s *GCMChannelResponse) SetLastModifiedDate(v string) *GCMChannelResponse

SetLastModifiedDate sets the LastModifiedDate field's value.

func (*GCMChannelResponse) SetPlatform

func (s *GCMChannelResponse) SetPlatform(v string) *GCMChannelResponse

SetPlatform sets the Platform field's value.

func (*GCMChannelResponse) SetVersion

func (s *GCMChannelResponse) SetVersion(v int64) *GCMChannelResponse

SetVersion sets the Version field's value.

func (GCMChannelResponse) String

func (s GCMChannelResponse) String() string

String returns the string representation

type GCMMessage added in v1.8.38

type GCMMessage struct {

	// The action that occurs if the user taps a push notification delivered by
	// the campaign: OPEN_APP - Your app launches, or it becomes the foreground
	// app if it has been sent to the background. This is the default action. DEEP_LINK
	// - Uses deep linking features in iOS and Android to open your app and display
	// a designated user interface within the app. URL - The default mobile browser
	// on the user's device launches and opens a web page at the URL you specify.
	// Possible values include: OPEN_APP | DEEP_LINK | URL
	Action *string `type:"string" enum:"Action"`

	// The message body of the notification, the email body or the text message.
	Body *string `type:"string"`

	// This parameter identifies a group of messages (e.g., with collapse_key: "Updates
	// Available") that can be collapsed, so that only the last message gets sent
	// when delivery can be resumed. This is intended to avoid sending too many
	// of the same messages when the device comes back online or becomes active.
	CollapseKey *string `type:"string"`

	// The data payload used for a silent push. This payload is added to the notifications'
	// data.pinpoint.jsonBody' object
	Data map[string]*string `type:"map"`

	// The icon image name of the asset saved in your application.
	IconReference *string `type:"string"`

	// The URL that points to an image used as the large icon to the notification
	// content view.
	ImageIconUrl *string `type:"string"`

	// The URL that points to an image used in the push notification.
	ImageUrl *string `type:"string"`

	// The message priority. Amazon Pinpoint uses this value to set the FCM or GCM
	// priority parameter when it sends the message. Accepts the following values:"Normal"
	// - Messages might be delayed. Delivery is optimized for battery usage on the
	// receiving device. Use normal priority unless immediate delivery is required."High"
	// - Messages are sent immediately and might wake a sleeping device.The equivalent
	// values for APNs messages are "5" and "10". Amazon Pinpoint accepts these
	// values here and converts them.For more information, see About FCM Messages
	// in the Firebase documentation.
	Priority *string `type:"string"`

	// The Raw JSON formatted string to be used as the payload. This value overrides
	// the message.
	RawContent *string `type:"string"`

	// This parameter specifies the package name of the application where the registration
	// tokens must match in order to receive the message.
	RestrictedPackageName *string `type:"string"`

	// Indicates if the message should display on the users device. Silent pushes
	// can be used for Remote Configuration and Phone Home use cases.
	SilentPush *bool `type:"boolean"`

	// The URL that points to an image used as the small icon for the notification
	// which will be used to represent the notification in the status bar and content
	// view
	SmallImageIconUrl *string `type:"string"`

	// Indicates a sound to play when the device receives the notification. Supports
	// default, or the filename of a sound resource bundled in the app. Android
	// sound files must reside in /res/raw/
	Sound *string `type:"string"`

	Substitutions map[string][]*string `type:"map"`

	// The length of time (in seconds) that FCM or GCM stores and attempts to deliver
	// the message. If unspecified, the value defaults to the maximum, which is
	// 2,419,200 seconds (28 days). Amazon Pinpoint uses this value to set the FCM
	// or GCM time_to_live parameter.
	TimeToLive *int64 `type:"integer"`

	// The message title that displays above the message on the user's device.
	Title *string `type:"string"`

	// The URL to open in the user's mobile browser. Used if the value for Action
	// is URL.
	Url *string `type:"string"`
	// contains filtered or unexported fields
}

GCM Message.

func (GCMMessage) GoString added in v1.8.38

func (s GCMMessage) GoString() string

GoString returns the string representation

func (*GCMMessage) SetAction added in v1.8.38

func (s *GCMMessage) SetAction(v string) *GCMMessage

SetAction sets the Action field's value.

func (*GCMMessage) SetBody added in v1.8.38

func (s *GCMMessage) SetBody(v string) *GCMMessage

SetBody sets the Body field's value.

func (*GCMMessage) SetCollapseKey added in v1.8.38

func (s *GCMMessage) SetCollapseKey(v string) *GCMMessage

SetCollapseKey sets the CollapseKey field's value.

func (*GCMMessage) SetData added in v1.8.38

func (s *GCMMessage) SetData(v map[string]*string) *GCMMessage

SetData sets the Data field's value.

func (*GCMMessage) SetIconReference added in v1.8.38

func (s *GCMMessage) SetIconReference(v string) *GCMMessage

SetIconReference sets the IconReference field's value.

func (*GCMMessage) SetImageIconUrl added in v1.8.38

func (s *GCMMessage) SetImageIconUrl(v string) *GCMMessage

SetImageIconUrl sets the ImageIconUrl field's value.

func (*GCMMessage) SetImageUrl added in v1.8.38

func (s *GCMMessage) SetImageUrl(v string) *GCMMessage

SetImageUrl sets the ImageUrl field's value.

func (*GCMMessage) SetPriority added in v1.12.17

func (s *GCMMessage) SetPriority(v string) *GCMMessage

SetPriority sets the Priority field's value.

func (*GCMMessage) SetRawContent added in v1.8.38

func (s *GCMMessage) SetRawContent(v string) *GCMMessage

SetRawContent sets the RawContent field's value.

func (*GCMMessage) SetRestrictedPackageName added in v1.8.38

func (s *GCMMessage) SetRestrictedPackageName(v string) *GCMMessage

SetRestrictedPackageName sets the RestrictedPackageName field's value.

func (*GCMMessage) SetSilentPush added in v1.8.38

func (s *GCMMessage) SetSilentPush(v bool) *GCMMessage

SetSilentPush sets the SilentPush field's value.

func (*GCMMessage) SetSmallImageIconUrl added in v1.8.38

func (s *GCMMessage) SetSmallImageIconUrl(v string) *GCMMessage

SetSmallImageIconUrl sets the SmallImageIconUrl field's value.

func (*GCMMessage) SetSound added in v1.8.38

func (s *GCMMessage) SetSound(v string) *GCMMessage

SetSound sets the Sound field's value.

func (*GCMMessage) SetSubstitutions added in v1.8.38

func (s *GCMMessage) SetSubstitutions(v map[string][]*string) *GCMMessage

SetSubstitutions sets the Substitutions field's value.

func (*GCMMessage) SetTimeToLive added in v1.12.17

func (s *GCMMessage) SetTimeToLive(v int64) *GCMMessage

SetTimeToLive sets the TimeToLive field's value.

func (*GCMMessage) SetTitle added in v1.8.38

func (s *GCMMessage) SetTitle(v string) *GCMMessage

SetTitle sets the Title field's value.

func (*GCMMessage) SetUrl added in v1.8.38

func (s *GCMMessage) SetUrl(v string) *GCMMessage

SetUrl sets the Url field's value.

func (GCMMessage) String added in v1.8.38

func (s GCMMessage) String() string

String returns the string representation

type GetAdmChannelInput added in v1.12.1

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) GoString added in v1.12.1

func (s GetAdmChannelInput) GoString() string

GoString returns the string representation

func (*GetAdmChannelInput) SetApplicationId added in v1.12.1

func (s *GetAdmChannelInput) SetApplicationId(v string) *GetAdmChannelInput

SetApplicationId sets the ApplicationId field's value.

func (GetAdmChannelInput) String added in v1.12.1

func (s GetAdmChannelInput) String() string

String returns the string representation

func (*GetAdmChannelInput) Validate added in v1.12.1

func (s *GetAdmChannelInput) Validate() error

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

type GetAdmChannelOutput added in v1.12.1

type GetAdmChannelOutput struct {

	// Amazon Device Messaging channel definition.
	//
	// ADMChannelResponse is a required field
	ADMChannelResponse *ADMChannelResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (GetAdmChannelOutput) GoString added in v1.12.1

func (s GetAdmChannelOutput) GoString() string

GoString returns the string representation

func (*GetAdmChannelOutput) SetADMChannelResponse added in v1.12.1

func (s *GetAdmChannelOutput) SetADMChannelResponse(v *ADMChannelResponse) *GetAdmChannelOutput

SetADMChannelResponse sets the ADMChannelResponse field's value.

func (GetAdmChannelOutput) String added in v1.12.1

func (s GetAdmChannelOutput) String() string

String returns the string representation

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) GoString

func (s GetApnsChannelInput) GoString() string

GoString returns the string representation

func (*GetApnsChannelInput) SetApplicationId

func (s *GetApnsChannelInput) SetApplicationId(v string) *GetApnsChannelInput

SetApplicationId sets the ApplicationId field's value.

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 {

	// Apple Distribution Push Notification Service channel definition.
	//
	// APNSChannelResponse is a required field
	APNSChannelResponse *APNSChannelResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (GetApnsChannelOutput) GoString

func (s GetApnsChannelOutput) GoString() string

GoString returns the string representation

func (*GetApnsChannelOutput) SetAPNSChannelResponse

func (s *GetApnsChannelOutput) SetAPNSChannelResponse(v *APNSChannelResponse) *GetApnsChannelOutput

SetAPNSChannelResponse sets the APNSChannelResponse field's value.

func (GetApnsChannelOutput) String

func (s GetApnsChannelOutput) String() string

String returns the string representation

type GetApnsSandboxChannelInput added in v1.8.38

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) GoString added in v1.8.38

func (s GetApnsSandboxChannelInput) GoString() string

GoString returns the string representation

func (*GetApnsSandboxChannelInput) SetApplicationId added in v1.8.38

SetApplicationId sets the ApplicationId field's value.

func (GetApnsSandboxChannelInput) String added in v1.8.38

String returns the string representation

func (*GetApnsSandboxChannelInput) Validate added in v1.8.38

func (s *GetApnsSandboxChannelInput) Validate() error

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

type GetApnsSandboxChannelOutput added in v1.8.38

type GetApnsSandboxChannelOutput struct {

	// Apple Development Push Notification Service channel definition.
	//
	// APNSSandboxChannelResponse is a required field
	APNSSandboxChannelResponse *APNSSandboxChannelResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (GetApnsSandboxChannelOutput) GoString added in v1.8.38

func (s GetApnsSandboxChannelOutput) GoString() string

GoString returns the string representation

func (*GetApnsSandboxChannelOutput) SetAPNSSandboxChannelResponse added in v1.8.38

SetAPNSSandboxChannelResponse sets the APNSSandboxChannelResponse field's value.

func (GetApnsSandboxChannelOutput) String added in v1.8.38

String returns the string representation

type GetApnsVoipChannelInput added in v1.12.17

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) GoString added in v1.12.17

func (s GetApnsVoipChannelInput) GoString() string

GoString returns the string representation

func (*GetApnsVoipChannelInput) SetApplicationId added in v1.12.17

func (s *GetApnsVoipChannelInput) SetApplicationId(v string) *GetApnsVoipChannelInput

SetApplicationId sets the ApplicationId field's value.

func (GetApnsVoipChannelInput) String added in v1.12.17

func (s GetApnsVoipChannelInput) String() string

String returns the string representation

func (*GetApnsVoipChannelInput) Validate added in v1.12.17

func (s *GetApnsVoipChannelInput) Validate() error

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

type GetApnsVoipChannelOutput added in v1.12.17

type GetApnsVoipChannelOutput struct {

	// Apple VoIP Push Notification Service channel definition.
	//
	// APNSVoipChannelResponse is a required field
	APNSVoipChannelResponse *APNSVoipChannelResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (GetApnsVoipChannelOutput) GoString added in v1.12.17

func (s GetApnsVoipChannelOutput) GoString() string

GoString returns the string representation

func (*GetApnsVoipChannelOutput) SetAPNSVoipChannelResponse added in v1.12.17

SetAPNSVoipChannelResponse sets the APNSVoipChannelResponse field's value.

func (GetApnsVoipChannelOutput) String added in v1.12.17

func (s GetApnsVoipChannelOutput) String() string

String returns the string representation

type GetApnsVoipSandboxChannelInput added in v1.12.17

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) GoString added in v1.12.17

GoString returns the string representation

func (*GetApnsVoipSandboxChannelInput) SetApplicationId added in v1.12.17

SetApplicationId sets the ApplicationId field's value.

func (GetApnsVoipSandboxChannelInput) String added in v1.12.17

String returns the string representation

func (*GetApnsVoipSandboxChannelInput) Validate added in v1.12.17

func (s *GetApnsVoipSandboxChannelInput) Validate() error

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

type GetApnsVoipSandboxChannelOutput added in v1.12.17

type GetApnsVoipSandboxChannelOutput struct {

	// Apple VoIP Developer Push Notification Service channel definition.
	//
	// APNSVoipSandboxChannelResponse is a required field
	APNSVoipSandboxChannelResponse *APNSVoipSandboxChannelResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (GetApnsVoipSandboxChannelOutput) GoString added in v1.12.17

GoString returns the string representation

func (*GetApnsVoipSandboxChannelOutput) SetAPNSVoipSandboxChannelResponse added in v1.12.17

SetAPNSVoipSandboxChannelResponse sets the APNSVoipSandboxChannelResponse field's value.

func (GetApnsVoipSandboxChannelOutput) String added in v1.12.17

String returns the string representation

type GetAppInput added in v1.10.20

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) GoString added in v1.10.20

func (s GetAppInput) GoString() string

GoString returns the string representation

func (*GetAppInput) SetApplicationId added in v1.10.20

func (s *GetAppInput) SetApplicationId(v string) *GetAppInput

SetApplicationId sets the ApplicationId field's value.

func (GetAppInput) String added in v1.10.20

func (s GetAppInput) String() string

String returns the string representation

func (*GetAppInput) Validate added in v1.10.20

func (s *GetAppInput) Validate() error

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

type GetAppOutput added in v1.10.20

type GetAppOutput struct {

	// Application Response.
	//
	// ApplicationResponse is a required field
	ApplicationResponse *ApplicationResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (GetAppOutput) GoString added in v1.10.20

func (s GetAppOutput) GoString() string

GoString returns the string representation

func (*GetAppOutput) SetApplicationResponse added in v1.10.20

func (s *GetAppOutput) SetApplicationResponse(v *ApplicationResponse) *GetAppOutput

SetApplicationResponse sets the ApplicationResponse field's value.

func (GetAppOutput) String added in v1.10.20

func (s GetAppOutput) String() string

String returns the string representation

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) GoString

func (s GetApplicationSettingsInput) GoString() string

GoString returns the string representation

func (*GetApplicationSettingsInput) SetApplicationId

SetApplicationId sets the ApplicationId field's value.

func (GetApplicationSettingsInput) 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 {

	// Application settings.
	//
	// ApplicationSettingsResource is a required field
	ApplicationSettingsResource *ApplicationSettingsResource `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (GetApplicationSettingsOutput) GoString

func (s GetApplicationSettingsOutput) GoString() string

GoString returns the string representation

func (*GetApplicationSettingsOutput) SetApplicationSettingsResource

SetApplicationSettingsResource sets the ApplicationSettingsResource field's value.

func (GetApplicationSettingsOutput) String

String returns the string representation

type GetAppsInput added in v1.10.20

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) GoString added in v1.10.20

func (s GetAppsInput) GoString() string

GoString returns the string representation

func (*GetAppsInput) SetPageSize added in v1.10.20

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

SetPageSize sets the PageSize field's value.

func (*GetAppsInput) SetToken added in v1.10.20

func (s *GetAppsInput) SetToken(v string) *GetAppsInput

SetToken sets the Token field's value.

func (GetAppsInput) String added in v1.10.20

func (s GetAppsInput) String() string

String returns the string representation

type GetAppsOutput added in v1.10.20

type GetAppsOutput struct {

	// Get Applications Result.
	//
	// ApplicationsResponse is a required field
	ApplicationsResponse *ApplicationsResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (GetAppsOutput) GoString added in v1.10.20

func (s GetAppsOutput) GoString() string

GoString returns the string representation

func (*GetAppsOutput) SetApplicationsResponse added in v1.10.20

func (s *GetAppsOutput) SetApplicationsResponse(v *ApplicationsResponse) *GetAppsOutput

SetApplicationsResponse sets the ApplicationsResponse field's value.

func (GetAppsOutput) String added in v1.10.20

func (s GetAppsOutput) String() string

String returns the string representation

type GetBaiduChannelInput added in v1.12.1

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) GoString added in v1.12.1

func (s GetBaiduChannelInput) GoString() string

GoString returns the string representation

func (*GetBaiduChannelInput) SetApplicationId added in v1.12.1

func (s *GetBaiduChannelInput) SetApplicationId(v string) *GetBaiduChannelInput

SetApplicationId sets the ApplicationId field's value.

func (GetBaiduChannelInput) String added in v1.12.1

func (s GetBaiduChannelInput) String() string

String returns the string representation

func (*GetBaiduChannelInput) Validate added in v1.12.1

func (s *GetBaiduChannelInput) Validate() error

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

type GetBaiduChannelOutput added in v1.12.1

type GetBaiduChannelOutput struct {

	// Baidu Cloud Messaging channel definition
	//
	// BaiduChannelResponse is a required field
	BaiduChannelResponse *BaiduChannelResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (GetBaiduChannelOutput) GoString added in v1.12.1

func (s GetBaiduChannelOutput) GoString() string

GoString returns the string representation

func (*GetBaiduChannelOutput) SetBaiduChannelResponse added in v1.12.1

func (s *GetBaiduChannelOutput) SetBaiduChannelResponse(v *BaiduChannelResponse) *GetBaiduChannelOutput

SetBaiduChannelResponse sets the BaiduChannelResponse field's value.

func (GetBaiduChannelOutput) String added in v1.12.1

func (s GetBaiduChannelOutput) String() string

String returns the string representation

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) GoString

func (s GetCampaignActivitiesInput) GoString() string

GoString returns the string representation

func (*GetCampaignActivitiesInput) SetApplicationId

SetApplicationId sets the ApplicationId field's value.

func (*GetCampaignActivitiesInput) SetCampaignId

SetCampaignId sets the CampaignId field's value.

func (*GetCampaignActivitiesInput) SetPageSize

SetPageSize sets the PageSize field's value.

func (*GetCampaignActivitiesInput) SetToken

SetToken sets the Token field's value.

func (GetCampaignActivitiesInput) 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 {

	// Activities for campaign.
	//
	// ActivitiesResponse is a required field
	ActivitiesResponse *ActivitiesResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (GetCampaignActivitiesOutput) GoString

func (s GetCampaignActivitiesOutput) GoString() string

GoString returns the string representation

func (*GetCampaignActivitiesOutput) SetActivitiesResponse

SetActivitiesResponse sets the ActivitiesResponse field's value.

func (GetCampaignActivitiesOutput) String

String returns the string representation

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) GoString

func (s GetCampaignInput) GoString() string

GoString returns the string representation

func (*GetCampaignInput) SetApplicationId

func (s *GetCampaignInput) SetApplicationId(v string) *GetCampaignInput

SetApplicationId sets the ApplicationId field's value.

func (*GetCampaignInput) SetCampaignId

func (s *GetCampaignInput) SetCampaignId(v string) *GetCampaignInput

SetCampaignId sets the CampaignId field's value.

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 {

	// Campaign definition
	//
	// CampaignResponse is a required field
	CampaignResponse *CampaignResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (GetCampaignOutput) GoString

func (s GetCampaignOutput) GoString() string

GoString returns the string representation

func (*GetCampaignOutput) SetCampaignResponse

func (s *GetCampaignOutput) SetCampaignResponse(v *CampaignResponse) *GetCampaignOutput

SetCampaignResponse sets the CampaignResponse field's value.

func (GetCampaignOutput) String

func (s GetCampaignOutput) String() string

String returns the string representation

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) GoString

func (s GetCampaignVersionInput) GoString() string

GoString returns the string representation

func (*GetCampaignVersionInput) SetApplicationId

func (s *GetCampaignVersionInput) SetApplicationId(v string) *GetCampaignVersionInput

SetApplicationId sets the ApplicationId field's value.

func (*GetCampaignVersionInput) SetCampaignId

SetCampaignId sets the CampaignId field's value.

func (*GetCampaignVersionInput) SetVersion

SetVersion sets the Version field's value.

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 {

	// Campaign definition
	//
	// CampaignResponse is a required field
	CampaignResponse *CampaignResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (GetCampaignVersionOutput) GoString

func (s GetCampaignVersionOutput) GoString() string

GoString returns the string representation

func (*GetCampaignVersionOutput) SetCampaignResponse

SetCampaignResponse sets the CampaignResponse field's value.

func (GetCampaignVersionOutput) String

func (s GetCampaignVersionOutput) String() string

String returns the string representation

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) GoString

func (s GetCampaignVersionsInput) GoString() string

GoString returns the string representation

func (*GetCampaignVersionsInput) SetApplicationId

SetApplicationId sets the ApplicationId field's value.

func (*GetCampaignVersionsInput) SetCampaignId

SetCampaignId sets the CampaignId field's value.

func (*GetCampaignVersionsInput) SetPageSize

SetPageSize sets the PageSize field's value.

func (*GetCampaignVersionsInput) SetToken

SetToken sets the Token field's value.

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 {

	// List of available campaigns.
	//
	// CampaignsResponse is a required field
	CampaignsResponse *CampaignsResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (GetCampaignVersionsOutput) GoString

func (s GetCampaignVersionsOutput) GoString() string

GoString returns the string representation

func (*GetCampaignVersionsOutput) SetCampaignsResponse

SetCampaignsResponse sets the CampaignsResponse field's value.

func (GetCampaignVersionsOutput) String

func (s GetCampaignVersionsOutput) String() string

String returns the string representation

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) GoString

func (s GetCampaignsInput) GoString() string

GoString returns the string representation

func (*GetCampaignsInput) SetApplicationId

func (s *GetCampaignsInput) SetApplicationId(v string) *GetCampaignsInput

SetApplicationId sets the ApplicationId field's value.

func (*GetCampaignsInput) SetPageSize

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

SetPageSize sets the PageSize field's value.

func (*GetCampaignsInput) SetToken

func (s *GetCampaignsInput) SetToken(v string) *GetCampaignsInput

SetToken sets the Token field's value.

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 {

	// List of available campaigns.
	//
	// CampaignsResponse is a required field
	CampaignsResponse *CampaignsResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (GetCampaignsOutput) GoString

func (s GetCampaignsOutput) GoString() string

GoString returns the string representation

func (*GetCampaignsOutput) SetCampaignsResponse

func (s *GetCampaignsOutput) SetCampaignsResponse(v *CampaignsResponse) *GetCampaignsOutput

SetCampaignsResponse sets the CampaignsResponse field's value.

func (GetCampaignsOutput) String

func (s GetCampaignsOutput) String() string

String returns the string representation

type GetEmailChannelInput added in v1.8.38

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) GoString added in v1.8.38

func (s GetEmailChannelInput) GoString() string

GoString returns the string representation

func (*GetEmailChannelInput) SetApplicationId added in v1.8.38

func (s *GetEmailChannelInput) SetApplicationId(v string) *GetEmailChannelInput

SetApplicationId sets the ApplicationId field's value.

func (GetEmailChannelInput) String added in v1.8.38

func (s GetEmailChannelInput) String() string

String returns the string representation

func (*GetEmailChannelInput) Validate added in v1.8.38

func (s *GetEmailChannelInput) Validate() error

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

type GetEmailChannelOutput added in v1.8.38

type GetEmailChannelOutput struct {

	// Email Channel Response.
	//
	// EmailChannelResponse is a required field
	EmailChannelResponse *EmailChannelResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (GetEmailChannelOutput) GoString added in v1.8.38

func (s GetEmailChannelOutput) GoString() string

GoString returns the string representation

func (*GetEmailChannelOutput) SetEmailChannelResponse added in v1.8.38

func (s *GetEmailChannelOutput) SetEmailChannelResponse(v *EmailChannelResponse) *GetEmailChannelOutput

SetEmailChannelResponse sets the EmailChannelResponse field's value.

func (GetEmailChannelOutput) String added in v1.8.38

func (s GetEmailChannelOutput) String() string

String returns the string representation

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) GoString

func (s GetEndpointInput) GoString() string

GoString returns the string representation

func (*GetEndpointInput) SetApplicationId

func (s *GetEndpointInput) SetApplicationId(v string) *GetEndpointInput

SetApplicationId sets the ApplicationId field's value.

func (*GetEndpointInput) SetEndpointId

func (s *GetEndpointInput) SetEndpointId(v string) *GetEndpointInput

SetEndpointId sets the EndpointId field's value.

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 {

	// Endpoint response
	//
	// EndpointResponse is a required field
	EndpointResponse *EndpointResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (GetEndpointOutput) GoString

func (s GetEndpointOutput) GoString() string

GoString returns the string representation

func (*GetEndpointOutput) SetEndpointResponse

func (s *GetEndpointOutput) SetEndpointResponse(v *EndpointResponse) *GetEndpointOutput

SetEndpointResponse sets the EndpointResponse field's value.

func (GetEndpointOutput) String

func (s GetEndpointOutput) String() string

String returns the string representation

type GetEventStreamInput added in v1.8.0

type GetEventStreamInput struct {

	// Application Id.
	//
	// ApplicationId is a required field
	ApplicationId *string `location:"uri" locationName:"application-id" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetEventStreamInput) GoString added in v1.8.0

func (s GetEventStreamInput) GoString() string

GoString returns the string representation

func (*GetEventStreamInput) SetApplicationId added in v1.8.0

func (s *GetEventStreamInput) SetApplicationId(v string) *GetEventStreamInput

SetApplicationId sets the ApplicationId field's value.

func (GetEventStreamInput) String added in v1.8.0

func (s GetEventStreamInput) String() string

String returns the string representation

func (*GetEventStreamInput) Validate added in v1.8.0

func (s *GetEventStreamInput) Validate() error

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

type GetEventStreamOutput added in v1.8.0

type GetEventStreamOutput struct {

	// Model for an event publishing subscription export.
	//
	// EventStream is a required field
	EventStream *EventStream `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (GetEventStreamOutput) GoString added in v1.8.0

func (s GetEventStreamOutput) GoString() string

GoString returns the string representation

func (*GetEventStreamOutput) SetEventStream added in v1.8.0

func (s *GetEventStreamOutput) SetEventStream(v *EventStream) *GetEventStreamOutput

SetEventStream sets the EventStream field's value.

func (GetEventStreamOutput) String added in v1.8.0

func (s GetEventStreamOutput) String() string

String returns the string representation

type GetExportJobInput added in v1.13.11

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) GoString added in v1.13.11

func (s GetExportJobInput) GoString() string

GoString returns the string representation

func (*GetExportJobInput) SetApplicationId added in v1.13.11

func (s *GetExportJobInput) SetApplicationId(v string) *GetExportJobInput

SetApplicationId sets the ApplicationId field's value.

func (*GetExportJobInput) SetJobId added in v1.13.11

func (s *GetExportJobInput) SetJobId(v string) *GetExportJobInput

SetJobId sets the JobId field's value.

func (GetExportJobInput) String added in v1.13.11

func (s GetExportJobInput) String() string

String returns the string representation

func (*GetExportJobInput) Validate added in v1.13.11

func (s *GetExportJobInput) Validate() error

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

type GetExportJobOutput added in v1.13.11

type GetExportJobOutput struct {

	// ExportJobResponse is a required field
	ExportJobResponse *ExportJobResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (GetExportJobOutput) GoString added in v1.13.11

func (s GetExportJobOutput) GoString() string

GoString returns the string representation

func (*GetExportJobOutput) SetExportJobResponse added in v1.13.11

func (s *GetExportJobOutput) SetExportJobResponse(v *ExportJobResponse) *GetExportJobOutput

SetExportJobResponse sets the ExportJobResponse field's value.

func (GetExportJobOutput) String added in v1.13.11

func (s GetExportJobOutput) String() string

String returns the string representation

type GetExportJobsInput added in v1.13.11

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) GoString added in v1.13.11

func (s GetExportJobsInput) GoString() string

GoString returns the string representation

func (*GetExportJobsInput) SetApplicationId added in v1.13.11

func (s *GetExportJobsInput) SetApplicationId(v string) *GetExportJobsInput

SetApplicationId sets the ApplicationId field's value.

func (*GetExportJobsInput) SetPageSize added in v1.13.11

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

SetPageSize sets the PageSize field's value.

func (*GetExportJobsInput) SetToken added in v1.13.11

SetToken sets the Token field's value.

func (GetExportJobsInput) String added in v1.13.11

func (s GetExportJobsInput) String() string

String returns the string representation

func (*GetExportJobsInput) Validate added in v1.13.11

func (s *GetExportJobsInput) Validate() error

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

type GetExportJobsOutput added in v1.13.11

type GetExportJobsOutput struct {

	// Export job list.
	//
	// ExportJobsResponse is a required field
	ExportJobsResponse *ExportJobsResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (GetExportJobsOutput) GoString added in v1.13.11

func (s GetExportJobsOutput) GoString() string

GoString returns the string representation

func (*GetExportJobsOutput) SetExportJobsResponse added in v1.13.11

func (s *GetExportJobsOutput) SetExportJobsResponse(v *ExportJobsResponse) *GetExportJobsOutput

SetExportJobsResponse sets the ExportJobsResponse field's value.

func (GetExportJobsOutput) String added in v1.13.11

func (s GetExportJobsOutput) String() string

String returns the string representation

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) GoString

func (s GetGcmChannelInput) GoString() string

GoString returns the string representation

func (*GetGcmChannelInput) SetApplicationId

func (s *GetGcmChannelInput) SetApplicationId(v string) *GetGcmChannelInput

SetApplicationId sets the ApplicationId field's value.

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 {

	// Google Cloud Messaging channel definition
	//
	// GCMChannelResponse is a required field
	GCMChannelResponse *GCMChannelResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (GetGcmChannelOutput) GoString

func (s GetGcmChannelOutput) GoString() string

GoString returns the string representation

func (*GetGcmChannelOutput) SetGCMChannelResponse

func (s *GetGcmChannelOutput) SetGCMChannelResponse(v *GCMChannelResponse) *GetGcmChannelOutput

SetGCMChannelResponse sets the GCMChannelResponse field's value.

func (GetGcmChannelOutput) String

func (s GetGcmChannelOutput) String() string

String returns the string representation

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) GoString

func (s GetImportJobInput) GoString() string

GoString returns the string representation

func (*GetImportJobInput) SetApplicationId

func (s *GetImportJobInput) SetApplicationId(v string) *GetImportJobInput

SetApplicationId sets the ApplicationId field's value.

func (*GetImportJobInput) SetJobId

func (s *GetImportJobInput) SetJobId(v string) *GetImportJobInput

SetJobId sets the JobId field's value.

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 {

	// ImportJobResponse is a required field
	ImportJobResponse *ImportJobResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (GetImportJobOutput) GoString

func (s GetImportJobOutput) GoString() string

GoString returns the string representation

func (*GetImportJobOutput) SetImportJobResponse

func (s *GetImportJobOutput) SetImportJobResponse(v *ImportJobResponse) *GetImportJobOutput

SetImportJobResponse sets the ImportJobResponse field's value.

func (GetImportJobOutput) String

func (s GetImportJobOutput) String() string

String returns the string representation

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) GoString

func (s GetImportJobsInput) GoString() string

GoString returns the string representation

func (*GetImportJobsInput) SetApplicationId

func (s *GetImportJobsInput) SetApplicationId(v string) *GetImportJobsInput

SetApplicationId sets the ApplicationId field's value.

func (*GetImportJobsInput) SetPageSize

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

SetPageSize sets the PageSize field's value.

func (*GetImportJobsInput) SetToken

SetToken sets the Token field's value.

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 {

	// Import job list.
	//
	// ImportJobsResponse is a required field
	ImportJobsResponse *ImportJobsResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (GetImportJobsOutput) GoString

func (s GetImportJobsOutput) GoString() string

GoString returns the string representation

func (*GetImportJobsOutput) SetImportJobsResponse

func (s *GetImportJobsOutput) SetImportJobsResponse(v *ImportJobsResponse) *GetImportJobsOutput

SetImportJobsResponse sets the ImportJobsResponse field's value.

func (GetImportJobsOutput) String

func (s GetImportJobsOutput) String() string

String returns the string representation

type GetSegmentExportJobsInput added in v1.13.11

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) GoString added in v1.13.11

func (s GetSegmentExportJobsInput) GoString() string

GoString returns the string representation

func (*GetSegmentExportJobsInput) SetApplicationId added in v1.13.11

SetApplicationId sets the ApplicationId field's value.

func (*GetSegmentExportJobsInput) SetPageSize added in v1.13.11

SetPageSize sets the PageSize field's value.

func (*GetSegmentExportJobsInput) SetSegmentId added in v1.13.11

SetSegmentId sets the SegmentId field's value.

func (*GetSegmentExportJobsInput) SetToken added in v1.13.11

SetToken sets the Token field's value.

func (GetSegmentExportJobsInput) String added in v1.13.11

func (s GetSegmentExportJobsInput) String() string

String returns the string representation

func (*GetSegmentExportJobsInput) Validate added in v1.13.11

func (s *GetSegmentExportJobsInput) Validate() error

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

type GetSegmentExportJobsOutput added in v1.13.11

type GetSegmentExportJobsOutput struct {

	// Export job list.
	//
	// ExportJobsResponse is a required field
	ExportJobsResponse *ExportJobsResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (GetSegmentExportJobsOutput) GoString added in v1.13.11

func (s GetSegmentExportJobsOutput) GoString() string

GoString returns the string representation

func (*GetSegmentExportJobsOutput) SetExportJobsResponse added in v1.13.11

SetExportJobsResponse sets the ExportJobsResponse field's value.

func (GetSegmentExportJobsOutput) String added in v1.13.11

String returns the string representation

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) GoString

func (s GetSegmentImportJobsInput) GoString() string

GoString returns the string representation

func (*GetSegmentImportJobsInput) SetApplicationId

SetApplicationId sets the ApplicationId field's value.

func (*GetSegmentImportJobsInput) SetPageSize

SetPageSize sets the PageSize field's value.

func (*GetSegmentImportJobsInput) SetSegmentId

SetSegmentId sets the SegmentId field's value.

func (*GetSegmentImportJobsInput) SetToken

SetToken sets the Token field's value.

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 {

	// Import job list.
	//
	// ImportJobsResponse is a required field
	ImportJobsResponse *ImportJobsResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (GetSegmentImportJobsOutput) GoString

func (s GetSegmentImportJobsOutput) GoString() string

GoString returns the string representation

func (*GetSegmentImportJobsOutput) SetImportJobsResponse

SetImportJobsResponse sets the ImportJobsResponse field's value.

func (GetSegmentImportJobsOutput) String

String returns the string representation

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) GoString

func (s GetSegmentInput) GoString() string

GoString returns the string representation

func (*GetSegmentInput) SetApplicationId

func (s *GetSegmentInput) SetApplicationId(v string) *GetSegmentInput

SetApplicationId sets the ApplicationId field's value.

func (*GetSegmentInput) SetSegmentId

func (s *GetSegmentInput) SetSegmentId(v string) *GetSegmentInput

SetSegmentId sets the SegmentId field's value.

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 {

	// Segment definition.
	//
	// SegmentResponse is a required field
	SegmentResponse *SegmentResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (GetSegmentOutput) GoString

func (s GetSegmentOutput) GoString() string

GoString returns the string representation

func (*GetSegmentOutput) SetSegmentResponse

func (s *GetSegmentOutput) SetSegmentResponse(v *SegmentResponse) *GetSegmentOutput

SetSegmentResponse sets the SegmentResponse field's value.

func (GetSegmentOutput) String

func (s GetSegmentOutput) String() string

String returns the string representation

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) GoString

func (s GetSegmentVersionInput) GoString() string

GoString returns the string representation

func (*GetSegmentVersionInput) SetApplicationId

func (s *GetSegmentVersionInput) SetApplicationId(v string) *GetSegmentVersionInput

SetApplicationId sets the ApplicationId field's value.

func (*GetSegmentVersionInput) SetSegmentId

SetSegmentId sets the SegmentId field's value.

func (*GetSegmentVersionInput) SetVersion

SetVersion sets the Version field's value.

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 {

	// Segment definition.
	//
	// SegmentResponse is a required field
	SegmentResponse *SegmentResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (GetSegmentVersionOutput) GoString

func (s GetSegmentVersionOutput) GoString() string

GoString returns the string representation

func (*GetSegmentVersionOutput) SetSegmentResponse

SetSegmentResponse sets the SegmentResponse field's value.

func (GetSegmentVersionOutput) String

func (s GetSegmentVersionOutput) String() string

String returns the string representation

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) GoString

func (s GetSegmentVersionsInput) GoString() string

GoString returns the string representation

func (*GetSegmentVersionsInput) SetApplicationId

func (s *GetSegmentVersionsInput) SetApplicationId(v string) *GetSegmentVersionsInput

SetApplicationId sets the ApplicationId field's value.

func (*GetSegmentVersionsInput) SetPageSize

SetPageSize sets the PageSize field's value.

func (*GetSegmentVersionsInput) SetSegmentId

SetSegmentId sets the SegmentId field's value.

func (*GetSegmentVersionsInput) SetToken

SetToken sets the Token field's value.

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 {

	// Segments in your account.
	//
	// SegmentsResponse is a required field
	SegmentsResponse *SegmentsResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (GetSegmentVersionsOutput) GoString

func (s GetSegmentVersionsOutput) GoString() string

GoString returns the string representation

func (*GetSegmentVersionsOutput) SetSegmentsResponse

SetSegmentsResponse sets the SegmentsResponse field's value.

func (GetSegmentVersionsOutput) String

func (s GetSegmentVersionsOutput) String() string

String returns the string representation

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) GoString

func (s GetSegmentsInput) GoString() string

GoString returns the string representation

func (*GetSegmentsInput) SetApplicationId

func (s *GetSegmentsInput) SetApplicationId(v string) *GetSegmentsInput

SetApplicationId sets the ApplicationId field's value.

func (*GetSegmentsInput) SetPageSize

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

SetPageSize sets the PageSize field's value.

func (*GetSegmentsInput) SetToken

func (s *GetSegmentsInput) SetToken(v string) *GetSegmentsInput

SetToken sets the Token field's value.

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 {

	// Segments in your account.
	//
	// SegmentsResponse is a required field
	SegmentsResponse *SegmentsResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (GetSegmentsOutput) GoString

func (s GetSegmentsOutput) GoString() string

GoString returns the string representation

func (*GetSegmentsOutput) SetSegmentsResponse

func (s *GetSegmentsOutput) SetSegmentsResponse(v *SegmentsResponse) *GetSegmentsOutput

SetSegmentsResponse sets the SegmentsResponse field's value.

func (GetSegmentsOutput) String

func (s GetSegmentsOutput) String() string

String returns the string representation

type GetSmsChannelInput added in v1.8.38

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) GoString added in v1.8.38

func (s GetSmsChannelInput) GoString() string

GoString returns the string representation

func (*GetSmsChannelInput) SetApplicationId added in v1.8.38

func (s *GetSmsChannelInput) SetApplicationId(v string) *GetSmsChannelInput

SetApplicationId sets the ApplicationId field's value.

func (GetSmsChannelInput) String added in v1.8.38

func (s GetSmsChannelInput) String() string

String returns the string representation

func (*GetSmsChannelInput) Validate added in v1.8.38

func (s *GetSmsChannelInput) Validate() error

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

type GetSmsChannelOutput added in v1.8.38

type GetSmsChannelOutput struct {

	// SMS Channel Response.
	//
	// SMSChannelResponse is a required field
	SMSChannelResponse *SMSChannelResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (GetSmsChannelOutput) GoString added in v1.8.38

func (s GetSmsChannelOutput) GoString() string

GoString returns the string representation

func (*GetSmsChannelOutput) SetSMSChannelResponse added in v1.8.38

func (s *GetSmsChannelOutput) SetSMSChannelResponse(v *SMSChannelResponse) *GetSmsChannelOutput

SetSMSChannelResponse sets the SMSChannelResponse field's value.

func (GetSmsChannelOutput) String added in v1.8.38

func (s GetSmsChannelOutput) String() string

String returns the string representation

type ImportJobRequest

type ImportJobRequest struct {

	// Sets whether the endpoints create a segment when they are imported.
	DefineSegment *bool `type:"boolean"`

	// DEPRECATED. Your AWS account ID, which you assigned to the ExternalID key
	// in an IAM trust policy. Used by Amazon Pinpoint to assume an IAM role. This
	// requirement is removed, and external IDs are not recommended for IAM roles
	// assumed by Amazon Pinpoint.
	ExternalId *string `type:"string"`

	// The format of the files that contain the endpoint definitions.Valid values:
	// CSV, JSON
	Format *string `type:"string" enum:"Format"`

	// Sets whether the endpoints are registered with Amazon Pinpoint when they
	// are imported.
	RegisterEndpoints *bool `type:"boolean"`

	// The Amazon Resource Name (ARN) of an IAM role that grants Amazon Pinpoint
	// access to the Amazon S3 location that contains the endpoints to import.
	RoleArn *string `type:"string"`

	// A URL that points to the location within an Amazon S3 bucket that contains
	// the endpoints to import. The location can be a folder or a single file.The
	// URL should follow this format: s3://bucket-name/folder-name/file-nameAmazon
	// Pinpoint will import endpoints from this location and any subfolders it contains.
	S3Url *string `type:"string"`

	// The ID of the segment to update if the import job is meant to update an existing
	// segment.
	SegmentId *string `type:"string"`

	// A custom name for the segment created by the import job. Use if DefineSegment
	// is true.
	SegmentName *string `type:"string"`
	// contains filtered or unexported fields
}

func (ImportJobRequest) GoString

func (s ImportJobRequest) GoString() string

GoString returns the string representation

func (*ImportJobRequest) SetDefineSegment

func (s *ImportJobRequest) SetDefineSegment(v bool) *ImportJobRequest

SetDefineSegment sets the DefineSegment field's value.

func (*ImportJobRequest) SetExternalId

func (s *ImportJobRequest) SetExternalId(v string) *ImportJobRequest

SetExternalId sets the ExternalId field's value.

func (*ImportJobRequest) SetFormat

func (s *ImportJobRequest) SetFormat(v string) *ImportJobRequest

SetFormat sets the Format field's value.

func (*ImportJobRequest) SetRegisterEndpoints

func (s *ImportJobRequest) SetRegisterEndpoints(v bool) *ImportJobRequest

SetRegisterEndpoints sets the RegisterEndpoints field's value.

func (*ImportJobRequest) SetRoleArn

func (s *ImportJobRequest) SetRoleArn(v string) *ImportJobRequest

SetRoleArn sets the RoleArn field's value.

func (*ImportJobRequest) SetS3Url

func (s *ImportJobRequest) SetS3Url(v string) *ImportJobRequest

SetS3Url sets the S3Url field's value.

func (*ImportJobRequest) SetSegmentId

func (s *ImportJobRequest) SetSegmentId(v string) *ImportJobRequest

SetSegmentId sets the SegmentId field's value.

func (*ImportJobRequest) SetSegmentName

func (s *ImportJobRequest) SetSegmentName(v string) *ImportJobRequest

SetSegmentName sets the SegmentName field's value.

func (ImportJobRequest) String

func (s ImportJobRequest) String() string

String returns the string representation

type ImportJobResource

type ImportJobResource struct {

	// Sets whether the endpoints create a segment when they are imported.
	DefineSegment *bool `type:"boolean"`

	// DEPRECATED. Your AWS account ID, which you assigned to the ExternalID key
	// in an IAM trust policy. Used by Amazon Pinpoint to assume an IAM role. This
	// requirement is removed, and external IDs are not recommended for IAM roles
	// assumed by Amazon Pinpoint.
	ExternalId *string `type:"string"`

	// The format of the files that contain the endpoint definitions.Valid values:
	// CSV, JSON
	Format *string `type:"string" enum:"Format"`

	// Sets whether the endpoints are registered with Amazon Pinpoint when they
	// are imported.
	RegisterEndpoints *bool `type:"boolean"`

	// The Amazon Resource Name (ARN) of an IAM role that grants Amazon Pinpoint
	// access to the Amazon S3 location that contains the endpoints to import.
	RoleArn *string `type:"string"`

	// A URL that points to the location within an Amazon S3 bucket that contains
	// the endpoints to import. The location can be a folder or a single file.The
	// URL should follow this format: s3://bucket-name/folder-name/file-nameAmazon
	// Pinpoint will import endpoints from this location and any subfolders it contains.
	S3Url *string `type:"string"`

	// The ID of the segment to update if the import job is meant to update an existing
	// segment.
	SegmentId *string `type:"string"`

	// A custom name for the segment created by the import job. Use if DefineSegment
	// is true.
	SegmentName *string `type:"string"`
	// contains filtered or unexported fields
}

func (ImportJobResource) GoString

func (s ImportJobResource) GoString() string

GoString returns the string representation

func (*ImportJobResource) SetDefineSegment

func (s *ImportJobResource) SetDefineSegment(v bool) *ImportJobResource

SetDefineSegment sets the DefineSegment field's value.

func (*ImportJobResource) SetExternalId

func (s *ImportJobResource) SetExternalId(v string) *ImportJobResource

SetExternalId sets the ExternalId field's value.

func (*ImportJobResource) SetFormat

func (s *ImportJobResource) SetFormat(v string) *ImportJobResource

SetFormat sets the Format field's value.

func (*ImportJobResource) SetRegisterEndpoints

func (s *ImportJobResource) SetRegisterEndpoints(v bool) *ImportJobResource

SetRegisterEndpoints sets the RegisterEndpoints field's value.

func (*ImportJobResource) SetRoleArn

func (s *ImportJobResource) SetRoleArn(v string) *ImportJobResource

SetRoleArn sets the RoleArn field's value.

func (*ImportJobResource) SetS3Url

func (s *ImportJobResource) SetS3Url(v string) *ImportJobResource

SetS3Url sets the S3Url field's value.

func (*ImportJobResource) SetSegmentId

func (s *ImportJobResource) SetSegmentId(v string) *ImportJobResource

SetSegmentId sets the SegmentId field's value.

func (*ImportJobResource) SetSegmentName

func (s *ImportJobResource) SetSegmentName(v string) *ImportJobResource

SetSegmentName sets the SegmentName field's value.

func (ImportJobResource) String

func (s ImportJobResource) String() string

String returns the string representation

type ImportJobResponse

type ImportJobResponse struct {

	// The unique ID of the application to which the import job applies.
	ApplicationId *string `type:"string"`

	// The number of pieces that have successfully imported as of the time of the
	// request.
	CompletedPieces *int64 `type:"integer"`

	// The date the import job completed in ISO 8601 format.
	CompletionDate *string `type:"string"`

	// The date the import job was created in ISO 8601 format.
	CreationDate *string `type:"string"`

	// The import job settings.
	Definition *ImportJobResource `type:"structure"`

	// The number of pieces that have failed to import as of the time of the request.
	FailedPieces *int64 `type:"integer"`

	Failures []*string `type:"list"`

	// The unique ID of the import job.
	Id *string `type:"string"`

	// The status of the import job.Valid values: CREATED, INITIALIZING, PROCESSING,
	// COMPLETING, COMPLETED, FAILING, FAILEDThe job status is FAILED if one or
	// more pieces failed to import.
	JobStatus *string `type:"string" enum:"JobStatus"`

	// The number of endpoints that failed to import; for example, because of syntax
	// errors.
	TotalFailures *int64 `type:"integer"`

	// The total number of pieces that must be imported to finish the job. Each
	// piece is an approximately equal portion of the endpoints to import.
	TotalPieces *int64 `type:"integer"`

	// The number of endpoints that were processed by the import job.
	TotalProcessed *int64 `type:"integer"`

	// The job type. Will be Import.
	Type *string `type:"string"`
	// contains filtered or unexported fields
}

func (ImportJobResponse) GoString

func (s ImportJobResponse) GoString() string

GoString returns the string representation

func (*ImportJobResponse) SetApplicationId

func (s *ImportJobResponse) SetApplicationId(v string) *ImportJobResponse

SetApplicationId sets the ApplicationId field's value.

func (*ImportJobResponse) SetCompletedPieces

func (s *ImportJobResponse) SetCompletedPieces(v int64) *ImportJobResponse

SetCompletedPieces sets the CompletedPieces field's value.

func (*ImportJobResponse) SetCompletionDate

func (s *ImportJobResponse) SetCompletionDate(v string) *ImportJobResponse

SetCompletionDate sets the CompletionDate field's value.

func (*ImportJobResponse) SetCreationDate

func (s *ImportJobResponse) SetCreationDate(v string) *ImportJobResponse

SetCreationDate sets the CreationDate field's value.

func (*ImportJobResponse) SetDefinition

SetDefinition sets the Definition field's value.

func (*ImportJobResponse) SetFailedPieces

func (s *ImportJobResponse) SetFailedPieces(v int64) *ImportJobResponse

SetFailedPieces sets the FailedPieces field's value.

func (*ImportJobResponse) SetFailures

func (s *ImportJobResponse) SetFailures(v []*string) *ImportJobResponse

SetFailures sets the Failures field's value.

func (*ImportJobResponse) SetId

SetId sets the Id field's value.

func (*ImportJobResponse) SetJobStatus

func (s *ImportJobResponse) SetJobStatus(v string) *ImportJobResponse

SetJobStatus sets the JobStatus field's value.

func (*ImportJobResponse) SetTotalFailures

func (s *ImportJobResponse) SetTotalFailures(v int64) *ImportJobResponse

SetTotalFailures sets the TotalFailures field's value.

func (*ImportJobResponse) SetTotalPieces

func (s *ImportJobResponse) SetTotalPieces(v int64) *ImportJobResponse

SetTotalPieces sets the TotalPieces field's value.

func (*ImportJobResponse) SetTotalProcessed

func (s *ImportJobResponse) SetTotalProcessed(v int64) *ImportJobResponse

SetTotalProcessed sets the TotalProcessed field's value.

func (*ImportJobResponse) SetType

SetType sets the Type field's value.

func (ImportJobResponse) String

func (s ImportJobResponse) String() string

String returns the string representation

type ImportJobsResponse

type ImportJobsResponse struct {

	// A list of import jobs for the application.
	Item []*ImportJobResponse `type:"list"`

	// The string that you use in a subsequent request to get the next page of results
	// in a paginated response.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

Import job list.

func (ImportJobsResponse) GoString

func (s ImportJobsResponse) GoString() string

GoString returns the string representation

func (*ImportJobsResponse) SetItem

SetItem sets the Item field's value.

func (*ImportJobsResponse) SetNextToken

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

SetNextToken sets the NextToken field's value.

func (ImportJobsResponse) String

func (s ImportJobsResponse) String() string

String returns the string representation

type Message

type Message struct {

	// The action that occurs if the user taps a push notification delivered by
	// the campaign:OPEN_APP - Your app launches, or it becomes the foreground app
	// if it has been sent to the background. This is the default action.DEEP_LINK
	// - Uses deep linking features in iOS and Android to open your app and display
	// a designated user interface within the app.URL - The default mobile browser
	// on the user's device launches and opens a web page at the URL you specify.
	Action *string `type:"string" enum:"Action"`

	// The message body. Can include up to 140 characters.
	Body *string `type:"string"`

	// The URL that points to the icon image for the push notification icon, for
	// example, the app icon.
	ImageIconUrl *string `type:"string"`

	// The URL that points to the small icon image for the push notification icon,
	// for example, the app icon.
	ImageSmallIconUrl *string `type:"string"`

	// The URL that points to an image used in the push notification.
	ImageUrl *string `type:"string"`

	// The JSON payload used for a silent push.
	JsonBody *string `type:"string"`

	// The URL that points to the media resource, for example a .mp4 or .gif file.
	MediaUrl *string `type:"string"`

	// The Raw JSON formatted string to be used as the payload. This value overrides
	// the message.
	RawContent *string `type:"string"`

	// Indicates if the message should display on the users device.Silent pushes
	// can be used for Remote Configuration and Phone Home use cases.
	SilentPush *bool `type:"boolean"`

	// The message title that displays above the message on the user's device.
	Title *string `type:"string"`

	// The URL to open in the user's mobile browser. Used if the value for Action
	// is URL.
	Url *string `type:"string"`
	// contains filtered or unexported fields
}

func (Message) GoString

func (s Message) GoString() string

GoString returns the string representation

func (*Message) SetAction

func (s *Message) SetAction(v string) *Message

SetAction sets the Action field's value.

func (*Message) SetBody

func (s *Message) SetBody(v string) *Message

SetBody sets the Body field's value.

func (*Message) SetImageIconUrl

func (s *Message) SetImageIconUrl(v string) *Message

SetImageIconUrl sets the ImageIconUrl field's value.

func (*Message) SetImageSmallIconUrl added in v1.8.38

func (s *Message) SetImageSmallIconUrl(v string) *Message

SetImageSmallIconUrl sets the ImageSmallIconUrl field's value.

func (*Message) SetImageUrl

func (s *Message) SetImageUrl(v string) *Message

SetImageUrl sets the ImageUrl field's value.

func (*Message) SetJsonBody

func (s *Message) SetJsonBody(v string) *Message

SetJsonBody sets the JsonBody field's value.

func (*Message) SetMediaUrl

func (s *Message) SetMediaUrl(v string) *Message

SetMediaUrl sets the MediaUrl field's value.

func (*Message) SetRawContent added in v1.10.20

func (s *Message) SetRawContent(v string) *Message

SetRawContent sets the RawContent field's value.

func (*Message) SetSilentPush

func (s *Message) SetSilentPush(v bool) *Message

SetSilentPush sets the SilentPush field's value.

func (*Message) SetTitle

func (s *Message) SetTitle(v string) *Message

SetTitle sets the Title field's value.

func (*Message) SetUrl

func (s *Message) SetUrl(v string) *Message

SetUrl sets the Url field's value.

func (Message) String

func (s Message) String() string

String returns the string representation

type MessageBody

type MessageBody struct {

	// The error message returned from the API.
	Message *string `type:"string"`

	// The unique message body ID.
	RequestID *string `type:"string"`
	// contains filtered or unexported fields
}

Simple message object.

func (MessageBody) GoString

func (s MessageBody) GoString() string

GoString returns the string representation

func (*MessageBody) SetMessage

func (s *MessageBody) SetMessage(v string) *MessageBody

SetMessage sets the Message field's value.

func (*MessageBody) SetRequestID

func (s *MessageBody) SetRequestID(v string) *MessageBody

SetRequestID sets the RequestID field's value.

func (MessageBody) String

func (s MessageBody) String() string

String returns the string representation

type MessageConfiguration

type MessageConfiguration struct {

	// The message that the campaign delivers to ADM channels. Overrides the default
	// message.
	ADMMessage *Message `type:"structure"`

	// The message that the campaign delivers to APNS channels. Overrides the default
	// message.
	APNSMessage *Message `type:"structure"`

	// The message that the campaign delivers to Baidu channels. Overrides the default
	// message.
	BaiduMessage *Message `type:"structure"`

	// The default message for all channels.
	DefaultMessage *Message `type:"structure"`

	// The email message configuration.
	EmailMessage *CampaignEmailMessage `type:"structure"`

	// The message that the campaign delivers to GCM channels. Overrides the default
	// message.
	GCMMessage *Message `type:"structure"`

	// The SMS message configuration.
	SMSMessage *CampaignSmsMessage `type:"structure"`
	// contains filtered or unexported fields
}

Message configuration for a campaign.

func (MessageConfiguration) GoString

func (s MessageConfiguration) GoString() string

GoString returns the string representation

func (*MessageConfiguration) SetADMMessage added in v1.12.17

func (s *MessageConfiguration) SetADMMessage(v *Message) *MessageConfiguration

SetADMMessage sets the ADMMessage field's value.

func (*MessageConfiguration) SetAPNSMessage

func (s *MessageConfiguration) SetAPNSMessage(v *Message) *MessageConfiguration

SetAPNSMessage sets the APNSMessage field's value.

func (*MessageConfiguration) SetBaiduMessage added in v1.12.17

func (s *MessageConfiguration) SetBaiduMessage(v *Message) *MessageConfiguration

SetBaiduMessage sets the BaiduMessage field's value.

func (*MessageConfiguration) SetDefaultMessage

func (s *MessageConfiguration) SetDefaultMessage(v *Message) *MessageConfiguration

SetDefaultMessage sets the DefaultMessage field's value.

func (*MessageConfiguration) SetEmailMessage added in v1.8.38

SetEmailMessage sets the EmailMessage field's value.

func (*MessageConfiguration) SetGCMMessage

func (s *MessageConfiguration) SetGCMMessage(v *Message) *MessageConfiguration

SetGCMMessage sets the GCMMessage field's value.

func (*MessageConfiguration) SetSMSMessage added in v1.8.38

SetSMSMessage sets the SMSMessage field's value.

func (MessageConfiguration) String

func (s MessageConfiguration) String() string

String returns the string representation

type MessageRequest added in v1.8.38

type MessageRequest struct {

	// A map of destination addresses, with the address as the key(Email address,
	// phone number or push token) and the Address Configuration as the value.
	Addresses map[string]*AddressConfiguration `type:"map"`

	// A map of custom attributes to attributes to be attached to the message. This
	// payload is added to the push notification's 'data.pinpoint' object or added
	// to the email/sms delivery receipt event attributes.
	Context map[string]*string `type:"map"`

	// A map of destination addresses, with the address as the key(Email address,
	// phone number or push token) and the Address Configuration as the value.
	Endpoints map[string]*EndpointSendConfiguration `type:"map"`

	// Message configuration.
	MessageConfiguration *DirectMessageConfiguration `type:"structure"`
	// contains filtered or unexported fields
}

Send message request.

func (MessageRequest) GoString added in v1.8.38

func (s MessageRequest) GoString() string

GoString returns the string representation

func (*MessageRequest) SetAddresses added in v1.8.38

func (s *MessageRequest) SetAddresses(v map[string]*AddressConfiguration) *MessageRequest

SetAddresses sets the Addresses field's value.

func (*MessageRequest) SetContext added in v1.8.38

func (s *MessageRequest) SetContext(v map[string]*string) *MessageRequest

SetContext sets the Context field's value.

func (*MessageRequest) SetEndpoints added in v1.12.1

SetEndpoints sets the Endpoints field's value.

func (*MessageRequest) SetMessageConfiguration added in v1.8.38

func (s *MessageRequest) SetMessageConfiguration(v *DirectMessageConfiguration) *MessageRequest

SetMessageConfiguration sets the MessageConfiguration field's value.

func (MessageRequest) String added in v1.8.38

func (s MessageRequest) String() string

String returns the string representation

type MessageResponse added in v1.8.38

type MessageResponse struct {

	// Application id of the message.
	ApplicationId *string `type:"string"`

	// A map containing a multi part response for each address, with the endpointId
	// as the key and the result as the value.
	EndpointResult map[string]*EndpointMessageResult `type:"map"`

	// Original request Id for which this message was delivered.
	RequestId *string `type:"string"`

	// A map containing a multi part response for each address, with the address
	// as the key(Email address, phone number or push token) and the result as the
	// value.
	Result map[string]*MessageResult `type:"map"`
	// contains filtered or unexported fields
}

Send message response.

func (MessageResponse) GoString added in v1.8.38

func (s MessageResponse) GoString() string

GoString returns the string representation

func (*MessageResponse) SetApplicationId added in v1.8.38

func (s *MessageResponse) SetApplicationId(v string) *MessageResponse

SetApplicationId sets the ApplicationId field's value.

func (*MessageResponse) SetEndpointResult added in v1.12.1

func (s *MessageResponse) SetEndpointResult(v map[string]*EndpointMessageResult) *MessageResponse

SetEndpointResult sets the EndpointResult field's value.

func (*MessageResponse) SetRequestId added in v1.8.38

func (s *MessageResponse) SetRequestId(v string) *MessageResponse

SetRequestId sets the RequestId field's value.

func (*MessageResponse) SetResult added in v1.8.38

func (s *MessageResponse) SetResult(v map[string]*MessageResult) *MessageResponse

SetResult sets the Result field's value.

func (MessageResponse) String added in v1.8.38

func (s MessageResponse) String() string

String returns the string representation

type MessageResult added in v1.8.38

type MessageResult struct {

	// Delivery status of message.
	DeliveryStatus *string `type:"string" enum:"DeliveryStatus"`

	// Downstream service status code.
	StatusCode *int64 `type:"integer"`

	// Status message for message delivery.
	StatusMessage *string `type:"string"`

	// If token was updated as part of delivery. (This is GCM Specific)
	UpdatedToken *string `type:"string"`
	// contains filtered or unexported fields
}

The result from sending a message to an address.

func (MessageResult) GoString added in v1.8.38

func (s MessageResult) GoString() string

GoString returns the string representation

func (*MessageResult) SetDeliveryStatus added in v1.8.38

func (s *MessageResult) SetDeliveryStatus(v string) *MessageResult

SetDeliveryStatus sets the DeliveryStatus field's value.

func (*MessageResult) SetStatusCode added in v1.8.38

func (s *MessageResult) SetStatusCode(v int64) *MessageResult

SetStatusCode sets the StatusCode field's value.

func (*MessageResult) SetStatusMessage added in v1.8.38

func (s *MessageResult) SetStatusMessage(v string) *MessageResult

SetStatusMessage sets the StatusMessage field's value.

func (*MessageResult) SetUpdatedToken added in v1.8.38

func (s *MessageResult) SetUpdatedToken(v string) *MessageResult

SetUpdatedToken sets the UpdatedToken field's value.

func (MessageResult) String added in v1.8.38

func (s MessageResult) String() string

String returns the string representation

type Pinpoint

type Pinpoint struct {
	*client.Client
}

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

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

func New

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

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

Example:

// Create a Pinpoint client from just a session.
svc := pinpoint.New(mySession)

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

func (*Pinpoint) CreateApp added in v1.10.20

func (c *Pinpoint) CreateApp(input *CreateAppInput) (*CreateAppOutput, error)

CreateApp API operation for Amazon Pinpoint.

Creates or updates an app.

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

See the AWS API reference guide for Amazon Pinpoint's API operation CreateApp for usage and error information.

Returned Error Codes:

  • ErrCodeBadRequestException "BadRequestException"

  • ErrCodeInternalServerErrorException "InternalServerErrorException"

  • ErrCodeForbiddenException "ForbiddenException"

  • ErrCodeNotFoundException "NotFoundException"

  • ErrCodeMethodNotAllowedException "MethodNotAllowedException"

  • ErrCodeTooManyRequestsException "TooManyRequestsException"

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

func (*Pinpoint) CreateAppRequest added in v1.10.20

func (c *Pinpoint) CreateAppRequest(input *CreateAppInput) (req *request.Request, output *CreateAppOutput)

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

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

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

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

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

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

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

func (*Pinpoint) CreateAppWithContext added in v1.10.20

func (c *Pinpoint) CreateAppWithContext(ctx aws.Context, input *CreateAppInput, opts ...request.Option) (*CreateAppOutput, error)

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

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

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

func (*Pinpoint) CreateCampaign

func (c *Pinpoint) CreateCampaign(input *CreateCampaignInput) (*CreateCampaignOutput, error)

CreateCampaign API operation for Amazon Pinpoint.

Creates or updates a campaign.

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

See the AWS API reference guide for Amazon Pinpoint's API operation CreateCampaign for usage and error information.

Returned Error Codes:

  • ErrCodeBadRequestException "BadRequestException"

  • ErrCodeInternalServerErrorException "InternalServerErrorException"

  • ErrCodeForbiddenException "ForbiddenException"

  • ErrCodeNotFoundException "NotFoundException"

  • ErrCodeMethodNotAllowedException "MethodNotAllowedException"

  • ErrCodeTooManyRequestsException "TooManyRequestsException"

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

func (*Pinpoint) CreateCampaignRequest

func (c *Pinpoint) CreateCampaignRequest(input *CreateCampaignInput) (req *request.Request, output *CreateCampaignOutput)

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

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

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

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

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

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

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

func (*Pinpoint) CreateCampaignWithContext added in v1.8.0

func (c *Pinpoint) CreateCampaignWithContext(ctx aws.Context, input *CreateCampaignInput, opts ...request.Option) (*CreateCampaignOutput, error)

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

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

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

func (*Pinpoint) CreateExportJob added in v1.13.11

func (c *Pinpoint) CreateExportJob(input *CreateExportJobInput) (*CreateExportJobOutput, error)

CreateExportJob API operation for Amazon Pinpoint.

Creates an export job.

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

See the AWS API reference guide for Amazon Pinpoint's API operation CreateExportJob for usage and error information.

Returned Error Codes:

  • ErrCodeBadRequestException "BadRequestException"

  • ErrCodeInternalServerErrorException "InternalServerErrorException"

  • ErrCodeForbiddenException "ForbiddenException"

  • ErrCodeNotFoundException "NotFoundException"

  • ErrCodeMethodNotAllowedException "MethodNotAllowedException"

  • ErrCodeTooManyRequestsException "TooManyRequestsException"

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

func (*Pinpoint) CreateExportJobRequest added in v1.13.11

func (c *Pinpoint) CreateExportJobRequest(input *CreateExportJobInput) (req *request.Request, output *CreateExportJobOutput)

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

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

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

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

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

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

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

func (*Pinpoint) CreateExportJobWithContext added in v1.13.11

func (c *Pinpoint) CreateExportJobWithContext(ctx aws.Context, input *CreateExportJobInput, opts ...request.Option) (*CreateExportJobOutput, error)

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

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

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

func (*Pinpoint) CreateImportJob

func (c *Pinpoint) CreateImportJob(input *CreateImportJobInput) (*CreateImportJobOutput, error)

CreateImportJob API operation for Amazon Pinpoint.

Creates or updates an import job.

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

See the AWS API reference guide for Amazon Pinpoint's API operation CreateImportJob for usage and error information.

Returned Error Codes:

  • ErrCodeBadRequestException "BadRequestException"

  • ErrCodeInternalServerErrorException "InternalServerErrorException"

  • ErrCodeForbiddenException "ForbiddenException"

  • ErrCodeNotFoundException "NotFoundException"

  • ErrCodeMethodNotAllowedException "MethodNotAllowedException"

  • ErrCodeTooManyRequestsException "TooManyRequestsException"

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

func (*Pinpoint) CreateImportJobRequest

func (c *Pinpoint) CreateImportJobRequest(input *CreateImportJobInput) (req *request.Request, output *CreateImportJobOutput)

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

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

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

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

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

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

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

func (*Pinpoint) CreateImportJobWithContext added in v1.8.0

func (c *Pinpoint) CreateImportJobWithContext(ctx aws.Context, input *CreateImportJobInput, opts ...request.Option) (*CreateImportJobOutput, error)

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

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

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

func (*Pinpoint) CreateSegment

func (c *Pinpoint) CreateSegment(input *CreateSegmentInput) (*CreateSegmentOutput, error)

CreateSegment API operation for Amazon Pinpoint.

Used to create or update a segment.

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

See the AWS API reference guide for Amazon Pinpoint's API operation CreateSegment for usage and error information.

Returned Error Codes:

  • ErrCodeBadRequestException "BadRequestException"

  • ErrCodeInternalServerErrorException "InternalServerErrorException"

  • ErrCodeForbiddenException "ForbiddenException"

  • ErrCodeNotFoundException "NotFoundException"

  • ErrCodeMethodNotAllowedException "MethodNotAllowedException"

  • ErrCodeTooManyRequestsException "TooManyRequestsException"

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

func (*Pinpoint) CreateSegmentRequest

func (c *Pinpoint) CreateSegmentRequest(input *CreateSegmentInput) (req *request.Request, output *CreateSegmentOutput)

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

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

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

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

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

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

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

func (*Pinpoint) CreateSegmentWithContext added in v1.8.0

func (c *Pinpoint) CreateSegmentWithContext(ctx aws.Context, input *CreateSegmentInput, opts ...request.Option) (*CreateSegmentOutput, error)

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

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

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

func (*Pinpoint) DeleteAdmChannel added in v1.12.1

func (c *Pinpoint) DeleteAdmChannel(input *DeleteAdmChannelInput) (*DeleteAdmChannelOutput, error)

DeleteAdmChannel API operation for Amazon Pinpoint.

Delete an ADM channel

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

See the AWS API reference guide for Amazon Pinpoint's API operation DeleteAdmChannel for usage and error information.

Returned Error Codes:

  • ErrCodeBadRequestException "BadRequestException"

  • ErrCodeInternalServerErrorException "InternalServerErrorException"

  • ErrCodeForbiddenException "ForbiddenException"

  • ErrCodeNotFoundException "NotFoundException"

  • ErrCodeMethodNotAllowedException "MethodNotAllowedException"

  • ErrCodeTooManyRequestsException "TooManyRequestsException"

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

func (*Pinpoint) DeleteAdmChannelRequest added in v1.12.1

func (c *Pinpoint) DeleteAdmChannelRequest(input *DeleteAdmChannelInput) (req *request.Request, output *DeleteAdmChannelOutput)

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

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

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

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

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

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

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

func (*Pinpoint) DeleteAdmChannelWithContext added in v1.12.1

func (c *Pinpoint) DeleteAdmChannelWithContext(ctx aws.Context, input *DeleteAdmChannelInput, opts ...request.Option) (*DeleteAdmChannelOutput, error)

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

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

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

func (*Pinpoint) DeleteApnsChannel

func (c *Pinpoint) DeleteApnsChannel(input *DeleteApnsChannelInput) (*DeleteApnsChannelOutput, error)

DeleteApnsChannel API operation for Amazon Pinpoint.

Deletes the APNs channel for an app.

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

See the AWS API reference guide for Amazon Pinpoint's API operation DeleteApnsChannel for usage and error information.

Returned Error Codes:

  • ErrCodeBadRequestException "BadRequestException"

  • ErrCodeInternalServerErrorException "InternalServerErrorException"

  • ErrCodeForbiddenException "ForbiddenException"

  • ErrCodeNotFoundException "NotFoundException"

  • ErrCodeMethodNotAllowedException "MethodNotAllowedException"

  • ErrCodeTooManyRequestsException "TooManyRequestsException"

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

func (*Pinpoint) DeleteApnsChannelRequest

func (c *Pinpoint) DeleteApnsChannelRequest(input *DeleteApnsChannelInput) (req *request.Request, output *DeleteApnsChannelOutput)

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

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

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

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

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

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

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

func (*Pinpoint) DeleteApnsChannelWithContext added in v1.8.0

func (c *Pinpoint) DeleteApnsChannelWithContext(ctx aws.Context, input *DeleteApnsChannelInput, opts ...request.Option) (*DeleteApnsChannelOutput, error)

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

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

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

func (*Pinpoint) DeleteApnsSandboxChannel added in v1.8.38

func (c *Pinpoint) DeleteApnsSandboxChannel(input *DeleteApnsSandboxChannelInput) (*DeleteApnsSandboxChannelOutput, error)

DeleteApnsSandboxChannel API operation for Amazon Pinpoint.

Delete an APNS sandbox channel

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

See the AWS API reference guide for Amazon Pinpoint's API operation DeleteApnsSandboxChannel for usage and error information.

Returned Error Codes:

  • ErrCodeBadRequestException "BadRequestException"

  • ErrCodeInternalServerErrorException "InternalServerErrorException"

  • ErrCodeForbiddenException "ForbiddenException"

  • ErrCodeNotFoundException "NotFoundException"

  • ErrCodeMethodNotAllowedException "MethodNotAllowedException"

  • ErrCodeTooManyRequestsException "TooManyRequestsException"

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

func (*Pinpoint) DeleteApnsSandboxChannelRequest added in v1.8.38

func (c *Pinpoint) DeleteApnsSandboxChannelRequest(input *DeleteApnsSandboxChannelInput) (req *request.Request, output *DeleteApnsSandboxChannelOutput)

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

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

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

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

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

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

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

func (*Pinpoint) DeleteApnsSandboxChannelWithContext added in v1.8.38

func (c *Pinpoint) DeleteApnsSandboxChannelWithContext(ctx aws.Context, input *DeleteApnsSandboxChannelInput, opts ...request.Option) (*DeleteApnsSandboxChannelOutput, error)

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

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

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

func (*Pinpoint) DeleteApnsVoipChannel added in v1.12.17

func (c *Pinpoint) DeleteApnsVoipChannel(input *DeleteApnsVoipChannelInput) (*DeleteApnsVoipChannelOutput, error)

DeleteApnsVoipChannel API operation for Amazon Pinpoint.

Delete an APNS VoIP channel

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

See the AWS API reference guide for Amazon Pinpoint's API operation DeleteApnsVoipChannel for usage and error information.

Returned Error Codes:

  • ErrCodeBadRequestException "BadRequestException"

  • ErrCodeInternalServerErrorException "InternalServerErrorException"

  • ErrCodeForbiddenException "ForbiddenException"

  • ErrCodeNotFoundException "NotFoundException"

  • ErrCodeMethodNotAllowedException "MethodNotAllowedException"

  • ErrCodeTooManyRequestsException "TooManyRequestsException"

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

func (*Pinpoint) DeleteApnsVoipChannelRequest added in v1.12.17

func (c *Pinpoint) DeleteApnsVoipChannelRequest(input *DeleteApnsVoipChannelInput) (req *request.Request, output *DeleteApnsVoipChannelOutput)

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

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

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

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

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

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

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

func (*Pinpoint) DeleteApnsVoipChannelWithContext added in v1.12.17

func (c *Pinpoint) DeleteApnsVoipChannelWithContext(ctx aws.Context, input *DeleteApnsVoipChannelInput, opts ...request.Option) (*DeleteApnsVoipChannelOutput, error)

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

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

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

func (*Pinpoint) DeleteApnsVoipSandboxChannel added in v1.12.17

func (c *Pinpoint) DeleteApnsVoipSandboxChannel(input *DeleteApnsVoipSandboxChannelInput) (*DeleteApnsVoipSandboxChannelOutput, error)

DeleteApnsVoipSandboxChannel API operation for Amazon Pinpoint.

Delete an APNS VoIP sandbox channel

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

See the AWS API reference guide for Amazon Pinpoint's API operation DeleteApnsVoipSandboxChannel for usage and error information.

Returned Error Codes:

  • ErrCodeBadRequestException "BadRequestException"

  • ErrCodeInternalServerErrorException "InternalServerErrorException"

  • ErrCodeForbiddenException "ForbiddenException"

  • ErrCodeNotFoundException "NotFoundException"

  • ErrCodeMethodNotAllowedException "MethodNotAllowedException"

  • ErrCodeTooManyRequestsException "TooManyRequestsException"

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

func (*Pinpoint) DeleteApnsVoipSandboxChannelRequest added in v1.12.17

func (c *Pinpoint) DeleteApnsVoipSandboxChannelRequest(input *DeleteApnsVoipSandboxChannelInput) (req *request.Request, output *DeleteApnsVoipSandboxChannelOutput)

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

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

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

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

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

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

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

func (*Pinpoint) DeleteApnsVoipSandboxChannelWithContext added in v1.12.17

func (c *Pinpoint) DeleteApnsVoipSandboxChannelWithContext(ctx aws.Context, input *DeleteApnsVoipSandboxChannelInput, opts ...request.Option) (*DeleteApnsVoipSandboxChannelOutput, error)

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

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

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

func (*Pinpoint) DeleteApp added in v1.10.20

func (c *Pinpoint) DeleteApp(input *DeleteAppInput) (*DeleteAppOutput, error)

DeleteApp API operation for Amazon Pinpoint.

Deletes an app.

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

See the AWS API reference guide for Amazon Pinpoint's API operation DeleteApp for usage and error information.

Returned Error Codes:

  • ErrCodeBadRequestException "BadRequestException"

  • ErrCodeInternalServerErrorException "InternalServerErrorException"

  • ErrCodeForbiddenException "ForbiddenException"

  • ErrCodeNotFoundException "NotFoundException"

  • ErrCodeMethodNotAllowedException "MethodNotAllowedException"

  • ErrCodeTooManyRequestsException "TooManyRequestsException"

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

func (*Pinpoint) DeleteAppRequest added in v1.10.20

func (c *Pinpoint) DeleteAppRequest(input *DeleteAppInput) (req *request.Request, output *DeleteAppOutput)

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

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

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

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

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

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

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

func (*Pinpoint) DeleteAppWithContext added in v1.10.20

func (c *Pinpoint) DeleteAppWithContext(ctx aws.Context, input *DeleteAppInput, opts ...request.Option) (*DeleteAppOutput, error)

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

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

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

func (*Pinpoint) DeleteBaiduChannel added in v1.12.1

func (c *Pinpoint) DeleteBaiduChannel(input *DeleteBaiduChannelInput) (*DeleteBaiduChannelOutput, error)

DeleteBaiduChannel API operation for Amazon Pinpoint.

Delete a BAIDU GCM channel

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

See the AWS API reference guide for Amazon Pinpoint's API operation DeleteBaiduChannel for usage and error information.

Returned Error Codes:

  • ErrCodeBadRequestException "BadRequestException"

  • ErrCodeInternalServerErrorException "InternalServerErrorException"

  • ErrCodeForbiddenException "ForbiddenException"

  • ErrCodeNotFoundException "NotFoundException"

  • ErrCodeMethodNotAllowedException "MethodNotAllowedException"

  • ErrCodeTooManyRequestsException "TooManyRequestsException"

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

func (*Pinpoint) DeleteBaiduChannelRequest added in v1.12.1

func (c *Pinpoint) DeleteBaiduChannelRequest(input *DeleteBaiduChannelInput) (req *request.Request, output *DeleteBaiduChannelOutput)

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

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

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

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

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

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

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

func (*Pinpoint) DeleteBaiduChannelWithContext added in v1.12.1

func (c *Pinpoint) DeleteBaiduChannelWithContext(ctx aws.Context, input *DeleteBaiduChannelInput, opts ...request.Option) (*DeleteBaiduChannelOutput, error)

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

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

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

func (*Pinpoint) DeleteCampaign

func (c *Pinpoint) DeleteCampaign(input *DeleteCampaignInput) (*DeleteCampaignOutput, error)

DeleteCampaign API operation for Amazon Pinpoint.

Deletes a campaign.

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

See the AWS API reference guide for Amazon Pinpoint's API operation DeleteCampaign for usage and error information.

Returned Error Codes:

  • ErrCodeBadRequestException "BadRequestException"

  • ErrCodeInternalServerErrorException "InternalServerErrorException"

  • ErrCodeForbiddenException "ForbiddenException"

  • ErrCodeNotFoundException "NotFoundException"

  • ErrCodeMethodNotAllowedException "MethodNotAllowedException"

  • ErrCodeTooManyRequestsException "TooManyRequestsException"

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

func (*Pinpoint) DeleteCampaignRequest

func (c *Pinpoint) DeleteCampaignRequest(input *DeleteCampaignInput) (req *request.Request, output *DeleteCampaignOutput)

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

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

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

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

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

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

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

func (*Pinpoint) DeleteCampaignWithContext added in v1.8.0

func (c *Pinpoint) DeleteCampaignWithContext(ctx aws.Context, input *DeleteCampaignInput, opts ...request.Option) (*DeleteCampaignOutput, error)

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

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

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

func (*Pinpoint) DeleteEmailChannel added in v1.8.38

func (c *Pinpoint) DeleteEmailChannel(input *DeleteEmailChannelInput) (*DeleteEmailChannelOutput, error)

DeleteEmailChannel API operation for Amazon Pinpoint.

Delete an email channel

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

See the AWS API reference guide for Amazon Pinpoint's API operation DeleteEmailChannel for usage and error information.

Returned Error Codes:

  • ErrCodeBadRequestException "BadRequestException"

  • ErrCodeInternalServerErrorException "InternalServerErrorException"

  • ErrCodeForbiddenException "ForbiddenException"

  • ErrCodeNotFoundException "NotFoundException"

  • ErrCodeMethodNotAllowedException "MethodNotAllowedException"

  • ErrCodeTooManyRequestsException "TooManyRequestsException"

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

func (*Pinpoint) DeleteEmailChannelRequest added in v1.8.38

func (c *Pinpoint) DeleteEmailChannelRequest(input *DeleteEmailChannelInput) (req *request.Request, output *DeleteEmailChannelOutput)

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

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

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

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

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

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

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

func (*Pinpoint) DeleteEmailChannelWithContext added in v1.8.38

func (c *Pinpoint) DeleteEmailChannelWithContext(ctx aws.Context, input *DeleteEmailChannelInput, opts ...request.Option) (*DeleteEmailChannelOutput, error)

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

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

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

func (*Pinpoint) DeleteEndpoint added in v1.13.15

func (c *Pinpoint) DeleteEndpoint(input *DeleteEndpointInput) (*DeleteEndpointOutput, error)

DeleteEndpoint API operation for Amazon Pinpoint.

Deletes an endpoint.

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

See the AWS API reference guide for Amazon Pinpoint's API operation DeleteEndpoint for usage and error information.

Returned Error Codes:

  • ErrCodeBadRequestException "BadRequestException"

  • ErrCodeInternalServerErrorException "InternalServerErrorException"

  • ErrCodeForbiddenException "ForbiddenException"

  • ErrCodeNotFoundException "NotFoundException"

  • ErrCodeMethodNotAllowedException "MethodNotAllowedException"

  • ErrCodeTooManyRequestsException "TooManyRequestsException"

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

func (*Pinpoint) DeleteEndpointRequest added in v1.13.15

func (c *Pinpoint) DeleteEndpointRequest(input *DeleteEndpointInput) (req *request.Request, output *DeleteEndpointOutput)

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

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

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

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

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

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

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

func (*Pinpoint) DeleteEndpointWithContext added in v1.13.15

func (c *Pinpoint) DeleteEndpointWithContext(ctx aws.Context, input *DeleteEndpointInput, opts ...request.Option) (*DeleteEndpointOutput, error)

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

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

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

func (*Pinpoint) DeleteEventStream added in v1.8.0

func (c *Pinpoint) DeleteEventStream(input *DeleteEventStreamInput) (*DeleteEventStreamOutput, error)

DeleteEventStream API operation for Amazon Pinpoint.

Deletes the event stream for an app.

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

See the AWS API reference guide for Amazon Pinpoint's API operation DeleteEventStream for usage and error information.

Returned Error Codes:

  • ErrCodeBadRequestException "BadRequestException"

  • ErrCodeInternalServerErrorException "InternalServerErrorException"

  • ErrCodeForbiddenException "ForbiddenException"

  • ErrCodeNotFoundException "NotFoundException"

  • ErrCodeMethodNotAllowedException "MethodNotAllowedException"

  • ErrCodeTooManyRequestsException "TooManyRequestsException"

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

func (*Pinpoint) DeleteEventStreamRequest added in v1.8.0

func (c *Pinpoint) DeleteEventStreamRequest(input *DeleteEventStreamInput) (req *request.Request, output *DeleteEventStreamOutput)

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

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

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

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

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

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

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

func (*Pinpoint) DeleteEventStreamWithContext added in v1.8.0

func (c *Pinpoint) DeleteEventStreamWithContext(ctx aws.Context, input *DeleteEventStreamInput, opts ...request.Option) (*DeleteEventStreamOutput, error)

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

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

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

func (*Pinpoint) DeleteGcmChannel

func (c *Pinpoint) DeleteGcmChannel(input *DeleteGcmChannelInput) (*DeleteGcmChannelOutput, error)

DeleteGcmChannel API operation for Amazon Pinpoint.

Deletes the GCM channel for an app.

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

See the AWS API reference guide for Amazon Pinpoint's API operation DeleteGcmChannel for usage and error information.

Returned Error Codes:

  • ErrCodeBadRequestException "BadRequestException"

  • ErrCodeInternalServerErrorException "InternalServerErrorException"

  • ErrCodeForbiddenException "ForbiddenException"

  • ErrCodeNotFoundException "NotFoundException"

  • ErrCodeMethodNotAllowedException "MethodNotAllowedException"

  • ErrCodeTooManyRequestsException "TooManyRequestsException"

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

func (*Pinpoint) DeleteGcmChannelRequest

func (c *Pinpoint) DeleteGcmChannelRequest(input *DeleteGcmChannelInput) (req *request.Request, output *DeleteGcmChannelOutput)

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

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

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

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

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

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

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

func (*Pinpoint) DeleteGcmChannelWithContext added in v1.8.0

func (c *Pinpoint) DeleteGcmChannelWithContext(ctx aws.Context, input *DeleteGcmChannelInput, opts ...request.Option) (*DeleteGcmChannelOutput, error)

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

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

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

func (*Pinpoint) DeleteSegment

func (c *Pinpoint) DeleteSegment(input *DeleteSegmentInput) (*DeleteSegmentOutput, error)

DeleteSegment API operation for Amazon Pinpoint.

Deletes a segment.

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

See the AWS API reference guide for Amazon Pinpoint's API operation DeleteSegment for usage and error information.

Returned Error Codes:

  • ErrCodeBadRequestException "BadRequestException"

  • ErrCodeInternalServerErrorException "InternalServerErrorException"

  • ErrCodeForbiddenException "ForbiddenException"

  • ErrCodeNotFoundException "NotFoundException"

  • ErrCodeMethodNotAllowedException "MethodNotAllowedException"

  • ErrCodeTooManyRequestsException "TooManyRequestsException"

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

func (*Pinpoint) DeleteSegmentRequest

func (c *Pinpoint) DeleteSegmentRequest(input *DeleteSegmentInput) (req *request.Request, output *DeleteSegmentOutput)

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

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

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

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

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

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

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

func (*Pinpoint) DeleteSegmentWithContext added in v1.8.0

func (c *Pinpoint) DeleteSegmentWithContext(ctx aws.Context, input *DeleteSegmentInput, opts ...request.Option) (*DeleteSegmentOutput, error)

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

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

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

func (*Pinpoint) DeleteSmsChannel added in v1.8.38

func (c *Pinpoint) DeleteSmsChannel(input *DeleteSmsChannelInput) (*DeleteSmsChannelOutput, error)

DeleteSmsChannel API operation for Amazon Pinpoint.

Delete an SMS channel

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

See the AWS API reference guide for Amazon Pinpoint's API operation DeleteSmsChannel for usage and error information.

Returned Error Codes:

  • ErrCodeBadRequestException "BadRequestException"

  • ErrCodeInternalServerErrorException "InternalServerErrorException"

  • ErrCodeForbiddenException "ForbiddenException"

  • ErrCodeNotFoundException "NotFoundException"

  • ErrCodeMethodNotAllowedException "MethodNotAllowedException"

  • ErrCodeTooManyRequestsException "TooManyRequestsException"

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

func (*Pinpoint) DeleteSmsChannelRequest added in v1.8.38

func (c *Pinpoint) DeleteSmsChannelRequest(input *DeleteSmsChannelInput) (req *request.Request, output *DeleteSmsChannelOutput)

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

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

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

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

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

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

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

func (*Pinpoint) DeleteSmsChannelWithContext added in v1.8.38

func (c *Pinpoint) DeleteSmsChannelWithContext(ctx aws.Context, input *DeleteSmsChannelInput, opts ...request.Option) (*DeleteSmsChannelOutput, error)

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

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

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

func (*Pinpoint) GetAdmChannel added in v1.12.1

func (c *Pinpoint) GetAdmChannel(input *GetAdmChannelInput) (*GetAdmChannelOutput, error)

GetAdmChannel API operation for Amazon Pinpoint.

Get an ADM channel

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

See the AWS API reference guide for Amazon Pinpoint's API operation GetAdmChannel for usage and error information.

Returned Error Codes:

  • ErrCodeBadRequestException "BadRequestException"

  • ErrCodeInternalServerErrorException "InternalServerErrorException"

  • ErrCodeForbiddenException "ForbiddenException"

  • ErrCodeNotFoundException "NotFoundException"

  • ErrCodeMethodNotAllowedException "MethodNotAllowedException"

  • ErrCodeTooManyRequestsException "TooManyRequestsException"

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

func (*Pinpoint) GetAdmChannelRequest added in v1.12.1

func (c *Pinpoint) GetAdmChannelRequest(input *GetAdmChannelInput) (req *request.Request, output *GetAdmChannelOutput)

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

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

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

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

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

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

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

func (*Pinpoint) GetAdmChannelWithContext added in v1.12.1

func (c *Pinpoint) GetAdmChannelWithContext(ctx aws.Context, input *GetAdmChannelInput, opts ...request.Option) (*GetAdmChannelOutput, error)

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

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

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

func (*Pinpoint) GetApnsChannel

func (c *Pinpoint) GetApnsChannel(input *GetApnsChannelInput) (*GetApnsChannelOutput, error)

GetApnsChannel API operation for Amazon Pinpoint.

Returns information about the APNs channel for an app.

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

See the AWS API reference guide for Amazon Pinpoint's API operation GetApnsChannel for usage and error information.

Returned Error Codes:

  • ErrCodeBadRequestException "BadRequestException"

  • ErrCodeInternalServerErrorException "InternalServerErrorException"

  • ErrCodeForbiddenException "ForbiddenException"

  • ErrCodeNotFoundException "NotFoundException"

  • ErrCodeMethodNotAllowedException "MethodNotAllowedException"

  • ErrCodeTooManyRequestsException "TooManyRequestsException"

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

func (*Pinpoint) GetApnsChannelRequest

func (c *Pinpoint) GetApnsChannelRequest(input *GetApnsChannelInput) (req *request.Request, output *GetApnsChannelOutput)

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

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

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

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

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

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

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

func (*Pinpoint) GetApnsChannelWithContext added in v1.8.0

func (c *Pinpoint) GetApnsChannelWithContext(ctx aws.Context, input *GetApnsChannelInput, opts ...request.Option) (*GetApnsChannelOutput, error)

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

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

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

func (*Pinpoint) GetApnsSandboxChannel added in v1.8.38

func (c *Pinpoint) GetApnsSandboxChannel(input *GetApnsSandboxChannelInput) (*GetApnsSandboxChannelOutput, error)

GetApnsSandboxChannel API operation for Amazon Pinpoint.

Get an APNS sandbox channel

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

See the AWS API reference guide for Amazon Pinpoint's API operation GetApnsSandboxChannel for usage and error information.

Returned Error Codes:

  • ErrCodeBadRequestException "BadRequestException"

  • ErrCodeInternalServerErrorException "InternalServerErrorException"

  • ErrCodeForbiddenException "ForbiddenException"

  • ErrCodeNotFoundException "NotFoundException"

  • ErrCodeMethodNotAllowedException "MethodNotAllowedException"

  • ErrCodeTooManyRequestsException "TooManyRequestsException"

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

func (*Pinpoint) GetApnsSandboxChannelRequest added in v1.8.38

func (c *Pinpoint) GetApnsSandboxChannelRequest(input *GetApnsSandboxChannelInput) (req *request.Request, output *GetApnsSandboxChannelOutput)

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

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

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

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

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

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

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

func (*Pinpoint) GetApnsSandboxChannelWithContext added in v1.8.38

func (c *Pinpoint) GetApnsSandboxChannelWithContext(ctx aws.Context, input *GetApnsSandboxChannelInput, opts ...request.Option) (*GetApnsSandboxChannelOutput, error)

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

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

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

func (*Pinpoint) GetApnsVoipChannel added in v1.12.17

func (c *Pinpoint) GetApnsVoipChannel(input *GetApnsVoipChannelInput) (*GetApnsVoipChannelOutput, error)

GetApnsVoipChannel API operation for Amazon Pinpoint.

Get an APNS VoIP channel

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

See the AWS API reference guide for Amazon Pinpoint's API operation GetApnsVoipChannel for usage and error information.

Returned Error Codes:

  • ErrCodeBadRequestException "BadRequestException"

  • ErrCodeInternalServerErrorException "InternalServerErrorException"

  • ErrCodeForbiddenException "ForbiddenException"

  • ErrCodeNotFoundException "NotFoundException"

  • ErrCodeMethodNotAllowedException "MethodNotAllowedException"

  • ErrCodeTooManyRequestsException "TooManyRequestsException"

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

func (*Pinpoint) GetApnsVoipChannelRequest added in v1.12.17

func (c *Pinpoint) GetApnsVoipChannelRequest(input *GetApnsVoipChannelInput) (req *request.Request, output *GetApnsVoipChannelOutput)

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

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

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

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

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

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

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

func (*Pinpoint) GetApnsVoipChannelWithContext added in v1.12.17

func (c *Pinpoint) GetApnsVoipChannelWithContext(ctx aws.Context, input *GetApnsVoipChannelInput, opts ...request.Option) (*GetApnsVoipChannelOutput, error)

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

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

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

func (*Pinpoint) GetApnsVoipSandboxChannel added in v1.12.17

func (c *Pinpoint) GetApnsVoipSandboxChannel(input *GetApnsVoipSandboxChannelInput) (*GetApnsVoipSandboxChannelOutput, error)

GetApnsVoipSandboxChannel API operation for Amazon Pinpoint.

Get an APNS VoIPSandbox channel

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

See the AWS API reference guide for Amazon Pinpoint's API operation GetApnsVoipSandboxChannel for usage and error information.

Returned Error Codes:

  • ErrCodeBadRequestException "BadRequestException"

  • ErrCodeInternalServerErrorException "InternalServerErrorException"

  • ErrCodeForbiddenException "ForbiddenException"

  • ErrCodeNotFoundException "NotFoundException"

  • ErrCodeMethodNotAllowedException "MethodNotAllowedException"

  • ErrCodeTooManyRequestsException "TooManyRequestsException"

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

func (*Pinpoint) GetApnsVoipSandboxChannelRequest added in v1.12.17

func (c *Pinpoint) GetApnsVoipSandboxChannelRequest(input *GetApnsVoipSandboxChannelInput) (req *request.Request, output *GetApnsVoipSandboxChannelOutput)

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

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

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

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

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

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

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

func (*Pinpoint) GetApnsVoipSandboxChannelWithContext added in v1.12.17

func (c *Pinpoint) GetApnsVoipSandboxChannelWithContext(ctx aws.Context, input *GetApnsVoipSandboxChannelInput, opts ...request.Option) (*GetApnsVoipSandboxChannelOutput, error)

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

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

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

func (*Pinpoint) GetApp added in v1.10.20

func (c *Pinpoint) GetApp(input *GetAppInput) (*GetAppOutput, error)

GetApp API operation for Amazon Pinpoint.

Returns information about an app.

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

See the AWS API reference guide for Amazon Pinpoint's API operation GetApp for usage and error information.

Returned Error Codes:

  • ErrCodeBadRequestException "BadRequestException"

  • ErrCodeInternalServerErrorException "InternalServerErrorException"

  • ErrCodeForbiddenException "ForbiddenException"

  • ErrCodeNotFoundException "NotFoundException"

  • ErrCodeMethodNotAllowedException "MethodNotAllowedException"

  • ErrCodeTooManyRequestsException "TooManyRequestsException"

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

func (*Pinpoint) GetAppRequest added in v1.10.20

func (c *Pinpoint) GetAppRequest(input *GetAppInput) (req *request.Request, output *GetAppOutput)

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

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

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

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

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

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

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

func (*Pinpoint) GetAppWithContext added in v1.10.20

func (c *Pinpoint) GetAppWithContext(ctx aws.Context, input *GetAppInput, opts ...request.Option) (*GetAppOutput, error)

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

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

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

func (*Pinpoint) GetApplicationSettings

func (c *Pinpoint) GetApplicationSettings(input *GetApplicationSettingsInput) (*GetApplicationSettingsOutput, error)

GetApplicationSettings API operation for Amazon Pinpoint.

Used to request the settings for an app.

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

See the AWS API reference guide for Amazon Pinpoint's API operation GetApplicationSettings for usage and error information.

Returned Error Codes:

  • ErrCodeBadRequestException "BadRequestException"

  • ErrCodeInternalServerErrorException "InternalServerErrorException"

  • ErrCodeForbiddenException "ForbiddenException"

  • ErrCodeNotFoundException "NotFoundException"

  • ErrCodeMethodNotAllowedException "MethodNotAllowedException"

  • ErrCodeTooManyRequestsException "TooManyRequestsException"

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

func (*Pinpoint) GetApplicationSettingsRequest

func (c *Pinpoint) GetApplicationSettingsRequest(input *GetApplicationSettingsInput) (req *request.Request, output *GetApplicationSettingsOutput)

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

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

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

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

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

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

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

func (*Pinpoint) GetApplicationSettingsWithContext added in v1.8.0

func (c *Pinpoint) GetApplicationSettingsWithContext(ctx aws.Context, input *GetApplicationSettingsInput, opts ...request.Option) (*GetApplicationSettingsOutput, error)

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

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

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

func (*Pinpoint) GetApps added in v1.10.20

func (c *Pinpoint) GetApps(input *GetAppsInput) (*GetAppsOutput, error)

GetApps API operation for Amazon Pinpoint.

Returns information about your apps.

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

See the AWS API reference guide for Amazon Pinpoint's API operation GetApps for usage and error information.

Returned Error Codes:

  • ErrCodeBadRequestException "BadRequestException"

  • ErrCodeInternalServerErrorException "InternalServerErrorException"

  • ErrCodeForbiddenException "ForbiddenException"

  • ErrCodeNotFoundException "NotFoundException"

  • ErrCodeMethodNotAllowedException "MethodNotAllowedException"

  • ErrCodeTooManyRequestsException "TooManyRequestsException"

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

func (*Pinpoint) GetAppsRequest added in v1.10.20

func (c *Pinpoint) GetAppsRequest(input *GetAppsInput) (req *request.Request, output *GetAppsOutput)

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

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

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

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

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

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

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

func (*Pinpoint) GetAppsWithContext added in v1.10.20

func (c *Pinpoint) GetAppsWithContext(ctx aws.Context, input *GetAppsInput, opts ...request.Option) (*GetAppsOutput, error)

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

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

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

func (*Pinpoint) GetBaiduChannel added in v1.12.1

func (c *Pinpoint) GetBaiduChannel(input *GetBaiduChannelInput) (*GetBaiduChannelOutput, error)

GetBaiduChannel API operation for Amazon Pinpoint.

Get a BAIDU GCM channel

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

See the AWS API reference guide for Amazon Pinpoint's API operation GetBaiduChannel for usage and error information.

Returned Error Codes:

  • ErrCodeBadRequestException "BadRequestException"

  • ErrCodeInternalServerErrorException "InternalServerErrorException"

  • ErrCodeForbiddenException "ForbiddenException"

  • ErrCodeNotFoundException "NotFoundException"

  • ErrCodeMethodNotAllowedException "MethodNotAllowedException"

  • ErrCodeTooManyRequestsException "TooManyRequestsException"

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

func (*Pinpoint) GetBaiduChannelRequest added in v1.12.1

func (c *Pinpoint) GetBaiduChannelRequest(input *GetBaiduChannelInput) (req *request.Request, output *GetBaiduChannelOutput)

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

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

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

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

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

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

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

func (*Pinpoint) GetBaiduChannelWithContext added in v1.12.1

func (c *Pinpoint) GetBaiduChannelWithContext(ctx aws.Context, input *GetBaiduChannelInput, opts ...request.Option) (*GetBaiduChannelOutput, error)

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

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

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

func (*Pinpoint) GetCampaign

func (c *Pinpoint) GetCampaign(input *GetCampaignInput) (*GetCampaignOutput, error)

GetCampaign API operation for Amazon Pinpoint.

Returns information about a campaign.

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

See the AWS API reference guide for Amazon Pinpoint's API operation GetCampaign for usage and error information.

Returned Error Codes:

  • ErrCodeBadRequestException "BadRequestException"

  • ErrCodeInternalServerErrorException "InternalServerErrorException"

  • ErrCodeForbiddenException "ForbiddenException"

  • ErrCodeNotFoundException "NotFoundException"

  • ErrCodeMethodNotAllowedException "MethodNotAllowedException"

  • ErrCodeTooManyRequestsException "TooManyRequestsException"

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

func (*Pinpoint) GetCampaignActivities

func (c *Pinpoint) GetCampaignActivities(input *GetCampaignActivitiesInput) (*GetCampaignActivitiesOutput, error)

GetCampaignActivities API operation for Amazon Pinpoint.

Returns information about the activity performed by a campaign.

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

See the AWS API reference guide for Amazon Pinpoint's API operation GetCampaignActivities for usage and error information.

Returned Error Codes:

  • ErrCodeBadRequestException "BadRequestException"

  • ErrCodeInternalServerErrorException "InternalServerErrorException"

  • ErrCodeForbiddenException "ForbiddenException"

  • ErrCodeNotFoundException "NotFoundException"

  • ErrCodeMethodNotAllowedException "MethodNotAllowedException"

  • ErrCodeTooManyRequestsException "TooManyRequestsException"

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

func (*Pinpoint) GetCampaignActivitiesRequest

func (c *Pinpoint) GetCampaignActivitiesRequest(input *GetCampaignActivitiesInput) (req *request.Request, output *GetCampaignActivitiesOutput)

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

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

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

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

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

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

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

func (*Pinpoint) GetCampaignActivitiesWithContext added in v1.8.0

func (c *Pinpoint) GetCampaignActivitiesWithContext(ctx aws.Context, input *GetCampaignActivitiesInput, opts ...request.Option) (*GetCampaignActivitiesOutput, error)

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

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

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

func (*Pinpoint) GetCampaignRequest

func (c *Pinpoint) GetCampaignRequest(input *GetCampaignInput) (req *request.Request, output *GetCampaignOutput)

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

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

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

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

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

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

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

func (*Pinpoint) GetCampaignVersion

func (c *Pinpoint) GetCampaignVersion(input *GetCampaignVersionInput) (*GetCampaignVersionOutput, error)

GetCampaignVersion API operation for Amazon Pinpoint.

Returns information about a specific version of a campaign.

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

See the AWS API reference guide for Amazon Pinpoint's API operation GetCampaignVersion for usage and error information.

Returned Error Codes:

  • ErrCodeBadRequestException "BadRequestException"

  • ErrCodeInternalServerErrorException "InternalServerErrorException"

  • ErrCodeForbiddenException "ForbiddenException"

  • ErrCodeNotFoundException "NotFoundException"

  • ErrCodeMethodNotAllowedException "MethodNotAllowedException"

  • ErrCodeTooManyRequestsException "TooManyRequestsException"

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

func (*Pinpoint) GetCampaignVersionRequest

func (c *Pinpoint) GetCampaignVersionRequest(input *GetCampaignVersionInput) (req *request.Request, output *GetCampaignVersionOutput)

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

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

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

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

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

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

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

func (*Pinpoint) GetCampaignVersionWithContext added in v1.8.0

func (c *Pinpoint) GetCampaignVersionWithContext(ctx aws.Context, input *GetCampaignVersionInput, opts ...request.Option) (*GetCampaignVersionOutput, error)

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

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

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

func (*Pinpoint) GetCampaignVersions

func (c *Pinpoint) GetCampaignVersions(input *GetCampaignVersionsInput) (*GetCampaignVersionsOutput, error)

GetCampaignVersions API operation for Amazon Pinpoint.

Returns information about your campaign versions.

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

See the AWS API reference guide for Amazon Pinpoint's API operation GetCampaignVersions for usage and error information.

Returned Error Codes:

  • ErrCodeBadRequestException "BadRequestException"

  • ErrCodeInternalServerErrorException "InternalServerErrorException"

  • ErrCodeForbiddenException "ForbiddenException"

  • ErrCodeNotFoundException "NotFoundException"

  • ErrCodeMethodNotAllowedException "MethodNotAllowedException"

  • ErrCodeTooManyRequestsException "TooManyRequestsException"

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

func (*Pinpoint) GetCampaignVersionsRequest

func (c *Pinpoint) GetCampaignVersionsRequest(input *GetCampaignVersionsInput) (req *request.Request, output *GetCampaignVersionsOutput)

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

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

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

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

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

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

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

func (*Pinpoint) GetCampaignVersionsWithContext added in v1.8.0

func (c *Pinpoint) GetCampaignVersionsWithContext(ctx aws.Context, input *GetCampaignVersionsInput, opts ...request.Option) (*GetCampaignVersionsOutput, error)

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

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

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

func (*Pinpoint) GetCampaignWithContext added in v1.8.0

func (c *Pinpoint) GetCampaignWithContext(ctx aws.Context, input *GetCampaignInput, opts ...request.Option) (*GetCampaignOutput, error)

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

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

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

func (*Pinpoint) GetCampaigns

func (c *Pinpoint) GetCampaigns(input *GetCampaignsInput) (*GetCampaignsOutput, error)

GetCampaigns API operation for Amazon Pinpoint.

Returns information about your campaigns.

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

See the AWS API reference guide for Amazon Pinpoint's API operation GetCampaigns for usage and error information.

Returned Error Codes:

  • ErrCodeBadRequestException "BadRequestException"

  • ErrCodeInternalServerErrorException "InternalServerErrorException"

  • ErrCodeForbiddenException "ForbiddenException"

  • ErrCodeNotFoundException "NotFoundException"

  • ErrCodeMethodNotAllowedException "MethodNotAllowedException"

  • ErrCodeTooManyRequestsException "TooManyRequestsException"

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

func (*Pinpoint) GetCampaignsRequest

func (c *Pinpoint) GetCampaignsRequest(input *GetCampaignsInput) (req *request.Request, output *GetCampaignsOutput)

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

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

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

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

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

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

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

func (*Pinpoint) GetCampaignsWithContext added in v1.8.0

func (c *Pinpoint) GetCampaignsWithContext(ctx aws.Context, input *GetCampaignsInput, opts ...request.Option) (*GetCampaignsOutput, error)

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

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

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

func (*Pinpoint) GetEmailChannel added in v1.8.38

func (c *Pinpoint) GetEmailChannel(input *GetEmailChannelInput) (*GetEmailChannelOutput, error)

GetEmailChannel API operation for Amazon Pinpoint.

Get an email channel

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

See the AWS API reference guide for Amazon Pinpoint's API operation GetEmailChannel for usage and error information.

Returned Error Codes:

  • ErrCodeBadRequestException "BadRequestException"

  • ErrCodeInternalServerErrorException "InternalServerErrorException"

  • ErrCodeForbiddenException "ForbiddenException"

  • ErrCodeNotFoundException "NotFoundException"

  • ErrCodeMethodNotAllowedException "MethodNotAllowedException"

  • ErrCodeTooManyRequestsException "TooManyRequestsException"

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

func (*Pinpoint) GetEmailChannelRequest added in v1.8.38

func (c *Pinpoint) GetEmailChannelRequest(input *GetEmailChannelInput) (req *request.Request, output *GetEmailChannelOutput)

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

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

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

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

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

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

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

func (*Pinpoint) GetEmailChannelWithContext added in v1.8.38

func (c *Pinpoint) GetEmailChannelWithContext(ctx aws.Context, input *GetEmailChannelInput, opts ...request.Option) (*GetEmailChannelOutput, error)

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

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

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

func (*Pinpoint) GetEndpoint

func (c *Pinpoint) GetEndpoint(input *GetEndpointInput) (*GetEndpointOutput, error)

GetEndpoint API operation for Amazon Pinpoint.

Returns information about an endpoint.

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

See the AWS API reference guide for Amazon Pinpoint's API operation GetEndpoint for usage and error information.

Returned Error Codes:

  • ErrCodeBadRequestException "BadRequestException"

  • ErrCodeInternalServerErrorException "InternalServerErrorException"

  • ErrCodeForbiddenException "ForbiddenException"

  • ErrCodeNotFoundException "NotFoundException"

  • ErrCodeMethodNotAllowedException "MethodNotAllowedException"

  • ErrCodeTooManyRequestsException "TooManyRequestsException"

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

func (*Pinpoint) GetEndpointRequest

func (c *Pinpoint) GetEndpointRequest(input *GetEndpointInput) (req *request.Request, output *GetEndpointOutput)

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

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

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

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

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

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

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

func (*Pinpoint) GetEndpointWithContext added in v1.8.0

func (c *Pinpoint) GetEndpointWithContext(ctx aws.Context, input *GetEndpointInput, opts ...request.Option) (*GetEndpointOutput, error)

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

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

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

func (*Pinpoint) GetEventStream added in v1.8.0

func (c *Pinpoint) GetEventStream(input *GetEventStreamInput) (*GetEventStreamOutput, error)

GetEventStream API operation for Amazon Pinpoint.

Returns the event stream for an app.

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

See the AWS API reference guide for Amazon Pinpoint's API operation GetEventStream for usage and error information.

Returned Error Codes:

  • ErrCodeBadRequestException "BadRequestException"

  • ErrCodeInternalServerErrorException "InternalServerErrorException"

  • ErrCodeForbiddenException "ForbiddenException"

  • ErrCodeNotFoundException "NotFoundException"

  • ErrCodeMethodNotAllowedException "MethodNotAllowedException"

  • ErrCodeTooManyRequestsException "TooManyRequestsException"

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

func (*Pinpoint) GetEventStreamRequest added in v1.8.0

func (c *Pinpoint) GetEventStreamRequest(input *GetEventStreamInput) (req *request.Request, output *GetEventStreamOutput)

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

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

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

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

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

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

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

func (*Pinpoint) GetEventStreamWithContext added in v1.8.0

func (c *Pinpoint) GetEventStreamWithContext(ctx aws.Context, input *GetEventStreamInput, opts ...request.Option) (*GetEventStreamOutput, error)

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

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

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

func (*Pinpoint) GetExportJob added in v1.13.11

func (c *Pinpoint) GetExportJob(input *GetExportJobInput) (*GetExportJobOutput, error)

GetExportJob API operation for Amazon Pinpoint.

Returns information about an export job.

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

See the AWS API reference guide for Amazon Pinpoint's API operation GetExportJob for usage and error information.

Returned Error Codes:

  • ErrCodeBadRequestException "BadRequestException"

  • ErrCodeInternalServerErrorException "InternalServerErrorException"

  • ErrCodeForbiddenException "ForbiddenException"

  • ErrCodeNotFoundException "NotFoundException"

  • ErrCodeMethodNotAllowedException "MethodNotAllowedException"

  • ErrCodeTooManyRequestsException "TooManyRequestsException"

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

func (*Pinpoint) GetExportJobRequest added in v1.13.11

func (c *Pinpoint) GetExportJobRequest(input *GetExportJobInput) (req *request.Request, output *GetExportJobOutput)

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

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

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

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

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

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

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

func (*Pinpoint) GetExportJobWithContext added in v1.13.11

func (c *Pinpoint) GetExportJobWithContext(ctx aws.Context, input *GetExportJobInput, opts ...request.Option) (*GetExportJobOutput, error)

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

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

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

func (*Pinpoint) GetExportJobs added in v1.13.11

func (c *Pinpoint) GetExportJobs(input *GetExportJobsInput) (*GetExportJobsOutput, error)

GetExportJobs API operation for Amazon Pinpoint.

Returns information about your export jobs.

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

See the AWS API reference guide for Amazon Pinpoint's API operation GetExportJobs for usage and error information.

Returned Error Codes:

  • ErrCodeBadRequestException "BadRequestException"

  • ErrCodeInternalServerErrorException "InternalServerErrorException"

  • ErrCodeForbiddenException "ForbiddenException"

  • ErrCodeNotFoundException "NotFoundException"

  • ErrCodeMethodNotAllowedException "MethodNotAllowedException"

  • ErrCodeTooManyRequestsException "TooManyRequestsException"

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

func (*Pinpoint) GetExportJobsRequest added in v1.13.11

func (c *Pinpoint) GetExportJobsRequest(input *GetExportJobsInput) (req *request.Request, output *GetExportJobsOutput)

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

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

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

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

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

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

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

func (*Pinpoint) GetExportJobsWithContext added in v1.13.11

func (c *Pinpoint) GetExportJobsWithContext(ctx aws.Context, input *GetExportJobsInput, opts ...request.Option) (*GetExportJobsOutput, error)

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

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

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

func (*Pinpoint) GetGcmChannel

func (c *Pinpoint) GetGcmChannel(input *GetGcmChannelInput) (*GetGcmChannelOutput, error)

GetGcmChannel API operation for Amazon Pinpoint.

Returns information about the GCM channel for an app.

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

See the AWS API reference guide for Amazon Pinpoint's API operation GetGcmChannel for usage and error information.

Returned Error Codes:

  • ErrCodeBadRequestException "BadRequestException"

  • ErrCodeInternalServerErrorException "InternalServerErrorException"

  • ErrCodeForbiddenException "ForbiddenException"

  • ErrCodeNotFoundException "NotFoundException"

  • ErrCodeMethodNotAllowedException "MethodNotAllowedException"

  • ErrCodeTooManyRequestsException "TooManyRequestsException"

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

func (*Pinpoint) GetGcmChannelRequest

func (c *Pinpoint) GetGcmChannelRequest(input *GetGcmChannelInput) (req *request.Request, output *GetGcmChannelOutput)

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

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

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

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

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

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

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

func (*Pinpoint) GetGcmChannelWithContext added in v1.8.0

func (c *Pinpoint) GetGcmChannelWithContext(ctx aws.Context, input *GetGcmChannelInput, opts ...request.Option) (*GetGcmChannelOutput, error)

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

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

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

func (*Pinpoint) GetImportJob

func (c *Pinpoint) GetImportJob(input *GetImportJobInput) (*GetImportJobOutput, error)

GetImportJob API operation for Amazon Pinpoint.

Returns information about an import job.

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

See the AWS API reference guide for Amazon Pinpoint's API operation GetImportJob for usage and error information.

Returned Error Codes:

  • ErrCodeBadRequestException "BadRequestException"

  • ErrCodeInternalServerErrorException "InternalServerErrorException"

  • ErrCodeForbiddenException "ForbiddenException"

  • ErrCodeNotFoundException "NotFoundException"

  • ErrCodeMethodNotAllowedException "MethodNotAllowedException"

  • ErrCodeTooManyRequestsException "TooManyRequestsException"

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

func (*Pinpoint) GetImportJobRequest

func (c *Pinpoint) GetImportJobRequest(input *GetImportJobInput) (req *request.Request, output *GetImportJobOutput)

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

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

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

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

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

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

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

func (*Pinpoint) GetImportJobWithContext added in v1.8.0

func (c *Pinpoint) GetImportJobWithContext(ctx aws.Context, input *GetImportJobInput, opts ...request.Option) (*GetImportJobOutput, error)

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

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

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

func (*Pinpoint) GetImportJobs

func (c *Pinpoint) GetImportJobs(input *GetImportJobsInput) (*GetImportJobsOutput, error)

GetImportJobs API operation for Amazon Pinpoint.

Returns information about your import jobs.

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

See the AWS API reference guide for Amazon Pinpoint's API operation GetImportJobs for usage and error information.

Returned Error Codes:

  • ErrCodeBadRequestException "BadRequestException"

  • ErrCodeInternalServerErrorException "InternalServerErrorException"

  • ErrCodeForbiddenException "ForbiddenException"

  • ErrCodeNotFoundException "NotFoundException"

  • ErrCodeMethodNotAllowedException "MethodNotAllowedException"

  • ErrCodeTooManyRequestsException "TooManyRequestsException"

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

func (*Pinpoint) GetImportJobsRequest

func (c *Pinpoint) GetImportJobsRequest(input *GetImportJobsInput) (req *request.Request, output *GetImportJobsOutput)

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

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

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

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

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

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

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

func (*Pinpoint) GetImportJobsWithContext added in v1.8.0

func (c *Pinpoint) GetImportJobsWithContext(ctx aws.Context, input *GetImportJobsInput, opts ...request.Option) (*GetImportJobsOutput, error)

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

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

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

func (*Pinpoint) GetSegment

func (c *Pinpoint) GetSegment(input *GetSegmentInput) (*GetSegmentOutput, error)

GetSegment API operation for Amazon Pinpoint.

Returns information about a segment.

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

See the AWS API reference guide for Amazon Pinpoint's API operation GetSegment for usage and error information.

Returned Error Codes:

  • ErrCodeBadRequestException "BadRequestException"

  • ErrCodeInternalServerErrorException "InternalServerErrorException"

  • ErrCodeForbiddenException "ForbiddenException"

  • ErrCodeNotFoundException "NotFoundException"

  • ErrCodeMethodNotAllowedException "MethodNotAllowedException"

  • ErrCodeTooManyRequestsException "TooManyRequestsException"

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

func (*Pinpoint) GetSegmentExportJobs added in v1.13.11

func (c *Pinpoint) GetSegmentExportJobs(input *GetSegmentExportJobsInput) (*GetSegmentExportJobsOutput, error)

GetSegmentExportJobs API operation for Amazon Pinpoint.

Returns a list of export jobs for a specific segment.

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

See the AWS API reference guide for Amazon Pinpoint's API operation GetSegmentExportJobs for usage and error information.

Returned Error Codes:

  • ErrCodeBadRequestException "BadRequestException"

  • ErrCodeInternalServerErrorException "InternalServerErrorException"

  • ErrCodeForbiddenException "ForbiddenException"

  • ErrCodeNotFoundException "NotFoundException"

  • ErrCodeMethodNotAllowedException "MethodNotAllowedException"

  • ErrCodeTooManyRequestsException "TooManyRequestsException"

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

func (*Pinpoint) GetSegmentExportJobsRequest added in v1.13.11

func (c *Pinpoint) GetSegmentExportJobsRequest(input *GetSegmentExportJobsInput) (req *request.Request, output *GetSegmentExportJobsOutput)

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

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

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

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

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

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

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

func (*Pinpoint) GetSegmentExportJobsWithContext added in v1.13.11

func (c *Pinpoint) GetSegmentExportJobsWithContext(ctx aws.Context, input *GetSegmentExportJobsInput, opts ...request.Option) (*GetSegmentExportJobsOutput, error)

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

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

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

func (*Pinpoint) GetSegmentImportJobs

func (c *Pinpoint) GetSegmentImportJobs(input *GetSegmentImportJobsInput) (*GetSegmentImportJobsOutput, error)

GetSegmentImportJobs API operation for Amazon Pinpoint.

Returns a list of import jobs for a specific segment.

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

See the AWS API reference guide for Amazon Pinpoint's API operation GetSegmentImportJobs for usage and error information.

Returned Error Codes:

  • ErrCodeBadRequestException "BadRequestException"

  • ErrCodeInternalServerErrorException "InternalServerErrorException"

  • ErrCodeForbiddenException "ForbiddenException"

  • ErrCodeNotFoundException "NotFoundException"

  • ErrCodeMethodNotAllowedException "MethodNotAllowedException"

  • ErrCodeTooManyRequestsException "TooManyRequestsException"

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

func (*Pinpoint) GetSegmentImportJobsRequest

func (c *Pinpoint) GetSegmentImportJobsRequest(input *GetSegmentImportJobsInput) (req *request.Request, output *GetSegmentImportJobsOutput)

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

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

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

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

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

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

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

func (*Pinpoint) GetSegmentImportJobsWithContext added in v1.8.0

func (c *Pinpoint) GetSegmentImportJobsWithContext(ctx aws.Context, input *GetSegmentImportJobsInput, opts ...request.Option) (*GetSegmentImportJobsOutput, error)

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

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

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

func (*Pinpoint) GetSegmentRequest

func (c *Pinpoint) GetSegmentRequest(input *GetSegmentInput) (req *request.Request, output *GetSegmentOutput)

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

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

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

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

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

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

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

func (*Pinpoint) GetSegmentVersion

func (c *Pinpoint) GetSegmentVersion(input *GetSegmentVersionInput) (*GetSegmentVersionOutput, error)

GetSegmentVersion API operation for Amazon Pinpoint.

Returns information about a segment version.

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

See the AWS API reference guide for Amazon Pinpoint's API operation GetSegmentVersion for usage and error information.

Returned Error Codes:

  • ErrCodeBadRequestException "BadRequestException"

  • ErrCodeInternalServerErrorException "InternalServerErrorException"

  • ErrCodeForbiddenException "ForbiddenException"

  • ErrCodeNotFoundException "NotFoundException"

  • ErrCodeMethodNotAllowedException "MethodNotAllowedException"

  • ErrCodeTooManyRequestsException "TooManyRequestsException"

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

func (*Pinpoint) GetSegmentVersionRequest

func (c *Pinpoint) GetSegmentVersionRequest(input *GetSegmentVersionInput) (req *request.Request, output *GetSegmentVersionOutput)

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

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

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

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

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

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

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

func (*Pinpoint) GetSegmentVersionWithContext added in v1.8.0

func (c *Pinpoint) GetSegmentVersionWithContext(ctx aws.Context, input *GetSegmentVersionInput, opts ...request.Option) (*GetSegmentVersionOutput, error)

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

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

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

func (*Pinpoint) GetSegmentVersions

func (c *Pinpoint) GetSegmentVersions(input *GetSegmentVersionsInput) (*GetSegmentVersionsOutput, error)

GetSegmentVersions API operation for Amazon Pinpoint.

Returns information about your segment versions.

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

See the AWS API reference guide for Amazon Pinpoint's API operation GetSegmentVersions for usage and error information.

Returned Error Codes:

  • ErrCodeBadRequestException "BadRequestException"

  • ErrCodeInternalServerErrorException "InternalServerErrorException"

  • ErrCodeForbiddenException "ForbiddenException"

  • ErrCodeNotFoundException "NotFoundException"

  • ErrCodeMethodNotAllowedException "MethodNotAllowedException"

  • ErrCodeTooManyRequestsException "TooManyRequestsException"

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

func (*Pinpoint) GetSegmentVersionsRequest

func (c *Pinpoint) GetSegmentVersionsRequest(input *GetSegmentVersionsInput) (req *request.Request, output *GetSegmentVersionsOutput)

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

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

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

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

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

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

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

func (*Pinpoint) GetSegmentVersionsWithContext added in v1.8.0

func (c *Pinpoint) GetSegmentVersionsWithContext(ctx aws.Context, input *GetSegmentVersionsInput, opts ...request.Option) (*GetSegmentVersionsOutput, error)

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

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

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

func (*Pinpoint) GetSegmentWithContext added in v1.8.0

func (c *Pinpoint) GetSegmentWithContext(ctx aws.Context, input *GetSegmentInput, opts ...request.Option) (*GetSegmentOutput, error)

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

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

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

func (*Pinpoint) GetSegments

func (c *Pinpoint) GetSegments(input *GetSegmentsInput) (*GetSegmentsOutput, error)

GetSegments API operation for Amazon Pinpoint.

Used to get information about your segments.

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

See the AWS API reference guide for Amazon Pinpoint's API operation GetSegments for usage and error information.

Returned Error Codes:

  • ErrCodeBadRequestException "BadRequestException"

  • ErrCodeInternalServerErrorException "InternalServerErrorException"

  • ErrCodeForbiddenException "ForbiddenException"

  • ErrCodeNotFoundException "NotFoundException"

  • ErrCodeMethodNotAllowedException "MethodNotAllowedException"

  • ErrCodeTooManyRequestsException "TooManyRequestsException"

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

func (*Pinpoint) GetSegmentsRequest

func (c *Pinpoint) GetSegmentsRequest(input *GetSegmentsInput) (req *request.Request, output *GetSegmentsOutput)

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

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

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

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

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

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

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

func (*Pinpoint) GetSegmentsWithContext added in v1.8.0

func (c *Pinpoint) GetSegmentsWithContext(ctx aws.Context, input *GetSegmentsInput, opts ...request.Option) (*GetSegmentsOutput, error)

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

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

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

func (*Pinpoint) GetSmsChannel added in v1.8.38

func (c *Pinpoint) GetSmsChannel(input *GetSmsChannelInput) (*GetSmsChannelOutput, error)

GetSmsChannel API operation for Amazon Pinpoint.

Get an SMS channel

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

See the AWS API reference guide for Amazon Pinpoint's API operation GetSmsChannel for usage and error information.

Returned Error Codes:

  • ErrCodeBadRequestException "BadRequestException"

  • ErrCodeInternalServerErrorException "InternalServerErrorException"

  • ErrCodeForbiddenException "ForbiddenException"

  • ErrCodeNotFoundException "NotFoundException"

  • ErrCodeMethodNotAllowedException "MethodNotAllowedException"

  • ErrCodeTooManyRequestsException "TooManyRequestsException"

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

func (*Pinpoint) GetSmsChannelRequest added in v1.8.38

func (c *Pinpoint) GetSmsChannelRequest(input *GetSmsChannelInput) (req *request.Request, output *GetSmsChannelOutput)

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

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

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

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

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

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

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

func (*Pinpoint) GetSmsChannelWithContext added in v1.8.38

func (c *Pinpoint) GetSmsChannelWithContext(ctx aws.Context, input *GetSmsChannelInput, opts ...request.Option) (*GetSmsChannelOutput, error)

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

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

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

func (*Pinpoint) PutEventStream added in v1.8.0

func (c *Pinpoint) PutEventStream(input *PutEventStreamInput) (*PutEventStreamOutput, error)

PutEventStream API operation for Amazon Pinpoint.

Use to create or update the event stream for an app.

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

See the AWS API reference guide for Amazon Pinpoint's API operation PutEventStream for usage and error information.

Returned Error Codes:

  • ErrCodeBadRequestException "BadRequestException"

  • ErrCodeInternalServerErrorException "InternalServerErrorException"

  • ErrCodeForbiddenException "ForbiddenException"

  • ErrCodeNotFoundException "NotFoundException"

  • ErrCodeMethodNotAllowedException "MethodNotAllowedException"

  • ErrCodeTooManyRequestsException "TooManyRequestsException"

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

func (*Pinpoint) PutEventStreamRequest added in v1.8.0

func (c *Pinpoint) PutEventStreamRequest(input *PutEventStreamInput) (req *request.Request, output *PutEventStreamOutput)

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

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

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

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

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

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

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

func (*Pinpoint) PutEventStreamWithContext added in v1.8.0

func (c *Pinpoint) PutEventStreamWithContext(ctx aws.Context, input *PutEventStreamInput, opts ...request.Option) (*PutEventStreamOutput, error)

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

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

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

func (*Pinpoint) SendMessages added in v1.8.38

func (c *Pinpoint) SendMessages(input *SendMessagesInput) (*SendMessagesOutput, error)

SendMessages API operation for Amazon Pinpoint.

Send a batch of messages

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

See the AWS API reference guide for Amazon Pinpoint's API operation SendMessages for usage and error information.

Returned Error Codes:

  • ErrCodeBadRequestException "BadRequestException"

  • ErrCodeInternalServerErrorException "InternalServerErrorException"

  • ErrCodeForbiddenException "ForbiddenException"

  • ErrCodeNotFoundException "NotFoundException"

  • ErrCodeMethodNotAllowedException "MethodNotAllowedException"

  • ErrCodeTooManyRequestsException "TooManyRequestsException"

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

func (*Pinpoint) SendMessagesRequest added in v1.8.38

func (c *Pinpoint) SendMessagesRequest(input *SendMessagesInput) (req *request.Request, output *SendMessagesOutput)

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

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

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

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

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

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

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

func (*Pinpoint) SendMessagesWithContext added in v1.8.38

func (c *Pinpoint) SendMessagesWithContext(ctx aws.Context, input *SendMessagesInput, opts ...request.Option) (*SendMessagesOutput, error)

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

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

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

func (*Pinpoint) SendUsersMessages added in v1.12.1

func (c *Pinpoint) SendUsersMessages(input *SendUsersMessagesInput) (*SendUsersMessagesOutput, error)

SendUsersMessages API operation for Amazon Pinpoint.

Send a batch of messages to users

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

See the AWS API reference guide for Amazon Pinpoint's API operation SendUsersMessages for usage and error information.

Returned Error Codes:

  • ErrCodeBadRequestException "BadRequestException"

  • ErrCodeInternalServerErrorException "InternalServerErrorException"

  • ErrCodeForbiddenException "ForbiddenException"

  • ErrCodeNotFoundException "NotFoundException"

  • ErrCodeMethodNotAllowedException "MethodNotAllowedException"

  • ErrCodeTooManyRequestsException "TooManyRequestsException"

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

func (*Pinpoint) SendUsersMessagesRequest added in v1.12.1

func (c *Pinpoint) SendUsersMessagesRequest(input *SendUsersMessagesInput) (req *request.Request, output *SendUsersMessagesOutput)

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

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

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

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

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

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

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

func (*Pinpoint) SendUsersMessagesWithContext added in v1.12.1

func (c *Pinpoint) SendUsersMessagesWithContext(ctx aws.Context, input *SendUsersMessagesInput, opts ...request.Option) (*SendUsersMessagesOutput, error)

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

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

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

func (*Pinpoint) UpdateAdmChannel added in v1.12.1

func (c *Pinpoint) UpdateAdmChannel(input *UpdateAdmChannelInput) (*UpdateAdmChannelOutput, error)

UpdateAdmChannel API operation for Amazon Pinpoint.

Update an ADM channel

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

See the AWS API reference guide for Amazon Pinpoint's API operation UpdateAdmChannel for usage and error information.

Returned Error Codes:

  • ErrCodeBadRequestException "BadRequestException"

  • ErrCodeInternalServerErrorException "InternalServerErrorException"

  • ErrCodeForbiddenException "ForbiddenException"

  • ErrCodeNotFoundException "NotFoundException"

  • ErrCodeMethodNotAllowedException "MethodNotAllowedException"

  • ErrCodeTooManyRequestsException "TooManyRequestsException"

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

func (*Pinpoint) UpdateAdmChannelRequest added in v1.12.1

func (c *Pinpoint) UpdateAdmChannelRequest(input *UpdateAdmChannelInput) (req *request.Request, output *UpdateAdmChannelOutput)

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

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

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

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

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

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

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

func (*Pinpoint) UpdateAdmChannelWithContext added in v1.12.1

func (c *Pinpoint) UpdateAdmChannelWithContext(ctx aws.Context, input *UpdateAdmChannelInput, opts ...request.Option) (*UpdateAdmChannelOutput, error)

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

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

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

func (*Pinpoint) UpdateApnsChannel

func (c *Pinpoint) UpdateApnsChannel(input *UpdateApnsChannelInput) (*UpdateApnsChannelOutput, error)

UpdateApnsChannel API operation for Amazon Pinpoint.

Use to update the APNs channel for an app.

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

See the AWS API reference guide for Amazon Pinpoint's API operation UpdateApnsChannel for usage and error information.

Returned Error Codes:

  • ErrCodeBadRequestException "BadRequestException"

  • ErrCodeInternalServerErrorException "InternalServerErrorException"

  • ErrCodeForbiddenException "ForbiddenException"

  • ErrCodeNotFoundException "NotFoundException"

  • ErrCodeMethodNotAllowedException "MethodNotAllowedException"

  • ErrCodeTooManyRequestsException "TooManyRequestsException"

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

func (*Pinpoint) UpdateApnsChannelRequest

func (c *Pinpoint) UpdateApnsChannelRequest(input *UpdateApnsChannelInput) (req *request.Request, output *UpdateApnsChannelOutput)

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

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

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

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

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

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

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

func (*Pinpoint) UpdateApnsChannelWithContext added in v1.8.0

func (c *Pinpoint) UpdateApnsChannelWithContext(ctx aws.Context, input *UpdateApnsChannelInput, opts ...request.Option) (*UpdateApnsChannelOutput, error)

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

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

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

func (*Pinpoint) UpdateApnsSandboxChannel added in v1.8.38

func (c *Pinpoint) UpdateApnsSandboxChannel(input *UpdateApnsSandboxChannelInput) (*UpdateApnsSandboxChannelOutput, error)

UpdateApnsSandboxChannel API operation for Amazon Pinpoint.

Update an APNS sandbox channel

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

See the AWS API reference guide for Amazon Pinpoint's API operation UpdateApnsSandboxChannel for usage and error information.

Returned Error Codes:

  • ErrCodeBadRequestException "BadRequestException"

  • ErrCodeInternalServerErrorException "InternalServerErrorException"

  • ErrCodeForbiddenException "ForbiddenException"

  • ErrCodeNotFoundException "NotFoundException"

  • ErrCodeMethodNotAllowedException "MethodNotAllowedException"

  • ErrCodeTooManyRequestsException "TooManyRequestsException"

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

func (*Pinpoint) UpdateApnsSandboxChannelRequest added in v1.8.38

func (c *Pinpoint) UpdateApnsSandboxChannelRequest(input *UpdateApnsSandboxChannelInput) (req *request.Request, output *UpdateApnsSandboxChannelOutput)

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

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

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

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

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

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

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

func (*Pinpoint) UpdateApnsSandboxChannelWithContext added in v1.8.38

func (c *Pinpoint) UpdateApnsSandboxChannelWithContext(ctx aws.Context, input *UpdateApnsSandboxChannelInput, opts ...request.Option) (*UpdateApnsSandboxChannelOutput, error)

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

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

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

func (*Pinpoint) UpdateApnsVoipChannel added in v1.12.17

func (c *Pinpoint) UpdateApnsVoipChannel(input *UpdateApnsVoipChannelInput) (*UpdateApnsVoipChannelOutput, error)

UpdateApnsVoipChannel API operation for Amazon Pinpoint.

Update an APNS VoIP channel

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

See the AWS API reference guide for Amazon Pinpoint's API operation UpdateApnsVoipChannel for usage and error information.

Returned Error Codes:

  • ErrCodeBadRequestException "BadRequestException"

  • ErrCodeInternalServerErrorException "InternalServerErrorException"

  • ErrCodeForbiddenException "ForbiddenException"

  • ErrCodeNotFoundException "NotFoundException"

  • ErrCodeMethodNotAllowedException "MethodNotAllowedException"

  • ErrCodeTooManyRequestsException "TooManyRequestsException"

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

func (*Pinpoint) UpdateApnsVoipChannelRequest added in v1.12.17

func (c *Pinpoint) UpdateApnsVoipChannelRequest(input *UpdateApnsVoipChannelInput) (req *request.Request, output *UpdateApnsVoipChannelOutput)

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

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

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

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

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

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

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

func (*Pinpoint) UpdateApnsVoipChannelWithContext added in v1.12.17

func (c *Pinpoint) UpdateApnsVoipChannelWithContext(ctx aws.Context, input *UpdateApnsVoipChannelInput, opts ...request.Option) (*UpdateApnsVoipChannelOutput, error)

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

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

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

func (*Pinpoint) UpdateApnsVoipSandboxChannel added in v1.12.17

func (c *Pinpoint) UpdateApnsVoipSandboxChannel(input *UpdateApnsVoipSandboxChannelInput) (*UpdateApnsVoipSandboxChannelOutput, error)

UpdateApnsVoipSandboxChannel API operation for Amazon Pinpoint.

Update an APNS VoIP sandbox channel

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

See the AWS API reference guide for Amazon Pinpoint's API operation UpdateApnsVoipSandboxChannel for usage and error information.

Returned Error Codes:

  • ErrCodeBadRequestException "BadRequestException"

  • ErrCodeInternalServerErrorException "InternalServerErrorException"

  • ErrCodeForbiddenException "ForbiddenException"

  • ErrCodeNotFoundException "NotFoundException"

  • ErrCodeMethodNotAllowedException "MethodNotAllowedException"

  • ErrCodeTooManyRequestsException "TooManyRequestsException"

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

func (*Pinpoint) UpdateApnsVoipSandboxChannelRequest added in v1.12.17

func (c *Pinpoint) UpdateApnsVoipSandboxChannelRequest(input *UpdateApnsVoipSandboxChannelInput) (req *request.Request, output *UpdateApnsVoipSandboxChannelOutput)

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

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

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

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

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

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

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

func (*Pinpoint) UpdateApnsVoipSandboxChannelWithContext added in v1.12.17

func (c *Pinpoint) UpdateApnsVoipSandboxChannelWithContext(ctx aws.Context, input *UpdateApnsVoipSandboxChannelInput, opts ...request.Option) (*UpdateApnsVoipSandboxChannelOutput, error)

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

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

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

func (*Pinpoint) UpdateApplicationSettings

func (c *Pinpoint) UpdateApplicationSettings(input *UpdateApplicationSettingsInput) (*UpdateApplicationSettingsOutput, error)

UpdateApplicationSettings API operation for Amazon Pinpoint.

Used to update the settings for an app.

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

See the AWS API reference guide for Amazon Pinpoint's API operation UpdateApplicationSettings for usage and error information.

Returned Error Codes:

  • ErrCodeBadRequestException "BadRequestException"

  • ErrCodeInternalServerErrorException "InternalServerErrorException"

  • ErrCodeForbiddenException "ForbiddenException"

  • ErrCodeNotFoundException "NotFoundException"

  • ErrCodeMethodNotAllowedException "MethodNotAllowedException"

  • ErrCodeTooManyRequestsException "TooManyRequestsException"

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

func (*Pinpoint) UpdateApplicationSettingsRequest

func (c *Pinpoint) UpdateApplicationSettingsRequest(input *UpdateApplicationSettingsInput) (req *request.Request, output *UpdateApplicationSettingsOutput)

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

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

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

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

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

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

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

func (*Pinpoint) UpdateApplicationSettingsWithContext added in v1.8.0

func (c *Pinpoint) UpdateApplicationSettingsWithContext(ctx aws.Context, input *UpdateApplicationSettingsInput, opts ...request.Option) (*UpdateApplicationSettingsOutput, error)

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

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

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

func (*Pinpoint) UpdateBaiduChannel added in v1.12.1

func (c *Pinpoint) UpdateBaiduChannel(input *UpdateBaiduChannelInput) (*UpdateBaiduChannelOutput, error)

UpdateBaiduChannel API operation for Amazon Pinpoint.

Update a BAIDU GCM channel

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

See the AWS API reference guide for Amazon Pinpoint's API operation UpdateBaiduChannel for usage and error information.

Returned Error Codes:

  • ErrCodeBadRequestException "BadRequestException"

  • ErrCodeInternalServerErrorException "InternalServerErrorException"

  • ErrCodeForbiddenException "ForbiddenException"

  • ErrCodeNotFoundException "NotFoundException"

  • ErrCodeMethodNotAllowedException "MethodNotAllowedException"

  • ErrCodeTooManyRequestsException "TooManyRequestsException"

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

func (*Pinpoint) UpdateBaiduChannelRequest added in v1.12.1

func (c *Pinpoint) UpdateBaiduChannelRequest(input *UpdateBaiduChannelInput) (req *request.Request, output *UpdateBaiduChannelOutput)

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

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

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

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

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

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

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

func (*Pinpoint) UpdateBaiduChannelWithContext added in v1.12.1

func (c *Pinpoint) UpdateBaiduChannelWithContext(ctx aws.Context, input *UpdateBaiduChannelInput, opts ...request.Option) (*UpdateBaiduChannelOutput, error)

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

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

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

func (*Pinpoint) UpdateCampaign

func (c *Pinpoint) UpdateCampaign(input *UpdateCampaignInput) (*UpdateCampaignOutput, error)

UpdateCampaign API operation for Amazon Pinpoint.

Use to update a campaign.

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

See the AWS API reference guide for Amazon Pinpoint's API operation UpdateCampaign for usage and error information.

Returned Error Codes:

  • ErrCodeBadRequestException "BadRequestException"

  • ErrCodeInternalServerErrorException "InternalServerErrorException"

  • ErrCodeForbiddenException "ForbiddenException"

  • ErrCodeNotFoundException "NotFoundException"

  • ErrCodeMethodNotAllowedException "MethodNotAllowedException"

  • ErrCodeTooManyRequestsException "TooManyRequestsException"

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

func (*Pinpoint) UpdateCampaignRequest

func (c *Pinpoint) UpdateCampaignRequest(input *UpdateCampaignInput) (req *request.Request, output *UpdateCampaignOutput)

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

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

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

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

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

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

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

func (*Pinpoint) UpdateCampaignWithContext added in v1.8.0

func (c *Pinpoint) UpdateCampaignWithContext(ctx aws.Context, input *UpdateCampaignInput, opts ...request.Option) (*UpdateCampaignOutput, error)

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

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

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

func (*Pinpoint) UpdateEmailChannel added in v1.8.38

func (c *Pinpoint) UpdateEmailChannel(input *UpdateEmailChannelInput) (*UpdateEmailChannelOutput, error)

UpdateEmailChannel API operation for Amazon Pinpoint.

Update an email channel

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

See the AWS API reference guide for Amazon Pinpoint's API operation UpdateEmailChannel for usage and error information.

Returned Error Codes:

  • ErrCodeBadRequestException "BadRequestException"

  • ErrCodeInternalServerErrorException "InternalServerErrorException"

  • ErrCodeForbiddenException "ForbiddenException"

  • ErrCodeNotFoundException "NotFoundException"

  • ErrCodeMethodNotAllowedException "MethodNotAllowedException"

  • ErrCodeTooManyRequestsException "TooManyRequestsException"

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

func (*Pinpoint) UpdateEmailChannelRequest added in v1.8.38

func (c *Pinpoint) UpdateEmailChannelRequest(input *UpdateEmailChannelInput) (req *request.Request, output *UpdateEmailChannelOutput)

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

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

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

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

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

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

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

func (*Pinpoint) UpdateEmailChannelWithContext added in v1.8.38

func (c *Pinpoint) UpdateEmailChannelWithContext(ctx aws.Context, input *UpdateEmailChannelInput, opts ...request.Option) (*UpdateEmailChannelOutput, error)

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

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

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

func (*Pinpoint) UpdateEndpoint

func (c *Pinpoint) UpdateEndpoint(input *UpdateEndpointInput) (*UpdateEndpointOutput, error)

UpdateEndpoint API operation for Amazon Pinpoint.

Use to update an endpoint.

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

See the AWS API reference guide for Amazon Pinpoint's API operation UpdateEndpoint for usage and error information.

Returned Error Codes:

  • ErrCodeBadRequestException "BadRequestException"

  • ErrCodeInternalServerErrorException "InternalServerErrorException"

  • ErrCodeForbiddenException "ForbiddenException"

  • ErrCodeNotFoundException "NotFoundException"

  • ErrCodeMethodNotAllowedException "MethodNotAllowedException"

  • ErrCodeTooManyRequestsException "TooManyRequestsException"

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

func (*Pinpoint) UpdateEndpointRequest

func (c *Pinpoint) UpdateEndpointRequest(input *UpdateEndpointInput) (req *request.Request, output *UpdateEndpointOutput)

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

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

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

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

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

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

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

func (*Pinpoint) UpdateEndpointWithContext added in v1.8.0

func (c *Pinpoint) UpdateEndpointWithContext(ctx aws.Context, input *UpdateEndpointInput, opts ...request.Option) (*UpdateEndpointOutput, error)

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

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

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

func (*Pinpoint) UpdateEndpointsBatch

func (c *Pinpoint) UpdateEndpointsBatch(input *UpdateEndpointsBatchInput) (*UpdateEndpointsBatchOutput, error)

UpdateEndpointsBatch API operation for Amazon Pinpoint.

Use to update a batch of endpoints.

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

See the AWS API reference guide for Amazon Pinpoint's API operation UpdateEndpointsBatch for usage and error information.

Returned Error Codes:

  • ErrCodeBadRequestException "BadRequestException"

  • ErrCodeInternalServerErrorException "InternalServerErrorException"

  • ErrCodeForbiddenException "ForbiddenException"

  • ErrCodeNotFoundException "NotFoundException"

  • ErrCodeMethodNotAllowedException "MethodNotAllowedException"

  • ErrCodeTooManyRequestsException "TooManyRequestsException"

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

func (*Pinpoint) UpdateEndpointsBatchRequest

func (c *Pinpoint) UpdateEndpointsBatchRequest(input *UpdateEndpointsBatchInput) (req *request.Request, output *UpdateEndpointsBatchOutput)

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

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

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

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

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

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

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

func (*Pinpoint) UpdateEndpointsBatchWithContext added in v1.8.0

func (c *Pinpoint) UpdateEndpointsBatchWithContext(ctx aws.Context, input *UpdateEndpointsBatchInput, opts ...request.Option) (*UpdateEndpointsBatchOutput, error)

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

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

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

func (*Pinpoint) UpdateGcmChannel

func (c *Pinpoint) UpdateGcmChannel(input *UpdateGcmChannelInput) (*UpdateGcmChannelOutput, error)

UpdateGcmChannel API operation for Amazon Pinpoint.

Use to update the GCM channel for an app.

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

See the AWS API reference guide for Amazon Pinpoint's API operation UpdateGcmChannel for usage and error information.

Returned Error Codes:

  • ErrCodeBadRequestException "BadRequestException"

  • ErrCodeInternalServerErrorException "InternalServerErrorException"

  • ErrCodeForbiddenException "ForbiddenException"

  • ErrCodeNotFoundException "NotFoundException"

  • ErrCodeMethodNotAllowedException "MethodNotAllowedException"

  • ErrCodeTooManyRequestsException "TooManyRequestsException"

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

func (*Pinpoint) UpdateGcmChannelRequest

func (c *Pinpoint) UpdateGcmChannelRequest(input *UpdateGcmChannelInput) (req *request.Request, output *UpdateGcmChannelOutput)

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

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

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

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

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

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/UpdateGcmChannel

func (*Pinpoint) UpdateGcmChannelWithContext added in v1.8.0

func (c *Pinpoint) UpdateGcmChannelWithContext(ctx aws.Context, input *UpdateGcmChannelInput, opts ...request.Option) (*UpdateGcmChannelOutput, error)

UpdateGcmChannelWithContext is the same as UpdateGcmChannel with the addition of the ability to pass a context and additional request options.

See UpdateGcmChannel for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Pinpoint) UpdateSegment

func (c *Pinpoint) UpdateSegment(input *UpdateSegmentInput) (*UpdateSegmentOutput, error)

UpdateSegment API operation for Amazon Pinpoint.

Use to update a segment.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint's API operation UpdateSegment for usage and error information.

Returned Error Codes:

  • ErrCodeBadRequestException "BadRequestException"

  • ErrCodeInternalServerErrorException "InternalServerErrorException"

  • ErrCodeForbiddenException "ForbiddenException"

  • ErrCodeNotFoundException "NotFoundException"

  • ErrCodeMethodNotAllowedException "MethodNotAllowedException"

  • ErrCodeTooManyRequestsException "TooManyRequestsException"

See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/UpdateSegment

func (*Pinpoint) UpdateSegmentRequest

func (c *Pinpoint) UpdateSegmentRequest(input *UpdateSegmentInput) (req *request.Request, output *UpdateSegmentOutput)

UpdateSegmentRequest generates a "aws/request.Request" representing the client's request for the UpdateSegment operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateSegment for more information on using the UpdateSegment API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateSegmentRequest method.
req, resp := client.UpdateSegmentRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/UpdateSegment

func (*Pinpoint) UpdateSegmentWithContext added in v1.8.0

func (c *Pinpoint) UpdateSegmentWithContext(ctx aws.Context, input *UpdateSegmentInput, opts ...request.Option) (*UpdateSegmentOutput, error)

UpdateSegmentWithContext is the same as UpdateSegment with the addition of the ability to pass a context and additional request options.

See UpdateSegment for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Pinpoint) UpdateSmsChannel added in v1.8.38

func (c *Pinpoint) UpdateSmsChannel(input *UpdateSmsChannelInput) (*UpdateSmsChannelOutput, error)

UpdateSmsChannel API operation for Amazon Pinpoint.

Update an SMS channel

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint's API operation UpdateSmsChannel for usage and error information.

Returned Error Codes:

  • ErrCodeBadRequestException "BadRequestException"

  • ErrCodeInternalServerErrorException "InternalServerErrorException"

  • ErrCodeForbiddenException "ForbiddenException"

  • ErrCodeNotFoundException "NotFoundException"

  • ErrCodeMethodNotAllowedException "MethodNotAllowedException"

  • ErrCodeTooManyRequestsException "TooManyRequestsException"

See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/UpdateSmsChannel

func (*Pinpoint) UpdateSmsChannelRequest added in v1.8.38

func (c *Pinpoint) UpdateSmsChannelRequest(input *UpdateSmsChannelInput) (req *request.Request, output *UpdateSmsChannelOutput)

UpdateSmsChannelRequest generates a "aws/request.Request" representing the client's request for the UpdateSmsChannel operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateSmsChannel for more information on using the UpdateSmsChannel API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateSmsChannelRequest method.
req, resp := client.UpdateSmsChannelRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/UpdateSmsChannel

func (*Pinpoint) UpdateSmsChannelWithContext added in v1.8.38

func (c *Pinpoint) UpdateSmsChannelWithContext(ctx aws.Context, input *UpdateSmsChannelInput, opts ...request.Option) (*UpdateSmsChannelOutput, error)

UpdateSmsChannelWithContext is the same as UpdateSmsChannel with the addition of the ability to pass a context and additional request options.

See UpdateSmsChannel for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

type PutEventStreamInput added in v1.8.0

type PutEventStreamInput struct {

	// Application Id.
	//
	// ApplicationId is a required field
	ApplicationId *string `location:"uri" locationName:"application-id" type:"string" required:"true"`

	// Write event stream wrapper.
	//
	// WriteEventStream is a required field
	WriteEventStream *WriteEventStream `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (PutEventStreamInput) GoString added in v1.8.0

func (s PutEventStreamInput) GoString() string

GoString returns the string representation

func (*PutEventStreamInput) SetApplicationId added in v1.8.0

func (s *PutEventStreamInput) SetApplicationId(v string) *PutEventStreamInput

SetApplicationId sets the ApplicationId field's value.

func (*PutEventStreamInput) SetWriteEventStream added in v1.8.0

func (s *PutEventStreamInput) SetWriteEventStream(v *WriteEventStream) *PutEventStreamInput

SetWriteEventStream sets the WriteEventStream field's value.

func (PutEventStreamInput) String added in v1.8.0

func (s PutEventStreamInput) String() string

String returns the string representation

func (*PutEventStreamInput) Validate added in v1.8.0

func (s *PutEventStreamInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PutEventStreamOutput added in v1.8.0

type PutEventStreamOutput struct {

	// Model for an event publishing subscription export.
	//
	// EventStream is a required field
	EventStream *EventStream `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (PutEventStreamOutput) GoString added in v1.8.0

func (s PutEventStreamOutput) GoString() string

GoString returns the string representation

func (*PutEventStreamOutput) SetEventStream added in v1.8.0

func (s *PutEventStreamOutput) SetEventStream(v *EventStream) *PutEventStreamOutput

SetEventStream sets the EventStream field's value.

func (PutEventStreamOutput) String added in v1.8.0

func (s PutEventStreamOutput) String() string

String returns the string representation

type QuietTime

type QuietTime struct {

	// The default end time for quiet time in ISO 8601 format.
	End *string `type:"string"`

	// The default start time for quiet time in ISO 8601 format.
	Start *string `type:"string"`
	// contains filtered or unexported fields
}

Quiet Time

func (QuietTime) GoString

func (s QuietTime) GoString() string

GoString returns the string representation

func (*QuietTime) SetEnd

func (s *QuietTime) SetEnd(v string) *QuietTime

SetEnd sets the End field's value.

func (*QuietTime) SetStart

func (s *QuietTime) SetStart(v string) *QuietTime

SetStart sets the Start field's value.

func (QuietTime) String

func (s QuietTime) String() string

String returns the string representation

type RecencyDimension

type RecencyDimension struct {

	// The length of time during which users have been active or inactive with your
	// app.Valid values: HR_24, DAY_7, DAY_14, DAY_30
	Duration *string `type:"string" enum:"Duration"`

	// The recency dimension type:ACTIVE - Users who have used your app within the
	// specified duration are included in the segment.INACTIVE - Users who have
	// not used your app within the specified duration are included in the segment.
	RecencyType *string `type:"string" enum:"RecencyType"`
	// contains filtered or unexported fields
}

Define how a segment based on recency of use.

func (RecencyDimension) GoString

func (s RecencyDimension) GoString() string

GoString returns the string representation

func (*RecencyDimension) SetDuration

func (s *RecencyDimension) SetDuration(v string) *RecencyDimension

SetDuration sets the Duration field's value.

func (*RecencyDimension) SetRecencyType

func (s *RecencyDimension) SetRecencyType(v string) *RecencyDimension

SetRecencyType sets the RecencyType field's value.

func (RecencyDimension) String

func (s RecencyDimension) String() string

String returns the string representation

type SMSChannelRequest added in v1.8.38

type SMSChannelRequest struct {

	// If the channel is enabled for sending messages.
	Enabled *bool `type:"boolean"`

	// Sender identifier of your messages.
	SenderId *string `type:"string"`

	// ShortCode registered with phone provider.
	ShortCode *string `type:"string"`
	// contains filtered or unexported fields
}

SMS Channel Request

func (SMSChannelRequest) GoString added in v1.8.38

func (s SMSChannelRequest) GoString() string

GoString returns the string representation

func (*SMSChannelRequest) SetEnabled added in v1.8.38

func (s *SMSChannelRequest) SetEnabled(v bool) *SMSChannelRequest

SetEnabled sets the Enabled field's value.

func (*SMSChannelRequest) SetSenderId added in v1.8.38

func (s *SMSChannelRequest) SetSenderId(v string) *SMSChannelRequest

SetSenderId sets the SenderId field's value.

func (*SMSChannelRequest) SetShortCode added in v1.12.1

func (s *SMSChannelRequest) SetShortCode(v string) *SMSChannelRequest

SetShortCode sets the ShortCode field's value.

func (SMSChannelRequest) String added in v1.8.38

func (s SMSChannelRequest) String() string

String returns the string representation

type SMSChannelResponse added in v1.8.38

type SMSChannelResponse struct {

	// The unique ID of the application to which the SMS channel belongs.
	ApplicationId *string `type:"string"`

	// The date that the settings were last updated in ISO 8601 format.
	CreationDate *string `type:"string"`

	// If the channel is enabled for sending messages.
	Enabled *bool `type:"boolean"`

	// If the channel is registered with a credential for authentication.
	HasCredential *bool `type:"boolean"`

	// Channel ID. Not used, only for backwards compatibility.
	Id *string `type:"string"`

	// Is this channel archived
	IsArchived *bool `type:"boolean"`

	// Who last updated this entry
	LastModifiedBy *string `type:"string"`

	// Last date this was updated
	LastModifiedDate *string `type:"string"`

	// Platform type. Will be "SMS"
	Platform *string `type:"string"`

	// Sender identifier of your messages.
	SenderId *string `type:"string"`

	// The short code registered with the phone provider.
	ShortCode *string `type:"string"`

	// Version of channel
	Version *int64 `type:"integer"`
	// contains filtered or unexported fields
}

SMS Channel Response.

func (SMSChannelResponse) GoString added in v1.8.38

func (s SMSChannelResponse) GoString() string

GoString returns the string representation

func (*SMSChannelResponse) SetApplicationId added in v1.8.38

func (s *SMSChannelResponse) SetApplicationId(v string) *SMSChannelResponse

SetApplicationId sets the ApplicationId field's value.

func (*SMSChannelResponse) SetCreationDate added in v1.8.38

func (s *SMSChannelResponse) SetCreationDate(v string) *SMSChannelResponse

SetCreationDate sets the CreationDate field's value.

func (*SMSChannelResponse) SetEnabled added in v1.8.38

func (s *SMSChannelResponse) SetEnabled(v bool) *SMSChannelResponse

SetEnabled sets the Enabled field's value.

func (*SMSChannelResponse) SetHasCredential added in v1.12.17

func (s *SMSChannelResponse) SetHasCredential(v bool) *SMSChannelResponse

SetHasCredential sets the HasCredential field's value.

func (*SMSChannelResponse) SetId added in v1.8.38

SetId sets the Id field's value.

func (*SMSChannelResponse) SetIsArchived added in v1.8.38

func (s *SMSChannelResponse) SetIsArchived(v bool) *SMSChannelResponse

SetIsArchived sets the IsArchived field's value.

func (*SMSChannelResponse) SetLastModifiedBy added in v1.8.38

func (s *SMSChannelResponse) SetLastModifiedBy(v string) *SMSChannelResponse

SetLastModifiedBy sets the LastModifiedBy field's value.

func (*SMSChannelResponse) SetLastModifiedDate added in v1.8.38

func (s *SMSChannelResponse) SetLastModifiedDate(v string) *SMSChannelResponse

SetLastModifiedDate sets the LastModifiedDate field's value.

func (*SMSChannelResponse) SetPlatform added in v1.8.38

func (s *SMSChannelResponse) SetPlatform(v string) *SMSChannelResponse

SetPlatform sets the Platform field's value.

func (*SMSChannelResponse) SetSenderId added in v1.8.38

func (s *SMSChannelResponse) SetSenderId(v string) *SMSChannelResponse

SetSenderId sets the SenderId field's value.

func (*SMSChannelResponse) SetShortCode added in v1.8.38

func (s *SMSChannelResponse) SetShortCode(v string) *SMSChannelResponse

SetShortCode sets the ShortCode field's value.

func (*SMSChannelResponse) SetVersion added in v1.8.38

func (s *SMSChannelResponse) SetVersion(v int64) *SMSChannelResponse

SetVersion sets the Version field's value.

func (SMSChannelResponse) String added in v1.8.38

func (s SMSChannelResponse) String() string

String returns the string representation

type SMSMessage added in v1.8.38

type SMSMessage struct {

	// The message body of the notification, the email body or the text message.
	Body *string `type:"string"`

	// Is this a transaction priority message or lower priority.
	MessageType *string `type:"string" enum:"MessageType"`

	// The phone number that the SMS message originates from. Specify one of the
	// dedicated long codes or short codes that you requested from AWS Support and
	// that is assigned to your account. If this attribute is not specified, Amazon
	// Pinpoint randomly assigns a long code.
	OriginationNumber *string `type:"string"`

	// The sender ID that is shown as the message sender on the recipient's device.
	// Support for sender IDs varies by country or region.
	SenderId *string `type:"string"`

	Substitutions map[string][]*string `type:"map"`
	// contains filtered or unexported fields
}

SMS Message.

func (SMSMessage) GoString added in v1.8.38

func (s SMSMessage) GoString() string

GoString returns the string representation

func (*SMSMessage) SetBody added in v1.8.38

func (s *SMSMessage) SetBody(v string) *SMSMessage

SetBody sets the Body field's value.

func (*SMSMessage) SetMessageType added in v1.8.38

func (s *SMSMessage) SetMessageType(v string) *SMSMessage

SetMessageType sets the MessageType field's value.

func (*SMSMessage) SetOriginationNumber added in v1.13.15

func (s *SMSMessage) SetOriginationNumber(v string) *SMSMessage

SetOriginationNumber sets the OriginationNumber field's value.

func (*SMSMessage) SetSenderId added in v1.8.38

func (s *SMSMessage) SetSenderId(v string) *SMSMessage

SetSenderId sets the SenderId field's value.

func (*SMSMessage) SetSubstitutions added in v1.8.38

func (s *SMSMessage) SetSubstitutions(v map[string][]*string) *SMSMessage

SetSubstitutions sets the Substitutions field's value.

func (SMSMessage) String added in v1.8.38

func (s SMSMessage) String() string

String returns the string representation

type Schedule

type Schedule struct {

	// The scheduled time that the campaign ends in ISO 8601 format.
	EndTime *string `type:"string"`

	// How often the campaign delivers messages.Valid values: ONCE, HOURLY, DAILY,
	// WEEKLY, MONTHLY
	Frequency *string `type:"string" enum:"Frequency"`

	// Indicates whether the campaign schedule takes effect according to each user's
	// local time.
	IsLocalTime *bool `type:"boolean"`

	// The time during which the campaign sends no messages.
	QuietTime *QuietTime `type:"structure"`

	// The scheduled time that the campaign begins in ISO 8601 format.
	StartTime *string `type:"string"`

	// The starting UTC offset for the schedule if the value for isLocalTime is
	// trueValid values: UTCUTC+01UTC+02UTC+03UTC+03:30UTC+04UTC+04:30UTC+05UTC+05:30UTC+05:45UTC+06UTC+06:30UTC+07UTC+08UTC+09UTC+09:30UTC+10UTC+10:30UTC+11UTC+12UTC+13UTC-02UTC-03UTC-04UTC-05UTC-06UTC-07UTC-08UTC-09UTC-10UTC-11
	Timezone *string `type:"string"`
	// contains filtered or unexported fields
}

Shcedule that defines when a campaign is run.

func (Schedule) GoString

func (s Schedule) GoString() string

GoString returns the string representation

func (*Schedule) SetEndTime

func (s *Schedule) SetEndTime(v string) *Schedule

SetEndTime sets the EndTime field's value.

func (*Schedule) SetFrequency

func (s *Schedule) SetFrequency(v string) *Schedule

SetFrequency sets the Frequency field's value.

func (*Schedule) SetIsLocalTime

func (s *Schedule) SetIsLocalTime(v bool) *Schedule

SetIsLocalTime sets the IsLocalTime field's value.

func (*Schedule) SetQuietTime

func (s *Schedule) SetQuietTime(v *QuietTime) *Schedule

SetQuietTime sets the QuietTime field's value.

func (*Schedule) SetStartTime

func (s *Schedule) SetStartTime(v string) *Schedule

SetStartTime sets the StartTime field's value.

func (*Schedule) SetTimezone

func (s *Schedule) SetTimezone(v string) *Schedule

SetTimezone sets the Timezone field's value.

func (Schedule) String

func (s Schedule) String() string

String returns the string representation

type SegmentBehaviors

type SegmentBehaviors struct {

	// The recency of use.
	Recency *RecencyDimension `type:"structure"`
	// contains filtered or unexported fields
}

Segment behavior dimensions

func (SegmentBehaviors) GoString

func (s SegmentBehaviors) GoString() string

GoString returns the string representation

func (*SegmentBehaviors) SetRecency

SetRecency sets the Recency field's value.

func (SegmentBehaviors) String

func (s SegmentBehaviors) String() string

String returns the string representation

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
}

Segment demographic dimensions

func (SegmentDemographics) GoString

func (s SegmentDemographics) GoString() string

GoString returns the string representation

func (*SegmentDemographics) SetAppVersion

SetAppVersion sets the AppVersion field's value.

func (*SegmentDemographics) SetChannel added in v1.8.38

SetChannel sets the Channel field's value.

func (*SegmentDemographics) SetDeviceType

SetDeviceType sets the DeviceType field's value.

func (*SegmentDemographics) SetMake

SetMake sets the Make field's value.

func (*SegmentDemographics) SetModel

SetModel sets the Model field's value.

func (*SegmentDemographics) SetPlatform

SetPlatform sets the Platform field's value.

func (SegmentDemographics) String

func (s SegmentDemographics) String() string

String returns the string representation

type SegmentDimensions

type SegmentDimensions struct {

	// Custom segment attributes.
	Attributes map[string]*AttributeDimension `type:"map"`

	// The segment behaviors attributes.
	Behavior *SegmentBehaviors `type:"structure"`

	// The segment demographics attributes.
	Demographic *SegmentDemographics `type:"structure"`

	// The segment location attributes.
	Location *SegmentLocation `type:"structure"`

	// Custom segment user attributes.
	UserAttributes map[string]*AttributeDimension `type:"map"`
	// contains filtered or unexported fields
}

Segment dimensions

func (SegmentDimensions) GoString

func (s SegmentDimensions) GoString() string

GoString returns the string representation

func (*SegmentDimensions) SetAttributes

SetAttributes sets the Attributes field's value.

func (*SegmentDimensions) SetBehavior

SetBehavior sets the Behavior field's value.

func (*SegmentDimensions) SetDemographic

SetDemographic sets the Demographic field's value.

func (*SegmentDimensions) SetLocation

SetLocation sets the Location field's value.

func (*SegmentDimensions) SetUserAttributes added in v1.8.0

func (s *SegmentDimensions) SetUserAttributes(v map[string]*AttributeDimension) *SegmentDimensions

SetUserAttributes sets the UserAttributes field's value.

func (SegmentDimensions) String

func (s SegmentDimensions) String() string

String returns the string representation

type SegmentImportResource

type SegmentImportResource struct {

	// Channel type counts
	ChannelCounts map[string]*int64 `type:"map"`

	// DEPRECATED. Your AWS account ID, which you assigned to the ExternalID key
	// in an IAM trust policy. Used by Amazon Pinpoint to assume an IAM role. This
	// requirement is removed, and external IDs are not recommended for IAM roles
	// assumed by Amazon Pinpoint.
	ExternalId *string `type:"string"`

	// The format of the endpoint files that were imported to create this segment.Valid
	// values: CSV, JSON
	Format *string `type:"string" enum:"Format"`

	// The Amazon Resource Name (ARN) of an IAM role that grants Amazon Pinpoint
	// access to the endpoints in Amazon S3.
	RoleArn *string `type:"string"`

	// A URL that points to the Amazon S3 location from which the endpoints for
	// this segment were imported.
	S3Url *string `type:"string"`

	// The number of endpoints that were successfully imported to create this segment.
	Size *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Segment import definition.

func (SegmentImportResource) GoString

func (s SegmentImportResource) GoString() string

GoString returns the string representation

func (*SegmentImportResource) SetChannelCounts added in v1.8.38

func (s *SegmentImportResource) SetChannelCounts(v map[string]*int64) *SegmentImportResource

SetChannelCounts sets the ChannelCounts field's value.

func (*SegmentImportResource) SetExternalId

func (s *SegmentImportResource) SetExternalId(v string) *SegmentImportResource

SetExternalId sets the ExternalId field's value.

func (*SegmentImportResource) SetFormat

SetFormat sets the Format field's value.

func (*SegmentImportResource) SetRoleArn

SetRoleArn sets the RoleArn field's value.

func (*SegmentImportResource) SetS3Url

SetS3Url sets the S3Url field's value.

func (*SegmentImportResource) SetSize

SetSize sets the Size field's value.

func (SegmentImportResource) String

func (s SegmentImportResource) String() string

String returns the string representation

type SegmentLocation

type SegmentLocation struct {

	// The country filter according to ISO 3166-1 Alpha-2 codes.
	Country *SetDimension `type:"structure"`
	// contains filtered or unexported fields
}

Segment location dimensions

func (SegmentLocation) GoString

func (s SegmentLocation) GoString() string

GoString returns the string representation

func (*SegmentLocation) SetCountry

func (s *SegmentLocation) SetCountry(v *SetDimension) *SegmentLocation

SetCountry sets the Country field's value.

func (SegmentLocation) String

func (s SegmentLocation) String() string

String returns the string representation

type SegmentResponse

type SegmentResponse struct {

	// The ID of the application to which the segment applies.
	ApplicationId *string `type:"string"`

	// The date the segment was created in ISO 8601 format.
	CreationDate *string `type:"string"`

	// The segment dimensions attributes.
	Dimensions *SegmentDimensions `type:"structure"`

	// The unique segment ID.
	Id *string `type:"string"`

	// The import job settings.
	ImportDefinition *SegmentImportResource `type:"structure"`

	// The date the segment was last updated in ISO 8601 format.
	LastModifiedDate *string `type:"string"`

	// The name of segment
	Name *string `type:"string"`

	// The segment type:DIMENSIONAL - A dynamic segment built from selection criteria
	// based on endpoint data reported by your app. You create this type of segment
	// by using the segment builder in the Amazon Pinpoint console or by making
	// a POST request to the segments resource.IMPORT - A static segment built from
	// an imported set of endpoint definitions. You create this type of segment
	// by importing a segment in the Amazon Pinpoint console or by making a POST
	// request to the jobs/import resource.
	SegmentType *string `type:"string" enum:"SegmentType"`

	// The segment version number.
	Version *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Segment definition.

func (SegmentResponse) GoString

func (s SegmentResponse) GoString() string

GoString returns the string representation

func (*SegmentResponse) SetApplicationId

func (s *SegmentResponse) SetApplicationId(v string) *SegmentResponse

SetApplicationId sets the ApplicationId field's value.

func (*SegmentResponse) SetCreationDate

func (s *SegmentResponse) SetCreationDate(v string) *SegmentResponse

SetCreationDate sets the CreationDate field's value.

func (*SegmentResponse) SetDimensions

func (s *SegmentResponse) SetDimensions(v *SegmentDimensions) *SegmentResponse

SetDimensions sets the Dimensions field's value.

func (*SegmentResponse) SetId

func (s *SegmentResponse) SetId(v string) *SegmentResponse

SetId sets the Id field's value.

func (*SegmentResponse) SetImportDefinition

func (s *SegmentResponse) SetImportDefinition(v *SegmentImportResource) *SegmentResponse

SetImportDefinition sets the ImportDefinition field's value.

func (*SegmentResponse) SetLastModifiedDate

func (s *SegmentResponse) SetLastModifiedDate(v string) *SegmentResponse

SetLastModifiedDate sets the LastModifiedDate field's value.

func (*SegmentResponse) SetName

func (s *SegmentResponse) SetName(v string) *SegmentResponse

SetName sets the Name field's value.

func (*SegmentResponse) SetSegmentType

func (s *SegmentResponse) SetSegmentType(v string) *SegmentResponse

SetSegmentType sets the SegmentType field's value.

func (*SegmentResponse) SetVersion

func (s *SegmentResponse) SetVersion(v int64) *SegmentResponse

SetVersion sets the Version field's value.

func (SegmentResponse) String

func (s SegmentResponse) String() string

String returns the string representation

type SegmentsResponse

type SegmentsResponse struct {

	// The list of segments.
	Item []*SegmentResponse `type:"list"`

	// An identifier used to retrieve the next page of results. The token is null
	// if no additional pages exist.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

Segments in your account.

func (SegmentsResponse) GoString

func (s SegmentsResponse) GoString() string

GoString returns the string representation

func (*SegmentsResponse) SetItem

SetItem sets the Item field's value.

func (*SegmentsResponse) SetNextToken

func (s *SegmentsResponse) SetNextToken(v string) *SegmentsResponse

SetNextToken sets the NextToken field's value.

func (SegmentsResponse) String

func (s SegmentsResponse) String() string

String returns the string representation

type SendMessagesInput added in v1.8.38

type SendMessagesInput struct {

	// ApplicationId is a required field
	ApplicationId *string `location:"uri" locationName:"application-id" type:"string" required:"true"`

	// Send message request.
	//
	// MessageRequest is a required field
	MessageRequest *MessageRequest `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (SendMessagesInput) GoString added in v1.8.38

func (s SendMessagesInput) GoString() string

GoString returns the string representation

func (*SendMessagesInput) SetApplicationId added in v1.8.38

func (s *SendMessagesInput) SetApplicationId(v string) *SendMessagesInput

SetApplicationId sets the ApplicationId field's value.

func (*SendMessagesInput) SetMessageRequest added in v1.8.38

func (s *SendMessagesInput) SetMessageRequest(v *MessageRequest) *SendMessagesInput

SetMessageRequest sets the MessageRequest field's value.

func (SendMessagesInput) String added in v1.8.38

func (s SendMessagesInput) String() string

String returns the string representation

func (*SendMessagesInput) Validate added in v1.8.38

func (s *SendMessagesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type SendMessagesOutput added in v1.8.38

type SendMessagesOutput struct {

	// Send message response.
	//
	// MessageResponse is a required field
	MessageResponse *MessageResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (SendMessagesOutput) GoString added in v1.8.38

func (s SendMessagesOutput) GoString() string

GoString returns the string representation

func (*SendMessagesOutput) SetMessageResponse added in v1.8.38

func (s *SendMessagesOutput) SetMessageResponse(v *MessageResponse) *SendMessagesOutput

SetMessageResponse sets the MessageResponse field's value.

func (SendMessagesOutput) String added in v1.8.38

func (s SendMessagesOutput) String() string

String returns the string representation

type SendUsersMessageRequest added in v1.12.1

type SendUsersMessageRequest struct {

	// A map of custom attributes to attributes to be attached to the message. This
	// payload is added to the push notification's 'data.pinpoint' object or added
	// to the email/sms delivery receipt event attributes.
	Context map[string]*string `type:"map"`

	// Message configuration.
	MessageConfiguration *DirectMessageConfiguration `type:"structure"`

	// A map of destination endpoints, with the EndpointId as the key Endpoint Message
	// Configuration as the value.
	Users map[string]*EndpointSendConfiguration `type:"map"`
	// contains filtered or unexported fields
}

Send message request.

func (SendUsersMessageRequest) GoString added in v1.12.1

func (s SendUsersMessageRequest) GoString() string

GoString returns the string representation

func (*SendUsersMessageRequest) SetContext added in v1.12.1

SetContext sets the Context field's value.

func (*SendUsersMessageRequest) SetMessageConfiguration added in v1.12.1

SetMessageConfiguration sets the MessageConfiguration field's value.

func (*SendUsersMessageRequest) SetUsers added in v1.12.1

SetUsers sets the Users field's value.

func (SendUsersMessageRequest) String added in v1.12.1

func (s SendUsersMessageRequest) String() string

String returns the string representation

type SendUsersMessageResponse added in v1.12.1

type SendUsersMessageResponse struct {

	// Application id of the message.
	ApplicationId *string `type:"string"`

	// Original request Id for which this message was delivered.
	RequestId *string `type:"string"`

	// A map containing of UserId to Map of EndpointId to Endpoint Message Result.
	Result map[string]map[string]*EndpointMessageResult `type:"map"`
	// contains filtered or unexported fields
}

User send message response.

func (SendUsersMessageResponse) GoString added in v1.12.1

func (s SendUsersMessageResponse) GoString() string

GoString returns the string representation

func (*SendUsersMessageResponse) SetApplicationId added in v1.12.1

SetApplicationId sets the ApplicationId field's value.

func (*SendUsersMessageResponse) SetRequestId added in v1.12.1

SetRequestId sets the RequestId field's value.

func (*SendUsersMessageResponse) SetResult added in v1.12.1

SetResult sets the Result field's value.

func (SendUsersMessageResponse) String added in v1.12.1

func (s SendUsersMessageResponse) String() string

String returns the string representation

type SendUsersMessagesInput added in v1.12.1

type SendUsersMessagesInput struct {

	// ApplicationId is a required field
	ApplicationId *string `location:"uri" locationName:"application-id" type:"string" required:"true"`

	// Send message request.
	//
	// SendUsersMessageRequest is a required field
	SendUsersMessageRequest *SendUsersMessageRequest `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (SendUsersMessagesInput) GoString added in v1.12.1

func (s SendUsersMessagesInput) GoString() string

GoString returns the string representation

func (*SendUsersMessagesInput) SetApplicationId added in v1.12.1

func (s *SendUsersMessagesInput) SetApplicationId(v string) *SendUsersMessagesInput

SetApplicationId sets the ApplicationId field's value.

func (*SendUsersMessagesInput) SetSendUsersMessageRequest added in v1.12.1

func (s *SendUsersMessagesInput) SetSendUsersMessageRequest(v *SendUsersMessageRequest) *SendUsersMessagesInput

SetSendUsersMessageRequest sets the SendUsersMessageRequest field's value.

func (SendUsersMessagesInput) String added in v1.12.1

func (s SendUsersMessagesInput) String() string

String returns the string representation

func (*SendUsersMessagesInput) Validate added in v1.12.1

func (s *SendUsersMessagesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type SendUsersMessagesOutput added in v1.12.1

type SendUsersMessagesOutput struct {

	// User send message response.
	//
	// SendUsersMessageResponse is a required field
	SendUsersMessageResponse *SendUsersMessageResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (SendUsersMessagesOutput) GoString added in v1.12.1

func (s SendUsersMessagesOutput) GoString() string

GoString returns the string representation

func (*SendUsersMessagesOutput) SetSendUsersMessageResponse added in v1.12.1

func (s *SendUsersMessagesOutput) SetSendUsersMessageResponse(v *SendUsersMessageResponse) *SendUsersMessagesOutput

SetSendUsersMessageResponse sets the SendUsersMessageResponse field's value.

func (SendUsersMessagesOutput) String added in v1.12.1

func (s SendUsersMessagesOutput) String() string

String returns the string representation

type SetDimension

type SetDimension struct {

	// The type of dimension:INCLUSIVE - Endpoints that match the criteria are included
	// in the segment.EXCLUSIVE - Endpoints that match the criteria are excluded
	// from the segment.
	DimensionType *string `type:"string" enum:"DimensionType"`

	Values []*string `type:"list"`
	// contains filtered or unexported fields
}

Dimension specification of a segment.

func (SetDimension) GoString

func (s SetDimension) GoString() string

GoString returns the string representation

func (*SetDimension) SetDimensionType

func (s *SetDimension) SetDimensionType(v string) *SetDimension

SetDimensionType sets the DimensionType field's value.

func (*SetDimension) SetValues

func (s *SetDimension) SetValues(v []*string) *SetDimension

SetValues sets the Values field's value.

func (SetDimension) String

func (s SetDimension) String() string

String returns the string representation

type TreatmentResource

type TreatmentResource struct {

	// The unique treatment ID.
	Id *string `type:"string"`

	// The message configuration settings.
	MessageConfiguration *MessageConfiguration `type:"structure"`

	// The campaign schedule.
	Schedule *Schedule `type:"structure"`

	// The allocated percentage of users for this treatment.
	SizePercent *int64 `type:"integer"`

	// The treatment status.
	State *CampaignState `type:"structure"`

	// A custom description for the treatment.
	TreatmentDescription *string `type:"string"`

	// The custom name of a variation of the campaign used for A/B testing.
	TreatmentName *string `type:"string"`
	// contains filtered or unexported fields
}

Treatment resource

func (TreatmentResource) GoString

func (s TreatmentResource) GoString() string

GoString returns the string representation

func (*TreatmentResource) SetId

SetId sets the Id field's value.

func (*TreatmentResource) SetMessageConfiguration

func (s *TreatmentResource) SetMessageConfiguration(v *MessageConfiguration) *TreatmentResource

SetMessageConfiguration sets the MessageConfiguration field's value.

func (*TreatmentResource) SetSchedule

func (s *TreatmentResource) SetSchedule(v *Schedule) *TreatmentResource

SetSchedule sets the Schedule field's value.

func (*TreatmentResource) SetSizePercent

func (s *TreatmentResource) SetSizePercent(v int64) *TreatmentResource

SetSizePercent sets the SizePercent field's value.

func (*TreatmentResource) SetState

SetState sets the State field's value.

func (*TreatmentResource) SetTreatmentDescription

func (s *TreatmentResource) SetTreatmentDescription(v string) *TreatmentResource

SetTreatmentDescription sets the TreatmentDescription field's value.

func (*TreatmentResource) SetTreatmentName

func (s *TreatmentResource) SetTreatmentName(v string) *TreatmentResource

SetTreatmentName sets the TreatmentName field's value.

func (TreatmentResource) String

func (s TreatmentResource) String() string

String returns the string representation

type UpdateAdmChannelInput added in v1.12.1

type UpdateAdmChannelInput struct {

	// Amazon Device Messaging channel definition.
	//
	// 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) GoString added in v1.12.1

func (s UpdateAdmChannelInput) GoString() string

GoString returns the string representation

func (*UpdateAdmChannelInput) SetADMChannelRequest added in v1.12.1

func (s *UpdateAdmChannelInput) SetADMChannelRequest(v *ADMChannelRequest) *UpdateAdmChannelInput

SetADMChannelRequest sets the ADMChannelRequest field's value.

func (*UpdateAdmChannelInput) SetApplicationId added in v1.12.1

func (s *UpdateAdmChannelInput) SetApplicationId(v string) *UpdateAdmChannelInput

SetApplicationId sets the ApplicationId field's value.

func (UpdateAdmChannelInput) String added in v1.12.1

func (s UpdateAdmChannelInput) String() string

String returns the string representation

func (*UpdateAdmChannelInput) Validate added in v1.12.1

func (s *UpdateAdmChannelInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateAdmChannelOutput added in v1.12.1

type UpdateAdmChannelOutput struct {

	// Amazon Device Messaging channel definition.
	//
	// ADMChannelResponse is a required field
	ADMChannelResponse *ADMChannelResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateAdmChannelOutput) GoString added in v1.12.1

func (s UpdateAdmChannelOutput) GoString() string

GoString returns the string representation

func (*UpdateAdmChannelOutput) SetADMChannelResponse added in v1.12.1

SetADMChannelResponse sets the ADMChannelResponse field's value.

func (UpdateAdmChannelOutput) String added in v1.12.1

func (s UpdateAdmChannelOutput) String() string

String returns the string representation

type UpdateApnsChannelInput

type UpdateApnsChannelInput struct {

	// Apple Push Notification Service channel definition.
	//
	// 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) GoString

func (s UpdateApnsChannelInput) GoString() string

GoString returns the string representation

func (*UpdateApnsChannelInput) SetAPNSChannelRequest

SetAPNSChannelRequest sets the APNSChannelRequest field's value.

func (*UpdateApnsChannelInput) SetApplicationId

func (s *UpdateApnsChannelInput) SetApplicationId(v string) *UpdateApnsChannelInput

SetApplicationId sets the ApplicationId field's value.

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 {

	// Apple Distribution Push Notification Service channel definition.
	//
	// APNSChannelResponse is a required field
	APNSChannelResponse *APNSChannelResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateApnsChannelOutput) GoString

func (s UpdateApnsChannelOutput) GoString() string

GoString returns the string representation

func (*UpdateApnsChannelOutput) SetAPNSChannelResponse

SetAPNSChannelResponse sets the APNSChannelResponse field's value.

func (UpdateApnsChannelOutput) String

func (s UpdateApnsChannelOutput) String() string

String returns the string representation

type UpdateApnsSandboxChannelInput added in v1.8.38

type UpdateApnsSandboxChannelInput struct {

	// Apple Development Push Notification Service channel definition.
	//
	// 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) GoString added in v1.8.38

GoString returns the string representation

func (*UpdateApnsSandboxChannelInput) SetAPNSSandboxChannelRequest added in v1.8.38

SetAPNSSandboxChannelRequest sets the APNSSandboxChannelRequest field's value.

func (*UpdateApnsSandboxChannelInput) SetApplicationId added in v1.8.38

SetApplicationId sets the ApplicationId field's value.

func (UpdateApnsSandboxChannelInput) String added in v1.8.38

String returns the string representation

func (*UpdateApnsSandboxChannelInput) Validate added in v1.8.38

func (s *UpdateApnsSandboxChannelInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateApnsSandboxChannelOutput added in v1.8.38

type UpdateApnsSandboxChannelOutput struct {

	// Apple Development Push Notification Service channel definition.
	//
	// APNSSandboxChannelResponse is a required field
	APNSSandboxChannelResponse *APNSSandboxChannelResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateApnsSandboxChannelOutput) GoString added in v1.8.38

GoString returns the string representation

func (*UpdateApnsSandboxChannelOutput) SetAPNSSandboxChannelResponse added in v1.8.38

SetAPNSSandboxChannelResponse sets the APNSSandboxChannelResponse field's value.

func (UpdateApnsSandboxChannelOutput) String added in v1.8.38

String returns the string representation

type UpdateApnsVoipChannelInput added in v1.12.17

type UpdateApnsVoipChannelInput struct {

	// Apple VoIP Push Notification Service channel definition.
	//
	// 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) GoString added in v1.12.17

func (s UpdateApnsVoipChannelInput) GoString() string

GoString returns the string representation

func (*UpdateApnsVoipChannelInput) SetAPNSVoipChannelRequest added in v1.12.17

SetAPNSVoipChannelRequest sets the APNSVoipChannelRequest field's value.

func (*UpdateApnsVoipChannelInput) SetApplicationId added in v1.12.17

SetApplicationId sets the ApplicationId field's value.

func (UpdateApnsVoipChannelInput) String added in v1.12.17

String returns the string representation

func (*UpdateApnsVoipChannelInput) Validate added in v1.12.17

func (s *UpdateApnsVoipChannelInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateApnsVoipChannelOutput added in v1.12.17

type UpdateApnsVoipChannelOutput struct {

	// Apple VoIP Push Notification Service channel definition.
	//
	// APNSVoipChannelResponse is a required field
	APNSVoipChannelResponse *APNSVoipChannelResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateApnsVoipChannelOutput) GoString added in v1.12.17

func (s UpdateApnsVoipChannelOutput) GoString() string

GoString returns the string representation

func (*UpdateApnsVoipChannelOutput) SetAPNSVoipChannelResponse added in v1.12.17

SetAPNSVoipChannelResponse sets the APNSVoipChannelResponse field's value.

func (UpdateApnsVoipChannelOutput) String added in v1.12.17

String returns the string representation

type UpdateApnsVoipSandboxChannelInput added in v1.12.17

type UpdateApnsVoipSandboxChannelInput struct {

	// Apple VoIP Developer Push Notification Service channel definition.
	//
	// 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) GoString added in v1.12.17

GoString returns the string representation

func (*UpdateApnsVoipSandboxChannelInput) SetAPNSVoipSandboxChannelRequest added in v1.12.17

SetAPNSVoipSandboxChannelRequest sets the APNSVoipSandboxChannelRequest field's value.

func (*UpdateApnsVoipSandboxChannelInput) SetApplicationId added in v1.12.17

SetApplicationId sets the ApplicationId field's value.

func (UpdateApnsVoipSandboxChannelInput) String added in v1.12.17

String returns the string representation

func (*UpdateApnsVoipSandboxChannelInput) Validate added in v1.12.17

Validate inspects the fields of the type to determine if they are valid.

type UpdateApnsVoipSandboxChannelOutput added in v1.12.17

type UpdateApnsVoipSandboxChannelOutput struct {

	// Apple VoIP Developer Push Notification Service channel definition.
	//
	// APNSVoipSandboxChannelResponse is a required field
	APNSVoipSandboxChannelResponse *APNSVoipSandboxChannelResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateApnsVoipSandboxChannelOutput) GoString added in v1.12.17

GoString returns the string representation

func (*UpdateApnsVoipSandboxChannelOutput) SetAPNSVoipSandboxChannelResponse added in v1.12.17

SetAPNSVoipSandboxChannelResponse sets the APNSVoipSandboxChannelResponse field's value.

func (UpdateApnsVoipSandboxChannelOutput) String added in v1.12.17

String returns the string representation

type UpdateApplicationSettingsInput

type UpdateApplicationSettingsInput struct {

	// ApplicationId is a required field
	ApplicationId *string `location:"uri" locationName:"application-id" type:"string" required:"true"`

	// Creating application setting request
	//
	// WriteApplicationSettingsRequest is a required field
	WriteApplicationSettingsRequest *WriteApplicationSettingsRequest `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateApplicationSettingsInput) GoString

GoString returns the string representation

func (*UpdateApplicationSettingsInput) SetApplicationId

SetApplicationId sets the ApplicationId field's value.

func (*UpdateApplicationSettingsInput) SetWriteApplicationSettingsRequest

SetWriteApplicationSettingsRequest sets the WriteApplicationSettingsRequest field's value.

func (UpdateApplicationSettingsInput) 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 {

	// Application settings.
	//
	// ApplicationSettingsResource is a required field
	ApplicationSettingsResource *ApplicationSettingsResource `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateApplicationSettingsOutput) GoString

GoString returns the string representation

func (*UpdateApplicationSettingsOutput) SetApplicationSettingsResource

SetApplicationSettingsResource sets the ApplicationSettingsResource field's value.

func (UpdateApplicationSettingsOutput) String

String returns the string representation

type UpdateBaiduChannelInput added in v1.12.1

type UpdateBaiduChannelInput struct {

	// ApplicationId is a required field
	ApplicationId *string `location:"uri" locationName:"application-id" type:"string" required:"true"`

	// Baidu Cloud Push credentials
	//
	// BaiduChannelRequest is a required field
	BaiduChannelRequest *BaiduChannelRequest `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateBaiduChannelInput) GoString added in v1.12.1

func (s UpdateBaiduChannelInput) GoString() string

GoString returns the string representation

func (*UpdateBaiduChannelInput) SetApplicationId added in v1.12.1

func (s *UpdateBaiduChannelInput) SetApplicationId(v string) *UpdateBaiduChannelInput

SetApplicationId sets the ApplicationId field's value.

func (*UpdateBaiduChannelInput) SetBaiduChannelRequest added in v1.12.1

SetBaiduChannelRequest sets the BaiduChannelRequest field's value.

func (UpdateBaiduChannelInput) String added in v1.12.1

func (s UpdateBaiduChannelInput) String() string

String returns the string representation

func (*UpdateBaiduChannelInput) Validate added in v1.12.1

func (s *UpdateBaiduChannelInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateBaiduChannelOutput added in v1.12.1

type UpdateBaiduChannelOutput struct {

	// Baidu Cloud Messaging channel definition
	//
	// BaiduChannelResponse is a required field
	BaiduChannelResponse *BaiduChannelResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateBaiduChannelOutput) GoString added in v1.12.1

func (s UpdateBaiduChannelOutput) GoString() string

GoString returns the string representation

func (*UpdateBaiduChannelOutput) SetBaiduChannelResponse added in v1.12.1

SetBaiduChannelResponse sets the BaiduChannelResponse field's value.

func (UpdateBaiduChannelOutput) String added in v1.12.1

func (s UpdateBaiduChannelOutput) String() string

String returns the string representation

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"`

	// Used to create a campaign.
	//
	// WriteCampaignRequest is a required field
	WriteCampaignRequest *WriteCampaignRequest `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateCampaignInput) GoString

func (s UpdateCampaignInput) GoString() string

GoString returns the string representation

func (*UpdateCampaignInput) SetApplicationId

func (s *UpdateCampaignInput) SetApplicationId(v string) *UpdateCampaignInput

SetApplicationId sets the ApplicationId field's value.

func (*UpdateCampaignInput) SetCampaignId

func (s *UpdateCampaignInput) SetCampaignId(v string) *UpdateCampaignInput

SetCampaignId sets the CampaignId field's value.

func (*UpdateCampaignInput) SetWriteCampaignRequest

func (s *UpdateCampaignInput) SetWriteCampaignRequest(v *WriteCampaignRequest) *UpdateCampaignInput

SetWriteCampaignRequest sets the WriteCampaignRequest field's value.

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 {

	// Campaign definition
	//
	// CampaignResponse is a required field
	CampaignResponse *CampaignResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateCampaignOutput) GoString

func (s UpdateCampaignOutput) GoString() string

GoString returns the string representation

func (*UpdateCampaignOutput) SetCampaignResponse

func (s *UpdateCampaignOutput) SetCampaignResponse(v *CampaignResponse) *UpdateCampaignOutput

SetCampaignResponse sets the CampaignResponse field's value.

func (UpdateCampaignOutput) String

func (s UpdateCampaignOutput) String() string

String returns the string representation

type UpdateEmailChannelInput added in v1.8.38

type UpdateEmailChannelInput struct {

	// ApplicationId is a required field
	ApplicationId *string `location:"uri" locationName:"application-id" type:"string" required:"true"`

	// Email Channel Request
	//
	// EmailChannelRequest is a required field
	EmailChannelRequest *EmailChannelRequest `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateEmailChannelInput) GoString added in v1.8.38

func (s UpdateEmailChannelInput) GoString() string

GoString returns the string representation

func (*UpdateEmailChannelInput) SetApplicationId added in v1.8.38

func (s *UpdateEmailChannelInput) SetApplicationId(v string) *UpdateEmailChannelInput

SetApplicationId sets the ApplicationId field's value.

func (*UpdateEmailChannelInput) SetEmailChannelRequest added in v1.8.38

SetEmailChannelRequest sets the EmailChannelRequest field's value.

func (UpdateEmailChannelInput) String added in v1.8.38

func (s UpdateEmailChannelInput) String() string

String returns the string representation

func (*UpdateEmailChannelInput) Validate added in v1.8.38

func (s *UpdateEmailChannelInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateEmailChannelOutput added in v1.8.38

type UpdateEmailChannelOutput struct {

	// Email Channel Response.
	//
	// EmailChannelResponse is a required field
	EmailChannelResponse *EmailChannelResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateEmailChannelOutput) GoString added in v1.8.38

func (s UpdateEmailChannelOutput) GoString() string

GoString returns the string representation

func (*UpdateEmailChannelOutput) SetEmailChannelResponse added in v1.8.38

SetEmailChannelResponse sets the EmailChannelResponse field's value.

func (UpdateEmailChannelOutput) String added in v1.8.38

func (s UpdateEmailChannelOutput) String() string

String returns the string representation

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"`

	// Endpoint update request
	//
	// EndpointRequest is a required field
	EndpointRequest *EndpointRequest `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateEndpointInput) GoString

func (s UpdateEndpointInput) GoString() string

GoString returns the string representation

func (*UpdateEndpointInput) SetApplicationId

func (s *UpdateEndpointInput) SetApplicationId(v string) *UpdateEndpointInput

SetApplicationId sets the ApplicationId field's value.

func (*UpdateEndpointInput) SetEndpointId

func (s *UpdateEndpointInput) SetEndpointId(v string) *UpdateEndpointInput

SetEndpointId sets the EndpointId field's value.

func (*UpdateEndpointInput) SetEndpointRequest

func (s *UpdateEndpointInput) SetEndpointRequest(v *EndpointRequest) *UpdateEndpointInput

SetEndpointRequest sets the EndpointRequest field's value.

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 {

	// Simple message object.
	//
	// MessageBody is a required field
	MessageBody *MessageBody `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateEndpointOutput) GoString

func (s UpdateEndpointOutput) GoString() string

GoString returns the string representation

func (*UpdateEndpointOutput) SetMessageBody

func (s *UpdateEndpointOutput) SetMessageBody(v *MessageBody) *UpdateEndpointOutput

SetMessageBody sets the MessageBody field's value.

func (UpdateEndpointOutput) String

func (s UpdateEndpointOutput) String() string

String returns the string representation

type UpdateEndpointsBatchInput

type UpdateEndpointsBatchInput struct {

	// ApplicationId is a required field
	ApplicationId *string `location:"uri" locationName:"application-id" type:"string" required:"true"`

	// Endpoint batch update request.
	//
	// EndpointBatchRequest is a required field
	EndpointBatchRequest *EndpointBatchRequest `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateEndpointsBatchInput) GoString

func (s UpdateEndpointsBatchInput) GoString() string

GoString returns the string representation

func (*UpdateEndpointsBatchInput) SetApplicationId

SetApplicationId sets the ApplicationId field's value.

func (*UpdateEndpointsBatchInput) SetEndpointBatchRequest

SetEndpointBatchRequest sets the EndpointBatchRequest field's value.

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 {

	// Simple message object.
	//
	// MessageBody is a required field
	MessageBody *MessageBody `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateEndpointsBatchOutput) GoString

func (s UpdateEndpointsBatchOutput) GoString() string

GoString returns the string representation

func (*UpdateEndpointsBatchOutput) SetMessageBody

SetMessageBody sets the MessageBody field's value.

func (UpdateEndpointsBatchOutput) String

String returns the string representation

type UpdateGcmChannelInput

type UpdateGcmChannelInput struct {

	// ApplicationId is a required field
	ApplicationId *string `location:"uri" locationName:"application-id" type:"string" required:"true"`

	// Google Cloud Messaging credentials
	//
	// GCMChannelRequest is a required field
	GCMChannelRequest *GCMChannelRequest `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateGcmChannelInput) GoString

func (s UpdateGcmChannelInput) GoString() string

GoString returns the string representation

func (*UpdateGcmChannelInput) SetApplicationId

func (s *UpdateGcmChannelInput) SetApplicationId(v string) *UpdateGcmChannelInput

SetApplicationId sets the ApplicationId field's value.

func (*UpdateGcmChannelInput) SetGCMChannelRequest

func (s *UpdateGcmChannelInput) SetGCMChannelRequest(v *GCMChannelRequest) *UpdateGcmChannelInput

SetGCMChannelRequest sets the GCMChannelRequest field's value.

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 {

	// Google Cloud Messaging channel definition
	//
	// GCMChannelResponse is a required field
	GCMChannelResponse *GCMChannelResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateGcmChannelOutput) GoString

func (s UpdateGcmChannelOutput) GoString() string

GoString returns the string representation

func (*UpdateGcmChannelOutput) SetGCMChannelResponse

SetGCMChannelResponse sets the GCMChannelResponse field's value.

func (UpdateGcmChannelOutput) String

func (s UpdateGcmChannelOutput) String() string

String returns the string representation

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"`

	// Segment definition.
	//
	// WriteSegmentRequest is a required field
	WriteSegmentRequest *WriteSegmentRequest `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateSegmentInput) GoString

func (s UpdateSegmentInput) GoString() string

GoString returns the string representation

func (*UpdateSegmentInput) SetApplicationId

func (s *UpdateSegmentInput) SetApplicationId(v string) *UpdateSegmentInput

SetApplicationId sets the ApplicationId field's value.

func (*UpdateSegmentInput) SetSegmentId

func (s *UpdateSegmentInput) SetSegmentId(v string) *UpdateSegmentInput

SetSegmentId sets the SegmentId field's value.

func (*UpdateSegmentInput) SetWriteSegmentRequest

func (s *UpdateSegmentInput) SetWriteSegmentRequest(v *WriteSegmentRequest) *UpdateSegmentInput

SetWriteSegmentRequest sets the WriteSegmentRequest field's value.

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 {

	// Segment definition.
	//
	// SegmentResponse is a required field
	SegmentResponse *SegmentResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateSegmentOutput) GoString

func (s UpdateSegmentOutput) GoString() string

GoString returns the string representation

func (*UpdateSegmentOutput) SetSegmentResponse

func (s *UpdateSegmentOutput) SetSegmentResponse(v *SegmentResponse) *UpdateSegmentOutput

SetSegmentResponse sets the SegmentResponse field's value.

func (UpdateSegmentOutput) String

func (s UpdateSegmentOutput) String() string

String returns the string representation

type UpdateSmsChannelInput added in v1.8.38

type UpdateSmsChannelInput struct {

	// ApplicationId is a required field
	ApplicationId *string `location:"uri" locationName:"application-id" type:"string" required:"true"`

	// SMS Channel Request
	//
	// SMSChannelRequest is a required field
	SMSChannelRequest *SMSChannelRequest `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateSmsChannelInput) GoString added in v1.8.38

func (s UpdateSmsChannelInput) GoString() string

GoString returns the string representation

func (*UpdateSmsChannelInput) SetApplicationId added in v1.8.38

func (s *UpdateSmsChannelInput) SetApplicationId(v string) *UpdateSmsChannelInput

SetApplicationId sets the ApplicationId field's value.

func (*UpdateSmsChannelInput) SetSMSChannelRequest added in v1.8.38

func (s *UpdateSmsChannelInput) SetSMSChannelRequest(v *SMSChannelRequest) *UpdateSmsChannelInput

SetSMSChannelRequest sets the SMSChannelRequest field's value.

func (UpdateSmsChannelInput) String added in v1.8.38

func (s UpdateSmsChannelInput) String() string

String returns the string representation

func (*UpdateSmsChannelInput) Validate added in v1.8.38

func (s *UpdateSmsChannelInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateSmsChannelOutput added in v1.8.38

type UpdateSmsChannelOutput struct {

	// SMS Channel Response.
	//
	// SMSChannelResponse is a required field
	SMSChannelResponse *SMSChannelResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateSmsChannelOutput) GoString added in v1.8.38

func (s UpdateSmsChannelOutput) GoString() string

GoString returns the string representation

func (*UpdateSmsChannelOutput) SetSMSChannelResponse added in v1.8.38

SetSMSChannelResponse sets the SMSChannelResponse field's value.

func (UpdateSmsChannelOutput) String added in v1.8.38

func (s UpdateSmsChannelOutput) String() string

String returns the string representation

type WriteApplicationSettingsRequest

type WriteApplicationSettingsRequest struct {

	// Default campaign hook information.
	CampaignHook *CampaignHook `type:"structure"`

	// The default campaign limits for the app. These limits apply to each campaign
	// for the app, unless the campaign overrides the default with limits of its
	// own.
	Limits *CampaignLimits `type:"structure"`

	// The default quiet time for the app. Each campaign for this app sends no messages
	// during this time unless the campaign overrides the default with a quiet time
	// of its own.
	QuietTime *QuietTime `type:"structure"`
	// contains filtered or unexported fields
}

Creating application setting request

func (WriteApplicationSettingsRequest) GoString

GoString returns the string representation

func (*WriteApplicationSettingsRequest) SetCampaignHook added in v1.13.11

SetCampaignHook sets the CampaignHook field's value.

func (*WriteApplicationSettingsRequest) SetLimits

SetLimits sets the Limits field's value.

func (*WriteApplicationSettingsRequest) SetQuietTime

SetQuietTime sets the QuietTime field's value.

func (WriteApplicationSettingsRequest) String

String returns the string representation

type WriteCampaignRequest

type WriteCampaignRequest struct {

	// Treatments that are defined in addition to the default treatment.
	AdditionalTreatments []*WriteTreatmentResource `type:"list"`

	// A description of the campaign.
	Description *string `type:"string"`

	// The allocated percentage of end users who will not receive messages from
	// this campaign.
	HoldoutPercent *int64 `type:"integer"`

	// Campaign hook information.
	Hook *CampaignHook `type:"structure"`

	// Indicates whether the campaign is paused. A paused campaign does not send
	// messages unless you resume it by setting IsPaused to false.
	IsPaused *bool `type:"boolean"`

	// The campaign limits settings.
	Limits *CampaignLimits `type:"structure"`

	// The message configuration settings.
	MessageConfiguration *MessageConfiguration `type:"structure"`

	// The custom name of the campaign.
	Name *string `type:"string"`

	// The campaign schedule.
	Schedule *Schedule `type:"structure"`

	// The ID of the segment to which the campaign sends messages.
	SegmentId *string `type:"string"`

	// The version of the segment to which the campaign sends messages.
	SegmentVersion *int64 `type:"integer"`

	// A custom description for the treatment.
	TreatmentDescription *string `type:"string"`

	// The custom name of a variation of the campaign used for A/B testing.
	TreatmentName *string `type:"string"`
	// contains filtered or unexported fields
}

Used to create a campaign.

func (WriteCampaignRequest) GoString

func (s WriteCampaignRequest) GoString() string

GoString returns the string representation

func (*WriteCampaignRequest) SetAdditionalTreatments

func (s *WriteCampaignRequest) SetAdditionalTreatments(v []*WriteTreatmentResource) *WriteCampaignRequest

SetAdditionalTreatments sets the AdditionalTreatments field's value.

func (*WriteCampaignRequest) SetDescription

func (s *WriteCampaignRequest) SetDescription(v string) *WriteCampaignRequest

SetDescription sets the Description field's value.

func (*WriteCampaignRequest) SetHoldoutPercent

func (s *WriteCampaignRequest) SetHoldoutPercent(v int64) *WriteCampaignRequest

SetHoldoutPercent sets the HoldoutPercent field's value.

func (*WriteCampaignRequest) SetHook added in v1.13.11

SetHook sets the Hook field's value.

func (*WriteCampaignRequest) SetIsPaused

func (s *WriteCampaignRequest) SetIsPaused(v bool) *WriteCampaignRequest

SetIsPaused sets the IsPaused field's value.

func (*WriteCampaignRequest) SetLimits

SetLimits sets the Limits field's value.

func (*WriteCampaignRequest) SetMessageConfiguration

func (s *WriteCampaignRequest) SetMessageConfiguration(v *MessageConfiguration) *WriteCampaignRequest

SetMessageConfiguration sets the MessageConfiguration field's value.

func (*WriteCampaignRequest) SetName

SetName sets the Name field's value.

func (*WriteCampaignRequest) SetSchedule

SetSchedule sets the Schedule field's value.

func (*WriteCampaignRequest) SetSegmentId

func (s *WriteCampaignRequest) SetSegmentId(v string) *WriteCampaignRequest

SetSegmentId sets the SegmentId field's value.

func (*WriteCampaignRequest) SetSegmentVersion

func (s *WriteCampaignRequest) SetSegmentVersion(v int64) *WriteCampaignRequest

SetSegmentVersion sets the SegmentVersion field's value.

func (*WriteCampaignRequest) SetTreatmentDescription

func (s *WriteCampaignRequest) SetTreatmentDescription(v string) *WriteCampaignRequest

SetTreatmentDescription sets the TreatmentDescription field's value.

func (*WriteCampaignRequest) SetTreatmentName

func (s *WriteCampaignRequest) SetTreatmentName(v string) *WriteCampaignRequest

SetTreatmentName sets the TreatmentName field's value.

func (WriteCampaignRequest) String

func (s WriteCampaignRequest) String() string

String returns the string representation

type WriteEventStream added in v1.8.0

type WriteEventStream struct {

	// The Amazon Resource Name (ARN) of the Amazon Kinesis stream or Firehose delivery
	// stream to which you want to publish events. Firehose ARN: arn:aws:firehose:REGION:ACCOUNT_ID:deliverystream/STREAM_NAME
	// Kinesis ARN: arn:aws:kinesis:REGION:ACCOUNT_ID:stream/STREAM_NAME
	DestinationStreamArn *string `type:"string"`

	// The IAM role that authorizes Amazon Pinpoint to publish events to the stream
	// in your account.
	RoleArn *string `type:"string"`
	// contains filtered or unexported fields
}

Request to save an EventStream.

func (WriteEventStream) GoString added in v1.8.0

func (s WriteEventStream) GoString() string

GoString returns the string representation

func (*WriteEventStream) SetDestinationStreamArn added in v1.8.0

func (s *WriteEventStream) SetDestinationStreamArn(v string) *WriteEventStream

SetDestinationStreamArn sets the DestinationStreamArn field's value.

func (*WriteEventStream) SetRoleArn added in v1.8.0

func (s *WriteEventStream) SetRoleArn(v string) *WriteEventStream

SetRoleArn sets the RoleArn field's value.

func (WriteEventStream) String added in v1.8.0

func (s WriteEventStream) String() string

String returns the string representation

type WriteSegmentRequest

type WriteSegmentRequest struct {

	// The segment dimensions attributes.
	Dimensions *SegmentDimensions `type:"structure"`

	// The name of segment
	Name *string `type:"string"`
	// contains filtered or unexported fields
}

Segment definition.

func (WriteSegmentRequest) GoString

func (s WriteSegmentRequest) GoString() string

GoString returns the string representation

func (*WriteSegmentRequest) SetDimensions

SetDimensions sets the Dimensions field's value.

func (*WriteSegmentRequest) SetName

SetName sets the Name field's value.

func (WriteSegmentRequest) String

func (s WriteSegmentRequest) String() string

String returns the string representation

type WriteTreatmentResource

type WriteTreatmentResource struct {

	// The message configuration settings.
	MessageConfiguration *MessageConfiguration `type:"structure"`

	// The campaign schedule.
	Schedule *Schedule `type:"structure"`

	// The allocated percentage of users for this treatment.
	SizePercent *int64 `type:"integer"`

	// A custom description for the treatment.
	TreatmentDescription *string `type:"string"`

	// The custom name of a variation of the campaign used for A/B testing.
	TreatmentName *string `type:"string"`
	// contains filtered or unexported fields
}

Used to create a campaign treatment.

func (WriteTreatmentResource) GoString

func (s WriteTreatmentResource) GoString() string

GoString returns the string representation

func (*WriteTreatmentResource) SetMessageConfiguration

func (s *WriteTreatmentResource) SetMessageConfiguration(v *MessageConfiguration) *WriteTreatmentResource

SetMessageConfiguration sets the MessageConfiguration field's value.

func (*WriteTreatmentResource) SetSchedule

SetSchedule sets the Schedule field's value.

func (*WriteTreatmentResource) SetSizePercent

func (s *WriteTreatmentResource) SetSizePercent(v int64) *WriteTreatmentResource

SetSizePercent sets the SizePercent field's value.

func (*WriteTreatmentResource) SetTreatmentDescription

func (s *WriteTreatmentResource) SetTreatmentDescription(v string) *WriteTreatmentResource

SetTreatmentDescription sets the TreatmentDescription field's value.

func (*WriteTreatmentResource) SetTreatmentName

func (s *WriteTreatmentResource) SetTreatmentName(v string) *WriteTreatmentResource

SetTreatmentName sets the TreatmentName field's value.

func (WriteTreatmentResource) String

func (s WriteTreatmentResource) String() string

String returns the string representation

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