pinpoint

package
v1.44.15 Latest Latest
Warning

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

 Go to latest Published: May 16, 2022 License: Apache-2.0 Imports: 10 Imported by: 54

Documentation

Overview

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

Doc Engage API - Amazon Pinpoint API

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

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

Using the Client

To 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 (
	// AlignmentLeft is a Alignment enum value
	AlignmentLeft = "LEFT"

	// AlignmentCenter is a Alignment enum value
	AlignmentCenter = "CENTER"

	// AlignmentRight is a Alignment enum value
	AlignmentRight = "RIGHT"
)
View Source 
const (
	// AttributeTypeInclusive is a AttributeType enum value
	AttributeTypeInclusive = "INCLUSIVE"

	// AttributeTypeExclusive is a AttributeType enum value
	AttributeTypeExclusive = "EXCLUSIVE"

	// AttributeTypeContains is a AttributeType enum value
	AttributeTypeContains = "CONTAINS"

	// AttributeTypeBefore is a AttributeType enum value
	AttributeTypeBefore = "BEFORE"

	// AttributeTypeAfter is a AttributeType enum value
	AttributeTypeAfter = "AFTER"

	// AttributeTypeBetween is a AttributeType enum value
	AttributeTypeBetween = "BETWEEN"

	// AttributeTypeOn is a AttributeType enum value
	AttributeTypeOn = "ON"
)
View Source 
const (
	// ButtonActionLink is a ButtonAction enum value
	ButtonActionLink = "LINK"

	// ButtonActionDeepLink is a ButtonAction enum value
	ButtonActionDeepLink = "DEEP_LINK"

	// ButtonActionClose is a ButtonAction enum value
	ButtonActionClose = "CLOSE"
)
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"

	// CampaignStatusDeleted is a CampaignStatus enum value
	CampaignStatusDeleted = "DELETED"

	// CampaignStatusInvalid is a CampaignStatus enum value
	CampaignStatusInvalid = "INVALID"
)
View Source 
const (
	// ChannelTypePush is a ChannelType enum value
	ChannelTypePush = "PUSH"

	// 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"

	// ChannelTypeVoice is a ChannelType enum value
	ChannelTypeVoice = "VOICE"

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

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

	// ChannelTypeCustom is a ChannelType enum value
	ChannelTypeCustom = "CUSTOM"

	// ChannelTypeInApp is a ChannelType enum value
	ChannelTypeInApp = "IN_APP"
)
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 (
	// EndpointTypesElementPush is a EndpointTypesElement enum value
	EndpointTypesElementPush = "PUSH"

	// EndpointTypesElementGcm is a EndpointTypesElement enum value
	EndpointTypesElementGcm = "GCM"

	// EndpointTypesElementApns is a EndpointTypesElement enum value
	EndpointTypesElementApns = "APNS"

	// EndpointTypesElementApnsSandbox is a EndpointTypesElement enum value
	EndpointTypesElementApnsSandbox = "APNS_SANDBOX"

	// EndpointTypesElementApnsVoip is a EndpointTypesElement enum value
	EndpointTypesElementApnsVoip = "APNS_VOIP"

	// EndpointTypesElementApnsVoipSandbox is a EndpointTypesElement enum value
	EndpointTypesElementApnsVoipSandbox = "APNS_VOIP_SANDBOX"

	// EndpointTypesElementAdm is a EndpointTypesElement enum value
	EndpointTypesElementAdm = "ADM"

	// EndpointTypesElementSms is a EndpointTypesElement enum value
	EndpointTypesElementSms = "SMS"

	// EndpointTypesElementVoice is a EndpointTypesElement enum value
	EndpointTypesElementVoice = "VOICE"

	// EndpointTypesElementEmail is a EndpointTypesElement enum value
	EndpointTypesElementEmail = "EMAIL"

	// EndpointTypesElementBaidu is a EndpointTypesElement enum value
	EndpointTypesElementBaidu = "BAIDU"

	// EndpointTypesElementCustom is a EndpointTypesElement enum value
	EndpointTypesElementCustom = "CUSTOM"

	// EndpointTypesElementInApp is a EndpointTypesElement enum value
	EndpointTypesElementInApp = "IN_APP"
)
View Source 
const (
	// FilterTypeSystem is a FilterType enum value
	FilterTypeSystem = "SYSTEM"

	// FilterTypeEndpoint is a FilterType enum value
	FilterTypeEndpoint = "ENDPOINT"
)
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"

	// FrequencyEvent is a Frequency enum value
	FrequencyEvent = "EVENT"

	// FrequencyInAppEvent is a Frequency enum value
	FrequencyInAppEvent = "IN_APP_EVENT"
)
View Source 
const (
	// IncludeAll is a Include enum value
	IncludeAll = "ALL"

	// IncludeAny is a Include enum value
	IncludeAny = "ANY"

	// IncludeNone is a Include enum value
	IncludeNone = "NONE"
)
View Source 
const (
	// JobStatusCreated is a JobStatus enum value
	JobStatusCreated = "CREATED"

	// JobStatusPreparingForInitialization is a JobStatus enum value
	JobStatusPreparingForInitialization = "PREPARING_FOR_INITIALIZATION"

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

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

	// JobStatusPendingJob is a JobStatus enum value
	JobStatusPendingJob = "PENDING_JOB"

	// 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 (
	// LayoutBottomBanner is a Layout enum value
	LayoutBottomBanner = "BOTTOM_BANNER"

	// LayoutTopBanner is a Layout enum value
	LayoutTopBanner = "TOP_BANNER"

	// LayoutOverlays is a Layout enum value
	LayoutOverlays = "OVERLAYS"

	// LayoutMobileFeed is a Layout enum value
	LayoutMobileFeed = "MOBILE_FEED"

	// LayoutMiddleBanner is a Layout enum value
	LayoutMiddleBanner = "MIDDLE_BANNER"

	// LayoutCarousel is a Layout enum value
	LayoutCarousel = "CAROUSEL"
)
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 (
	// OperatorAll is a Operator enum value
	OperatorAll = "ALL"

	// OperatorAny is a Operator enum value
	OperatorAny = "ANY"
)
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 (
	// SourceTypeAll is a SourceType enum value
	SourceTypeAll = "ALL"

	// SourceTypeAny is a SourceType enum value
	SourceTypeAny = "ANY"

	// SourceTypeNone is a SourceType enum value
	SourceTypeNone = "NONE"
)
View Source 
const (
	// StateDraft is a State enum value
	StateDraft = "DRAFT"

	// StateActive is a State enum value
	StateActive = "ACTIVE"

	// StateCompleted is a State enum value
	StateCompleted = "COMPLETED"

	// StateCancelled is a State enum value
	StateCancelled = "CANCELLED"

	// StateClosed is a State enum value
	StateClosed = "CLOSED"

	// StatePaused is a State enum value
	StatePaused = "PAUSED"
)
View Source 
const (
	// TemplateTypeEmail is a TemplateType enum value
	TemplateTypeEmail = "EMAIL"

	// TemplateTypeSms is a TemplateType enum value
	TemplateTypeSms = "SMS"

	// TemplateTypeVoice is a TemplateType enum value
	TemplateTypeVoice = "VOICE"

	// TemplateTypePush is a TemplateType enum value
	TemplateTypePush = "PUSH"

	// TemplateTypeInapp is a TemplateType enum value
	TemplateTypeInapp = "INAPP"
)
View Source 
const (
	// TypeAll is a Type enum value
	TypeAll = "ALL"

	// TypeAny is a Type enum value
	TypeAny = "ANY"

	// TypeNone is a Type enum value
	TypeNone = "NONE"
)
View Source 
const (

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

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

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

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

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

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

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

	// ErrCodeTooManyRequestsException for service response error code
	// "TooManyRequestsException".
	//
	// Provides information about an API request or response.
	ErrCodeTooManyRequestsException = "TooManyRequestsException"
)
View Source 
const (
	ServiceName = "pinpoint"  // Name of service.
	EndpointsID = ServiceName // ID to lookup a service endpoint with.
	ServiceID   = "Pinpoint"  // ServiceID is a unique identifier of a specific service.
)

Service information constants

Variables

This section is empty.

Functions

func Action_Values added in v1.34.3 

func Action_Values() []string

Action_Values returns all elements of the Action enum

func Alignment_Values added in v1.40.44 

func Alignment_Values() []string

Alignment_Values returns all elements of the Alignment enum

func AttributeType_Values added in v1.34.3 

func AttributeType_Values() []string

AttributeType_Values returns all elements of the AttributeType enum

func ButtonAction_Values added in v1.40.44 

func ButtonAction_Values() []string

ButtonAction_Values returns all elements of the ButtonAction enum

func CampaignStatus_Values added in v1.34.3 

func CampaignStatus_Values() []string

CampaignStatus_Values returns all elements of the CampaignStatus enum

func ChannelType_Values added in v1.34.3 

func ChannelType_Values() []string

ChannelType_Values returns all elements of the ChannelType enum

func DeliveryStatus_Values added in v1.34.3 

func DeliveryStatus_Values() []string

DeliveryStatus_Values returns all elements of the DeliveryStatus enum

func DimensionType_Values added in v1.34.3 

func DimensionType_Values() []string

DimensionType_Values returns all elements of the DimensionType enum

func Duration_Values added in v1.34.3 

func Duration_Values() []string

Duration_Values returns all elements of the Duration enum

func EndpointTypesElement_Values added in v1.34.3 

func EndpointTypesElement_Values() []string

EndpointTypesElement_Values returns all elements of the EndpointTypesElement enum

func FilterType_Values added in v1.34.3 

func FilterType_Values() []string

FilterType_Values returns all elements of the FilterType enum

func Format_Values added in v1.34.3 

func Format_Values() []string

Format_Values returns all elements of the Format enum

func Frequency_Values added in v1.34.3 

func Frequency_Values() []string

Frequency_Values returns all elements of the Frequency enum

func Include_Values added in v1.34.3 

func Include_Values() []string

Include_Values returns all elements of the Include enum

func JobStatus_Values added in v1.34.3 

func JobStatus_Values() []string

JobStatus_Values returns all elements of the JobStatus enum

func Layout_Values added in v1.40.44 

func Layout_Values() []string

Layout_Values returns all elements of the Layout enum

func MessageType_Values added in v1.34.3 

func MessageType_Values() []string

MessageType_Values returns all elements of the MessageType enum

func Mode_Values added in v1.34.3 

func Mode_Values() []string

Mode_Values returns all elements of the Mode enum

func Operator_Values added in v1.34.3 

func Operator_Values() []string

Operator_Values returns all elements of the Operator enum

func RecencyType_Values added in v1.34.3 

func RecencyType_Values() []string

RecencyType_Values returns all elements of the RecencyType enum

func SegmentType_Values added in v1.34.3 

func SegmentType_Values() []string

SegmentType_Values returns all elements of the SegmentType enum

func SourceType_Values added in v1.34.3 

func SourceType_Values() []string

SourceType_Values returns all elements of the SourceType enum

func State_Values added in v1.34.3 

func State_Values() []string

State_Values returns all elements of the State enum

func TemplateType_Values added in v1.34.3 

func TemplateType_Values() []string

TemplateType_Values returns all elements of the TemplateType enum

func Type_Values added in v1.34.3 

func Type_Values() []string

Type_Values returns all elements of the Type enum

Types

type ADMChannelRequest added in v1.12.1 

type ADMChannelRequest struct {

	// The Client ID that you received from Amazon to send messages by using ADM.
	//
	// ClientId is a required field
	ClientId *string `type:"string" required:"true"`

	// The Client Secret that you received from Amazon to send messages by using
	// ADM.
	//
	// ClientSecret is a required field
	ClientSecret *string `type:"string" required:"true"`

	// Specifies whether to enable the ADM channel for the application.
	Enabled *bool `type:"boolean"`
	// contains filtered or unexported fields
}

Specifies the status and settings of the ADM (Amazon Device Messaging) channel for an application.

func (ADMChannelRequest) GoString added in v1.12.1 

func (s ADMChannelRequest) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ADMChannelRequest) Validate added in v1.20.11 

func (s *ADMChannelRequest) Validate() error

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

type ADMChannelResponse added in v1.12.1 

type ADMChannelResponse struct {

	// The unique identifier for the application that the ADM channel applies to.
	ApplicationId *string `type:"string"`

	// The date and time when the ADM channel was enabled.
	CreationDate *string `type:"string"`

	// Specifies whether the ADM channel is enabled for the application.
	Enabled *bool `type:"boolean"`

	// (Not used) This property is retained only for backward compatibility.
	HasCredential *bool `type:"boolean"`

	// (Deprecated) An identifier for the ADM channel. This property is retained
	// only for backward compatibility.
	Id *string `type:"string"`

	// Specifies whether the ADM channel is archived.
	IsArchived *bool `type:"boolean"`

	// The user who last modified the ADM channel.
	LastModifiedBy *string `type:"string"`

	// The date and time when the ADM channel was last modified.
	LastModifiedDate *string `type:"string"`

	// The type of messaging or notification platform for the channel. For the ADM
	// channel, this value is ADM.
	//
	// Platform is a required field
	Platform *string `type:"string" required:"true"`

	// The current version of the ADM channel.
	Version *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Provides information about the status and settings of the ADM (Amazon Device Messaging) channel for an application.

func (ADMChannelResponse) GoString added in v1.12.1 

func (s ADMChannelResponse) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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 

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

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ADMMessage added in v1.12.1 

type ADMMessage struct {

	// The action to occur if the recipient taps the push notification. Valid values
	// are:
	//
	//    * OPEN_APP - Your app opens or it becomes the foreground app if it was
	//    sent to the background. This is the default action.
	//
	//    * DEEP_LINK - Your app opens and displays a designated user interface
	//    in the app. This action uses the deep-linking features of the Android
	//    platform.
	//
	//    * URL - The default mobile browser on the recipient's device opens and
	//    loads the web page at a URL that you specify.
	Action *string `type:"string" enum:"Action"`

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

	// An arbitrary string that indicates that multiple messages are logically the
	// same and that Amazon Device Messaging (ADM) can drop previously enqueued
	// messages in favor of this message.
	ConsolidationKey *string `type:"string"`

	// The JSON data payload to use for the push notification, if the notification
	// is a silent push notification. This payload is added to the data.pinpoint.jsonBody
	// object of the notification.
	Data map[string]*string `type:"map"`

	// The amount of time, in seconds, that ADM should store the message if the
	// recipient's device is offline. Amazon Pinpoint specifies this value in the
	// expiresAfter parameter when it sends the notification message to ADM.
	ExpiresAfter *string `type:"string"`

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

	// The URL of the large icon image to display in the content view of the push
	// notification.
	ImageIconUrl *string `type:"string"`

	// The URL of an image to display in the push notification.
	ImageUrl *string `type:"string"`

	// The base64-encoded, MD5 checksum of the value specified by the Data property.
	// ADM uses the MD5 value to verify the integrity of the data.
	MD5 *string `type:"string"`

	// The raw, JSON-formatted string to use as the payload for the notification
	// message. If specified, this value overrides all other content for the message.
	RawContent *string `type:"string"`

	// Specifies whether the notification is a silent push notification, which is
	// a push notification that doesn't display on a recipient's device. Silent
	// push notifications can be used for cases such as updating an app's configuration
	// or supporting phone home functionality.
	SilentPush *bool `type:"boolean"`

	// The URL of the small icon image to display in the status bar and the content
	// view of the push notification.
	SmallImageIconUrl *string `type:"string"`

	// The sound to play when the recipient receives the push notification. You
	// can use the default stream or specify the file name of a sound resource that's
	// bundled in your app. On an Android platform, the sound file must reside in
	// /res/raw/.
	Sound *string `type:"string"`

	// The default message variables to use in the notification message. You can
	// override the default variables with individual address variables.
	Substitutions map[string][]*string `type:"map"`

	// The title to display above the notification message on the recipient's device.
	Title *string `type:"string"`

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

Specifies the settings for a one-time message that's sent directly to an endpoint through the ADM (Amazon Device Messaging) channel.

func (ADMMessage) GoString added in v1.12.1 

func (s ADMMessage) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type APNSChannelRequest 

type APNSChannelRequest struct {

	// The bundle identifier that's assigned to your iOS app. This identifier is
	// used for APNs tokens.
	BundleId *string `type:"string"`

	// The APNs client certificate that you received from Apple, if you want Amazon
	// Pinpoint to communicate with APNs by using an APNs certificate.
	Certificate *string `type:"string"`

	// The default authentication method that you want Amazon Pinpoint to use when
	// authenticating with APNs, key or certificate.
	DefaultAuthenticationMethod *string `type:"string"`

	// Specifies whether to enable the APNs channel for the application.
	Enabled *bool `type:"boolean"`

	// The private key for the APNs client certificate that you want Amazon Pinpoint
	// to use to communicate with APNs.
	PrivateKey *string `type:"string"`

	// The identifier that's assigned to your Apple developer account team. This
	// identifier is used for APNs tokens.
	TeamId *string `type:"string"`

	// The authentication key to use for APNs tokens.
	TokenKey *string `type:"string"`

	// The key identifier that's assigned to your APNs signing key, if you want
	// Amazon Pinpoint to communicate with APNs by using APNs tokens.
	TokenKeyId *string `type:"string"`
	// contains filtered or unexported fields
}

Specifies the status and settings of the APNs (Apple Push Notification service) channel for an application.

func (APNSChannelRequest) GoString 

func (s APNSChannelRequest) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type APNSChannelResponse 

type APNSChannelResponse struct {

	// The unique identifier for the application that the APNs channel applies to.
	ApplicationId *string `type:"string"`

	// The date and time when the APNs channel was enabled.
	CreationDate *string `type:"string"`

	// The default authentication method that Amazon Pinpoint uses to authenticate
	// with APNs for this channel, key or certificate.
	DefaultAuthenticationMethod *string `type:"string"`

	// Specifies whether the APNs channel is enabled for the application.
	Enabled *bool `type:"boolean"`

	// (Not used) This property is retained only for backward compatibility.
	HasCredential *bool `type:"boolean"`

	// Specifies whether the APNs channel is configured to communicate with APNs
	// by using APNs tokens. To provide an authentication key for APNs tokens, set
	// the TokenKey property of the channel.
	HasTokenKey *bool `type:"boolean"`

	// (Deprecated) An identifier for the APNs channel. This property is retained
	// only for backward compatibility.
	Id *string `type:"string"`

	// Specifies whether the APNs channel is archived.
	IsArchived *bool `type:"boolean"`

	// The user who last modified the APNs channel.
	LastModifiedBy *string `type:"string"`

	// The date and time when the APNs channel was last modified.
	LastModifiedDate *string `type:"string"`

	// The type of messaging or notification platform for the channel. For the APNs
	// channel, this value is APNS.
	//
	// Platform is a required field
	Platform *string `type:"string" required:"true"`

	// The current version of the APNs channel.
	Version *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Provides information about the status and settings of the APNs (Apple Push Notification service) channel for an application.

func (APNSChannelResponse) GoString 

func (s APNSChannelResponse) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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 

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

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type APNSMessage added in v1.8.38 

type APNSMessage struct {

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

	// The action to occur if the recipient taps the push notification. Valid values
	// are:
	//
	//    * OPEN_APP - Your app opens or it becomes the foreground app if it was
	//    sent to the background. This is the default action.
	//
	//    * DEEP_LINK - Your app opens and displays a designated user interface
	//    in the app. This setting uses the deep-linking features of the iOS platform.
	//
	//    * URL - The default mobile browser on the recipient's device opens and
	//    loads the web page at a URL that you specify.
	Action *string `type:"string" enum:"Action"`

	// The key that indicates whether and how to modify the badge of your app's
	// icon when the recipient receives the push notification. If this key isn't
	// included in the dictionary, the badge doesn't change. To remove the badge,
	// set this value to 0.
	Badge *int64 `type:"integer"`

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

	// The key that indicates the notification type for the push notification. This
	// key is a value that's defined by the identifier property of one of your app's
	// registered categories.
	Category *string `type:"string"`

	// An arbitrary identifier that, if assigned to multiple messages, APNs uses
	// to coalesce the messages into a single push notification instead of delivering
	// each message individually. This value can't exceed 64 bytes.
	//
	// Amazon Pinpoint specifies this value in the apns-collapse-id request header
	// when it sends the notification message to APNs.
	CollapseId *string `type:"string"`

	// The JSON payload to use for a silent push notification. This payload is added
	// to the data.pinpoint.jsonBody object of the notification.
	Data map[string]*string `type:"map"`

	// The URL of an image or video to display in the push notification.
	MediaUrl *string `type:"string"`

	// The authentication method that you want Amazon Pinpoint to use when authenticating
	// with APNs, CERTIFICATE or TOKEN.
	PreferredAuthenticationMethod *string `type:"string"`

	// para>5 - Low priority, the notification might be delayed, delivered as part
	// of a group, or throttled.
	// /listitem>
	// 10 - High priority, the notification is sent immediately. This is the default
	// value. A high priority notification should trigger an alert, play a sound,
	// or badge your app's icon on the recipient's device.
	// /para>
	// Amazon Pinpoint specifies this value in the apns-priority request header
	// when it sends the notification message to APNs.
	//
	// The equivalent values for Firebase Cloud Messaging (FCM), formerly Google
	// Cloud Messaging (GCM), are normal, for 5, and high, for 10. If you specify
	// an FCM value for this property, Amazon Pinpoint accepts and converts the
	// value to the corresponding APNs value.
	Priority *string `type:"string"`

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

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

	// The key for the sound to play when the recipient receives the push notification.
	// The value for this key is the name of a sound file in your app's main bundle
	// or the Library/Sounds folder in your app's data container. If the sound file
	// can't be found or you specify default for the value, the system plays the
	// default alert sound.
	Sound *string `type:"string"`

	// The default message variables to use in the notification message. You can
	// override these default variables with individual address variables.
	Substitutions map[string][]*string `type:"map"`

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

	// The amount of time, in seconds, that APNs should store and attempt to deliver
	// the push notification, if the service is unable to deliver the notification
	// the first time. If this value is 0, APNs treats the notification as if it
	// expires immediately and the service doesn't store or try to deliver the notification
	// again.
	//
	// Amazon Pinpoint specifies this value in the apns-expiration request header
	// when it sends the notification message to APNs.
	TimeToLive *int64 `type:"integer"`

	// The title to display above the notification message on the recipient's device.
	Title *string `type:"string"`

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

Specifies the settings for a one-time message that's sent directly to an endpoint through the APNs (Apple Push Notification service) channel.

func (APNSMessage) GoString added in v1.8.38 

func (s APNSMessage) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*APNSMessage) SetAPNSPushType added in v1.25.25 

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

SetAPNSPushType sets the APNSPushType field's value.

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type APNSPushNotificationTemplate added in v1.25.7 

type APNSPushNotificationTemplate struct {

	// The action to occur if a recipient taps a push notification that's based
	// on the message template. Valid values are:
	//
	//    * OPEN_APP - Your app opens or it becomes the foreground app if it was
	//    sent to the background. This is the default action.
	//
	//    * DEEP_LINK - Your app opens and displays a designated user interface
	//    in the app. This setting uses the deep-linking features of the iOS platform.
	//
	//    * URL - The default mobile browser on the recipient's device opens and
	//    loads the web page at a URL that you specify.
	Action *string `type:"string" enum:"Action"`

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

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

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

	// The key for the sound to play when the recipient receives a push notification
	// that's based on the message template. The value for this key is the name
	// of a sound file in your app's main bundle or the Library/Sounds folder in
	// your app's data container. If the sound file can't be found or you specify
	// default for the value, the system plays the default alert sound.
	Sound *string `type:"string"`

	// The title to use in push notifications that are based on the message template.
	// This title appears above the notification message on a recipient's device.
	Title *string `type:"string"`

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

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

func (APNSPushNotificationTemplate) GoString added in v1.25.7 

func (s APNSPushNotificationTemplate) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*APNSPushNotificationTemplate) SetAction added in v1.25.7 

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

SetAction sets the Action field's value.

func (*APNSPushNotificationTemplate) SetBody added in v1.25.7 

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

SetBody sets the Body field's value.

func (*APNSPushNotificationTemplate) SetMediaUrl added in v1.25.7 

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

SetMediaUrl sets the MediaUrl field's value.

func (*APNSPushNotificationTemplate) SetRawContent added in v1.25.37 

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

SetRawContent sets the RawContent field's value.

func (*APNSPushNotificationTemplate) SetSound added in v1.25.7 

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

SetSound sets the Sound field's value.

func (*APNSPushNotificationTemplate) SetTitle added in v1.25.7 

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

SetTitle sets the Title field's value.

func (*APNSPushNotificationTemplate) SetUrl added in v1.25.7 

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

SetUrl sets the Url field's value.

func (APNSPushNotificationTemplate) String added in v1.25.7 

func (s APNSPushNotificationTemplate) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type APNSSandboxChannelRequest added in v1.8.38 

type APNSSandboxChannelRequest struct {

	// The bundle identifier that's assigned to your iOS app. This identifier is
	// used for APNs tokens.
	BundleId *string `type:"string"`

	// The APNs client certificate that you received from Apple, if you want Amazon
	// Pinpoint to communicate with the APNs sandbox environment by using an APNs
	// certificate.
	Certificate *string `type:"string"`

	// The default authentication method that you want Amazon Pinpoint to use when
	// authenticating with the APNs sandbox environment, key or certificate.
	DefaultAuthenticationMethod *string `type:"string"`

	// Specifies whether to enable the APNs sandbox channel for the application.
	Enabled *bool `type:"boolean"`

	// The private key for the APNs client certificate that you want Amazon Pinpoint
	// to use to communicate with the APNs sandbox environment.
	PrivateKey *string `type:"string"`

	// The identifier that's assigned to your Apple developer account team. This
	// identifier is used for APNs tokens.
	TeamId *string `type:"string"`

	// The authentication key to use for APNs tokens.
	TokenKey *string `type:"string"`

	// The key identifier that's assigned to your APNs signing key, if you want
	// Amazon Pinpoint to communicate with the APNs sandbox environment by using
	// APNs tokens.
	TokenKeyId *string `type:"string"`
	// contains filtered or unexported fields
}

Specifies the status and settings of the APNs (Apple Push Notification service) sandbox channel for an application.

func (APNSSandboxChannelRequest) GoString added in v1.8.38 

func (s APNSSandboxChannelRequest) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*APNSSandboxChannelRequest) SetBundleId added in v1.12.1 

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

SetBundleId sets the BundleId field's value.

func (*APNSSandboxChannelRequest) SetCertificate added in v1.8.38 

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

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 

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

SetEnabled sets the Enabled field's value.

func (*APNSSandboxChannelRequest) SetPrivateKey added in v1.8.38 

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

SetPrivateKey sets the PrivateKey field's value.

func (*APNSSandboxChannelRequest) SetTeamId added in v1.12.1 

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

SetTeamId sets the TeamId field's value.

func (*APNSSandboxChannelRequest) SetTokenKey added in v1.12.1 

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

SetTokenKey sets the TokenKey field's value.

func (*APNSSandboxChannelRequest) SetTokenKeyId added in v1.12.1 

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

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type APNSSandboxChannelResponse added in v1.8.38 

type APNSSandboxChannelResponse struct {

	// The unique identifier for the application that the APNs sandbox channel applies
	// to.
	ApplicationId *string `type:"string"`

	// The date and time when the APNs sandbox channel was enabled.
	CreationDate *string `type:"string"`

	// The default authentication method that Amazon Pinpoint uses to authenticate
	// with the APNs sandbox environment for this channel, key or certificate.
	DefaultAuthenticationMethod *string `type:"string"`

	// Specifies whether the APNs sandbox channel is enabled for the application.
	Enabled *bool `type:"boolean"`

	// (Not used) This property is retained only for backward compatibility.
	HasCredential *bool `type:"boolean"`

	// Specifies whether the APNs sandbox channel is configured to communicate with
	// APNs by using APNs tokens. To provide an authentication key for APNs tokens,
	// set the TokenKey property of the channel.
	HasTokenKey *bool `type:"boolean"`

	// (Deprecated) An identifier for the APNs sandbox channel. This property is
	// retained only for backward compatibility.
	Id *string `type:"string"`

	// Specifies whether the APNs sandbox channel is archived.
	IsArchived *bool `type:"boolean"`

	// The user who last modified the APNs sandbox channel.
	LastModifiedBy *string `type:"string"`

	// The date and time when the APNs sandbox channel was last modified.
	LastModifiedDate *string `type:"string"`

	// The type of messaging or notification platform for the channel. For the APNs
	// sandbox channel, this value is APNS_SANDBOX.
	//
	// Platform is a required field
	Platform *string `type:"string" required:"true"`

	// The current version of the APNs sandbox channel.
	Version *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Provides information about the status and settings of the APNs (Apple Push Notification service) sandbox channel for an application.

func (APNSSandboxChannelResponse) GoString added in v1.8.38 

func (s APNSSandboxChannelResponse) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*APNSSandboxChannelResponse) SetApplicationId added in v1.8.38 

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

SetApplicationId sets the ApplicationId field's value.

func (*APNSSandboxChannelResponse) SetCreationDate added in v1.8.38 

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

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 

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

SetEnabled sets the Enabled field's value.

func (*APNSSandboxChannelResponse) SetHasCredential added in v1.12.17 

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

SetHasCredential sets the HasCredential field's value.

func (*APNSSandboxChannelResponse) SetHasTokenKey added in v1.12.17 

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

SetHasTokenKey sets the HasTokenKey field's value.

func (*APNSSandboxChannelResponse) SetId added in v1.8.38 

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

SetId sets the Id field's value.

func (*APNSSandboxChannelResponse) SetIsArchived added in v1.8.38 

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

SetIsArchived sets the IsArchived field's value.

func (*APNSSandboxChannelResponse) SetLastModifiedBy added in v1.8.38 

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

SetLastModifiedBy sets the LastModifiedBy field's value.

func (*APNSSandboxChannelResponse) SetLastModifiedDate added in v1.8.38 

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

SetLastModifiedDate sets the LastModifiedDate field's value.

func (*APNSSandboxChannelResponse) SetPlatform added in v1.8.38 

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

SetPlatform sets the Platform field's value.

func (*APNSSandboxChannelResponse) SetVersion added in v1.8.38 

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

SetVersion sets the Version field's value.

func (APNSSandboxChannelResponse) String added in v1.8.38 

func (s APNSSandboxChannelResponse) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type APNSVoipChannelRequest added in v1.12.17 

type APNSVoipChannelRequest struct {

	// The bundle identifier that's assigned to your iOS app. This identifier is
	// used for APNs tokens.
	BundleId *string `type:"string"`

	// The APNs client certificate that you received from Apple, if you want Amazon
	// Pinpoint to communicate with APNs by using an APNs certificate.
	Certificate *string `type:"string"`

	// The default authentication method that you want Amazon Pinpoint to use when
	// authenticating with APNs, key or certificate.
	DefaultAuthenticationMethod *string `type:"string"`

	// Specifies whether to enable the APNs VoIP channel for the application.
	Enabled *bool `type:"boolean"`

	// The private key for the APNs client certificate that you want Amazon Pinpoint
	// to use to communicate with APNs.
	PrivateKey *string `type:"string"`

	// The identifier that's assigned to your Apple developer account team. This
	// identifier is used for APNs tokens.
	TeamId *string `type:"string"`

	// The authentication key to use for APNs tokens.
	TokenKey *string `type:"string"`

	// The key identifier that's assigned to your APNs signing key, if you want
	// Amazon Pinpoint to communicate with APNs by using APNs tokens.
	TokenKeyId *string `type:"string"`
	// contains filtered or unexported fields
}

Specifies the status and settings of the APNs (Apple Push Notification service) VoIP channel for an application.

func (APNSVoipChannelRequest) GoString added in v1.12.17 

func (s APNSVoipChannelRequest) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*APNSVoipChannelRequest) SetBundleId added in v1.12.17 

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

SetBundleId sets the BundleId field's value.

func (*APNSVoipChannelRequest) SetCertificate added in v1.12.17 

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

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 

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

SetEnabled sets the Enabled field's value.

func (*APNSVoipChannelRequest) SetPrivateKey added in v1.12.17 

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

SetPrivateKey sets the PrivateKey field's value.

func (*APNSVoipChannelRequest) SetTeamId added in v1.12.17 

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

SetTeamId sets the TeamId field's value.

func (*APNSVoipChannelRequest) SetTokenKey added in v1.12.17 

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

SetTokenKey sets the TokenKey field's value.

func (*APNSVoipChannelRequest) SetTokenKeyId added in v1.12.17 

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

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type APNSVoipChannelResponse added in v1.12.17 

type APNSVoipChannelResponse struct {

	// The unique identifier for the application that the APNs VoIP channel applies
	// to.
	ApplicationId *string `type:"string"`

	// The date and time when the APNs VoIP channel was enabled.
	CreationDate *string `type:"string"`

	// The default authentication method that Amazon Pinpoint uses to authenticate
	// with APNs for this channel, key or certificate.
	DefaultAuthenticationMethod *string `type:"string"`

	// Specifies whether the APNs VoIP channel is enabled for the application.
	Enabled *bool `type:"boolean"`

	// (Not used) This property is retained only for backward compatibility.
	HasCredential *bool `type:"boolean"`

	// Specifies whether the APNs VoIP channel is configured to communicate with
	// APNs by using APNs tokens. To provide an authentication key for APNs tokens,
	// set the TokenKey property of the channel.
	HasTokenKey *bool `type:"boolean"`

	// (Deprecated) An identifier for the APNs VoIP channel. This property is retained
	// only for backward compatibility.
	Id *string `type:"string"`

	// Specifies whether the APNs VoIP channel is archived.
	IsArchived *bool `type:"boolean"`

	// The user who last modified the APNs VoIP channel.
	LastModifiedBy *string `type:"string"`

	// The date and time when the APNs VoIP channel was last modified.
	LastModifiedDate *string `type:"string"`

	// The type of messaging or notification platform for the channel. For the APNs
	// VoIP channel, this value is APNS_VOIP.
	//
	// Platform is a required field
	Platform *string `type:"string" required:"true"`

	// The current version of the APNs VoIP channel.
	Version *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Provides information about the status and settings of the APNs (Apple Push Notification service) VoIP channel for an application.

func (APNSVoipChannelResponse) GoString added in v1.12.17 

func (s APNSVoipChannelResponse) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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 

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

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 

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

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 

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

SetHasTokenKey sets the HasTokenKey field's value.

func (*APNSVoipChannelResponse) SetId added in v1.12.17 

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

SetId sets the Id field's value.

func (*APNSVoipChannelResponse) SetIsArchived added in v1.12.17 

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

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 

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

SetPlatform sets the Platform field's value.

func (*APNSVoipChannelResponse) SetVersion added in v1.12.17 

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

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type APNSVoipSandboxChannelRequest added in v1.12.17 

type APNSVoipSandboxChannelRequest struct {

	// The bundle identifier that's assigned to your iOS app. This identifier is
	// used for APNs tokens.
	BundleId *string `type:"string"`

	// The APNs client certificate that you received from Apple, if you want Amazon
	// Pinpoint to communicate with the APNs sandbox environment by using an APNs
	// certificate.
	Certificate *string `type:"string"`

	// The default authentication method that you want Amazon Pinpoint to use when
	// authenticating with the APNs sandbox environment for this channel, key or
	// certificate.
	DefaultAuthenticationMethod *string `type:"string"`

	// Specifies whether the APNs VoIP sandbox channel is enabled for the application.
	Enabled *bool `type:"boolean"`

	// The private key for the APNs client certificate that you want Amazon Pinpoint
	// to use to communicate with the APNs sandbox environment.
	PrivateKey *string `type:"string"`

	// The identifier that's assigned to your Apple developer account team. This
	// identifier is used for APNs tokens.
	TeamId *string `type:"string"`

	// The authentication key to use for APNs tokens.
	TokenKey *string `type:"string"`

	// The key identifier that's assigned to your APNs signing key, if you want
	// Amazon Pinpoint to communicate with the APNs sandbox environment by using
	// APNs tokens.
	TokenKeyId *string `type:"string"`
	// contains filtered or unexported fields
}

Specifies the status and settings of the APNs (Apple Push Notification service) VoIP sandbox channel for an application.

func (APNSVoipSandboxChannelRequest) GoString added in v1.12.17 

func (s APNSVoipSandboxChannelRequest) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*APNSVoipSandboxChannelRequest) SetBundleId added in v1.12.17 

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

SetBundleId sets the BundleId field's value.

func (*APNSVoipSandboxChannelRequest) SetCertificate added in v1.12.17 

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

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 

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

SetEnabled sets the Enabled field's value.

func (*APNSVoipSandboxChannelRequest) SetPrivateKey added in v1.12.17 

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

SetPrivateKey sets the PrivateKey field's value.

func (*APNSVoipSandboxChannelRequest) SetTeamId added in v1.12.17 

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

SetTeamId sets the TeamId field's value.

func (*APNSVoipSandboxChannelRequest) SetTokenKey added in v1.12.17 

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

SetTokenKey sets the TokenKey field's value.

func (*APNSVoipSandboxChannelRequest) SetTokenKeyId added in v1.12.17 

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

SetTokenKeyId sets the TokenKeyId field's value.

func (APNSVoipSandboxChannelRequest) String added in v1.12.17 

func (s APNSVoipSandboxChannelRequest) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type APNSVoipSandboxChannelResponse added in v1.12.17 

type APNSVoipSandboxChannelResponse struct {

	// The unique identifier for the application that the APNs VoIP sandbox channel
	// applies to.
	ApplicationId *string `type:"string"`

	// The date and time when the APNs VoIP sandbox channel was enabled.
	CreationDate *string `type:"string"`

	// The default authentication method that Amazon Pinpoint uses to authenticate
	// with the APNs sandbox environment for this channel, key or certificate.
	DefaultAuthenticationMethod *string `type:"string"`

	// Specifies whether the APNs VoIP sandbox channel is enabled for the application.
	Enabled *bool `type:"boolean"`

	// (Not used) This property is retained only for backward compatibility.
	HasCredential *bool `type:"boolean"`

	// Specifies whether the APNs VoIP sandbox channel is configured to communicate
	// with APNs by using APNs tokens. To provide an authentication key for APNs
	// tokens, set the TokenKey property of the channel.
	HasTokenKey *bool `type:"boolean"`

	// (Deprecated) An identifier for the APNs VoIP sandbox channel. This property
	// is retained only for backward compatibility.
	Id *string `type:"string"`

	// Specifies whether the APNs VoIP sandbox channel is archived.
	IsArchived *bool `type:"boolean"`

	// The user who last modified the APNs VoIP sandbox channel.
	LastModifiedBy *string `type:"string"`

	// The date and time when the APNs VoIP sandbox channel was last modified.
	LastModifiedDate *string `type:"string"`

	// The type of messaging or notification platform for the channel. For the APNs
	// VoIP sandbox channel, this value is APNS_VOIP_SANDBOX.
	//
	// Platform is a required field
	Platform *string `type:"string" required:"true"`

	// The current version of the APNs VoIP sandbox channel.
	Version *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Provides information about the status and settings of the APNs (Apple Push Notification service) VoIP sandbox channel for an application.

func (APNSVoipSandboxChannelResponse) GoString added in v1.12.17 

func (s APNSVoipSandboxChannelResponse) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*APNSVoipSandboxChannelResponse) SetApplicationId added in v1.12.17 

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

SetApplicationId sets the ApplicationId field's value.

func (*APNSVoipSandboxChannelResponse) SetCreationDate added in v1.12.17 

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

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 

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

SetEnabled sets the Enabled field's value.

func (*APNSVoipSandboxChannelResponse) SetHasCredential added in v1.12.17 

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

SetHasCredential sets the HasCredential field's value.

func (*APNSVoipSandboxChannelResponse) SetHasTokenKey added in v1.12.17 

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

SetHasTokenKey sets the HasTokenKey field's value.

func (*APNSVoipSandboxChannelResponse) SetId added in v1.12.17 

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

SetId sets the Id field's value.

func (*APNSVoipSandboxChannelResponse) SetIsArchived added in v1.12.17 

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

SetIsArchived sets the IsArchived field's value.

func (*APNSVoipSandboxChannelResponse) SetLastModifiedBy added in v1.12.17 

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

SetLastModifiedBy sets the LastModifiedBy field's value.

func (*APNSVoipSandboxChannelResponse) SetLastModifiedDate added in v1.12.17 

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

SetLastModifiedDate sets the LastModifiedDate field's value.

func (*APNSVoipSandboxChannelResponse) SetPlatform added in v1.12.17 

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

SetPlatform sets the Platform field's value.

func (*APNSVoipSandboxChannelResponse) SetVersion added in v1.12.17 

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

SetVersion sets the Version field's value.

func (APNSVoipSandboxChannelResponse) String added in v1.12.17 

func (s APNSVoipSandboxChannelResponse) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ActivitiesResponse 

type ActivitiesResponse struct {

	// An array of responses, one for each activity that was performed by the campaign.
	//
	// Item is a required field
	Item []*ActivityResponse `type:"list" required:"true"`

	// The string to use in a subsequent request to get the next page of results
	// in a paginated response. This value is null if there are no additional pages.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

Provides information about the activities that were performed by a campaign.

func (ActivitiesResponse) GoString 

func (s ActivitiesResponse) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ActivitiesResponse) SetItem 

func (s *ActivitiesResponse) SetItem(v []*ActivityResponse) *ActivitiesResponse

SetItem sets the Item field's value.

func (*ActivitiesResponse) SetNextToken added in v1.15.7 

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

SetNextToken sets the NextToken field's value.

func (ActivitiesResponse) String 

func (s ActivitiesResponse) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Activity added in v1.25.25 

type Activity struct {

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

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

	// The settings for a connect activity. This type of activity initiates a contact
	// center call to participants.
	ContactCenter *ContactCenterActivity `type:"structure"`

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

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

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

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

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

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

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

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

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

func (Activity) GoString added in v1.25.25 

func (s Activity) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Activity) SetCUSTOM added in v1.31.12 

func (s *Activity) SetCUSTOM(v *CustomMessageActivity) *Activity

SetCUSTOM sets the CUSTOM field's value.

func (*Activity) SetConditionalSplit added in v1.25.25 

func (s *Activity) SetConditionalSplit(v *ConditionalSplitActivity) *Activity

SetConditionalSplit sets the ConditionalSplit field's value.

func (*Activity) SetContactCenter added in v1.40.50 

func (s *Activity) SetContactCenter(v *ContactCenterActivity) *Activity

SetContactCenter sets the ContactCenter field's value.

func (*Activity) SetDescription added in v1.25.25 

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

SetDescription sets the Description field's value.

func (*Activity) SetEMAIL added in v1.25.25 

func (s *Activity) SetEMAIL(v *EmailMessageActivity) *Activity

SetEMAIL sets the EMAIL field's value.

func (*Activity) SetHoldout added in v1.25.25 

func (s *Activity) SetHoldout(v *HoldoutActivity) *Activity

SetHoldout sets the Holdout field's value.

func (*Activity) SetMultiCondition added in v1.25.25 

func (s *Activity) SetMultiCondition(v *MultiConditionalSplitActivity) *Activity

SetMultiCondition sets the MultiCondition field's value.

func (*Activity) SetPUSH added in v1.31.12 

func (s *Activity) SetPUSH(v *PushMessageActivity) *Activity

SetPUSH sets the PUSH field's value.

func (*Activity) SetRandomSplit added in v1.25.25 

func (s *Activity) SetRandomSplit(v *RandomSplitActivity) *Activity

SetRandomSplit sets the RandomSplit field's value.

func (*Activity) SetSMS added in v1.31.12 

func (s *Activity) SetSMS(v *SMSMessageActivity) *Activity

SetSMS sets the SMS field's value.

func (*Activity) SetWait added in v1.25.25 

func (s *Activity) SetWait(v *WaitActivity) *Activity

SetWait sets the Wait field's value.

func (Activity) String added in v1.25.25 

func (s Activity) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Activity) Validate added in v1.25.25 

func (s *Activity) Validate() error

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

type ActivityResponse 

type ActivityResponse struct {

	// The unique identifier for the application that the campaign applies to.
	//
	// ApplicationId is a required field
	ApplicationId *string `type:"string" required:"true"`

	// The unique identifier for the campaign that the activity applies to.
	//
	// CampaignId is a required field
	CampaignId *string `type:"string" required:"true"`

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

	// The unique identifier for the activity.
	//
	// Id is a required field
	Id *string `type:"string" required:"true"`

	// Specifies whether the activity succeeded. Possible values are SUCCESS and
	// FAIL.
	Result *string `type:"string"`

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

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

	// The current status of the activity. Possible values are: PENDING, INITIALIZING,
	// RUNNING, PAUSED, CANCELLED, and COMPLETED.
	State *string `type:"string"`

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

	// The total number of time zones that were completed.
	TimezonesCompletedCount *int64 `type:"integer"`

	// The total number of unique time zones that are in the segment for the campaign.
	TimezonesTotalCount *int64 `type:"integer"`

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

	// The unique identifier for the campaign treatment that the activity applies
	// to. A treatment is a variation of a campaign that's used for A/B testing
	// of a campaign.
	TreatmentId *string `type:"string"`
	// contains filtered or unexported fields
}

Provides information about an activity that was performed by a campaign.

func (ActivityResponse) GoString 

func (s ActivityResponse) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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 

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

SetEnd sets the End field's value.

func (*ActivityResponse) SetId 

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

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AddressConfiguration added in v1.8.38 

type AddressConfiguration struct {

	// The message body to use instead of the default message body. This value overrides
	// the default message body.
	BodyOverride *string `type:"string"`

	// The channel to use when sending the message.
	ChannelType *string `type:"string" enum:"ChannelType"`

	// An object that maps custom attributes to attributes for the address and is
	// attached to the message. Attribute names are case sensitive.
	//
	// For a push notification, this payload is added to the data.pinpoint object.
	// For an email or text message, this payload is added to email/SMS delivery
	// receipt event attributes.
	Context map[string]*string `type:"map"`

	// The raw, JSON-formatted string to use as the payload for the message. If
	// specified, this value overrides all other values for the message.
	RawContent *string `type:"string"`

	// A map of the message variables to merge with the variables specified by properties
	// of the DefaultMessage object. The variables specified in this map take precedence
	// over all other variables.
	Substitutions map[string][]*string `type:"map"`

	// The message title to use instead of the default message title. This value
	// overrides the default message title.
	TitleOverride *string `type:"string"`
	// contains filtered or unexported fields
}

Specifies address-based configuration settings for a message that's sent directly to an endpoint.

func (AddressConfiguration) GoString added in v1.8.38 

func (s AddressConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AndroidPushNotificationTemplate added in v1.25.7 

type AndroidPushNotificationTemplate struct {

	// The action to occur if a recipient taps a push notification that's based
	// on the message template. Valid values are:
	//
	//    * OPEN_APP - Your app opens or it becomes the foreground app if it was
	//    sent to the background. This is the default action.
	//
	//    * DEEP_LINK - Your app opens and displays a designated user interface
	//    in the app. This action uses the deep-linking features of the Android
	//    platform.
	//
	//    * URL - The default mobile browser on the recipient's device opens and
	//    loads the web page at a URL that you specify.
	Action *string `type:"string" enum:"Action"`

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

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

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

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

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

	// The sound to play when a recipient receives a push notification that's based
	// on the message template. You can use the default stream or specify the file
	// name of a sound resource that's bundled in your app. On an Android platform,
	// the sound file must reside in /res/raw/.
	Sound *string `type:"string"`

	// The title to use in a push notification that's based on the message template.
	// This title appears above the notification message on a recipient's device.
	Title *string `type:"string"`

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

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

func (AndroidPushNotificationTemplate) GoString added in v1.25.7 

func (s AndroidPushNotificationTemplate) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AndroidPushNotificationTemplate) SetAction added in v1.25.7 

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

SetAction sets the Action field's value.

func (*AndroidPushNotificationTemplate) SetBody added in v1.25.7 

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

SetBody sets the Body field's value.

func (*AndroidPushNotificationTemplate) SetImageIconUrl added in v1.25.7 

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

SetImageIconUrl sets the ImageIconUrl field's value.

func (*AndroidPushNotificationTemplate) SetImageUrl added in v1.25.7 

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

SetImageUrl sets the ImageUrl field's value.

func (*AndroidPushNotificationTemplate) SetRawContent added in v1.25.37 

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

SetRawContent sets the RawContent field's value.

func (*AndroidPushNotificationTemplate) SetSmallImageIconUrl added in v1.25.7 

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

SetSmallImageIconUrl sets the SmallImageIconUrl field's value.

func (*AndroidPushNotificationTemplate) SetSound added in v1.25.7 

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

SetSound sets the Sound field's value.

func (*AndroidPushNotificationTemplate) SetTitle added in v1.25.7 

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

SetTitle sets the Title field's value.

func (*AndroidPushNotificationTemplate) SetUrl added in v1.25.7 

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

SetUrl sets the Url field's value.

func (AndroidPushNotificationTemplate) String added in v1.25.7 

func (s AndroidPushNotificationTemplate) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ApplicationDateRangeKpiResponse added in v1.21.4 

type ApplicationDateRangeKpiResponse struct {

	// The unique identifier for the application that the metric applies to.
	//
	// ApplicationId is a required field
	ApplicationId *string `type:"string" required:"true"`

	// EndTime is a required field
	EndTime *time.Time `type:"timestamp" timestampFormat:"iso8601" required:"true"`

	// The name of the metric, also referred to as a key performance indicator (KPI),
	// that the data was retrieved for. This value describes the associated metric
	// and consists of two or more terms, which are comprised of lowercase alphanumeric
	// characters, separated by a hyphen. For a list of possible values, see the
	// Amazon Pinpoint Developer Guide (https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html).
	//
	// KpiName is a required field
	KpiName *string `type:"string" required:"true"`

	// An array of objects that contains the results of the query. Each object contains
	// the value for the metric and metadata about that value.
	//
	// KpiResult is a required field
	KpiResult *BaseKpiResult `type:"structure" required:"true"`

	// The string to use in a subsequent request to get the next page of results
	// in a paginated response. This value is null for the Application Metrics resource
	// because the resource returns all results in a single page.
	NextToken *string `type:"string"`

	// StartTime is a required field
	StartTime *time.Time `type:"timestamp" timestampFormat:"iso8601" required:"true"`
	// contains filtered or unexported fields
}

Provides the results of a query that retrieved the data for a standard metric that applies to an application, and provides information about that query.

func (ApplicationDateRangeKpiResponse) GoString added in v1.21.4 

func (s ApplicationDateRangeKpiResponse) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ApplicationDateRangeKpiResponse) SetApplicationId added in v1.21.4 

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

SetApplicationId sets the ApplicationId field's value.

func (*ApplicationDateRangeKpiResponse) SetEndTime added in v1.21.4 

func (s *ApplicationDateRangeKpiResponse) SetEndTime(v time.Time) *ApplicationDateRangeKpiResponse

SetEndTime sets the EndTime field's value.

func (*ApplicationDateRangeKpiResponse) SetKpiName added in v1.21.4 

func (s *ApplicationDateRangeKpiResponse) SetKpiName(v string) *ApplicationDateRangeKpiResponse

SetKpiName sets the KpiName field's value.

func (*ApplicationDateRangeKpiResponse) SetKpiResult added in v1.21.4 

func (s *ApplicationDateRangeKpiResponse) SetKpiResult(v *BaseKpiResult) *ApplicationDateRangeKpiResponse

SetKpiResult sets the KpiResult field's value.

func (*ApplicationDateRangeKpiResponse) SetNextToken added in v1.21.4 

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

SetNextToken sets the NextToken field's value.

func (*ApplicationDateRangeKpiResponse) SetStartTime added in v1.21.4 

func (s *ApplicationDateRangeKpiResponse) SetStartTime(v time.Time) *ApplicationDateRangeKpiResponse

SetStartTime sets the StartTime field's value.

func (ApplicationDateRangeKpiResponse) String added in v1.21.4 

func (s ApplicationDateRangeKpiResponse) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ApplicationResponse added in v1.10.20 

type ApplicationResponse struct {

	// The Amazon Resource Name (ARN) of the application.
	//
	// Arn is a required field
	Arn *string `type:"string" required:"true"`

	// The date and time when the Application was created.
	CreationDate *string `type:"string"`

	// The unique identifier for the application. This identifier is displayed as
	// the Project ID on the Amazon Pinpoint console.
	//
	// Id is a required field
	Id *string `type:"string" required:"true"`

	// The display name of the application. This name is displayed as the Project
	// name on the Amazon Pinpoint console.
	//
	// Name is a required field
	Name *string `type:"string" required:"true"`

	// A string-to-string map of key-value pairs that identifies the tags that are
	// associated with the application. Each tag consists of a required tag key
	// and an associated tag value.
	Tags map[string]*string `locationName:"tags" type:"map"`
	// contains filtered or unexported fields
}

Provides information about an application.

func (ApplicationResponse) GoString added in v1.10.20 

func (s ApplicationResponse) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ApplicationResponse) SetArn added in v1.17.6 

func (s *ApplicationResponse) SetArn(v string) *ApplicationResponse

SetArn sets the Arn field's value.

func (*ApplicationResponse) SetCreationDate added in v1.42.51 

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

SetCreationDate sets the CreationDate field's value.

func (*ApplicationResponse) SetId added in v1.10.20 

func (s *ApplicationResponse) SetId(v string) *ApplicationResponse

SetId sets the Id field's value.

func (*ApplicationResponse) SetName added in v1.10.20 

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

SetName sets the Name field's value.

func (*ApplicationResponse) SetTags added in v1.17.6 

func (s *ApplicationResponse) SetTags(v map[string]*string) *ApplicationResponse

SetTags sets the Tags field's value.

func (ApplicationResponse) String added in v1.10.20 

func (s ApplicationResponse) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ApplicationSettingsResource 

type ApplicationSettingsResource struct {

	// The unique identifier for the application. This identifier is displayed as
	// the Project ID on the Amazon Pinpoint console.
	//
	// ApplicationId is a required field
	ApplicationId *string `type:"string" required:"true"`

	// The settings for the AWS Lambda function to invoke by default as a code hook
	// for campaigns in the application. You can use this hook to customize segments
	// that are used by campaigns in the application.
	CampaignHook *CampaignHook `type:"structure"`

	// The date and time, in ISO 8601 format, when the application's settings were
	// last modified.
	LastModifiedDate *string `type:"string"`

	// The default sending limits for campaigns in the application.
	Limits *CampaignLimits `type:"structure"`

	// The default quiet time for campaigns in the application. Quiet time is a
	// specific time range when messages aren't sent to endpoints, if all the following
	// conditions are met:
	//
	//    * The EndpointDemographic.Timezone property of the endpoint is set to
	//    a valid value.
	//
	//    * The current time in the endpoint's time zone is later than or equal
	//    to the time specified by the QuietTime.Start property for the application
	//    (or a campaign or journey that has custom quiet time settings).
	//
	//    * The current time in the endpoint's time zone is earlier than or equal
	//    to the time specified by the QuietTime.End property for the application
	//    (or a campaign or journey that has custom quiet time settings).
	//
	// If any of the preceding conditions isn't met, the endpoint will receive messages
	// from a campaign or journey, even if quiet time is enabled.
	QuietTime *QuietTime `type:"structure"`
	// contains filtered or unexported fields
}

Provides information about an application, including the default settings for an application.

func (ApplicationSettingsResource) GoString 

func (s ApplicationSettingsResource) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ApplicationSettingsResource) SetApplicationId 

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

SetApplicationId sets the ApplicationId field's value.

func (*ApplicationSettingsResource) SetCampaignHook added in v1.13.11 

func (s *ApplicationSettingsResource) SetCampaignHook(v *CampaignHook) *ApplicationSettingsResource

SetCampaignHook sets the CampaignHook field's value.

func (*ApplicationSettingsResource) SetLastModifiedDate 

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

SetLastModifiedDate sets the LastModifiedDate field's value.

func (*ApplicationSettingsResource) SetLimits 

func (s *ApplicationSettingsResource) SetLimits(v *CampaignLimits) *ApplicationSettingsResource

SetLimits sets the Limits field's value.

func (*ApplicationSettingsResource) SetQuietTime 

func (s *ApplicationSettingsResource) SetQuietTime(v *QuietTime) *ApplicationSettingsResource

SetQuietTime sets the QuietTime field's value.

func (ApplicationSettingsResource) String 

func (s ApplicationSettingsResource) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ApplicationsResponse added in v1.10.20 

type ApplicationsResponse struct {

	// An array of responses, one for each application that was returned.
	Item []*ApplicationResponse `type:"list"`

	// The string to use in a subsequent request to get the next page of results
	// in a paginated response. This value is null if there are no additional pages.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

Provides information about all of your applications.

func (ApplicationsResponse) GoString added in v1.10.20 

func (s ApplicationsResponse) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ApplicationsResponse) SetItem added in v1.10.20 

func (s *ApplicationsResponse) SetItem(v []*ApplicationResponse) *ApplicationsResponse

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AttributeDimension 

type AttributeDimension struct {
	AttributeType *string `type:"string" enum:"AttributeType"`

	// The criteria values to use for the segment dimension. Depending on the value
	// of the AttributeType property, endpoints are included or excluded from the
	// segment if their attribute values match the criteria values.
	//
	// Values is a required field
	Values []*string `type:"list" required:"true"`
	// contains filtered or unexported fields
}

Specifies attribute-based criteria for including or excluding endpoints from a segment.

func (AttributeDimension) GoString 

func (s AttributeDimension) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AttributeDimension) Validate added in v1.20.11 

func (s *AttributeDimension) Validate() error

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

type AttributesResource added in v1.14.20 

type AttributesResource struct {

	// The unique identifier for the application.
	//
	// ApplicationId is a required field
	ApplicationId *string `type:"string" required:"true"`

	// The type of attribute or attributes that were removed from the endpoints.
	// Valid values are:
	//
	//    * endpoint-custom-attributes - Custom attributes that describe endpoints.
	//
	//    * endpoint-metric-attributes - Custom metrics that your app reports to
	//    Amazon Pinpoint for endpoints.
	//
	//    * endpoint-user-attributes - Custom attributes that describe users.
	//
	// AttributeType is a required field
	AttributeType *string `type:"string" required:"true"`

	// An array that specifies the names of the attributes that were removed from
	// the endpoints.
	Attributes []*string `type:"list"`
	// contains filtered or unexported fields
}

Provides information about the type and the names of attributes that were removed from all the endpoints that are associated with an application.

func (AttributesResource) GoString added in v1.14.20 

func (s AttributesResource) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AttributesResource) SetApplicationId added in v1.14.20 

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

SetApplicationId sets the ApplicationId field's value.

func (*AttributesResource) SetAttributeType added in v1.14.20 

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

SetAttributeType sets the AttributeType field's value.

func (*AttributesResource) SetAttributes added in v1.14.20 

func (s *AttributesResource) SetAttributes(v []*string) *AttributesResource

SetAttributes sets the Attributes field's value.

func (AttributesResource) String added in v1.14.20 

func (s AttributesResource) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type BadRequestException added in v1.28.0 

type BadRequestException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`

	RequestID_ *string `locationName:"RequestID" type:"string"`
	// contains filtered or unexported fields
}

Provides information about an API request or response.

func (*BadRequestException) Code added in v1.28.0 

func (s *BadRequestException) Code() string

Code returns the exception type name.

func (*BadRequestException) Error added in v1.28.0 

func (s *BadRequestException) Error() string

func (BadRequestException) GoString added in v1.28.0 

func (s BadRequestException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BadRequestException) Message added in v1.28.0 

func (s *BadRequestException) Message() string

Message returns the exception's message.

func (*BadRequestException) OrigErr added in v1.28.0 

func (s *BadRequestException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*BadRequestException) RequestID added in v1.28.0 

func (s *BadRequestException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*BadRequestException) StatusCode added in v1.28.0 

func (s *BadRequestException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (BadRequestException) String added in v1.28.0 

func (s BadRequestException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type BaiduChannelRequest added in v1.12.1 

type BaiduChannelRequest struct {

	// The API key that you received from the Baidu Cloud Push service to communicate
	// with the service.
	//
	// ApiKey is a required field
	ApiKey *string `type:"string" required:"true"`

	// Specifies whether to enable the Baidu channel for the application.
	Enabled *bool `type:"boolean"`

	// The secret key that you received from the Baidu Cloud Push service to communicate
	// with the service.
	//
	// SecretKey is a required field
	SecretKey *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Specifies the status and settings of the Baidu (Baidu Cloud Push) channel for an application.

func (BaiduChannelRequest) GoString added in v1.12.1 

func (s BaiduChannelRequest) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BaiduChannelRequest) SetApiKey added in v1.12.1 

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

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BaiduChannelRequest) Validate added in v1.20.11 

func (s *BaiduChannelRequest) Validate() error

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

type BaiduChannelResponse added in v1.12.1 

type BaiduChannelResponse struct {

	// The unique identifier for the application that the Baidu channel applies
	// to.
	ApplicationId *string `type:"string"`

	// The date and time when the Baidu channel was enabled.
	CreationDate *string `type:"string"`

	// The API key that you received from the Baidu Cloud Push service to communicate
	// with the service.
	//
	// Credential is a required field
	Credential *string `type:"string" required:"true"`

	// Specifies whether the Baidu channel is enabled for the application.
	Enabled *bool `type:"boolean"`

	// (Not used) This property is retained only for backward compatibility.
	HasCredential *bool `type:"boolean"`

	// (Deprecated) An identifier for the Baidu channel. This property is retained
	// only for backward compatibility.
	Id *string `type:"string"`

	// Specifies whether the Baidu channel is archived.
	IsArchived *bool `type:"boolean"`

	// The user who last modified the Baidu channel.
	LastModifiedBy *string `type:"string"`

	// The date and time when the Baidu channel was last modified.
	LastModifiedDate *string `type:"string"`

	// The type of messaging or notification platform for the channel. For the Baidu
	// channel, this value is BAIDU.
	//
	// Platform is a required field
	Platform *string `type:"string" required:"true"`

	// The current version of the Baidu channel.
	Version *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Provides information about the status and settings of the Baidu (Baidu Cloud Push) channel for an application.

func (BaiduChannelResponse) GoString added in v1.12.1 

func (s BaiduChannelResponse) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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 

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

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 

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

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 

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

SetPlatform sets the Platform field's value.

func (*BaiduChannelResponse) SetVersion added in v1.12.1 

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

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type BaiduMessage added in v1.12.1 

type BaiduMessage struct {

	// The action to occur if the recipient taps the push notification. Valid values
	// are:
	//
	//    * OPEN_APP - Your app opens or it becomes the foreground app if it was
	//    sent to the background. This is the default action.
	//
	//    * DEEP_LINK - Your app opens and displays a designated user interface
	//    in the app. This action uses the deep-linking features of the Android
	//    platform.
	//
	//    * URL - The default mobile browser on the recipient's device opens and
	//    loads the web page at a URL that you specify.
	Action *string `type:"string" enum:"Action"`

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

	// The JSON data payload to use for the push notification, if the notification
	// is a silent push notification. This payload is added to the data.pinpoint.jsonBody
	// object of the notification.
	Data map[string]*string `type:"map"`

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

	// The URL of the large icon image to display in the content view of the push
	// notification.
	ImageIconUrl *string `type:"string"`

	// The URL of an image to display in the push notification.
	ImageUrl *string `type:"string"`

	// The raw, JSON-formatted string to use as the payload for the notification
	// message. If specified, this value overrides all other content for the message.
	RawContent *string `type:"string"`

	// Specifies whether the notification is a silent push notification, which is
	// a push notification that doesn't display on a recipient's device. Silent
	// push notifications can be used for cases such as updating an app's configuration
	// or supporting phone home functionality.
	SilentPush *bool `type:"boolean"`

	// The URL of the small icon image to display in the status bar and the content
	// view of the push notification.
	SmallImageIconUrl *string `type:"string"`

	// The sound to play when the recipient receives the push notification. You
	// can use the default stream or specify the file name of a sound resource that's
	// bundled in your app. On an Android platform, the sound file must reside in
	// /res/raw/.
	Sound *string `type:"string"`

	// The default message variables to use in the notification message. You can
	// override the default variables with individual address variables.
	Substitutions map[string][]*string `type:"map"`

	// The amount of time, in seconds, that the Baidu Cloud Push service should
	// store the message if the recipient's device is offline. The default value
	// and maximum supported time is 604,800 seconds (7 days).
	TimeToLive *int64 `type:"integer"`

	// The title to display above the notification message on the recipient's device.
	Title *string `type:"string"`

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

Specifies the settings for a one-time message that's sent directly to an endpoint through the Baidu (Baidu Cloud Push) channel.

func (BaiduMessage) GoString added in v1.12.1 

func (s BaiduMessage) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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) SetTimeToLive added in v1.14.20 

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

SetTimeToLive sets the TimeToLive 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type BaseKpiResult added in v1.21.4 

type BaseKpiResult struct {

	// An array of objects that provides the results of a query that retrieved the
	// data for a standard metric that applies to an application, campaign, or journey.
	//
	// Rows is a required field
	Rows []*ResultRow `type:"list" required:"true"`
	// contains filtered or unexported fields
}

Provides the results of a query that retrieved the data for a standard metric that applies to an application, campaign, or journey.

func (BaseKpiResult) GoString added in v1.21.4 

func (s BaseKpiResult) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BaseKpiResult) SetRows added in v1.21.4 

func (s *BaseKpiResult) SetRows(v []*ResultRow) *BaseKpiResult

SetRows sets the Rows field's value.

func (BaseKpiResult) String added in v1.21.4 

func (s BaseKpiResult) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CampaignCustomMessage added in v1.30.13 

type CampaignCustomMessage struct {

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

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

func (CampaignCustomMessage) GoString added in v1.30.13 

func (s CampaignCustomMessage) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CampaignCustomMessage) SetData added in v1.30.13 

func (s *CampaignCustomMessage) SetData(v string) *CampaignCustomMessage

SetData sets the Data field's value.

func (CampaignCustomMessage) String added in v1.30.13 

func (s CampaignCustomMessage) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CampaignDateRangeKpiResponse added in v1.21.4 

type CampaignDateRangeKpiResponse struct {

	// The unique identifier for the application that the metric applies to.
	//
	// ApplicationId is a required field
	ApplicationId *string `type:"string" required:"true"`

	// The unique identifier for the campaign that the metric applies to.
	//
	// CampaignId is a required field
	CampaignId *string `type:"string" required:"true"`

	// EndTime is a required field
	EndTime *time.Time `type:"timestamp" timestampFormat:"iso8601" required:"true"`

	// The name of the metric, also referred to as a key performance indicator (KPI),
	// that the data was retrieved for. This value describes the associated metric
	// and consists of two or more terms, which are comprised of lowercase alphanumeric
	// characters, separated by a hyphen. For a list of possible values, see the
	// Amazon Pinpoint Developer Guide (https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html).
	//
	// KpiName is a required field
	KpiName *string `type:"string" required:"true"`

	// An array of objects that contains the results of the query. Each object contains
	// the value for the metric and metadata about that value.
	//
	// KpiResult is a required field
	KpiResult *BaseKpiResult `type:"structure" required:"true"`

	// The string to use in a subsequent request to get the next page of results
	// in a paginated response. This value is null for the Campaign Metrics resource
	// because the resource returns all results in a single page.
	NextToken *string `type:"string"`

	// StartTime is a required field
	StartTime *time.Time `type:"timestamp" timestampFormat:"iso8601" required:"true"`
	// contains filtered or unexported fields
}

Provides the results of a query that retrieved the data for a standard metric that applies to a campaign, and provides information about that query.

func (CampaignDateRangeKpiResponse) GoString added in v1.21.4 

func (s CampaignDateRangeKpiResponse) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CampaignDateRangeKpiResponse) SetApplicationId added in v1.21.4 

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

SetApplicationId sets the ApplicationId field's value.

func (*CampaignDateRangeKpiResponse) SetCampaignId added in v1.21.4 

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

SetCampaignId sets the CampaignId field's value.

func (*CampaignDateRangeKpiResponse) SetEndTime added in v1.21.4 

func (s *CampaignDateRangeKpiResponse) SetEndTime(v time.Time) *CampaignDateRangeKpiResponse

SetEndTime sets the EndTime field's value.

func (*CampaignDateRangeKpiResponse) SetKpiName added in v1.21.4 

func (s *CampaignDateRangeKpiResponse) SetKpiName(v string) *CampaignDateRangeKpiResponse

SetKpiName sets the KpiName field's value.

func (*CampaignDateRangeKpiResponse) SetKpiResult added in v1.21.4 

func (s *CampaignDateRangeKpiResponse) SetKpiResult(v *BaseKpiResult) *CampaignDateRangeKpiResponse

SetKpiResult sets the KpiResult field's value.

func (*CampaignDateRangeKpiResponse) SetNextToken added in v1.21.4 

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

SetNextToken sets the NextToken field's value.

func (*CampaignDateRangeKpiResponse) SetStartTime added in v1.21.4 

func (s *CampaignDateRangeKpiResponse) SetStartTime(v time.Time) *CampaignDateRangeKpiResponse

SetStartTime sets the StartTime field's value.

func (CampaignDateRangeKpiResponse) String added in v1.21.4 

func (s CampaignDateRangeKpiResponse) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CampaignEmailMessage added in v1.8.38 

type CampaignEmailMessage struct {

	// The body of the email for recipients whose email clients don't render HTML
	// content.
	Body *string `type:"string"`

	// The verified email address to send the email from. The default address is
	// the FromAddress specified for the email channel for the application.
	FromAddress *string `type:"string"`

	// The body of the email, in HTML format, for recipients whose email clients
	// render HTML content.
	HtmlBody *string `type:"string"`

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

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

func (CampaignEmailMessage) GoString added in v1.8.38 

func (s CampaignEmailMessage) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CampaignEmailMessage) SetBody added in v1.8.38 

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

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 

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

SetHtmlBody sets the HtmlBody field's value.

func (*CampaignEmailMessage) SetTitle added in v1.8.38 

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

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CampaignEventFilter added in v1.15.77 

type CampaignEventFilter struct {

	// The dimension settings of the event filter for the campaign.
	//
	// Dimensions is a required field
	Dimensions *EventDimensions `type:"structure" required:"true"`

	// The type of event that causes the campaign to be sent. Valid values are:
	// SYSTEM, sends the campaign when a system event occurs; and, ENDPOINT, sends
	// the campaign when an endpoint event (Events resource) occurs.
	//
	// FilterType is a required field
	FilterType *string `type:"string" required:"true" enum:"FilterType"`
	// contains filtered or unexported fields
}

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

func (CampaignEventFilter) GoString added in v1.15.77 

func (s CampaignEventFilter) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CampaignEventFilter) SetDimensions added in v1.15.77 

func (s *CampaignEventFilter) SetDimensions(v *EventDimensions) *CampaignEventFilter

SetDimensions sets the Dimensions field's value.

func (*CampaignEventFilter) SetFilterType added in v1.15.77 

func (s *CampaignEventFilter) SetFilterType(v string) *CampaignEventFilter

SetFilterType sets the FilterType field's value.

func (CampaignEventFilter) String added in v1.15.77 

func (s CampaignEventFilter) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CampaignEventFilter) Validate added in v1.20.11 

func (s *CampaignEventFilter) Validate() error

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

type CampaignHook added in v1.13.11 

type CampaignHook struct {

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

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

	// The web URL that Amazon Pinpoint calls to invoke the AWS Lambda function
	// over HTTPS.
	WebUrl *string `type:"string"`
	// contains filtered or unexported fields
}

Specifies settings for invoking an AWS Lambda function that customizes a segment for a campaign.

func (CampaignHook) GoString added in v1.13.11 

func (s CampaignHook) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CampaignInAppMessage added in v1.40.44 

type CampaignInAppMessage struct {

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

	// In-app message content.
	Content []*InAppMessageContent `type:"list"`

	// Custom config to be sent to client.
	CustomConfig map[string]*string `type:"map"`

	// In-app message layout.
	Layout *string `type:"string" enum:"Layout"`
	// contains filtered or unexported fields
}

In-app message configuration.

func (CampaignInAppMessage) GoString added in v1.40.44 

func (s CampaignInAppMessage) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CampaignInAppMessage) SetBody added in v1.40.44 

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

SetBody sets the Body field's value.

func (*CampaignInAppMessage) SetContent added in v1.40.44 

func (s *CampaignInAppMessage) SetContent(v []*InAppMessageContent) *CampaignInAppMessage

SetContent sets the Content field's value.

func (*CampaignInAppMessage) SetCustomConfig added in v1.40.44 

func (s *CampaignInAppMessage) SetCustomConfig(v map[string]*string) *CampaignInAppMessage

SetCustomConfig sets the CustomConfig field's value.

func (*CampaignInAppMessage) SetLayout added in v1.40.44 

func (s *CampaignInAppMessage) SetLayout(v string) *CampaignInAppMessage

SetLayout sets the Layout field's value.

func (CampaignInAppMessage) String added in v1.40.44 

func (s CampaignInAppMessage) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CampaignInAppMessage) Validate added in v1.40.44 

func (s *CampaignInAppMessage) Validate() error

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

type CampaignLimits 

type CampaignLimits struct {

	// The maximum number of messages that a campaign can send to a single endpoint
	// during a 24-hour period. For an application, this value specifies the default
	// limit for the number of messages that campaigns and journeys can send to
	// a single endpoint during a 24-hour period. The maximum value is 100.
	Daily *int64 `type:"integer"`

	// The maximum amount of time, in seconds, that a campaign can attempt to deliver
	// a message after the scheduled start time for the campaign. The minimum value
	// is 60 seconds.
	MaximumDuration *int64 `type:"integer"`

	// The maximum number of messages that a campaign can send each second. For
	// an application, this value specifies the default limit for the number of
	// messages that campaigns can send each second. The minimum value is 50. The
	// maximum value is 20,000.
	MessagesPerSecond *int64 `type:"integer"`

	// The maximum total number of messages that the campaign can send per user
	// session.
	Session *int64 `type:"integer"`

	// The maximum number of messages that a campaign can send to a single endpoint
	// during the course of the campaign. If a campaign recurs, this setting applies
	// to all runs of the campaign. The maximum value is 100.
	Total *int64 `type:"integer"`
	// contains filtered or unexported fields
}

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

func (CampaignLimits) GoString 

func (s CampaignLimits) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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) SetSession added in v1.40.44 

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

SetSession sets the Session 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CampaignResponse 

type CampaignResponse struct {

	// An array of responses, one for each treatment that you defined for the campaign,
	// in addition to the default treatment.
	AdditionalTreatments []*TreatmentResource `type:"list"`

	// The unique identifier for the application that the campaign applies to.
	//
	// ApplicationId is a required field
	ApplicationId *string `type:"string" required:"true"`

	// The Amazon Resource Name (ARN) of the campaign.
	//
	// Arn is a required field
	Arn *string `type:"string" required:"true"`

	// The date, in ISO 8601 format, when the campaign was created.
	//
	// CreationDate is a required field
	CreationDate *string `type:"string" required:"true"`

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

	// The current status of the campaign's default treatment. This value exists
	// only for campaigns that have more than one treatment.
	DefaultState *CampaignState `type:"structure"`

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

	// The allocated percentage of users (segment members) who shouldn't receive
	// messages from the campaign.
	HoldoutPercent *int64 `type:"integer"`

	// The settings for the AWS Lambda function to use as a code hook for the campaign.
	// You can use this hook to customize the segment that's used by the campaign.
	Hook *CampaignHook `type:"structure"`

	// The unique identifier for the campaign.
	//
	// Id is a required field
	Id *string `type:"string" required:"true"`

	// Specifies whether the campaign is paused. A paused campaign doesn't run unless
	// you resume it by changing this value to false.
	IsPaused *bool `type:"boolean"`

	// The date, in ISO 8601 format, when the campaign was last modified.
	//
	// LastModifiedDate is a required field
	LastModifiedDate *string `type:"string" required:"true"`

	// The messaging limits for the campaign.
	Limits *CampaignLimits `type:"structure"`

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

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

	// Defines the priority of the campaign, used to decide the order of messages
	// displayed to user if there are multiple messages scheduled to be displayed
	// at the same moment
	Priority *int64 `type:"integer"`

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

	// The unique identifier for the segment that's associated with the campaign.
	//
	// SegmentId is a required field
	SegmentId *string `type:"string" required:"true"`

	// The version number of the segment that's associated with the campaign.
	//
	// SegmentVersion is a required field
	SegmentVersion *int64 `type:"integer" required:"true"`

	// The current status of the campaign.
	State *CampaignState `type:"structure"`

	// A string-to-string map of key-value pairs that identifies the tags that are
	// associated with the campaign. Each tag consists of a required tag key and
	// an associated tag value.
	Tags map[string]*string `locationName:"tags" type:"map"`

	// The message template that’s used for the campaign.
	TemplateConfiguration *TemplateConfiguration `type:"structure"`

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

	// The custom name of the default treatment for the campaign, if the campaign
	// has multiple treatments. A treatment is a variation of a campaign that's
	// used for A/B testing.
	TreatmentName *string `type:"string"`

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

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

func (CampaignResponse) GoString 

func (s CampaignResponse) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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) SetArn added in v1.17.6 

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

SetArn sets the Arn field's value.

func (*CampaignResponse) SetCreationDate 

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

SetCreationDate sets the CreationDate field's value.

func (*CampaignResponse) SetCustomDeliveryConfiguration added in v1.30.13 

func (s *CampaignResponse) SetCustomDeliveryConfiguration(v *CustomDeliveryConfiguration) *CampaignResponse

SetCustomDeliveryConfiguration sets the CustomDeliveryConfiguration 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 

func (s *CampaignResponse) SetHook(v *CampaignHook) *CampaignResponse

SetHook sets the Hook field's value.

func (*CampaignResponse) SetId 

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

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 

func (s *CampaignResponse) SetLimits(v *CampaignLimits) *CampaignResponse

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) SetPriority added in v1.40.44 

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

SetPriority sets the Priority 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 

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

SetState sets the State field's value.

func (*CampaignResponse) SetTags added in v1.17.6 

func (s *CampaignResponse) SetTags(v map[string]*string) *CampaignResponse

SetTags sets the Tags field's value.

func (*CampaignResponse) SetTemplateConfiguration added in v1.25.7 

func (s *CampaignResponse) SetTemplateConfiguration(v *TemplateConfiguration) *CampaignResponse

SetTemplateConfiguration sets the TemplateConfiguration 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CampaignSmsMessage added in v1.8.38 

type CampaignSmsMessage struct {

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

	// The entity ID or Principal Entity (PE) id received from the regulatory body
	// for sending SMS in your country.
	EntityId *string `type:"string"`

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

	// The long code to send the SMS message from. This value should be one of the
	// dedicated long codes that's assigned to your AWS account. Although it isn't
	// required, we recommend that you specify the long code using an E.164 format
	// to ensure prompt and accurate delivery of the message. For example, +12065550100.
	OriginationNumber *string `type:"string"`

	// The sender ID to display on recipients' devices when they receive the SMS
	// message.
	SenderId *string `type:"string"`

	// The template ID received from the regulatory body for sending SMS in your
	// country.
	TemplateId *string `type:"string"`
	// contains filtered or unexported fields
}

Specifies the content and settings for an SMS message that's sent to recipients of a campaign.

func (CampaignSmsMessage) GoString added in v1.8.38 

func (s CampaignSmsMessage) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CampaignSmsMessage) SetBody added in v1.8.38 

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

SetBody sets the Body field's value.

func (*CampaignSmsMessage) SetEntityId added in v1.37.17 

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

SetEntityId sets the EntityId 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) SetOriginationNumber added in v1.37.11 

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

SetOriginationNumber sets the OriginationNumber 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) SetTemplateId added in v1.37.17 

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

SetTemplateId sets the TemplateId field's value.

func (CampaignSmsMessage) String added in v1.8.38 

func (s CampaignSmsMessage) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CampaignState 

type CampaignState struct {

	// The current status of the campaign, or the current status of a treatment
	// that belongs to an A/B test campaign.
	//
	// If a campaign uses A/B testing, the campaign has a status of COMPLETED only
	// if all campaign treatments have a status of COMPLETED. If you delete the
	// segment that's associated with a campaign, the campaign fails and has a status
	// of DELETED.
	CampaignStatus *string `type:"string" enum:"CampaignStatus"`
	// contains filtered or unexported fields
}

Provides information about the status of a campaign.

func (CampaignState) GoString 

func (s CampaignState) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CampaignsResponse 

type CampaignsResponse struct {

	// An array of responses, one for each campaign that's associated with the application.
	//
	// Item is a required field
	Item []*CampaignResponse `type:"list" required:"true"`

	// The string to use in a subsequent request to get the next page of results
	// in a paginated response. This value is null if there are no additional pages.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

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

func (CampaignsResponse) GoString 

func (s CampaignsResponse) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CampaignsResponse) SetItem 

func (s *CampaignsResponse) SetItem(v []*CampaignResponse) *CampaignsResponse

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ChannelResponse added in v1.14.20 

type ChannelResponse struct {

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

	// The date and time, in ISO 8601 format, when the channel was enabled.
	CreationDate *string `type:"string"`

	// Specifies whether the channel is enabled for the application.
	Enabled *bool `type:"boolean"`

	// (Not used) This property is retained only for backward compatibility.
	HasCredential *bool `type:"boolean"`

	// (Deprecated) An identifier for the channel. This property is retained only
	// for backward compatibility.
	Id *string `type:"string"`

	// Specifies whether the channel is archived.
	IsArchived *bool `type:"boolean"`

	// The user who last modified the channel.
	LastModifiedBy *string `type:"string"`

	// The date and time, in ISO 8601 format, when the channel was last modified.
	LastModifiedDate *string `type:"string"`

	// The current version of the channel.
	Version *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Provides information about the general settings and status of a channel for an application.

func (ChannelResponse) GoString added in v1.14.20 

func (s ChannelResponse) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ChannelResponse) SetApplicationId added in v1.14.20 

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

SetApplicationId sets the ApplicationId field's value.

func (*ChannelResponse) SetCreationDate added in v1.14.20 

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

SetCreationDate sets the CreationDate field's value.

func (*ChannelResponse) SetEnabled added in v1.14.20 

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

SetEnabled sets the Enabled field's value.

func (*ChannelResponse) SetHasCredential added in v1.14.20 

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

SetHasCredential sets the HasCredential field's value.

func (*ChannelResponse) SetId added in v1.14.20 

func (s *ChannelResponse) SetId(v string) *ChannelResponse

SetId sets the Id field's value.

func (*ChannelResponse) SetIsArchived added in v1.14.20 

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

SetIsArchived sets the IsArchived field's value.

func (*ChannelResponse) SetLastModifiedBy added in v1.14.20 

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

SetLastModifiedBy sets the LastModifiedBy field's value.

func (*ChannelResponse) SetLastModifiedDate added in v1.14.20 

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

SetLastModifiedDate sets the LastModifiedDate field's value.

func (*ChannelResponse) SetVersion added in v1.14.20 

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

SetVersion sets the Version field's value.

func (ChannelResponse) String added in v1.14.20 

func (s ChannelResponse) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ChannelsResponse added in v1.14.20 

type ChannelsResponse struct {

	// A map that contains a multipart response for each channel. For each item
	// in this object, the ChannelType is the key and the Channel is the value.
	//
	// Channels is a required field
	Channels map[string]*ChannelResponse `type:"map" required:"true"`
	// contains filtered or unexported fields
}

Provides information about the general settings and status of all channels for an application, including channels that aren't enabled for the application.

func (ChannelsResponse) GoString added in v1.14.20 

func (s ChannelsResponse) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ChannelsResponse) SetChannels added in v1.14.20 

func (s *ChannelsResponse) SetChannels(v map[string]*ChannelResponse) *ChannelsResponse

SetChannels sets the Channels field's value.

func (ChannelsResponse) String added in v1.14.20 

func (s ChannelsResponse) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Condition added in v1.25.25 

type Condition struct {

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

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

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

func (Condition) GoString added in v1.25.25 

func (s Condition) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Condition) SetConditions added in v1.25.25 

func (s *Condition) SetConditions(v []*SimpleCondition) *Condition

SetConditions sets the Conditions field's value.

func (*Condition) SetOperator added in v1.25.25 

func (s *Condition) SetOperator(v string) *Condition

SetOperator sets the Operator field's value.

func (Condition) String added in v1.25.25 

func (s Condition) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Condition) Validate added in v1.25.25 

func (s *Condition) Validate() error

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

type ConditionalSplitActivity added in v1.25.25 

type ConditionalSplitActivity struct {

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

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

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

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

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

To create yes/no split activities that send participants down different paths based on push notification events (such as Open or Received events), your mobile app has to specify the User ID and Endpoint ID values. For more information, see Integrating Amazon Pinpoint with your application (https://docs.aws.amazon.com/pinpoint/latest/developerguide/integrate.html) in the Amazon Pinpoint Developer Guide.

func (ConditionalSplitActivity) GoString added in v1.25.25 

func (s ConditionalSplitActivity) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ConditionalSplitActivity) SetCondition added in v1.25.25 

func (s *ConditionalSplitActivity) SetCondition(v *Condition) *ConditionalSplitActivity

SetCondition sets the Condition field's value.

func (*ConditionalSplitActivity) SetEvaluationWaitTime added in v1.25.25 

func (s *ConditionalSplitActivity) SetEvaluationWaitTime(v *WaitTime) *ConditionalSplitActivity

SetEvaluationWaitTime sets the EvaluationWaitTime field's value.

func (*ConditionalSplitActivity) SetFalseActivity added in v1.25.25 

func (s *ConditionalSplitActivity) SetFalseActivity(v string) *ConditionalSplitActivity

SetFalseActivity sets the FalseActivity field's value.

func (*ConditionalSplitActivity) SetTrueActivity added in v1.25.25 

func (s *ConditionalSplitActivity) SetTrueActivity(v string) *ConditionalSplitActivity

SetTrueActivity sets the TrueActivity field's value.

func (ConditionalSplitActivity) String added in v1.25.25 

func (s ConditionalSplitActivity) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ConditionalSplitActivity) Validate added in v1.25.25 

func (s *ConditionalSplitActivity) Validate() error

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

type ConflictException added in v1.35.0 

type ConflictException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`

	RequestID_ *string `locationName:"RequestID" type:"string"`
	// contains filtered or unexported fields
}

Provides information about an API request or response.

func (*ConflictException) Code added in v1.35.0 

func (s *ConflictException) Code() string

Code returns the exception type name.

func (*ConflictException) Error added in v1.35.0 

func (s *ConflictException) Error() string

func (ConflictException) GoString added in v1.35.0 

func (s ConflictException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ConflictException) Message added in v1.35.0 

func (s *ConflictException) Message() string

Message returns the exception's message.

func (*ConflictException) OrigErr added in v1.35.0 

func (s *ConflictException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ConflictException) RequestID added in v1.35.0 

func (s *ConflictException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ConflictException) StatusCode added in v1.35.0 

func (s *ConflictException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ConflictException) String added in v1.35.0 

func (s ConflictException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ContactCenterActivity added in v1.40.50 

type ContactCenterActivity struct {

	// The unique identifier for the next activity to perform after the this activity.
	NextActivity *string `type:"string"`
	// contains filtered or unexported fields
}

The settings for a connect activity. This type of activity initiates a contact center call to participants.

func (ContactCenterActivity) GoString added in v1.40.50 

func (s ContactCenterActivity) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ContactCenterActivity) SetNextActivity added in v1.40.50 

func (s *ContactCenterActivity) SetNextActivity(v string) *ContactCenterActivity

SetNextActivity sets the NextActivity field's value.

func (ContactCenterActivity) String added in v1.40.50 

func (s ContactCenterActivity) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateAppInput added in v1.10.20 

type CreateAppInput struct {

	// Specifies the display name of an application and the tags to associate with
	// the application.
	//
	// CreateApplicationRequest is a required field
	CreateApplicationRequest *CreateApplicationRequest `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (CreateAppInput) GoString added in v1.10.20 

func (s CreateAppInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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 {

	// Provides information about an application.
	//
	// 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateApplicationRequest added in v1.10.20 

type CreateApplicationRequest struct {

	// The display name of the application. This name is displayed as the Project
	// name on the Amazon Pinpoint console.
	//
	// Name is a required field
	Name *string `type:"string" required:"true"`

	// A string-to-string map of key-value pairs that defines the tags to associate
	// with the application. Each tag consists of a required tag key and an associated
	// tag value.
	Tags map[string]*string `locationName:"tags" type:"map"`
	// contains filtered or unexported fields
}

Specifies the display name of an application and the tags to associate with the application.

func (CreateApplicationRequest) GoString added in v1.10.20 

func (s CreateApplicationRequest) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateApplicationRequest) SetName added in v1.10.20 

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

SetName sets the Name field's value.

func (*CreateApplicationRequest) SetTags added in v1.17.6 

func (s *CreateApplicationRequest) SetTags(v map[string]*string) *CreateApplicationRequest

SetTags sets the Tags field's value.

func (CreateApplicationRequest) String added in v1.10.20 

func (s CreateApplicationRequest) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateApplicationRequest) Validate added in v1.20.11 

func (s *CreateApplicationRequest) Validate() error

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

type CreateCampaignInput 

type CreateCampaignInput struct {

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

	// Specifies the configuration and other settings for a campaign.
	//
	// WriteCampaignRequest is a required field
	WriteCampaignRequest *WriteCampaignRequest `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (CreateCampaignInput) GoString 

func (s CreateCampaignInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateCampaignInput) Validate 

func (s *CreateCampaignInput) Validate() error

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

type CreateCampaignOutput 

type CreateCampaignOutput struct {

	// Provides information about the status, configuration, and other settings
	// for a campaign.
	//
	// CampaignResponse is a required field
	CampaignResponse *CampaignResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (CreateCampaignOutput) GoString 

func (s CreateCampaignOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateEmailTemplateInput added in v1.25.7 

type CreateEmailTemplateInput struct {

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

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

func (CreateEmailTemplateInput) GoString added in v1.25.7 

func (s CreateEmailTemplateInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateEmailTemplateInput) SetEmailTemplateRequest added in v1.25.7 

func (s *CreateEmailTemplateInput) SetEmailTemplateRequest(v *EmailTemplateRequest) *CreateEmailTemplateInput

SetEmailTemplateRequest sets the EmailTemplateRequest field's value.

func (*CreateEmailTemplateInput) SetTemplateName added in v1.25.7 

func (s *CreateEmailTemplateInput) SetTemplateName(v string) *CreateEmailTemplateInput

SetTemplateName sets the TemplateName field's value.

func (CreateEmailTemplateInput) String added in v1.25.7 

func (s CreateEmailTemplateInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateEmailTemplateInput) Validate added in v1.25.7 

func (s *CreateEmailTemplateInput) Validate() error

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

type CreateEmailTemplateOutput added in v1.25.7 

type CreateEmailTemplateOutput struct {

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

func (CreateEmailTemplateOutput) GoString added in v1.25.7 

func (s CreateEmailTemplateOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateEmailTemplateOutput) SetCreateTemplateMessageBody added in v1.25.7 

func (s *CreateEmailTemplateOutput) SetCreateTemplateMessageBody(v *CreateTemplateMessageBody) *CreateEmailTemplateOutput

SetCreateTemplateMessageBody sets the CreateTemplateMessageBody field's value.

func (CreateEmailTemplateOutput) String added in v1.25.7 

func (s CreateEmailTemplateOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type 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"`

	// Specifies the settings for a job that exports endpoint definitions to an
	// Amazon Simple Storage Service (Amazon S3) bucket.
	//
	// ExportJobRequest is a required field
	ExportJobRequest *ExportJobRequest `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (CreateExportJobInput) GoString added in v1.13.11 

func (s CreateExportJobInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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 {

	// Provides information about the status and settings of a job that exports
	// endpoint definitions to a file. The file can be added directly to an Amazon
	// Simple Storage Service (Amazon S3) bucket by using the Amazon Pinpoint API
	// or downloaded directly to a computer by using the Amazon Pinpoint console.
	//
	// ExportJobResponse is a required field
	ExportJobResponse *ExportJobResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (CreateExportJobOutput) GoString added in v1.13.11 

func (s CreateExportJobOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateImportJobInput 

type CreateImportJobInput struct {

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

	// Specifies the settings for a job that imports endpoint definitions from an
	// Amazon Simple Storage Service (Amazon S3) bucket.
	//
	// ImportJobRequest is a required field
	ImportJobRequest *ImportJobRequest `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (CreateImportJobInput) GoString 

func (s CreateImportJobInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateImportJobInput) Validate 

func (s *CreateImportJobInput) Validate() error

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

type CreateImportJobOutput 

type CreateImportJobOutput struct {

	// Provides information about the status and settings of a job that imports
	// endpoint definitions from one or more files. The files can be stored in an
	// Amazon Simple Storage Service (Amazon S3) bucket or uploaded directly from
	// a computer by using the Amazon Pinpoint console.
	//
	// ImportJobResponse is a required field
	ImportJobResponse *ImportJobResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (CreateImportJobOutput) GoString 

func (s CreateImportJobOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateInAppTemplateInput added in v1.40.44 

type CreateInAppTemplateInput struct {

	// In-App Template Request.
	//
	// InAppTemplateRequest is a required field
	InAppTemplateRequest *InAppTemplateRequest `type:"structure" required:"true"`

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

func (CreateInAppTemplateInput) GoString added in v1.40.44 

func (s CreateInAppTemplateInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateInAppTemplateInput) SetInAppTemplateRequest added in v1.40.44 

func (s *CreateInAppTemplateInput) SetInAppTemplateRequest(v *InAppTemplateRequest) *CreateInAppTemplateInput

SetInAppTemplateRequest sets the InAppTemplateRequest field's value.

func (*CreateInAppTemplateInput) SetTemplateName added in v1.40.44 

func (s *CreateInAppTemplateInput) SetTemplateName(v string) *CreateInAppTemplateInput

SetTemplateName sets the TemplateName field's value.

func (CreateInAppTemplateInput) String added in v1.40.44 

func (s CreateInAppTemplateInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateInAppTemplateInput) Validate added in v1.40.44 

func (s *CreateInAppTemplateInput) Validate() error

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

type CreateInAppTemplateOutput added in v1.40.44 

type CreateInAppTemplateOutput struct {

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

func (CreateInAppTemplateOutput) GoString added in v1.40.44 

func (s CreateInAppTemplateOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateInAppTemplateOutput) SetTemplateCreateMessageBody added in v1.40.44 

func (s *CreateInAppTemplateOutput) SetTemplateCreateMessageBody(v *TemplateCreateMessageBody) *CreateInAppTemplateOutput

SetTemplateCreateMessageBody sets the TemplateCreateMessageBody field's value.

func (CreateInAppTemplateOutput) String added in v1.40.44 

func (s CreateInAppTemplateOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateJourneyInput added in v1.25.25 

type CreateJourneyInput struct {

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

	// Specifies the configuration and other settings for a journey.
	//
	// WriteJourneyRequest is a required field
	WriteJourneyRequest *WriteJourneyRequest `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (CreateJourneyInput) GoString added in v1.25.25 

func (s CreateJourneyInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateJourneyInput) SetApplicationId added in v1.25.25 

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

SetApplicationId sets the ApplicationId field's value.

func (*CreateJourneyInput) SetWriteJourneyRequest added in v1.25.25 

func (s *CreateJourneyInput) SetWriteJourneyRequest(v *WriteJourneyRequest) *CreateJourneyInput

SetWriteJourneyRequest sets the WriteJourneyRequest field's value.

func (CreateJourneyInput) String added in v1.25.25 

func (s CreateJourneyInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateJourneyInput) Validate added in v1.25.25 

func (s *CreateJourneyInput) Validate() error

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

type CreateJourneyOutput added in v1.25.25 

type CreateJourneyOutput struct {

	// Provides information about the status, configuration, and other settings
	// for a journey.
	//
	// JourneyResponse is a required field
	JourneyResponse *JourneyResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (CreateJourneyOutput) GoString added in v1.25.25 

func (s CreateJourneyOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateJourneyOutput) SetJourneyResponse added in v1.25.25 

func (s *CreateJourneyOutput) SetJourneyResponse(v *JourneyResponse) *CreateJourneyOutput

SetJourneyResponse sets the JourneyResponse field's value.

func (CreateJourneyOutput) String added in v1.25.25 

func (s CreateJourneyOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreatePushTemplateInput added in v1.25.7 

type CreatePushTemplateInput struct {

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

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

func (CreatePushTemplateInput) GoString added in v1.25.7 

func (s CreatePushTemplateInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreatePushTemplateInput) SetPushNotificationTemplateRequest added in v1.25.7 

func (s *CreatePushTemplateInput) SetPushNotificationTemplateRequest(v *PushNotificationTemplateRequest) *CreatePushTemplateInput

SetPushNotificationTemplateRequest sets the PushNotificationTemplateRequest field's value.

func (*CreatePushTemplateInput) SetTemplateName added in v1.25.7 

func (s *CreatePushTemplateInput) SetTemplateName(v string) *CreatePushTemplateInput

SetTemplateName sets the TemplateName field's value.

func (CreatePushTemplateInput) String added in v1.25.7 

func (s CreatePushTemplateInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreatePushTemplateInput) Validate added in v1.25.7 

func (s *CreatePushTemplateInput) Validate() error

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

type CreatePushTemplateOutput added in v1.25.7 

type CreatePushTemplateOutput struct {

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

func (CreatePushTemplateOutput) GoString added in v1.25.7 

func (s CreatePushTemplateOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreatePushTemplateOutput) SetCreateTemplateMessageBody added in v1.25.7 

func (s *CreatePushTemplateOutput) SetCreateTemplateMessageBody(v *CreateTemplateMessageBody) *CreatePushTemplateOutput

SetCreateTemplateMessageBody sets the CreateTemplateMessageBody field's value.

func (CreatePushTemplateOutput) String added in v1.25.7 

func (s CreatePushTemplateOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateRecommenderConfiguration added in v1.29.17 

type CreateRecommenderConfiguration struct {

	// A map of key-value pairs that defines 1-10 custom endpoint or user attributes,
	// depending on the value for the RecommendationProviderIdType property. Each
	// of these attributes temporarily stores a recommended item that's retrieved
	// from the recommender model and sent to an AWS Lambda function for additional
	// processing. Each attribute can be used as a message variable in a message
	// template.
	//
	// In the map, the key is the name of a custom attribute and the value is a
	// custom display name for that attribute. The display name appears in the Attribute
	// finder of the template editor on the Amazon Pinpoint console. The following
	// restrictions apply to these names:
	//
	//    * An attribute name must start with a letter or number and it can contain
	//    up to 50 characters. The characters can be letters, numbers, underscores
	//    (_), or hyphens (-). Attribute names are case sensitive and must be unique.
	//
	//    * An attribute display name must start with a letter or number and it
	//    can contain up to 25 characters. The characters can be letters, numbers,
	//    spaces, underscores (_), or hyphens (-).
	//
	// This object is required if the configuration invokes an AWS Lambda function
	// (RecommendationTransformerUri) to process recommendation data. Otherwise,
	// don't include this object in your request.
	Attributes map[string]*string `type:"map"`

	// A custom description of the configuration for the recommender model. The
	// description can contain up to 128 characters. The characters can be letters,
	// numbers, spaces, or the following symbols: _ ; () , ‐.
	Description *string `type:"string"`

	// A custom name of the configuration for the recommender model. The name must
	// start with a letter or number and it can contain up to 128 characters. The
	// characters can be letters, numbers, spaces, underscores (_), or hyphens (-).
	Name *string `type:"string"`

	// The type of Amazon Pinpoint ID to associate with unique user IDs in the recommender
	// model. This value enables the model to use attribute and event data that’s
	// specific to a particular endpoint or user in an Amazon Pinpoint application.
	// Valid values are:
	//
	//    * PINPOINT_ENDPOINT_ID - Associate each user in the model with a particular
	//    endpoint in Amazon Pinpoint. The data is correlated based on endpoint
	//    IDs in Amazon Pinpoint. This is the default value.
	//
	//    * PINPOINT_USER_ID - Associate each user in the model with a particular
	//    user and endpoint in Amazon Pinpoint. The data is correlated based on
	//    user IDs in Amazon Pinpoint. If you specify this value, an endpoint definition
	//    in Amazon Pinpoint has to specify both a user ID (UserId) and an endpoint
	//    ID. Otherwise, messages won’t be sent to the user's endpoint.
	RecommendationProviderIdType *string `type:"string"`

	// The Amazon Resource Name (ARN) of the AWS Identity and Access Management
	// (IAM) role that authorizes Amazon Pinpoint to retrieve recommendation data
	// from the recommender model.
	//
	// RecommendationProviderRoleArn is a required field
	RecommendationProviderRoleArn *string `type:"string" required:"true"`

	// The Amazon Resource Name (ARN) of the recommender model to retrieve recommendation
	// data from. This value must match the ARN of an Amazon Personalize campaign.
	//
	// RecommendationProviderUri is a required field
	RecommendationProviderUri *string `type:"string" required:"true"`

	// The name or Amazon Resource Name (ARN) of the AWS Lambda function to invoke
	// for additional processing of recommendation data that's retrieved from the
	// recommender model.
	RecommendationTransformerUri *string `type:"string"`

	// A custom display name for the standard endpoint or user attribute (RecommendationItems)
	// that temporarily stores recommended items for each endpoint or user, depending
	// on the value for the RecommendationProviderIdType property. This value is
	// required if the configuration doesn't invoke an AWS Lambda function (RecommendationTransformerUri)
	// to perform additional processing of recommendation data.
	//
	// This name appears in the Attribute finder of the template editor on the Amazon
	// Pinpoint console. The name can contain up to 25 characters. The characters
	// can be letters, numbers, spaces, underscores (_), or hyphens (-). These restrictions
	// don't apply to attribute values.
	RecommendationsDisplayName *string `type:"string"`

	// The number of recommended items to retrieve from the model for each endpoint
	// or user, depending on the value for the RecommendationProviderIdType property.
	// This number determines how many recommended items are available for use in
	// message variables. The minimum value is 1. The maximum value is 5. The default
	// value is 5.
	//
	// To use multiple recommended items and custom attributes with message variables,
	// you have to use an AWS Lambda function (RecommendationTransformerUri) to
	// perform additional processing of recommendation data.
	RecommendationsPerMessage *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Specifies Amazon Pinpoint configuration settings for retrieving and processing recommendation data from a recommender model.

func (CreateRecommenderConfiguration) GoString added in v1.29.17 

func (s CreateRecommenderConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateRecommenderConfiguration) SetAttributes added in v1.29.17 

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

SetAttributes sets the Attributes field's value.

func (*CreateRecommenderConfiguration) SetDescription added in v1.29.17 

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

SetDescription sets the Description field's value.

func (*CreateRecommenderConfiguration) SetName added in v1.29.17 

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

SetName sets the Name field's value.

func (*CreateRecommenderConfiguration) SetRecommendationProviderIdType added in v1.29.17 

func (s *CreateRecommenderConfiguration) SetRecommendationProviderIdType(v string) *CreateRecommenderConfiguration

SetRecommendationProviderIdType sets the RecommendationProviderIdType field's value.

func (*CreateRecommenderConfiguration) SetRecommendationProviderRoleArn added in v1.29.17 

func (s *CreateRecommenderConfiguration) SetRecommendationProviderRoleArn(v string) *CreateRecommenderConfiguration

SetRecommendationProviderRoleArn sets the RecommendationProviderRoleArn field's value.

func (*CreateRecommenderConfiguration) SetRecommendationProviderUri added in v1.29.17 

func (s *CreateRecommenderConfiguration) SetRecommendationProviderUri(v string) *CreateRecommenderConfiguration

SetRecommendationProviderUri sets the RecommendationProviderUri field's value.

func (*CreateRecommenderConfiguration) SetRecommendationTransformerUri added in v1.29.17 

func (s *CreateRecommenderConfiguration) SetRecommendationTransformerUri(v string) *CreateRecommenderConfiguration

SetRecommendationTransformerUri sets the RecommendationTransformerUri field's value.

func (*CreateRecommenderConfiguration) SetRecommendationsDisplayName added in v1.29.17 

func (s *CreateRecommenderConfiguration) SetRecommendationsDisplayName(v string) *CreateRecommenderConfiguration

SetRecommendationsDisplayName sets the RecommendationsDisplayName field's value.

func (*CreateRecommenderConfiguration) SetRecommendationsPerMessage added in v1.29.17 

func (s *CreateRecommenderConfiguration) SetRecommendationsPerMessage(v int64) *CreateRecommenderConfiguration

SetRecommendationsPerMessage sets the RecommendationsPerMessage field's value.

func (CreateRecommenderConfiguration) String added in v1.29.17 

func (s CreateRecommenderConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateRecommenderConfiguration) Validate added in v1.29.17 

func (s *CreateRecommenderConfiguration) Validate() error

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

type CreateRecommenderConfigurationInput added in v1.29.17 

type CreateRecommenderConfigurationInput struct {

	// Specifies Amazon Pinpoint configuration settings for retrieving and processing
	// recommendation data from a recommender model.
	//
	// CreateRecommenderConfiguration is a required field
	CreateRecommenderConfiguration *CreateRecommenderConfiguration `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (CreateRecommenderConfigurationInput) GoString added in v1.29.17 

func (s CreateRecommenderConfigurationInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateRecommenderConfigurationInput) SetCreateRecommenderConfiguration added in v1.29.17 

func (s *CreateRecommenderConfigurationInput) SetCreateRecommenderConfiguration(v *CreateRecommenderConfiguration) *CreateRecommenderConfigurationInput

SetCreateRecommenderConfiguration sets the CreateRecommenderConfiguration field's value.

func (CreateRecommenderConfigurationInput) String added in v1.29.17 

func (s CreateRecommenderConfigurationInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateRecommenderConfigurationInput) Validate added in v1.29.17 

func (s *CreateRecommenderConfigurationInput) Validate() error

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

type CreateRecommenderConfigurationOutput added in v1.29.17 

type CreateRecommenderConfigurationOutput struct {

	// Provides information about Amazon Pinpoint configuration settings for retrieving
	// and processing data from a recommender model.
	//
	// RecommenderConfigurationResponse is a required field
	RecommenderConfigurationResponse *RecommenderConfigurationResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (CreateRecommenderConfigurationOutput) GoString added in v1.29.17 

func (s CreateRecommenderConfigurationOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateRecommenderConfigurationOutput) SetRecommenderConfigurationResponse added in v1.29.17 

func (s *CreateRecommenderConfigurationOutput) SetRecommenderConfigurationResponse(v *RecommenderConfigurationResponse) *CreateRecommenderConfigurationOutput

SetRecommenderConfigurationResponse sets the RecommenderConfigurationResponse field's value.

func (CreateRecommenderConfigurationOutput) String added in v1.29.17 

func (s CreateRecommenderConfigurationOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateSegmentInput 

type CreateSegmentInput struct {

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

	// Specifies the configuration, dimension, and other settings for a segment.
	// A WriteSegmentRequest object can include a Dimensions object or a SegmentGroups
	// object, but not both.
	//
	// WriteSegmentRequest is a required field
	WriteSegmentRequest *WriteSegmentRequest `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (CreateSegmentInput) GoString 

func (s CreateSegmentInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateSegmentInput) Validate 

func (s *CreateSegmentInput) Validate() error

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

type CreateSegmentOutput 

type CreateSegmentOutput struct {

	// Provides information about the configuration, dimension, and other settings
	// for a segment.
	//
	// SegmentResponse is a required field
	SegmentResponse *SegmentResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (CreateSegmentOutput) GoString 

func (s CreateSegmentOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateSmsTemplateInput added in v1.25.7 

type CreateSmsTemplateInput struct {

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

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

func (CreateSmsTemplateInput) GoString added in v1.25.7 

func (s CreateSmsTemplateInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateSmsTemplateInput) SetSMSTemplateRequest added in v1.25.7 

func (s *CreateSmsTemplateInput) SetSMSTemplateRequest(v *SMSTemplateRequest) *CreateSmsTemplateInput

SetSMSTemplateRequest sets the SMSTemplateRequest field's value.

func (*CreateSmsTemplateInput) SetTemplateName added in v1.25.7 

func (s *CreateSmsTemplateInput) SetTemplateName(v string) *CreateSmsTemplateInput

SetTemplateName sets the TemplateName field's value.

func (CreateSmsTemplateInput) String added in v1.25.7 

func (s CreateSmsTemplateInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateSmsTemplateInput) Validate added in v1.25.7 

func (s *CreateSmsTemplateInput) Validate() error

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

type CreateSmsTemplateOutput added in v1.25.7 

type CreateSmsTemplateOutput struct {

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

func (CreateSmsTemplateOutput) GoString added in v1.25.7 

func (s CreateSmsTemplateOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateSmsTemplateOutput) SetCreateTemplateMessageBody added in v1.25.7 

func (s *CreateSmsTemplateOutput) SetCreateTemplateMessageBody(v *CreateTemplateMessageBody) *CreateSmsTemplateOutput

SetCreateTemplateMessageBody sets the CreateTemplateMessageBody field's value.

func (CreateSmsTemplateOutput) String added in v1.25.7 

func (s CreateSmsTemplateOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateTemplateMessageBody added in v1.25.7 

type CreateTemplateMessageBody struct {

	// The Amazon Resource Name (ARN) of the message template that was created.
	Arn *string `type:"string"`

	// The message that's returned from the API for the request to create the message
	// template.
	Message *string `type:"string"`

	// The unique identifier for the request to create the message template.
	RequestID *string `type:"string"`
	// contains filtered or unexported fields
}

Provides information about a request to create a message template.

func (CreateTemplateMessageBody) GoString added in v1.25.7 

func (s CreateTemplateMessageBody) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateTemplateMessageBody) SetArn added in v1.25.7 

func (s *CreateTemplateMessageBody) SetArn(v string) *CreateTemplateMessageBody

SetArn sets the Arn field's value.

func (*CreateTemplateMessageBody) SetMessage added in v1.25.7 

func (s *CreateTemplateMessageBody) SetMessage(v string) *CreateTemplateMessageBody

SetMessage sets the Message field's value.

func (*CreateTemplateMessageBody) SetRequestID added in v1.25.7 

func (s *CreateTemplateMessageBody) SetRequestID(v string) *CreateTemplateMessageBody

SetRequestID sets the RequestID field's value.

func (CreateTemplateMessageBody) String added in v1.25.7 

func (s CreateTemplateMessageBody) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateVoiceTemplateInput added in v1.25.37 

type CreateVoiceTemplateInput struct {

	// TemplateName is a required field
	TemplateName *string `location:"uri" locationName:"template-name" type:"string" required:"true"`

	// Specifies the content and settings for a message template that can be used
	// in messages that are sent through the voice channel.
	//
	// VoiceTemplateRequest is a required field
	VoiceTemplateRequest *VoiceTemplateRequest `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (CreateVoiceTemplateInput) GoString added in v1.25.37 

func (s CreateVoiceTemplateInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateVoiceTemplateInput) SetTemplateName added in v1.25.37 

func (s *CreateVoiceTemplateInput) SetTemplateName(v string) *CreateVoiceTemplateInput

SetTemplateName sets the TemplateName field's value.

func (*CreateVoiceTemplateInput) SetVoiceTemplateRequest added in v1.25.37 

func (s *CreateVoiceTemplateInput) SetVoiceTemplateRequest(v *VoiceTemplateRequest) *CreateVoiceTemplateInput

SetVoiceTemplateRequest sets the VoiceTemplateRequest field's value.

func (CreateVoiceTemplateInput) String added in v1.25.37 

func (s CreateVoiceTemplateInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateVoiceTemplateInput) Validate added in v1.25.37 

func (s *CreateVoiceTemplateInput) Validate() error

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

type CreateVoiceTemplateOutput added in v1.25.37 

type CreateVoiceTemplateOutput struct {

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

func (CreateVoiceTemplateOutput) GoString added in v1.25.37 

func (s CreateVoiceTemplateOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateVoiceTemplateOutput) SetCreateTemplateMessageBody added in v1.25.37 

func (s *CreateVoiceTemplateOutput) SetCreateTemplateMessageBody(v *CreateTemplateMessageBody) *CreateVoiceTemplateOutput

SetCreateTemplateMessageBody sets the CreateTemplateMessageBody field's value.

func (CreateVoiceTemplateOutput) String added in v1.25.37 

func (s CreateVoiceTemplateOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CustomDeliveryConfiguration added in v1.30.13 

type CustomDeliveryConfiguration struct {

	// The destination to send the campaign or treatment to. This value can be one
	// of the following:
	//
	//    * The name or Amazon Resource Name (ARN) of an AWS Lambda function to
	//    invoke to handle delivery of the campaign or treatment.
	//
	//    * The URL for a web application or service that supports HTTPS and can
	//    receive the message. The URL has to be a full URL, including the HTTPS
	//    protocol.
	//
	// DeliveryUri is a required field
	DeliveryUri *string `type:"string" required:"true"`

	// The types of endpoints to send the campaign or treatment to. Each valid value
	// maps to a type of channel that you can associate with an endpoint by using
	// the ChannelType property of an endpoint.
	EndpointTypes []*string `type:"list" enum:"EndpointTypesElement"`
	// contains filtered or unexported fields
}

Specifies the delivery configuration settings for sending a campaign or campaign treatment through a custom channel. This object is required if you use the CampaignCustomMessage object to define the message to send for the campaign or campaign treatment.

func (CustomDeliveryConfiguration) GoString added in v1.30.13 

func (s CustomDeliveryConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CustomDeliveryConfiguration) SetDeliveryUri added in v1.30.13 

func (s *CustomDeliveryConfiguration) SetDeliveryUri(v string) *CustomDeliveryConfiguration

SetDeliveryUri sets the DeliveryUri field's value.

func (*CustomDeliveryConfiguration) SetEndpointTypes added in v1.30.13 

func (s *CustomDeliveryConfiguration) SetEndpointTypes(v []*string) *CustomDeliveryConfiguration

SetEndpointTypes sets the EndpointTypes field's value.

func (CustomDeliveryConfiguration) String added in v1.30.13 

func (s CustomDeliveryConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CustomDeliveryConfiguration) Validate added in v1.30.13 

func (s *CustomDeliveryConfiguration) Validate() error

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

type CustomMessageActivity added in v1.31.12 

type CustomMessageActivity struct {

	// The destination to send the campaign or treatment to. This value can be one
	// of the following:
	//
	//    * The name or Amazon Resource Name (ARN) of an AWS Lambda function to
	//    invoke to handle delivery of the campaign or treatment.
	//
	//    * The URL for a web application or service that supports HTTPS and can
	//    receive the message. The URL has to be a full URL, including the HTTPS
	//    protocol.
	DeliveryUri *string `type:"string"`

	// The types of endpoints to send the custom message to. Each valid value maps
	// to a type of channel that you can associate with an endpoint by using the
	// ChannelType property of an endpoint.
	EndpointTypes []*string `type:"list" enum:"EndpointTypesElement"`

	// Specifies the message data included in a custom channel message that's sent
	// to participants in a journey.
	MessageConfig *JourneyCustomMessage `type:"structure"`

	// The unique identifier for the next activity to perform, after Amazon Pinpoint
	// calls the AWS Lambda function or web hook.
	NextActivity *string `type:"string"`

	// The name of the custom message template to use for the message. If specified,
	// this value must match the name of an existing message template.
	TemplateName *string `type:"string"`

	// The unique identifier for the version of the message template to use for
	// the message. If specified, this value must match the identifier for an existing
	// template version. To retrieve a list of versions and version identifiers
	// for a template, use the Template Versions resource.
	//
	// If you don't specify a value for this property, Amazon Pinpoint uses the
	// active version of the template. The active version is typically the version
	// of a template that's been most recently reviewed and approved for use, depending
	// on your workflow. It isn't necessarily the latest version of a template.
	TemplateVersion *string `type:"string"`
	// contains filtered or unexported fields
}

The settings for a custom message activity. This type of activity calls an AWS Lambda function or web hook that sends messages to participants.

func (CustomMessageActivity) GoString added in v1.31.12 

func (s CustomMessageActivity) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CustomMessageActivity) SetDeliveryUri added in v1.31.12 

func (s *CustomMessageActivity) SetDeliveryUri(v string) *CustomMessageActivity

SetDeliveryUri sets the DeliveryUri field's value.

func (*CustomMessageActivity) SetEndpointTypes added in v1.31.12 

func (s *CustomMessageActivity) SetEndpointTypes(v []*string) *CustomMessageActivity

SetEndpointTypes sets the EndpointTypes field's value.

func (*CustomMessageActivity) SetMessageConfig added in v1.31.12 

func (s *CustomMessageActivity) SetMessageConfig(v *JourneyCustomMessage) *CustomMessageActivity

SetMessageConfig sets the MessageConfig field's value.

func (*CustomMessageActivity) SetNextActivity added in v1.31.12 

func (s *CustomMessageActivity) SetNextActivity(v string) *CustomMessageActivity

SetNextActivity sets the NextActivity field's value.

func (*CustomMessageActivity) SetTemplateName added in v1.31.12 

func (s *CustomMessageActivity) SetTemplateName(v string) *CustomMessageActivity

SetTemplateName sets the TemplateName field's value.

func (*CustomMessageActivity) SetTemplateVersion added in v1.31.12 

func (s *CustomMessageActivity) SetTemplateVersion(v string) *CustomMessageActivity

SetTemplateVersion sets the TemplateVersion field's value.

func (CustomMessageActivity) String added in v1.31.12 

func (s CustomMessageActivity) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DefaultButtonConfiguration added in v1.40.44 

type DefaultButtonConfiguration struct {

	// The background color of the button.
	BackgroundColor *string `type:"string"`

	// The border radius of the button.
	BorderRadius *int64 `type:"integer"`

	// Action triggered by the button.
	//
	// ButtonAction is a required field
	ButtonAction *string `type:"string" required:"true" enum:"ButtonAction"`

	// Button destination.
	Link *string `type:"string"`

	// Button text.
	//
	// Text is a required field
	Text *string `type:"string" required:"true"`

	// The text color of the button.
	TextColor *string `type:"string"`
	// contains filtered or unexported fields
}

Default button configuration.

func (DefaultButtonConfiguration) GoString added in v1.40.44 

func (s DefaultButtonConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DefaultButtonConfiguration) SetBackgroundColor added in v1.40.44 

func (s *DefaultButtonConfiguration) SetBackgroundColor(v string) *DefaultButtonConfiguration

SetBackgroundColor sets the BackgroundColor field's value.

func (*DefaultButtonConfiguration) SetBorderRadius added in v1.40.44 

func (s *DefaultButtonConfiguration) SetBorderRadius(v int64) *DefaultButtonConfiguration

SetBorderRadius sets the BorderRadius field's value.

func (*DefaultButtonConfiguration) SetButtonAction added in v1.40.44 

func (s *DefaultButtonConfiguration) SetButtonAction(v string) *DefaultButtonConfiguration

SetButtonAction sets the ButtonAction field's value. 

func (s *DefaultButtonConfiguration) SetLink(v string) *DefaultButtonConfiguration

SetLink sets the Link field's value.

func (*DefaultButtonConfiguration) SetText added in v1.40.44 

func (s *DefaultButtonConfiguration) SetText(v string) *DefaultButtonConfiguration

SetText sets the Text field's value.

func (*DefaultButtonConfiguration) SetTextColor added in v1.40.44 

func (s *DefaultButtonConfiguration) SetTextColor(v string) *DefaultButtonConfiguration

SetTextColor sets the TextColor field's value.

func (DefaultButtonConfiguration) String added in v1.40.44 

func (s DefaultButtonConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DefaultButtonConfiguration) Validate added in v1.40.44 

func (s *DefaultButtonConfiguration) Validate() error

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

type DefaultMessage added in v1.8.38 

type DefaultMessage struct {

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

	// The default message variables to use in the message. You can override these
	// default variables with individual address variables.
	Substitutions map[string][]*string `type:"map"`
	// contains filtered or unexported fields
}

Specifies the default message for all channels.

func (DefaultMessage) GoString added in v1.8.38 

func (s DefaultMessage) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DefaultPushNotificationMessage added in v1.8.38 

type DefaultPushNotificationMessage struct {

	// The default action to occur if a recipient taps the push notification. Valid
	// values are:
	//
	//    * OPEN_APP - Your app opens or it becomes the foreground app if it was
	//    sent to the background. This is the default action.
	//
	//    * DEEP_LINK - Your app opens and displays a designated user interface
	//    in the app. This setting uses the deep-linking features of the iOS and
	//    Android platforms.
	//
	//    * URL - The default mobile browser on the recipient's device opens and
	//    loads the web page at a URL that you specify.
	Action *string `type:"string" enum:"Action"`

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

	// The JSON data payload to use for the default push notification, if the notification
	// is a silent push notification. This payload is added to the data.pinpoint.jsonBody
	// object of the notification.
	Data map[string]*string `type:"map"`

	// Specifies whether the default notification is a silent push notification,
	// which is a push notification that doesn't display on a recipient's device.
	// Silent push notifications can be used for cases such as updating an app's
	// configuration or delivering messages to an in-app notification center.
	SilentPush *bool `type:"boolean"`

	// The default message variables to use in the notification message. You can
	// override the default variables with individual address variables.
	Substitutions map[string][]*string `type:"map"`

	// The default title to display above the notification message on a recipient's
	// device.
	Title *string `type:"string"`

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

Specifies the default settings and content for a push notification that's sent directly to an endpoint.

func (DefaultPushNotificationMessage) GoString added in v1.8.38 

func (s DefaultPushNotificationMessage) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DefaultPushNotificationMessage) SetAction added in v1.8.38 

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

SetAction sets the Action field's value.

func (*DefaultPushNotificationMessage) SetBody added in v1.8.38 

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

SetBody sets the Body field's value.

func (*DefaultPushNotificationMessage) SetData added in v1.8.38 

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

SetData sets the Data field's value.

func (*DefaultPushNotificationMessage) SetSilentPush added in v1.8.38 

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

SetSilentPush sets the SilentPush field's value.

func (*DefaultPushNotificationMessage) SetSubstitutions added in v1.8.38 

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

SetSubstitutions sets the Substitutions field's value.

func (*DefaultPushNotificationMessage) SetTitle added in v1.8.38 

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

SetTitle sets the Title field's value.

func (*DefaultPushNotificationMessage) SetUrl added in v1.8.38 

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

SetUrl sets the Url field's value.

func (DefaultPushNotificationMessage) String added in v1.8.38 

func (s DefaultPushNotificationMessage) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DefaultPushNotificationTemplate added in v1.25.7 

type DefaultPushNotificationTemplate struct {

	// The action to occur if a recipient taps a push notification that's based
	// on the message template. Valid values are:
	//
	//    * OPEN_APP - Your app opens or it becomes the foreground app if it was
	//    sent to the background. This is the default action.
	//
	//    * DEEP_LINK - Your app opens and displays a designated user interface
	//    in the app. This setting uses the deep-linking features of the iOS and
	//    Android platforms.
	//
	//    * URL - The default mobile browser on the recipient's device opens and
	//    loads the web page at a URL that you specify.
	Action *string `type:"string" enum:"Action"`

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

	// The sound to play when a recipient receives a push notification that's based
	// on the message template. You can use the default stream or specify the file
	// name of a sound resource that's bundled in your app. On an Android platform,
	// the sound file must reside in /res/raw/.
	//
	// For an iOS platform, this value is the key for the name of a sound file in
	// your app's main bundle or the Library/Sounds folder in your app's data container.
	// If the sound file can't be found or you specify default for the value, the
	// system plays the default alert sound.
	Sound *string `type:"string"`

	// The title to use in push notifications that are based on the message template.
	// This title appears above the notification message on a recipient's device.
	Title *string `type:"string"`

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

Specifies the default settings and content for a message template that can be used in messages that are sent through a push notification channel.

func (DefaultPushNotificationTemplate) GoString added in v1.25.7 

func (s DefaultPushNotificationTemplate) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DefaultPushNotificationTemplate) SetAction added in v1.25.7 

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

SetAction sets the Action field's value.

func (*DefaultPushNotificationTemplate) SetBody added in v1.25.7 

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

SetBody sets the Body field's value.

func (*DefaultPushNotificationTemplate) SetSound added in v1.25.7 

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

SetSound sets the Sound field's value.

func (*DefaultPushNotificationTemplate) SetTitle added in v1.25.7 

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

SetTitle sets the Title field's value.

func (*DefaultPushNotificationTemplate) SetUrl added in v1.25.7 

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

SetUrl sets the Url field's value.

func (DefaultPushNotificationTemplate) String added in v1.25.7 

func (s DefaultPushNotificationTemplate) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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 {

	// Provides information about the status and settings of the ADM (Amazon Device
	// Messaging) channel for an application.
	//
	// ADMChannelResponse is a required field
	ADMChannelResponse *ADMChannelResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteAdmChannelOutput) GoString added in v1.12.1 

func (s DeleteAdmChannelOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteAdmChannelOutput) SetADMChannelResponse added in v1.12.1 

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

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteApnsChannelInput) Validate 

func (s *DeleteApnsChannelInput) Validate() error

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

type DeleteApnsChannelOutput 

type DeleteApnsChannelOutput struct {

	// Provides information about the status and settings of the APNs (Apple Push
	// Notification service) channel for an application.
	//
	// APNSChannelResponse is a required field
	APNSChannelResponse *APNSChannelResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteApnsChannelOutput) GoString 

func (s DeleteApnsChannelOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteApnsChannelOutput) SetAPNSChannelResponse 

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

SetAPNSChannelResponse sets the APNSChannelResponse field's value.

func (DeleteApnsChannelOutput) String 

func (s DeleteApnsChannelOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type 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 

func (s DeleteApnsSandboxChannelInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteApnsSandboxChannelInput) SetApplicationId added in v1.8.38 

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

SetApplicationId sets the ApplicationId field's value.

func (DeleteApnsSandboxChannelInput) String added in v1.8.38 

func (s DeleteApnsSandboxChannelInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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 {

	// Provides information about the status and settings of the APNs (Apple Push
	// Notification service) sandbox channel for an application.
	//
	// APNSSandboxChannelResponse is a required field
	APNSSandboxChannelResponse *APNSSandboxChannelResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteApnsSandboxChannelOutput) GoString added in v1.8.38 

func (s DeleteApnsSandboxChannelOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteApnsSandboxChannelOutput) SetAPNSSandboxChannelResponse added in v1.8.38 

func (s *DeleteApnsSandboxChannelOutput) SetAPNSSandboxChannelResponse(v *APNSSandboxChannelResponse) *DeleteApnsSandboxChannelOutput

SetAPNSSandboxChannelResponse sets the APNSSandboxChannelResponse field's value.

func (DeleteApnsSandboxChannelOutput) String added in v1.8.38 

func (s DeleteApnsSandboxChannelOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteApnsVoipChannelInput) SetApplicationId added in v1.12.17 

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

SetApplicationId sets the ApplicationId field's value.

func (DeleteApnsVoipChannelInput) String added in v1.12.17 

func (s DeleteApnsVoipChannelInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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 {

	// Provides information about the status and settings of the APNs (Apple Push
	// Notification service) VoIP channel for an application.
	//
	// APNSVoipChannelResponse is a required field
	APNSVoipChannelResponse *APNSVoipChannelResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteApnsVoipChannelOutput) GoString added in v1.12.17 

func (s DeleteApnsVoipChannelOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteApnsVoipChannelOutput) SetAPNSVoipChannelResponse added in v1.12.17 

func (s *DeleteApnsVoipChannelOutput) SetAPNSVoipChannelResponse(v *APNSVoipChannelResponse) *DeleteApnsVoipChannelOutput

SetAPNSVoipChannelResponse sets the APNSVoipChannelResponse field's value.

func (DeleteApnsVoipChannelOutput) String added in v1.12.17 

func (s DeleteApnsVoipChannelOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type 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 

func (s DeleteApnsVoipSandboxChannelInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteApnsVoipSandboxChannelInput) SetApplicationId added in v1.12.17 

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

SetApplicationId sets the ApplicationId field's value.

func (DeleteApnsVoipSandboxChannelInput) String added in v1.12.17 

func (s DeleteApnsVoipSandboxChannelInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteApnsVoipSandboxChannelInput) Validate added in v1.12.17 

func (s *DeleteApnsVoipSandboxChannelInput) Validate() error

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

type DeleteApnsVoipSandboxChannelOutput added in v1.12.17 

type DeleteApnsVoipSandboxChannelOutput struct {

	// Provides information about the status and settings of the APNs (Apple Push
	// Notification service) VoIP sandbox channel for an application.
	//
	// APNSVoipSandboxChannelResponse is a required field
	APNSVoipSandboxChannelResponse *APNSVoipSandboxChannelResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteApnsVoipSandboxChannelOutput) GoString added in v1.12.17 

func (s DeleteApnsVoipSandboxChannelOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteApnsVoipSandboxChannelOutput) SetAPNSVoipSandboxChannelResponse added in v1.12.17 

func (s *DeleteApnsVoipSandboxChannelOutput) SetAPNSVoipSandboxChannelResponse(v *APNSVoipSandboxChannelResponse) *DeleteApnsVoipSandboxChannelOutput

SetAPNSVoipSandboxChannelResponse sets the APNSVoipSandboxChannelResponse field's value.

func (DeleteApnsVoipSandboxChannelOutput) String added in v1.12.17 

func (s DeleteApnsVoipSandboxChannelOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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 {

	// Provides information about an application.
	//
	// 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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 {

	// Provides information about the status and settings of the Baidu (Baidu Cloud
	// Push) channel for an application.
	//
	// BaiduChannelResponse is a required field
	BaiduChannelResponse *BaiduChannelResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteBaiduChannelOutput) GoString added in v1.12.1 

func (s DeleteBaiduChannelOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteBaiduChannelOutput) SetBaiduChannelResponse added in v1.12.1 

func (s *DeleteBaiduChannelOutput) SetBaiduChannelResponse(v *BaiduChannelResponse) *DeleteBaiduChannelOutput

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteCampaignInput) Validate 

func (s *DeleteCampaignInput) Validate() error

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

type DeleteCampaignOutput 

type DeleteCampaignOutput struct {

	// Provides information about the status, configuration, and other settings
	// for a campaign.
	//
	// CampaignResponse is a required field
	CampaignResponse *CampaignResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteCampaignOutput) GoString 

func (s DeleteCampaignOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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 {

	// Provides information about the status and settings of the email channel for
	// an application.
	//
	// EmailChannelResponse is a required field
	EmailChannelResponse *EmailChannelResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteEmailChannelOutput) GoString added in v1.8.38 

func (s DeleteEmailChannelOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteEmailChannelOutput) SetEmailChannelResponse added in v1.8.38 

func (s *DeleteEmailChannelOutput) SetEmailChannelResponse(v *EmailChannelResponse) *DeleteEmailChannelOutput

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteEmailTemplateInput added in v1.25.7 

type DeleteEmailTemplateInput struct {

	// TemplateName is a required field
	TemplateName *string `location:"uri" locationName:"template-name" type:"string" required:"true"`

	Version *string `location:"querystring" locationName:"version" type:"string"`
	// contains filtered or unexported fields
}

func (DeleteEmailTemplateInput) GoString added in v1.25.7 

func (s DeleteEmailTemplateInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteEmailTemplateInput) SetTemplateName added in v1.25.7 

func (s *DeleteEmailTemplateInput) SetTemplateName(v string) *DeleteEmailTemplateInput

SetTemplateName sets the TemplateName field's value.

func (*DeleteEmailTemplateInput) SetVersion added in v1.26.7 

func (s *DeleteEmailTemplateInput) SetVersion(v string) *DeleteEmailTemplateInput

SetVersion sets the Version field's value.

func (DeleteEmailTemplateInput) String added in v1.25.7 

func (s DeleteEmailTemplateInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteEmailTemplateInput) Validate added in v1.25.7 

func (s *DeleteEmailTemplateInput) Validate() error

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

type DeleteEmailTemplateOutput added in v1.25.7 

type DeleteEmailTemplateOutput struct {

	// Provides information about an API request or response.
	//
	// MessageBody is a required field
	MessageBody *MessageBody `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteEmailTemplateOutput) GoString added in v1.25.7 

func (s DeleteEmailTemplateOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteEmailTemplateOutput) SetMessageBody added in v1.25.7 

func (s *DeleteEmailTemplateOutput) SetMessageBody(v *MessageBody) *DeleteEmailTemplateOutput

SetMessageBody sets the MessageBody field's value.

func (DeleteEmailTemplateOutput) String added in v1.25.7 

func (s DeleteEmailTemplateOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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 {

	// Provides information about the channel type and other settings for an endpoint.
	//
	// EndpointResponse is a required field
	EndpointResponse *EndpointResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteEndpointOutput) GoString added in v1.13.15 

func (s DeleteEndpointOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteEventStreamInput added in v1.8.0 

type DeleteEventStreamInput struct {

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

func (DeleteEventStreamInput) GoString added in v1.8.0 

func (s DeleteEventStreamInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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 {

	// Specifies settings for publishing event data to an Amazon Kinesis data stream
	// or an Amazon Kinesis Data Firehose delivery stream.
	//
	// EventStream is a required field
	EventStream *EventStream `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteEventStreamOutput) GoString added in v1.8.0 

func (s DeleteEventStreamOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteEventStreamOutput) SetEventStream added in v1.8.0 

func (s *DeleteEventStreamOutput) SetEventStream(v *EventStream) *DeleteEventStreamOutput

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteGcmChannelInput) Validate 

func (s *DeleteGcmChannelInput) Validate() error

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

type DeleteGcmChannelOutput 

type DeleteGcmChannelOutput struct {

	// Provides information about the status and settings of the GCM channel for
	// an application. The GCM channel enables Amazon Pinpoint to send push notifications
	// through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging
	// (GCM), service.
	//
	// GCMChannelResponse is a required field
	GCMChannelResponse *GCMChannelResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteGcmChannelOutput) GoString 

func (s DeleteGcmChannelOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteGcmChannelOutput) SetGCMChannelResponse 

func (s *DeleteGcmChannelOutput) SetGCMChannelResponse(v *GCMChannelResponse) *DeleteGcmChannelOutput

SetGCMChannelResponse sets the GCMChannelResponse field's value.

func (DeleteGcmChannelOutput) String 

func (s DeleteGcmChannelOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteInAppTemplateInput added in v1.40.44 

type DeleteInAppTemplateInput struct {

	// TemplateName is a required field
	TemplateName *string `location:"uri" locationName:"template-name" type:"string" required:"true"`

	Version *string `location:"querystring" locationName:"version" type:"string"`
	// contains filtered or unexported fields
}

func (DeleteInAppTemplateInput) GoString added in v1.40.44 

func (s DeleteInAppTemplateInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteInAppTemplateInput) SetTemplateName added in v1.40.44 

func (s *DeleteInAppTemplateInput) SetTemplateName(v string) *DeleteInAppTemplateInput

SetTemplateName sets the TemplateName field's value.

func (*DeleteInAppTemplateInput) SetVersion added in v1.40.44 

func (s *DeleteInAppTemplateInput) SetVersion(v string) *DeleteInAppTemplateInput

SetVersion sets the Version field's value.

func (DeleteInAppTemplateInput) String added in v1.40.44 

func (s DeleteInAppTemplateInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteInAppTemplateInput) Validate added in v1.40.44 

func (s *DeleteInAppTemplateInput) Validate() error

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

type DeleteInAppTemplateOutput added in v1.40.44 

type DeleteInAppTemplateOutput struct {

	// Provides information about an API request or response.
	//
	// MessageBody is a required field
	MessageBody *MessageBody `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteInAppTemplateOutput) GoString added in v1.40.44 

func (s DeleteInAppTemplateOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteInAppTemplateOutput) SetMessageBody added in v1.40.44 

func (s *DeleteInAppTemplateOutput) SetMessageBody(v *MessageBody) *DeleteInAppTemplateOutput

SetMessageBody sets the MessageBody field's value.

func (DeleteInAppTemplateOutput) String added in v1.40.44 

func (s DeleteInAppTemplateOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteJourneyInput added in v1.25.25 

type DeleteJourneyInput struct {

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

	// JourneyId is a required field
	JourneyId *string `location:"uri" locationName:"journey-id" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteJourneyInput) GoString added in v1.25.25 

func (s DeleteJourneyInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteJourneyInput) SetApplicationId added in v1.25.25 

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

SetApplicationId sets the ApplicationId field's value.

func (*DeleteJourneyInput) SetJourneyId added in v1.25.25 

func (s *DeleteJourneyInput) SetJourneyId(v string) *DeleteJourneyInput

SetJourneyId sets the JourneyId field's value.

func (DeleteJourneyInput) String added in v1.25.25 

func (s DeleteJourneyInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteJourneyInput) Validate added in v1.25.25 

func (s *DeleteJourneyInput) Validate() error

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

type DeleteJourneyOutput added in v1.25.25 

type DeleteJourneyOutput struct {

	// Provides information about the status, configuration, and other settings
	// for a journey.
	//
	// JourneyResponse is a required field
	JourneyResponse *JourneyResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteJourneyOutput) GoString added in v1.25.25 

func (s DeleteJourneyOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteJourneyOutput) SetJourneyResponse added in v1.25.25 

func (s *DeleteJourneyOutput) SetJourneyResponse(v *JourneyResponse) *DeleteJourneyOutput

SetJourneyResponse sets the JourneyResponse field's value.

func (DeleteJourneyOutput) String added in v1.25.25 

func (s DeleteJourneyOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeletePushTemplateInput added in v1.25.7 

type DeletePushTemplateInput struct {

	// TemplateName is a required field
	TemplateName *string `location:"uri" locationName:"template-name" type:"string" required:"true"`

	Version *string `location:"querystring" locationName:"version" type:"string"`
	// contains filtered or unexported fields
}

func (DeletePushTemplateInput) GoString added in v1.25.7 

func (s DeletePushTemplateInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeletePushTemplateInput) SetTemplateName added in v1.25.7 

func (s *DeletePushTemplateInput) SetTemplateName(v string) *DeletePushTemplateInput

SetTemplateName sets the TemplateName field's value.

func (*DeletePushTemplateInput) SetVersion added in v1.26.7 

func (s *DeletePushTemplateInput) SetVersion(v string) *DeletePushTemplateInput

SetVersion sets the Version field's value.

func (DeletePushTemplateInput) String added in v1.25.7 

func (s DeletePushTemplateInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeletePushTemplateInput) Validate added in v1.25.7 

func (s *DeletePushTemplateInput) Validate() error

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

type DeletePushTemplateOutput added in v1.25.7 

type DeletePushTemplateOutput struct {

	// Provides information about an API request or response.
	//
	// MessageBody is a required field
	MessageBody *MessageBody `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (DeletePushTemplateOutput) GoString added in v1.25.7 

func (s DeletePushTemplateOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeletePushTemplateOutput) SetMessageBody added in v1.25.7 

func (s *DeletePushTemplateOutput) SetMessageBody(v *MessageBody) *DeletePushTemplateOutput

SetMessageBody sets the MessageBody field's value.

func (DeletePushTemplateOutput) String added in v1.25.7 

func (s DeletePushTemplateOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteRecommenderConfigurationInput added in v1.29.17 

type DeleteRecommenderConfigurationInput struct {

	// RecommenderId is a required field
	RecommenderId *string `location:"uri" locationName:"recommender-id" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteRecommenderConfigurationInput) GoString added in v1.29.17 

func (s DeleteRecommenderConfigurationInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteRecommenderConfigurationInput) SetRecommenderId added in v1.29.17 

func (s *DeleteRecommenderConfigurationInput) SetRecommenderId(v string) *DeleteRecommenderConfigurationInput

SetRecommenderId sets the RecommenderId field's value.

func (DeleteRecommenderConfigurationInput) String added in v1.29.17 

func (s DeleteRecommenderConfigurationInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteRecommenderConfigurationInput) Validate added in v1.29.17 

func (s *DeleteRecommenderConfigurationInput) Validate() error

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

type DeleteRecommenderConfigurationOutput added in v1.29.17 

type DeleteRecommenderConfigurationOutput struct {

	// Provides information about Amazon Pinpoint configuration settings for retrieving
	// and processing data from a recommender model.
	//
	// RecommenderConfigurationResponse is a required field
	RecommenderConfigurationResponse *RecommenderConfigurationResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteRecommenderConfigurationOutput) GoString added in v1.29.17 

func (s DeleteRecommenderConfigurationOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteRecommenderConfigurationOutput) SetRecommenderConfigurationResponse added in v1.29.17 

func (s *DeleteRecommenderConfigurationOutput) SetRecommenderConfigurationResponse(v *RecommenderConfigurationResponse) *DeleteRecommenderConfigurationOutput

SetRecommenderConfigurationResponse sets the RecommenderConfigurationResponse field's value.

func (DeleteRecommenderConfigurationOutput) String added in v1.29.17 

func (s DeleteRecommenderConfigurationOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteSegmentInput) Validate 

func (s *DeleteSegmentInput) Validate() error

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

type DeleteSegmentOutput 

type DeleteSegmentOutput struct {

	// Provides information about the configuration, dimension, and other settings
	// for a segment.
	//
	// SegmentResponse is a required field
	SegmentResponse *SegmentResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteSegmentOutput) GoString 

func (s DeleteSegmentOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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 {

	// Provides information about the status and settings of the SMS channel for
	// an application.
	//
	// SMSChannelResponse is a required field
	SMSChannelResponse *SMSChannelResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteSmsChannelOutput) GoString added in v1.8.38 

func (s DeleteSmsChannelOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteSmsChannelOutput) SetSMSChannelResponse added in v1.8.38 

func (s *DeleteSmsChannelOutput) SetSMSChannelResponse(v *SMSChannelResponse) *DeleteSmsChannelOutput

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteSmsTemplateInput added in v1.25.7 

type DeleteSmsTemplateInput struct {

	// TemplateName is a required field
	TemplateName *string `location:"uri" locationName:"template-name" type:"string" required:"true"`

	Version *string `location:"querystring" locationName:"version" type:"string"`
	// contains filtered or unexported fields
}

func (DeleteSmsTemplateInput) GoString added in v1.25.7 

func (s DeleteSmsTemplateInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteSmsTemplateInput) SetTemplateName added in v1.25.7 

func (s *DeleteSmsTemplateInput) SetTemplateName(v string) *DeleteSmsTemplateInput

SetTemplateName sets the TemplateName field's value.

func (*DeleteSmsTemplateInput) SetVersion added in v1.26.7 

func (s *DeleteSmsTemplateInput) SetVersion(v string) *DeleteSmsTemplateInput

SetVersion sets the Version field's value.

func (DeleteSmsTemplateInput) String added in v1.25.7 

func (s DeleteSmsTemplateInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteSmsTemplateInput) Validate added in v1.25.7 

func (s *DeleteSmsTemplateInput) Validate() error

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

type DeleteSmsTemplateOutput added in v1.25.7 

type DeleteSmsTemplateOutput struct {

	// Provides information about an API request or response.
	//
	// MessageBody is a required field
	MessageBody *MessageBody `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteSmsTemplateOutput) GoString added in v1.25.7 

func (s DeleteSmsTemplateOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteSmsTemplateOutput) SetMessageBody added in v1.25.7 

func (s *DeleteSmsTemplateOutput) SetMessageBody(v *MessageBody) *DeleteSmsTemplateOutput

SetMessageBody sets the MessageBody field's value.

func (DeleteSmsTemplateOutput) String added in v1.25.7 

func (s DeleteSmsTemplateOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteUserEndpointsInput added in v1.14.20 

type DeleteUserEndpointsInput struct {

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

	// UserId is a required field
	UserId *string `location:"uri" locationName:"user-id" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteUserEndpointsInput) GoString added in v1.14.20 

func (s DeleteUserEndpointsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteUserEndpointsInput) SetApplicationId added in v1.14.20 

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

SetApplicationId sets the ApplicationId field's value.

func (*DeleteUserEndpointsInput) SetUserId added in v1.14.20 

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

SetUserId sets the UserId field's value.

func (DeleteUserEndpointsInput) String added in v1.14.20 

func (s DeleteUserEndpointsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteUserEndpointsInput) Validate added in v1.14.20 

func (s *DeleteUserEndpointsInput) Validate() error

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

type DeleteUserEndpointsOutput added in v1.14.20 

type DeleteUserEndpointsOutput struct {

	// Provides information about all the endpoints that are associated with a user
	// ID.
	//
	// EndpointsResponse is a required field
	EndpointsResponse *EndpointsResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteUserEndpointsOutput) GoString added in v1.14.20 

func (s DeleteUserEndpointsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteUserEndpointsOutput) SetEndpointsResponse added in v1.14.20 

func (s *DeleteUserEndpointsOutput) SetEndpointsResponse(v *EndpointsResponse) *DeleteUserEndpointsOutput

SetEndpointsResponse sets the EndpointsResponse field's value.

func (DeleteUserEndpointsOutput) String added in v1.14.20 

func (s DeleteUserEndpointsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteVoiceChannelInput added in v1.15.77 

type DeleteVoiceChannelInput struct {

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

func (DeleteVoiceChannelInput) GoString added in v1.15.77 

func (s DeleteVoiceChannelInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteVoiceChannelInput) SetApplicationId added in v1.15.77 

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

SetApplicationId sets the ApplicationId field's value.

func (DeleteVoiceChannelInput) String added in v1.15.77 

func (s DeleteVoiceChannelInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteVoiceChannelInput) Validate added in v1.15.77 

func (s *DeleteVoiceChannelInput) Validate() error

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

type DeleteVoiceChannelOutput added in v1.15.77 

type DeleteVoiceChannelOutput struct {

	// Provides information about the status and settings of the voice channel for
	// an application.
	//
	// VoiceChannelResponse is a required field
	VoiceChannelResponse *VoiceChannelResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteVoiceChannelOutput) GoString added in v1.15.77 

func (s DeleteVoiceChannelOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteVoiceChannelOutput) SetVoiceChannelResponse added in v1.15.77 

func (s *DeleteVoiceChannelOutput) SetVoiceChannelResponse(v *VoiceChannelResponse) *DeleteVoiceChannelOutput

SetVoiceChannelResponse sets the VoiceChannelResponse field's value.

func (DeleteVoiceChannelOutput) String added in v1.15.77 

func (s DeleteVoiceChannelOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteVoiceTemplateInput added in v1.25.37 

type DeleteVoiceTemplateInput struct {

	// TemplateName is a required field
	TemplateName *string `location:"uri" locationName:"template-name" type:"string" required:"true"`

	Version *string `location:"querystring" locationName:"version" type:"string"`
	// contains filtered or unexported fields
}

func (DeleteVoiceTemplateInput) GoString added in v1.25.37 

func (s DeleteVoiceTemplateInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteVoiceTemplateInput) SetTemplateName added in v1.25.37 

func (s *DeleteVoiceTemplateInput) SetTemplateName(v string) *DeleteVoiceTemplateInput

SetTemplateName sets the TemplateName field's value.

func (*DeleteVoiceTemplateInput) SetVersion added in v1.26.7 

func (s *DeleteVoiceTemplateInput) SetVersion(v string) *DeleteVoiceTemplateInput

SetVersion sets the Version field's value.

func (DeleteVoiceTemplateInput) String added in v1.25.37 

func (s DeleteVoiceTemplateInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteVoiceTemplateInput) Validate added in v1.25.37 

func (s *DeleteVoiceTemplateInput) Validate() error

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

type DeleteVoiceTemplateOutput added in v1.25.37 

type DeleteVoiceTemplateOutput struct {

	// Provides information about an API request or response.
	//
	// MessageBody is a required field
	MessageBody *MessageBody `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteVoiceTemplateOutput) GoString added in v1.25.37 

func (s DeleteVoiceTemplateOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteVoiceTemplateOutput) SetMessageBody added in v1.25.37 

func (s *DeleteVoiceTemplateOutput) SetMessageBody(v *MessageBody) *DeleteVoiceTemplateOutput

SetMessageBody sets the MessageBody field's value.

func (DeleteVoiceTemplateOutput) String added in v1.25.37 

func (s DeleteVoiceTemplateOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DirectMessageConfiguration added in v1.8.38 

type DirectMessageConfiguration struct {

	// The default push notification message for the ADM (Amazon Device Messaging)
	// channel. This message overrides the default push notification message (DefaultPushNotificationMessage).
	ADMMessage *ADMMessage `type:"structure"`

	// The default push notification message for the APNs (Apple Push Notification
	// service) channel. This message overrides the default push notification message
	// (DefaultPushNotificationMessage).
	APNSMessage *APNSMessage `type:"structure"`

	// The default push notification message for the Baidu (Baidu Cloud Push) channel.
	// This message overrides the default push notification message (DefaultPushNotificationMessage).
	BaiduMessage *BaiduMessage `type:"structure"`

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

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

	// The default message for the email channel. This message overrides the default
	// message (DefaultMessage).
	EmailMessage *EmailMessage `type:"structure"`

	// The default push notification message for the GCM channel, which is used
	// to send notifications through the Firebase Cloud Messaging (FCM), formerly
	// Google Cloud Messaging (GCM), service. This message overrides the default
	// push notification message (DefaultPushNotificationMessage).
	GCMMessage *GCMMessage `type:"structure"`

	// The default message for the SMS channel. This message overrides the default
	// message (DefaultMessage).
	SMSMessage *SMSMessage `type:"structure"`

	// The default message for the voice channel. This message overrides the default
	// message (DefaultMessage).
	VoiceMessage *VoiceMessage `type:"structure"`
	// contains filtered or unexported fields
}

Specifies the settings and content for the default message and any default messages that you tailored for specific channels.

func (DirectMessageConfiguration) GoString added in v1.8.38 

func (s DirectMessageConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DirectMessageConfiguration) SetADMMessage added in v1.12.1 

func (s *DirectMessageConfiguration) SetADMMessage(v *ADMMessage) *DirectMessageConfiguration

SetADMMessage sets the ADMMessage field's value.

func (*DirectMessageConfiguration) SetAPNSMessage added in v1.8.38 

func (s *DirectMessageConfiguration) SetAPNSMessage(v *APNSMessage) *DirectMessageConfiguration

SetAPNSMessage sets the APNSMessage field's value.

func (*DirectMessageConfiguration) SetBaiduMessage added in v1.12.1 

func (s *DirectMessageConfiguration) SetBaiduMessage(v *BaiduMessage) *DirectMessageConfiguration

SetBaiduMessage sets the BaiduMessage field's value.

func (*DirectMessageConfiguration) SetDefaultMessage added in v1.8.38 

func (s *DirectMessageConfiguration) SetDefaultMessage(v *DefaultMessage) *DirectMessageConfiguration

SetDefaultMessage sets the DefaultMessage field's value.

func (*DirectMessageConfiguration) SetDefaultPushNotificationMessage added in v1.8.38 

func (s *DirectMessageConfiguration) SetDefaultPushNotificationMessage(v *DefaultPushNotificationMessage) *DirectMessageConfiguration

SetDefaultPushNotificationMessage sets the DefaultPushNotificationMessage field's value.

func (*DirectMessageConfiguration) SetEmailMessage added in v1.12.1 

func (s *DirectMessageConfiguration) SetEmailMessage(v *EmailMessage) *DirectMessageConfiguration

SetEmailMessage sets the EmailMessage field's value.

func (*DirectMessageConfiguration) SetGCMMessage added in v1.8.38 

func (s *DirectMessageConfiguration) SetGCMMessage(v *GCMMessage) *DirectMessageConfiguration

SetGCMMessage sets the GCMMessage field's value.

func (*DirectMessageConfiguration) SetSMSMessage added in v1.8.38 

func (s *DirectMessageConfiguration) SetSMSMessage(v *SMSMessage) *DirectMessageConfiguration

SetSMSMessage sets the SMSMessage field's value.

func (*DirectMessageConfiguration) SetVoiceMessage added in v1.15.77 

func (s *DirectMessageConfiguration) SetVoiceMessage(v *VoiceMessage) *DirectMessageConfiguration

SetVoiceMessage sets the VoiceMessage field's value.

func (DirectMessageConfiguration) String added in v1.8.38 

func (s DirectMessageConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type EmailChannelRequest added in v1.8.38 

type EmailChannelRequest struct {

	// The Amazon SES configuration set (https://docs.aws.amazon.com/ses/latest/APIReference/API_ConfigurationSet.html)
	// that you want to apply to messages that you send through the channel.
	ConfigurationSet *string `type:"string"`

	// Specifies whether to enable the email channel for the application.
	Enabled *bool `type:"boolean"`

	// The verified email address that you want to send email from when you send
	// email through the channel.
	//
	// FromAddress is a required field
	FromAddress *string `type:"string" required:"true"`

	// The Amazon Resource Name (ARN) of the identity, verified with Amazon Simple
	// Email Service (Amazon SES), that you want to use when you send email through
	// the channel.
	//
	// Identity is a required field
	Identity *string `type:"string" required:"true"`

	// The ARN of the AWS Identity and Access Management (IAM) role that you want
	// Amazon Pinpoint to use when it submits email-related event data for the channel.
	RoleArn *string `type:"string"`
	// contains filtered or unexported fields
}

Specifies the status and settings of the email channel for an application.

func (EmailChannelRequest) GoString added in v1.8.38 

func (s EmailChannelRequest) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EmailChannelRequest) SetConfigurationSet added in v1.15.70 

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

SetConfigurationSet sets the ConfigurationSet field's value.

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 

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

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EmailChannelRequest) Validate added in v1.20.11 

func (s *EmailChannelRequest) Validate() error

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

type EmailChannelResponse added in v1.8.38 

type EmailChannelResponse struct {

	// The unique identifier for the application that the email channel applies
	// to.
	ApplicationId *string `type:"string"`

	// The Amazon SES configuration set (https://docs.aws.amazon.com/ses/latest/APIReference/API_ConfigurationSet.html)
	// that's applied to messages that are sent through the channel.
	ConfigurationSet *string `type:"string"`

	// The date and time, in ISO 8601 format, when the email channel was enabled.
	CreationDate *string `type:"string"`

	// Specifies whether the email channel is enabled for the application.
	Enabled *bool `type:"boolean"`

	// The verified email address that email is sent from when you send email through
	// the channel.
	FromAddress *string `type:"string"`

	// (Not used) This property is retained only for backward compatibility.
	HasCredential *bool `type:"boolean"`

	// (Deprecated) An identifier for the email channel. This property is retained
	// only for backward compatibility.
	Id *string `type:"string"`

	// The Amazon Resource Name (ARN) of the identity, verified with Amazon Simple
	// Email Service (Amazon SES), that's used when you send email through the channel.
	Identity *string `type:"string"`

	// Specifies whether the email channel is archived.
	IsArchived *bool `type:"boolean"`

	// The user who last modified the email channel.
	LastModifiedBy *string `type:"string"`

	// The date and time, in ISO 8601 format, when the email channel was last modified.
	LastModifiedDate *string `type:"string"`

	// The maximum number of emails that can be sent through the channel each second.
	MessagesPerSecond *int64 `type:"integer"`

	// The type of messaging or notification platform for the channel. For the email
	// channel, this value is EMAIL.
	//
	// Platform is a required field
	Platform *string `type:"string" required:"true"`

	// The ARN of the AWS Identity and Access Management (IAM) role that Amazon
	// Pinpoint uses to submit email-related event data for the channel.
	RoleArn *string `type:"string"`

	// The current version of the email channel.
	Version *int64 `type:"integer"`
	// contains filtered or unexported fields
}

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

func (EmailChannelResponse) GoString added in v1.8.38 

func (s EmailChannelResponse) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EmailChannelResponse) SetApplicationId added in v1.8.38 

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

SetApplicationId sets the ApplicationId field's value.

func (*EmailChannelResponse) SetConfigurationSet added in v1.15.70 

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

SetConfigurationSet sets the ConfigurationSet 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 

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

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 

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

SetId sets the Id field's value.

func (*EmailChannelResponse) SetIdentity added in v1.8.38 

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

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) SetMessagesPerSecond added in v1.14.20 

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

SetMessagesPerSecond sets the MessagesPerSecond field's value.

func (*EmailChannelResponse) SetPlatform added in v1.8.38 

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

SetPlatform sets the Platform field's value.

func (*EmailChannelResponse) SetRoleArn added in v1.8.38 

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

SetRoleArn sets the RoleArn field's value.

func (*EmailChannelResponse) SetVersion added in v1.8.38 

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

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type EmailMessage added in v1.12.1 

type EmailMessage struct {

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

	// The email address to forward bounces and complaints to, if feedback forwarding
	// is enabled.
	FeedbackForwardingAddress *string `type:"string"`

	// The verified email address to send the email message from. The default value
	// is the FromAddress specified for the email channel.
	FromAddress *string `type:"string"`

	// The email message, represented as a raw MIME message.
	RawEmail *RawEmail `type:"structure"`

	// The reply-to email address(es) for the email message. If a recipient replies
	// to the email, each reply-to address receives the reply.
	ReplyToAddresses []*string `type:"list"`

	// The email message, composed of a subject, a text part, and an HTML part.
	SimpleEmail *SimpleEmail `type:"structure"`

	// The default message variables to use in the email message. You can override
	// the default variables with individual address variables.
	Substitutions map[string][]*string `type:"map"`
	// contains filtered or unexported fields
}

Specifies the default settings and content for a one-time email message that's sent directly to an endpoint.

func (EmailMessage) GoString added in v1.12.1 

func (s EmailMessage) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EmailMessage) SetBody added in v1.12.1 

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

SetBody sets the Body field's value.

func (*EmailMessage) SetFeedbackForwardingAddress added in v1.15.70 

func (s *EmailMessage) SetFeedbackForwardingAddress(v string) *EmailMessage

SetFeedbackForwardingAddress sets the FeedbackForwardingAddress field's value.

func (*EmailMessage) SetFromAddress added in v1.12.1 

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

SetFromAddress sets the FromAddress field's value.

func (*EmailMessage) SetRawEmail added in v1.15.70 

func (s *EmailMessage) SetRawEmail(v *RawEmail) *EmailMessage

SetRawEmail sets the RawEmail field's value.

func (*EmailMessage) SetReplyToAddresses added in v1.15.70 

func (s *EmailMessage) SetReplyToAddresses(v []*string) *EmailMessage

SetReplyToAddresses sets the ReplyToAddresses field's value.

func (*EmailMessage) SetSimpleEmail added in v1.15.70 

func (s *EmailMessage) SetSimpleEmail(v *SimpleEmail) *EmailMessage

SetSimpleEmail sets the SimpleEmail field's value.

func (*EmailMessage) SetSubstitutions added in v1.12.1 

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

SetSubstitutions sets the Substitutions field's value.

func (EmailMessage) String added in v1.12.1 

func (s EmailMessage) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type EmailMessageActivity added in v1.25.25 

type EmailMessageActivity struct {

	// Specifies the sender address for an email message that's sent to participants
	// in the journey.
	MessageConfig *JourneyEmailMessage `type:"structure"`

	// The unique identifier for the next activity to perform, after the message
	// is sent.
	NextActivity *string `type:"string"`

	// The name of the email message template to use for the message. If specified,
	// this value must match the name of an existing message template.
	TemplateName *string `type:"string"`

	// The unique identifier for the version of the email template to use for the
	// message. If specified, this value must match the identifier for an existing
	// template version. To retrieve a list of versions and version identifiers
	// for a template, use the Template Versions resource.
	//
	// If you don't specify a value for this property, Amazon Pinpoint uses the
	// active version of the template. The active version is typically the version
	// of a template that's been most recently reviewed and approved for use, depending
	// on your workflow. It isn't necessarily the latest version of a template.
	TemplateVersion *string `type:"string"`
	// contains filtered or unexported fields
}

Specifies the settings for an email activity in a journey. This type of activity sends an email message to participants.

func (EmailMessageActivity) GoString added in v1.25.25 

func (s EmailMessageActivity) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EmailMessageActivity) SetMessageConfig added in v1.25.25 

func (s *EmailMessageActivity) SetMessageConfig(v *JourneyEmailMessage) *EmailMessageActivity

SetMessageConfig sets the MessageConfig field's value.

func (*EmailMessageActivity) SetNextActivity added in v1.25.25 

func (s *EmailMessageActivity) SetNextActivity(v string) *EmailMessageActivity

SetNextActivity sets the NextActivity field's value.

func (*EmailMessageActivity) SetTemplateName added in v1.25.25 

func (s *EmailMessageActivity) SetTemplateName(v string) *EmailMessageActivity

SetTemplateName sets the TemplateName field's value.

func (*EmailMessageActivity) SetTemplateVersion added in v1.26.7 

func (s *EmailMessageActivity) SetTemplateVersion(v string) *EmailMessageActivity

SetTemplateVersion sets the TemplateVersion field's value.

func (EmailMessageActivity) String added in v1.25.25 

func (s EmailMessageActivity) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type EmailTemplateRequest added in v1.25.7 

type EmailTemplateRequest struct {

	// A JSON object that specifies the default values to use for message variables
	// in the message template. This object is a set of key-value pairs. Each key
	// defines a message variable in the template. The corresponding value defines
	// the default value for that variable. When you create a message that's based
	// on the template, you can override these defaults with message-specific and
	// address-specific variables and values.
	DefaultSubstitutions *string `type:"string"`

	// The message body, in HTML format, to use in email messages that are based
	// on the message template. We recommend using HTML format for email clients
	// that render HTML content. You can include links, formatted text, and more
	// in an HTML message.
	HtmlPart *string `type:"string"`

	// The unique identifier for the recommender model to use for the message template.
	// Amazon Pinpoint uses this value to determine how to retrieve and process
	// data from a recommender model when it sends messages that use the template,
	// if the template contains message variables for recommendation data.
	RecommenderId *string `type:"string"`

	// The subject line, or title, to use in email messages that are based on the
	// message template.
	Subject *string `type:"string"`

	// A string-to-string map of key-value pairs that defines the tags to associate
	// with the message template. Each tag consists of a required tag key and an
	// associated tag value.
	Tags map[string]*string `locationName:"tags" type:"map"`

	// A custom description of the message template.
	TemplateDescription *string `type:"string"`

	// The message body, in plain text format, to use in email messages that are
	// based on the message template. We recommend using plain text format for email
	// clients that don't render HTML content and clients that are connected to
	// high-latency networks, such as mobile devices.
	TextPart *string `type:"string"`
	// contains filtered or unexported fields
}

Specifies the content and settings for a message template that can be used in messages that are sent through the email channel.

func (EmailTemplateRequest) GoString added in v1.25.7 

func (s EmailTemplateRequest) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EmailTemplateRequest) SetDefaultSubstitutions added in v1.25.37 

func (s *EmailTemplateRequest) SetDefaultSubstitutions(v string) *EmailTemplateRequest

SetDefaultSubstitutions sets the DefaultSubstitutions field's value.

func (*EmailTemplateRequest) SetHtmlPart added in v1.25.7 

func (s *EmailTemplateRequest) SetHtmlPart(v string) *EmailTemplateRequest

SetHtmlPart sets the HtmlPart field's value.

func (*EmailTemplateRequest) SetRecommenderId added in v1.29.17 

func (s *EmailTemplateRequest) SetRecommenderId(v string) *EmailTemplateRequest

SetRecommenderId sets the RecommenderId field's value.

func (*EmailTemplateRequest) SetSubject added in v1.25.7 

func (s *EmailTemplateRequest) SetSubject(v string) *EmailTemplateRequest

SetSubject sets the Subject field's value.

func (*EmailTemplateRequest) SetTags added in v1.25.7 

func (s *EmailTemplateRequest) SetTags(v map[string]*string) *EmailTemplateRequest

SetTags sets the Tags field's value.

func (*EmailTemplateRequest) SetTemplateDescription added in v1.25.37 

func (s *EmailTemplateRequest) SetTemplateDescription(v string) *EmailTemplateRequest

SetTemplateDescription sets the TemplateDescription field's value.

func (*EmailTemplateRequest) SetTextPart added in v1.25.7 

func (s *EmailTemplateRequest) SetTextPart(v string) *EmailTemplateRequest

SetTextPart sets the TextPart field's value.

func (EmailTemplateRequest) String added in v1.25.7 

func (s EmailTemplateRequest) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type EmailTemplateResponse added in v1.25.7 

type EmailTemplateResponse struct {

	// The Amazon Resource Name (ARN) of the message template.
	Arn *string `type:"string"`

	// The date, in ISO 8601 format, when the message template was created.
	//
	// CreationDate is a required field
	CreationDate *string `type:"string" required:"true"`

	// The JSON object that specifies the default values that are used for message
	// variables in the message template. This object is a set of key-value pairs.
	// Each key defines a message variable in the template. The corresponding value
	// defines the default value for that variable.
	DefaultSubstitutions *string `type:"string"`

	// The message body, in HTML format, that's used in email messages that are
	// based on the message template.
	HtmlPart *string `type:"string"`

	// The date, in ISO 8601 format, when the message template was last modified.
	//
	// LastModifiedDate is a required field
	LastModifiedDate *string `type:"string" required:"true"`

	// The unique identifier for the recommender model that's used by the message
	// template.
	RecommenderId *string `type:"string"`

	// The subject line, or title, that's used in email messages that are based
	// on the message template.
	Subject *string `type:"string"`

	// A string-to-string map of key-value pairs that identifies the tags that are
	// associated with the message template. Each tag consists of a required tag
	// key and an associated tag value.
	Tags map[string]*string `locationName:"tags" type:"map"`

	// The custom description of the message template.
	TemplateDescription *string `type:"string"`

	// The name of the message template.
	//
	// TemplateName is a required field
	TemplateName *string `type:"string" required:"true"`

	// The type of channel that the message template is designed for. For an email
	// template, this value is EMAIL.
	//
	// TemplateType is a required field
	TemplateType *string `type:"string" required:"true" enum:"TemplateType"`

	// The message body, in plain text format, that's used in email messages that
	// are based on the message template.
	TextPart *string `type:"string"`

	// The unique identifier, as an integer, for the active version of the message
	// template, or the version of the template that you specified by using the
	// version parameter in your request.
	Version *string `type:"string"`
	// contains filtered or unexported fields
}

Provides information about the content and settings for a message template that can be used in messages that are sent through the email channel.

func (EmailTemplateResponse) GoString added in v1.25.7 

func (s EmailTemplateResponse) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EmailTemplateResponse) SetArn added in v1.25.7 

func (s *EmailTemplateResponse) SetArn(v string) *EmailTemplateResponse

SetArn sets the Arn field's value.

func (*EmailTemplateResponse) SetCreationDate added in v1.25.7 

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

SetCreationDate sets the CreationDate field's value.

func (*EmailTemplateResponse) SetDefaultSubstitutions added in v1.25.37 

func (s *EmailTemplateResponse) SetDefaultSubstitutions(v string) *EmailTemplateResponse

SetDefaultSubstitutions sets the DefaultSubstitutions field's value.

func (*EmailTemplateResponse) SetHtmlPart added in v1.25.7 

func (s *EmailTemplateResponse) SetHtmlPart(v string) *EmailTemplateResponse

SetHtmlPart sets the HtmlPart field's value.

func (*EmailTemplateResponse) SetLastModifiedDate added in v1.25.7 

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

SetLastModifiedDate sets the LastModifiedDate field's value.

func (*EmailTemplateResponse) SetRecommenderId added in v1.29.17 

func (s *EmailTemplateResponse) SetRecommenderId(v string) *EmailTemplateResponse

SetRecommenderId sets the RecommenderId field's value.

func (*EmailTemplateResponse) SetSubject added in v1.25.7 

func (s *EmailTemplateResponse) SetSubject(v string) *EmailTemplateResponse

SetSubject sets the Subject field's value.

func (*EmailTemplateResponse) SetTags added in v1.25.7 

func (s *EmailTemplateResponse) SetTags(v map[string]*string) *EmailTemplateResponse

SetTags sets the Tags field's value.

func (*EmailTemplateResponse) SetTemplateDescription added in v1.25.37 

func (s *EmailTemplateResponse) SetTemplateDescription(v string) *EmailTemplateResponse

SetTemplateDescription sets the TemplateDescription field's value.

func (*EmailTemplateResponse) SetTemplateName added in v1.25.7 

func (s *EmailTemplateResponse) SetTemplateName(v string) *EmailTemplateResponse

SetTemplateName sets the TemplateName field's value.

func (*EmailTemplateResponse) SetTemplateType added in v1.25.7 

func (s *EmailTemplateResponse) SetTemplateType(v string) *EmailTemplateResponse

SetTemplateType sets the TemplateType field's value.

func (*EmailTemplateResponse) SetTextPart added in v1.25.7 

func (s *EmailTemplateResponse) SetTextPart(v string) *EmailTemplateResponse

SetTextPart sets the TextPart field's value.

func (*EmailTemplateResponse) SetVersion added in v1.26.7 

func (s *EmailTemplateResponse) SetVersion(v string) *EmailTemplateResponse

SetVersion sets the Version field's value.

func (EmailTemplateResponse) String added in v1.25.7 

func (s EmailTemplateResponse) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type EndpointBatchItem 

type EndpointBatchItem struct {

	// The destination address for messages or push notifications that you send
	// to the endpoint. The address varies by channel. For a push-notification channel,
	// use the token provided by the push notification service, such as an Apple
	// Push Notification service (APNs) device token or a Firebase Cloud Messaging
	// (FCM) registration token. For the SMS channel, use a phone number in E.164
	// format, such as +12065550100. For the email channel, use an email address.
	Address *string `type:"string"`

	// One or more custom attributes that describe the endpoint by associating a
	// name with an array of values. For example, the value of a custom attribute
	// named Interests might be: ["Science", "Music", "Travel"]. You can use these
	// attributes as filter criteria when you create segments. Attribute names are
	// case sensitive.
	//
	// An attribute name can contain up to 50 characters. An attribute value can
	// contain up to 100 characters. When you define the name of a custom attribute,
	// avoid using the following characters: number sign (#), colon (:), question
	// mark (?), backslash (\), and slash (/). The Amazon Pinpoint console can't
	// display attribute names that contain these characters. This restriction doesn't
	// apply to attribute values.
	Attributes map[string][]*string `type:"map"`

	// The channel to use when sending messages or push notifications to the endpoint.
	ChannelType *string `type:"string" enum:"ChannelType"`

	// The demographic information for the endpoint, such as the time zone and platform.
	Demographic *EndpointDemographic `type:"structure"`

	// The date and time, in ISO 8601 format, when the endpoint was created or updated.
	EffectiveDate *string `type:"string"`

	// Specifies whether to send messages or push notifications to the endpoint.
	// Valid values are: ACTIVE, messages are sent to the endpoint; and, INACTIVE,
	// messages aren’t sent to the endpoint.
	//
	// Amazon Pinpoint automatically sets this value to ACTIVE when you create an
	// endpoint or update an existing endpoint. Amazon Pinpoint automatically sets
	// this value to INACTIVE if you update another endpoint that has the same address
	// specified by the Address property.
	EndpointStatus *string `type:"string"`

	// The unique identifier for the endpoint in the context of the batch.
	Id *string `type:"string"`

	// The geographic information for the endpoint.
	Location *EndpointLocation `type:"structure"`

	// One or more custom metrics that your app reports to Amazon Pinpoint for the
	// endpoint.
	Metrics map[string]*float64 `type:"map"`

	// Specifies whether the user who's associated with the endpoint has opted out
	// of receiving messages and push notifications from you. Possible values are:
	// ALL, the user has opted out and doesn't want to receive any messages or push
	// notifications; and, NONE, the user hasn't opted out and wants to receive
	// all messages and push notifications.
	OptOut *string `type:"string"`

	// The unique identifier for the request to create or update the endpoint.
	RequestId *string `type:"string"`

	// One or more custom attributes that describe the user who's associated with
	// the endpoint.
	User *EndpointUser `type:"structure"`
	// contains filtered or unexported fields
}

Specifies an endpoint to create or update and the settings and attributes to set or change for the endpoint.

func (EndpointBatchItem) GoString 

func (s EndpointBatchItem) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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 

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

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 

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

SetId sets the Id field's value.

func (*EndpointBatchItem) SetLocation 

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

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 

func (s *EndpointBatchItem) SetUser(v *EndpointUser) *EndpointBatchItem

SetUser sets the User field's value.

func (EndpointBatchItem) String 

func (s EndpointBatchItem) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type EndpointBatchRequest 

type EndpointBatchRequest struct {

	// An array that defines the endpoints to create or update and, for each endpoint,
	// the property values to set or change. An array can contain a maximum of 100
	// items.
	//
	// Item is a required field
	Item []*EndpointBatchItem `type:"list" required:"true"`
	// contains filtered or unexported fields
}

Specifies a batch of endpoints to create or update and the settings and attributes to set or change for each endpoint.

func (EndpointBatchRequest) GoString 

func (s EndpointBatchRequest) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EndpointBatchRequest) SetItem 

func (s *EndpointBatchRequest) SetItem(v []*EndpointBatchItem) *EndpointBatchRequest

SetItem sets the Item field's value.

func (EndpointBatchRequest) String 

func (s EndpointBatchRequest) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EndpointBatchRequest) Validate added in v1.20.11 

func (s *EndpointBatchRequest) Validate() error

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

type EndpointDemographic 

type EndpointDemographic struct {

	// The version of the app that's associated with the endpoint.
	AppVersion *string `type:"string"`

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

	// The manufacturer of the endpoint device, such as apple or samsung.
	Make *string `type:"string"`

	// The model name or number of the endpoint device, such as iPhone or SM-G900F.
	Model *string `type:"string"`

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

	// The platform of the endpoint device, such as ios.
	Platform *string `type:"string"`

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

	// The time zone of the endpoint, specified as a tz database name value, such
	// as America/Los_Angeles.
	Timezone *string `type:"string"`
	// contains filtered or unexported fields
}

Specifies demographic information about an endpoint, such as the applicable time zone and platform.

func (EndpointDemographic) GoString 

func (s EndpointDemographic) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EndpointDemographic) SetAppVersion 

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

SetAppVersion sets the AppVersion field's value.

func (*EndpointDemographic) SetLocale 

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

SetLocale sets the Locale field's value.

func (*EndpointDemographic) SetMake 

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

SetMake sets the Make field's value.

func (*EndpointDemographic) SetModel 

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

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type EndpointItemResponse added in v1.15.7 

type EndpointItemResponse struct {

	// The custom message that's returned in the response as a result of processing
	// the endpoint data.
	Message *string `type:"string"`

	// The status code that's returned in the response as a result of processing
	// the endpoint data.
	StatusCode *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Provides the status code and message that result from processing data for an endpoint.

func (EndpointItemResponse) GoString added in v1.15.7 

func (s EndpointItemResponse) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EndpointItemResponse) SetMessage added in v1.15.7 

func (s *EndpointItemResponse) SetMessage(v string) *EndpointItemResponse

SetMessage sets the Message field's value.

func (*EndpointItemResponse) SetStatusCode added in v1.15.7 

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

SetStatusCode sets the StatusCode field's value.

func (EndpointItemResponse) String added in v1.15.7 

func (s EndpointItemResponse) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type EndpointLocation 

type EndpointLocation struct {

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

	// The two-character code, in ISO 3166-1 alpha-2 format, for the country or
	// region where the endpoint is located. For example, US for the United States.
	Country *string `type:"string"`

	// The latitude coordinate of the endpoint location, rounded to one decimal
	// place.
	Latitude *float64 `type:"double"`

	// The longitude coordinate of the endpoint location, rounded to one decimal
	// place.
	Longitude *float64 `type:"double"`

	// The postal or ZIP code for the area where the endpoint is located.
	PostalCode *string `type:"string"`

	// The name of the region where the endpoint is located. For locations in the
	// United States, this value is the name of a state.
	Region *string `type:"string"`
	// contains filtered or unexported fields
}

Specifies geographic information about an endpoint.

func (EndpointLocation) GoString 

func (s EndpointLocation) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type EndpointMessageResult added in v1.12.1 

type EndpointMessageResult struct {

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

	// The delivery status of the message. Possible values are:
	//
	//    * DUPLICATE - The endpoint address is a duplicate of another endpoint
	//    address. Amazon Pinpoint won't attempt to send the message again.
	//
	//    * OPT_OUT - The user who's associated with the endpoint has opted out
	//    of receiving messages from you. Amazon Pinpoint won't attempt to send
	//    the message again.
	//
	//    * PERMANENT_FAILURE - An error occurred when delivering the message to
	//    the endpoint. Amazon Pinpoint won't attempt to send the message again.
	//
	//    * SUCCESSFUL - The message was successfully delivered to the endpoint.
	//
	//    * TEMPORARY_FAILURE - A temporary error occurred. Amazon Pinpoint won't
	//    attempt to send the message again.
	//
	//    * THROTTLED - Amazon Pinpoint throttled the operation to send the message
	//    to the endpoint.
	//
	//    * TIMEOUT - The message couldn't be sent within the timeout period.
	//
	//    * UNKNOWN_FAILURE - An unknown error occurred.
	//
	// DeliveryStatus is a required field
	DeliveryStatus *string `type:"string" required:"true" enum:"DeliveryStatus"`

	// The unique identifier for the message that was sent.
	MessageId *string `type:"string"`

	// The downstream service status code for delivering the message.
	//
	// StatusCode is a required field
	StatusCode *int64 `type:"integer" required:"true"`

	// The status message for delivering the message.
	StatusMessage *string `type:"string"`

	// For push notifications that are sent through the GCM channel, specifies whether
	// the endpoint's device registration token was updated as part of delivering
	// the message.
	UpdatedToken *string `type:"string"`
	// contains filtered or unexported fields
}

Provides information about the delivery status and results of sending a message directly to an endpoint.

func (EndpointMessageResult) GoString added in v1.12.1 

func (s EndpointMessageResult) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EndpointMessageResult) SetAddress added in v1.12.1 

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

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) SetMessageId added in v1.14.20 

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

SetMessageId sets the MessageId 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type EndpointRequest 

type EndpointRequest struct {

	// The destination address for messages or push notifications that you send
	// to the endpoint. The address varies by channel. For a push-notification channel,
	// use the token provided by the push notification service, such as an Apple
	// Push Notification service (APNs) device token or a Firebase Cloud Messaging
	// (FCM) registration token. For the SMS channel, use a phone number in E.164
	// format, such as +12065550100. For the email channel, use an email address.
	Address *string `type:"string"`

	// One or more custom attributes that describe the endpoint by associating a
	// name with an array of values. For example, the value of a custom attribute
	// named Interests might be: ["Science", "Music", "Travel"]. You can use these
	// attributes as filter criteria when you create segments. Attribute names are
	// case sensitive.
	//
	// An attribute name can contain up to 50 characters. An attribute value can
	// contain up to 100 characters. When you define the name of a custom attribute,
	// avoid using the following characters: number sign (#), colon (:), question
	// mark (?), backslash (\), and slash (/). The Amazon Pinpoint console can't
	// display attribute names that contain these characters. This restriction doesn't
	// apply to attribute values.
	Attributes map[string][]*string `type:"map"`

	// The channel to use when sending messages or push notifications to the endpoint.
	ChannelType *string `type:"string" enum:"ChannelType"`

	// The demographic information for the endpoint, such as the time zone and platform.
	Demographic *EndpointDemographic `type:"structure"`

	// The date and time, in ISO 8601 format, when the endpoint is updated.
	EffectiveDate *string `type:"string"`

	// Specifies whether to send messages or push notifications to the endpoint.
	// Valid values are: ACTIVE, messages are sent to the endpoint; and, INACTIVE,
	// messages aren’t sent to the endpoint.
	//
	// Amazon Pinpoint automatically sets this value to ACTIVE when you create an
	// endpoint or update an existing endpoint. Amazon Pinpoint automatically sets
	// this value to INACTIVE if you update another endpoint that has the same address
	// specified by the Address property.
	EndpointStatus *string `type:"string"`

	// The geographic information for the endpoint.
	Location *EndpointLocation `type:"structure"`

	// One or more custom metrics that your app reports to Amazon Pinpoint for the
	// endpoint.
	Metrics map[string]*float64 `type:"map"`

	// Specifies whether the user who's associated with the endpoint has opted out
	// of receiving messages and push notifications from you. Possible values are:
	// ALL, the user has opted out and doesn't want to receive any messages or push
	// notifications; and, NONE, the user hasn't opted out and wants to receive
	// all messages and push notifications.
	OptOut *string `type:"string"`

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

	// One or more custom attributes that describe the user who's associated with
	// the endpoint.
	User *EndpointUser `type:"structure"`
	// contains filtered or unexported fields
}

Specifies the channel type and other settings for an endpoint.

func (EndpointRequest) GoString 

func (s EndpointRequest) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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 

func (s *EndpointRequest) SetUser(v *EndpointUser) *EndpointRequest

SetUser sets the User field's value.

func (EndpointRequest) String 

func (s EndpointRequest) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type EndpointResponse 

type EndpointResponse struct {

	// The destination address for messages or push notifications that you send
	// to the endpoint. The address varies by channel. For example, the address
	// for a push-notification channel is typically the token provided by a push
	// notification service, such as an Apple Push Notification service (APNs) device
	// token or a Firebase Cloud Messaging (FCM) registration token. The address
	// for the SMS channel is a phone number in E.164 format, such as +12065550100.
	// The address for the email channel is an email address.
	Address *string `type:"string"`

	// The unique identifier for the application that's associated with the endpoint.
	ApplicationId *string `type:"string"`

	// One or more custom attributes that describe the endpoint by associating a
	// name with an array of values. For example, the value of a custom attribute
	// named Interests might be: ["Science", "Music", "Travel"]. You can use these
	// attributes as filter criteria when you create segments.
	Attributes map[string][]*string `type:"map"`

	// The channel that's used when sending messages or push notifications to the
	// endpoint.
	ChannelType *string `type:"string" enum:"ChannelType"`

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

	// The date and time, in ISO 8601 format, when the endpoint was created.
	CreationDate *string `type:"string"`

	// The demographic information for the endpoint, such as the time zone and platform.
	Demographic *EndpointDemographic `type:"structure"`

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

	// Specifies whether messages or push notifications are sent to the endpoint.
	// Possible values are: ACTIVE, messages are sent to the endpoint; and, INACTIVE,
	// messages aren’t sent to the endpoint.
	//
	// Amazon Pinpoint automatically sets this value to ACTIVE when you create an
	// endpoint or update an existing endpoint. Amazon Pinpoint automatically sets
	// this value to INACTIVE if you update another endpoint that has the same address
	// specified by the Address property.
	EndpointStatus *string `type:"string"`

	// The unique identifier that you assigned to the endpoint. The identifier should
	// be a globally unique identifier (GUID) to ensure that it doesn't conflict
	// with other endpoint identifiers that are associated with the application.
	Id *string `type:"string"`

	// The geographic information for the endpoint.
	Location *EndpointLocation `type:"structure"`

	// One or more custom metrics that your app reports to Amazon Pinpoint for the
	// endpoint.
	Metrics map[string]*float64 `type:"map"`

	// Specifies whether the user who's associated with the endpoint has opted out
	// of receiving messages and push notifications from you. Possible values are:
	// ALL, the user has opted out and doesn't want to receive any messages or push
	// notifications; and, NONE, the user hasn't opted out and wants to receive
	// all messages and push notifications.
	OptOut *string `type:"string"`

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

	// One or more custom user attributes that your app reports to Amazon Pinpoint
	// for the user who's associated with the endpoint.
	User *EndpointUser `type:"structure"`
	// contains filtered or unexported fields
}

Provides information about the channel type and other settings for an endpoint.

func (EndpointResponse) GoString 

func (s EndpointResponse) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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 

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

SetId sets the Id field's value.

func (*EndpointResponse) SetLocation 

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

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 

func (s *EndpointResponse) SetUser(v *EndpointUser) *EndpointResponse

SetUser sets the User field's value.

func (EndpointResponse) String 

func (s EndpointResponse) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type EndpointSendConfiguration added in v1.12.1 

type EndpointSendConfiguration struct {

	// The body of the message. If specified, this value overrides the default message
	// body.
	BodyOverride *string `type:"string"`

	// A map of custom attributes to attach to the message for the address. Attribute
	// names are case sensitive.
	//
	// For a push notification, this payload is added to the data.pinpoint object.
	// For an email or text message, this payload is added to email/SMS delivery
	// receipt event attributes.
	Context map[string]*string `type:"map"`

	// The raw, JSON-formatted string to use as the payload for the message. If
	// specified, this value overrides all other values for the message.
	RawContent *string `type:"string"`

	// A map of the message variables to merge with the variables specified for
	// the default message (DefaultMessage.Substitutions). The variables specified
	// in this map take precedence over all other variables.
	Substitutions map[string][]*string `type:"map"`

	// The title or subject line of the message. If specified, this value overrides
	// the default message title or subject line.
	TitleOverride *string `type:"string"`
	// contains filtered or unexported fields
}

Specifies the content, including message variables and attributes, to use in a message that's sent directly to an endpoint.

func (EndpointSendConfiguration) GoString added in v1.12.1 

func (s EndpointSendConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EndpointSendConfiguration) SetBodyOverride added in v1.12.1 

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

SetBodyOverride sets the BodyOverride field's value.

func (*EndpointSendConfiguration) SetContext added in v1.12.1 

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

SetContext sets the Context field's value.

func (*EndpointSendConfiguration) SetRawContent added in v1.12.1 

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

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 

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

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type EndpointUser 

type EndpointUser struct {

	// One or more custom attributes that describe the user by associating a name
	// with an array of values. For example, the value of an attribute named Interests
	// might be: ["Science", "Music", "Travel"]. You can use these attributes as
	// filter criteria when you create segments. Attribute names are case sensitive.
	//
	// An attribute name can contain up to 50 characters. An attribute value can
	// contain up to 100 characters. When you define the name of a custom attribute,
	// avoid using the following characters: number sign (#), colon (:), question
	// mark (?), backslash (\), and slash (/). The Amazon Pinpoint console can't
	// display attribute names that contain these characters. This restriction doesn't
	// apply to attribute values.
	UserAttributes map[string][]*string `type:"map"`

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

Specifies data for one or more attributes that describe the user who's associated with an endpoint.

func (EndpointUser) GoString 

func (s EndpointUser) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type EndpointsResponse added in v1.14.20 

type EndpointsResponse struct {

	// An array of responses, one for each endpoint that's associated with the user
	// ID.
	//
	// Item is a required field
	Item []*EndpointResponse `type:"list" required:"true"`
	// contains filtered or unexported fields
}

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

func (EndpointsResponse) GoString added in v1.14.20 

func (s EndpointsResponse) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EndpointsResponse) SetItem added in v1.14.20 

func (s *EndpointsResponse) SetItem(v []*EndpointResponse) *EndpointsResponse

SetItem sets the Item field's value.

func (EndpointsResponse) String added in v1.14.20 

func (s EndpointsResponse) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Event added in v1.15.7 

type Event struct {

	// The package name of the app that's recording the event.
	AppPackageName *string `type:"string"`

	// The title of the app that's recording the event.
	AppTitle *string `type:"string"`

	// The version number of the app that's recording the event.
	AppVersionCode *string `type:"string"`

	// One or more custom attributes that are associated with the event.
	Attributes map[string]*string `type:"map"`

	// The version of the SDK that's running on the client device.
	ClientSdkVersion *string `type:"string"`

	// The name of the event.
	//
	// EventType is a required field
	EventType *string `type:"string" required:"true"`

	// One or more custom metrics that are associated with the event.
	Metrics map[string]*float64 `type:"map"`

	// The name of the SDK that's being used to record the event.
	SdkName *string `type:"string"`

	// Information about the session in which the event occurred.
	Session *Session `type:"structure"`

	// The date and time, in ISO 8601 format, when the event occurred.
	//
	// Timestamp is a required field
	Timestamp *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Specifies information about an event that reports data to Amazon Pinpoint.

func (Event) GoString added in v1.15.7 

func (s Event) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Event) SetAppPackageName added in v1.16.21 

func (s *Event) SetAppPackageName(v string) *Event

SetAppPackageName sets the AppPackageName field's value.

func (*Event) SetAppTitle added in v1.16.21 

func (s *Event) SetAppTitle(v string) *Event

SetAppTitle sets the AppTitle field's value.

func (*Event) SetAppVersionCode added in v1.16.21 

func (s *Event) SetAppVersionCode(v string) *Event

SetAppVersionCode sets the AppVersionCode field's value.

func (*Event) SetAttributes added in v1.15.7 

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

SetAttributes sets the Attributes field's value.

func (*Event) SetClientSdkVersion added in v1.15.7 

func (s *Event) SetClientSdkVersion(v string) *Event

SetClientSdkVersion sets the ClientSdkVersion field's value.

func (*Event) SetEventType added in v1.15.7 

func (s *Event) SetEventType(v string) *Event

SetEventType sets the EventType field's value.

func (*Event) SetMetrics added in v1.15.7 

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

SetMetrics sets the Metrics field's value.

func (*Event) SetSdkName added in v1.16.21 

func (s *Event) SetSdkName(v string) *Event

SetSdkName sets the SdkName field's value.

func (*Event) SetSession added in v1.15.7 

func (s *Event) SetSession(v *Session) *Event

SetSession sets the Session field's value.

func (*Event) SetTimestamp added in v1.15.7 

func (s *Event) SetTimestamp(v string) *Event

SetTimestamp sets the Timestamp field's value.

func (Event) String added in v1.15.7 

func (s Event) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Event) Validate added in v1.20.11 

func (s *Event) Validate() error

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

type EventCondition added in v1.25.25 

type EventCondition struct {

	// The dimensions for the event filter to use for the activity.
	Dimensions *EventDimensions `type:"structure"`

	// The message identifier (message_id) for the message to use when determining
	// whether message events meet the condition.
	MessageActivity *string `type:"string"`
	// contains filtered or unexported fields
}

Specifies the conditions to evaluate for an event that applies to an activity in a journey.

func (EventCondition) GoString added in v1.25.25 

func (s EventCondition) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EventCondition) SetDimensions added in v1.25.25 

func (s *EventCondition) SetDimensions(v *EventDimensions) *EventCondition

SetDimensions sets the Dimensions field's value.

func (*EventCondition) SetMessageActivity added in v1.25.25 

func (s *EventCondition) SetMessageActivity(v string) *EventCondition

SetMessageActivity sets the MessageActivity field's value.

func (EventCondition) String added in v1.25.25 

func (s EventCondition) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EventCondition) Validate added in v1.25.25 

func (s *EventCondition) Validate() error

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

type EventDimensions added in v1.15.77 

type EventDimensions struct {

	// One or more custom attributes that your application reports to Amazon Pinpoint.
	// You can use these attributes as selection criteria when you create an event
	// filter.
	Attributes map[string]*AttributeDimension `type:"map"`

	// The name of the event that causes the campaign to be sent or the journey
	// activity to be performed. This can be a standard event that Amazon Pinpoint
	// generates, such as _email.delivered. For campaigns, this can also be a custom
	// event that's specific to your application. For information about standard
	// events, see Streaming Amazon Pinpoint Events (https://docs.aws.amazon.com/pinpoint/latest/developerguide/event-streams.html)
	// in the Amazon Pinpoint Developer Guide.
	EventType *SetDimension `type:"structure"`

	// One or more custom metrics that your application reports to Amazon Pinpoint.
	// You can use these metrics as selection criteria when you create an event
	// filter.
	Metrics map[string]*MetricDimension `type:"map"`
	// contains filtered or unexported fields
}

Specifies the dimensions for an event filter that determines when a campaign is sent or a journey activity is performed.

func (EventDimensions) GoString added in v1.15.77 

func (s EventDimensions) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EventDimensions) SetAttributes added in v1.15.77 

func (s *EventDimensions) SetAttributes(v map[string]*AttributeDimension) *EventDimensions

SetAttributes sets the Attributes field's value.

func (*EventDimensions) SetEventType added in v1.15.77 

func (s *EventDimensions) SetEventType(v *SetDimension) *EventDimensions

SetEventType sets the EventType field's value.

func (*EventDimensions) SetMetrics added in v1.15.77 

func (s *EventDimensions) SetMetrics(v map[string]*MetricDimension) *EventDimensions

SetMetrics sets the Metrics field's value.

func (EventDimensions) String added in v1.15.77 

func (s EventDimensions) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EventDimensions) Validate added in v1.20.11 

func (s *EventDimensions) Validate() error

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

type EventFilter added in v1.35.0 

type EventFilter struct {

	// The dimensions for the event filter to use for the campaign or the journey
	// activity.
	//
	// Dimensions is a required field
	Dimensions *EventDimensions `type:"structure" required:"true"`

	// The type of event that causes the campaign to be sent or the journey activity
	// to be performed. Valid values are: SYSTEM, sends the campaign or performs
	// the activity when a system event occurs; and, ENDPOINT, sends the campaign
	// or performs the activity when an endpoint event (Events resource) occurs.
	//
	// FilterType is a required field
	FilterType *string `type:"string" required:"true" enum:"FilterType"`
	// contains filtered or unexported fields
}

Specifies the settings for an event that causes a campaign to be sent or a journey activity to be performed.

func (EventFilter) GoString added in v1.35.0 

func (s EventFilter) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EventFilter) SetDimensions added in v1.35.0 

func (s *EventFilter) SetDimensions(v *EventDimensions) *EventFilter

SetDimensions sets the Dimensions field's value.

func (*EventFilter) SetFilterType added in v1.35.0 

func (s *EventFilter) SetFilterType(v string) *EventFilter

SetFilterType sets the FilterType field's value.

func (EventFilter) String added in v1.35.0 

func (s EventFilter) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EventFilter) Validate added in v1.35.0 

func (s *EventFilter) Validate() error

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

type EventItemResponse added in v1.15.7 

type EventItemResponse struct {

	// A custom message that's returned in the response as a result of processing
	// the event.
	Message *string `type:"string"`

	// The status code that's returned in the response as a result of processing
	// the event. Possible values are: 202, for events that were accepted; and,
	// 400, for events that weren't valid.
	StatusCode *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Provides the status code and message that result from processing an event.

func (EventItemResponse) GoString added in v1.15.7 

func (s EventItemResponse) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EventItemResponse) SetMessage added in v1.15.7 

func (s *EventItemResponse) SetMessage(v string) *EventItemResponse

SetMessage sets the Message field's value.

func (*EventItemResponse) SetStatusCode added in v1.15.7 

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

SetStatusCode sets the StatusCode field's value.

func (EventItemResponse) String added in v1.15.7 

func (s EventItemResponse) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type EventStartCondition added in v1.35.0 

type EventStartCondition struct {

	// Specifies the settings for an event that causes a campaign to be sent or
	// a journey activity to be performed.
	EventFilter *EventFilter `type:"structure"`

	SegmentId *string `type:"string"`
	// contains filtered or unexported fields
}

Specifies the settings for an event that causes a journey activity to start.

func (EventStartCondition) GoString added in v1.35.0 

func (s EventStartCondition) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EventStartCondition) SetEventFilter added in v1.35.0 

func (s *EventStartCondition) SetEventFilter(v *EventFilter) *EventStartCondition

SetEventFilter sets the EventFilter field's value.

func (*EventStartCondition) SetSegmentId added in v1.35.0 

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

SetSegmentId sets the SegmentId field's value.

func (EventStartCondition) String added in v1.35.0 

func (s EventStartCondition) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EventStartCondition) Validate added in v1.35.0 

func (s *EventStartCondition) Validate() error

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

type EventStream added in v1.8.0 

type EventStream struct {

	// The unique identifier for the application to publish event data for.
	//
	// ApplicationId is a required field
	ApplicationId *string `type:"string" required:"true"`

	// The Amazon Resource Name (ARN) of the Amazon Kinesis data stream or Amazon
	// Kinesis Data Firehose delivery stream to publish event data to.
	//
	// For a Kinesis data stream, the ARN format is: arn:aws:kinesis:region:account-id:stream/stream_name
	//
	// For a Kinesis Data Firehose delivery stream, the ARN format is: arn:aws:firehose:region:account-id:deliverystream/stream_name
	//
	// DestinationStreamArn is a required field
	DestinationStreamArn *string `type:"string" required:"true"`

	// (Deprecated) Your AWS account ID, which you assigned to an external ID key
	// in an IAM trust policy. Amazon Pinpoint previously used this value to assume
	// an IAM role when publishing event data, but we removed this requirement.
	// We don't recommend use of external IDs for IAM roles that are assumed by
	// Amazon Pinpoint.
	ExternalId *string `type:"string"`

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

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

	// The AWS Identity and Access Management (IAM) role that authorizes Amazon
	// Pinpoint to publish event data to the stream in your AWS account.
	//
	// RoleArn is a required field
	RoleArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Specifies settings for publishing event data to an Amazon Kinesis data stream or an Amazon Kinesis Data Firehose delivery stream.

func (EventStream) GoString added in v1.8.0 

func (s EventStream) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type EventsBatch added in v1.15.7 

type EventsBatch struct {

	// A set of properties and attributes that are associated with the endpoint.
	//
	// Endpoint is a required field
	Endpoint *PublicEndpoint `type:"structure" required:"true"`

	// A set of properties that are associated with the event.
	//
	// Events is a required field
	Events map[string]*Event `type:"map" required:"true"`
	// contains filtered or unexported fields
}

Specifies a batch of endpoints and events to process.

func (EventsBatch) GoString added in v1.15.7 

func (s EventsBatch) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EventsBatch) SetEndpoint added in v1.15.7 

func (s *EventsBatch) SetEndpoint(v *PublicEndpoint) *EventsBatch

SetEndpoint sets the Endpoint field's value.

func (*EventsBatch) SetEvents added in v1.15.7 

func (s *EventsBatch) SetEvents(v map[string]*Event) *EventsBatch

SetEvents sets the Events field's value.

func (EventsBatch) String added in v1.15.7 

func (s EventsBatch) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EventsBatch) Validate added in v1.20.11 

func (s *EventsBatch) Validate() error

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

type EventsRequest added in v1.15.7 

type EventsRequest struct {

	// The batch of events to process. For each item in a batch, the endpoint ID
	// acts as a key that has an EventsBatch object as its value.
	//
	// BatchItem is a required field
	BatchItem map[string]*EventsBatch `type:"map" required:"true"`
	// contains filtered or unexported fields
}

Specifies a batch of events to process.

func (EventsRequest) GoString added in v1.15.7 

func (s EventsRequest) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EventsRequest) SetBatchItem added in v1.15.7 

func (s *EventsRequest) SetBatchItem(v map[string]*EventsBatch) *EventsRequest

SetBatchItem sets the BatchItem field's value.

func (EventsRequest) String added in v1.15.7 

func (s EventsRequest) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EventsRequest) Validate added in v1.20.11 

func (s *EventsRequest) Validate() error

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

type EventsResponse added in v1.15.7 

type EventsResponse struct {

	// A map that contains a multipart response for each endpoint. For each item
	// in this object, the endpoint ID is the key and the item response is the value.
	// If no item response exists, the value can also be one of the following: 202,
	// the request was processed successfully; or 400, the payload wasn't valid
	// or required fields were missing.
	Results map[string]*ItemResponse `type:"map"`
	// contains filtered or unexported fields
}

Provides information about endpoints and the events that they're associated with.

func (EventsResponse) GoString added in v1.15.7 

func (s EventsResponse) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EventsResponse) SetResults added in v1.15.7 

func (s *EventsResponse) SetResults(v map[string]*ItemResponse) *EventsResponse

SetResults sets the Results field's value.

func (EventsResponse) String added in v1.15.7 

func (s EventsResponse) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ExportJobRequest added in v1.13.11 

type ExportJobRequest struct {

	// The Amazon Resource Name (ARN) of the AWS Identity and Access Management
	// (IAM) role that authorizes Amazon Pinpoint to access the Amazon S3 location
	// where you want to export endpoint definitions to.
	//
	// RoleArn is a required field
	RoleArn *string `type:"string" required:"true"`

	// The URL of the location in an Amazon Simple Storage Service (Amazon S3) bucket
	// where you want to export endpoint definitions to. This location is typically
	// a folder that contains multiple files. The URL should be in the following
	// format: s3://bucket-name/folder-name/.
	//
	// S3UrlPrefix is a required field
	S3UrlPrefix *string `type:"string" required:"true"`

	// The identifier for the segment to export endpoint definitions from. If you
	// don't specify this value, Amazon Pinpoint exports definitions for all the
	// endpoints that are associated with the application.
	SegmentId *string `type:"string"`

	// The version of the segment to export endpoint definitions from, if specified.
	SegmentVersion *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Specifies the settings for a job that exports endpoint definitions to an Amazon Simple Storage Service (Amazon S3) bucket.

func (ExportJobRequest) GoString added in v1.13.11 

func (s ExportJobRequest) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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) SetSegmentVersion added in v1.14.20 

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

SetSegmentVersion sets the SegmentVersion field's value.

func (ExportJobRequest) String added in v1.13.11 

func (s ExportJobRequest) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ExportJobRequest) Validate added in v1.20.11 

func (s *ExportJobRequest) Validate() error

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

type ExportJobResource added in v1.13.11 

type ExportJobResource struct {

	// The Amazon Resource Name (ARN) of the AWS Identity and Access Management
	// (IAM) role that authorized Amazon Pinpoint to access the Amazon S3 location
	// where the endpoint definitions were exported to.
	//
	// RoleArn is a required field
	RoleArn *string `type:"string" required:"true"`

	// The URL of the location in an Amazon Simple Storage Service (Amazon S3) bucket
	// where the endpoint definitions were exported to. This location is typically
	// a folder that contains multiple files. The URL should be in the following
	// format: s3://bucket-name/folder-name/.
	//
	// S3UrlPrefix is a required field
	S3UrlPrefix *string `type:"string" required:"true"`

	// The identifier for the segment that the endpoint definitions were exported
	// from. If this value isn't present, Amazon Pinpoint exported definitions for
	// all the endpoints that are associated with the application.
	SegmentId *string `type:"string"`

	// The version of the segment that the endpoint definitions were exported from.
	SegmentVersion *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Provides information about the resource settings for a job that exports endpoint definitions to a file. The file can be added directly to an Amazon Simple Storage Service (Amazon S3) bucket by using the Amazon Pinpoint API or downloaded directly to a computer by using the Amazon Pinpoint console.

func (ExportJobResource) GoString added in v1.13.11 

func (s ExportJobResource) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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) SetSegmentVersion added in v1.14.20 

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

SetSegmentVersion sets the SegmentVersion field's value.

func (ExportJobResource) String added in v1.13.11 

func (s ExportJobResource) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ExportJobResponse added in v1.13.11 

type ExportJobResponse struct {

	// The unique identifier for the application that's associated with the export
	// job.
	//
	// ApplicationId is a required field
	ApplicationId *string `type:"string" required:"true"`

	// The number of pieces that were processed successfully (completed) by the
	// export job, as of the time of the request.
	CompletedPieces *int64 `type:"integer"`

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

	// The date, in ISO 8601 format, when the export job was created.
	//
	// CreationDate is a required field
	CreationDate *string `type:"string" required:"true"`

	// The resource settings that apply to the export job.
	//
	// Definition is a required field
	Definition *ExportJobResource `type:"structure" required:"true"`

	// The number of pieces that weren't processed successfully (failed) by the
	// export job, as of the time of the request.
	FailedPieces *int64 `type:"integer"`

	// An array of entries, one for each of the first 100 entries that weren't processed
	// successfully (failed) by the export job, if any.
	Failures []*string `type:"list"`

	// The unique identifier for the export job.
	//
	// Id is a required field
	Id *string `type:"string" required:"true"`

	// The status of the export job. The job status is FAILED if Amazon Pinpoint
	// wasn't able to process one or more pieces in the job.
	//
	// JobStatus is a required field
	JobStatus *string `type:"string" required:"true" enum:"JobStatus"`

	// The total number of endpoint definitions that weren't processed successfully
	// (failed) by the export job, typically because an error, such as a syntax
	// error, occurred.
	TotalFailures *int64 `type:"integer"`

	// The total number of pieces that must be processed to complete the export
	// job. Each piece consists of an approximately equal portion of the endpoint
	// definitions that are part of the export job.
	TotalPieces *int64 `type:"integer"`

	// The total number of endpoint definitions that were processed by the export
	// job.
	TotalProcessed *int64 `type:"integer"`

	// The job type. This value is EXPORT for export jobs.
	//
	// Type is a required field
	Type *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Provides information about the status and settings of a job that exports endpoint definitions to a file. The file can be added directly to an Amazon Simple Storage Service (Amazon S3) bucket by using the Amazon Pinpoint API or downloaded directly to a computer by using the Amazon Pinpoint console.

func (ExportJobResponse) GoString added in v1.13.11 

func (s ExportJobResponse) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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 

func (s *ExportJobResponse) SetDefinition(v *ExportJobResource) *ExportJobResponse

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 

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

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 

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

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ExportJobsResponse added in v1.13.11 

type ExportJobsResponse struct {

	// An array of responses, one for each export job that's associated with the
	// application (Export Jobs resource) or segment (Segment Export Jobs resource).
	//
	// Item is a required field
	Item []*ExportJobResponse `type:"list" required:"true"`

	// The string to use in a subsequent request to get the next page of results
	// in a paginated response. This value is null if there are no additional pages.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

Provides information about all the export jobs that are associated with an application or segment. An export job is a job that exports endpoint definitions to a file.

func (ExportJobsResponse) GoString added in v1.13.11 

func (s ExportJobsResponse) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ExportJobsResponse) SetItem added in v1.13.11 

func (s *ExportJobsResponse) SetItem(v []*ExportJobResponse) *ExportJobsResponse

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ForbiddenException added in v1.28.0 

type ForbiddenException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`

	RequestID_ *string `locationName:"RequestID" type:"string"`
	// contains filtered or unexported fields
}

Provides information about an API request or response.

func (*ForbiddenException) Code added in v1.28.0 

func (s *ForbiddenException) Code() string

Code returns the exception type name.

func (*ForbiddenException) Error added in v1.28.0 

func (s *ForbiddenException) Error() string

func (ForbiddenException) GoString added in v1.28.0 

func (s ForbiddenException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ForbiddenException) Message added in v1.28.0 

func (s *ForbiddenException) Message() string

Message returns the exception's message.

func (*ForbiddenException) OrigErr added in v1.28.0 

func (s *ForbiddenException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ForbiddenException) RequestID added in v1.28.0 

func (s *ForbiddenException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ForbiddenException) StatusCode added in v1.28.0 

func (s *ForbiddenException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ForbiddenException) String added in v1.28.0 

func (s ForbiddenException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GCMChannelRequest 

type GCMChannelRequest struct {

	// The Web API Key, also referred to as an API_KEY or server key, that you received
	// from Google to communicate with Google services.
	//
	// ApiKey is a required field
	ApiKey *string `type:"string" required:"true"`

	// Specifies whether to enable the GCM channel for the application.
	Enabled *bool `type:"boolean"`
	// contains filtered or unexported fields
}

Specifies the status and settings of the GCM channel for an application. This channel enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service.

func (GCMChannelRequest) GoString 

func (s GCMChannelRequest) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GCMChannelRequest) Validate added in v1.20.11 

func (s *GCMChannelRequest) Validate() error

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

type GCMChannelResponse 

type GCMChannelResponse struct {

	// The unique identifier for the application that the GCM channel applies to.
	ApplicationId *string `type:"string"`

	// The date and time when the GCM channel was enabled.
	CreationDate *string `type:"string"`

	// The Web API Key, also referred to as an API_KEY or server key, that you received
	// from Google to communicate with Google services.
	//
	// Credential is a required field
	Credential *string `type:"string" required:"true"`

	// Specifies whether the GCM channel is enabled for the application.
	Enabled *bool `type:"boolean"`

	// (Not used) This property is retained only for backward compatibility.
	HasCredential *bool `type:"boolean"`

	// (Deprecated) An identifier for the GCM channel. This property is retained
	// only for backward compatibility.
	Id *string `type:"string"`

	// Specifies whether the GCM channel is archived.
	IsArchived *bool `type:"boolean"`

	// The user who last modified the GCM channel.
	LastModifiedBy *string `type:"string"`

	// The date and time when the GCM channel was last modified.
	LastModifiedDate *string `type:"string"`

	// The type of messaging or notification platform for the channel. For the GCM
	// channel, this value is GCM.
	//
	// Platform is a required field
	Platform *string `type:"string" required:"true"`

	// The current version of the GCM channel.
	Version *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Provides information about the status and settings of the GCM channel for an application. The GCM channel enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service.

func (GCMChannelResponse) GoString 

func (s GCMChannelResponse) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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 

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

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GCMMessage added in v1.8.38 

type GCMMessage struct {

	// The action to occur if the recipient taps the push notification. Valid values
	// are:
	//
	//    * OPEN_APP - Your app opens or it becomes the foreground app if it was
	//    sent to the background. This is the default action.
	//
	//    * DEEP_LINK - Your app opens and displays a designated user interface
	//    in the app. This action uses the deep-linking features of the Android
	//    platform.
	//
	//    * URL - The default mobile browser on the recipient's device opens and
	//    loads the web page at a URL that you specify.
	Action *string `type:"string" enum:"Action"`

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

	// An arbitrary string that identifies a group of messages that can be collapsed
	// to ensure that only the last message is sent when delivery can resume. This
	// helps avoid sending too many instances of the same messages when the recipient's
	// device comes online again or becomes active.
	//
	// Amazon Pinpoint specifies this value in the Firebase Cloud Messaging (FCM)
	// collapse_key parameter when it sends the notification message to FCM.
	CollapseKey *string `type:"string"`

	// The JSON data payload to use for the push notification, if the notification
	// is a silent push notification. This payload is added to the data.pinpoint.jsonBody
	// object of the notification.
	Data map[string]*string `type:"map"`

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

	// The URL of the large icon image to display in the content view of the push
	// notification.
	ImageIconUrl *string `type:"string"`

	// The URL of an image to display in the push notification.
	ImageUrl *string `type:"string"`

	// para>normal - The notification might be delayed. Delivery is optimized for
	// battery usage on the recipient's device. Use this value unless immediate
	// delivery is required.
	// /listitem>
	// high - The notification is sent immediately and might wake a sleeping device.
	// /para>
	// Amazon Pinpoint specifies this value in the FCM priority parameter when it
	// sends the notification message to FCM.
	//
	// The equivalent values for Apple Push Notification service (APNs) are 5, for
	// normal, and 10, for high. If you specify an APNs value for this property,
	// Amazon Pinpoint accepts and converts the value to the corresponding FCM value.
	Priority *string `type:"string"`

	// The raw, JSON-formatted string to use as the payload for the notification
	// message. If specified, this value overrides all other content for the message.
	RawContent *string `type:"string"`

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

	// Specifies whether the notification is a silent push notification, which is
	// a push notification that doesn't display on a recipient's device. Silent
	// push notifications can be used for cases such as updating an app's configuration
	// or supporting phone home functionality.
	SilentPush *bool `type:"boolean"`

	// The URL of the small icon image to display in the status bar and the content
	// view of the push notification.
	SmallImageIconUrl *string `type:"string"`

	// The sound to play when the recipient receives the push notification. You
	// can use the default stream or specify the file name of a sound resource that's
	// bundled in your app. On an Android platform, the sound file must reside in
	// /res/raw/.
	Sound *string `type:"string"`

	// The default message variables to use in the notification message. You can
	// override the default variables with individual address variables.
	Substitutions map[string][]*string `type:"map"`

	// The amount of time, in seconds, that FCM should store and attempt to deliver
	// the push notification, if the service is unable to deliver the notification
	// the first time. If you don't specify this value, FCM defaults to the maximum
	// value, which is 2,419,200 seconds (28 days).
	//
	// Amazon Pinpoint specifies this value in the FCM time_to_live parameter when
	// it sends the notification message to FCM.
	TimeToLive *int64 `type:"integer"`

	// The title to display above the notification message on the recipient's device.
	Title *string `type:"string"`

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

Specifies the settings for a one-time message that's sent directly to an endpoint through the GCM channel. The GCM channel enables Amazon Pinpoint to send messages to the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service.

func (GCMMessage) GoString added in v1.8.38 

func (s GCMMessage) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GPSCoordinates added in v1.14.20 

type GPSCoordinates struct {

	// The latitude coordinate of the location.
	//
	// Latitude is a required field
	Latitude *float64 `type:"double" required:"true"`

	// The longitude coordinate of the location.
	//
	// Longitude is a required field
	Longitude *float64 `type:"double" required:"true"`
	// contains filtered or unexported fields
}

Specifies the GPS coordinates of a location.

func (GPSCoordinates) GoString added in v1.14.20 

func (s GPSCoordinates) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GPSCoordinates) SetLatitude added in v1.14.20 

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

SetLatitude sets the Latitude field's value.

func (*GPSCoordinates) SetLongitude added in v1.14.20 

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

SetLongitude sets the Longitude field's value.

func (GPSCoordinates) String added in v1.14.20 

func (s GPSCoordinates) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GPSCoordinates) Validate added in v1.20.11 

func (s *GPSCoordinates) Validate() error

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

type GPSPointDimension added in v1.14.20 

type GPSPointDimension struct {

	// The GPS coordinates to measure distance from.
	//
	// Coordinates is a required field
	Coordinates *GPSCoordinates `type:"structure" required:"true"`

	// The range, in kilometers, from the GPS coordinates.
	RangeInKilometers *float64 `type:"double"`
	// contains filtered or unexported fields
}

Specifies GPS-based criteria for including or excluding endpoints from a segment.

func (GPSPointDimension) GoString added in v1.14.20 

func (s GPSPointDimension) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GPSPointDimension) SetCoordinates added in v1.14.20 

func (s *GPSPointDimension) SetCoordinates(v *GPSCoordinates) *GPSPointDimension

SetCoordinates sets the Coordinates field's value.

func (*GPSPointDimension) SetRangeInKilometers added in v1.14.20 

func (s *GPSPointDimension) SetRangeInKilometers(v float64) *GPSPointDimension

SetRangeInKilometers sets the RangeInKilometers field's value.

func (GPSPointDimension) String added in v1.14.20 

func (s GPSPointDimension) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GPSPointDimension) Validate added in v1.20.11 

func (s *GPSPointDimension) Validate() error

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

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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 {

	// Provides information about the status and settings of the ADM (Amazon Device
	// Messaging) channel for an application.
	//
	// ADMChannelResponse is a required field
	ADMChannelResponse *ADMChannelResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (GetAdmChannelOutput) GoString added in v1.12.1 

func (s GetAdmChannelOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetApnsChannelInput) Validate 

func (s *GetApnsChannelInput) Validate() error

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

type GetApnsChannelOutput 

type GetApnsChannelOutput struct {

	// Provides information about the status and settings of the APNs (Apple Push
	// Notification service) channel for an application.
	//
	// APNSChannelResponse is a required field
	APNSChannelResponse *APNSChannelResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (GetApnsChannelOutput) GoString 

func (s GetApnsChannelOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetApnsSandboxChannelInput) SetApplicationId added in v1.8.38 

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

SetApplicationId sets the ApplicationId field's value.

func (GetApnsSandboxChannelInput) String added in v1.8.38 

func (s GetApnsSandboxChannelInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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 {

	// Provides information about the status and settings of the APNs (Apple Push
	// Notification service) sandbox channel for an application.
	//
	// APNSSandboxChannelResponse is a required field
	APNSSandboxChannelResponse *APNSSandboxChannelResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (GetApnsSandboxChannelOutput) GoString added in v1.8.38 

func (s GetApnsSandboxChannelOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetApnsSandboxChannelOutput) SetAPNSSandboxChannelResponse added in v1.8.38 

func (s *GetApnsSandboxChannelOutput) SetAPNSSandboxChannelResponse(v *APNSSandboxChannelResponse) *GetApnsSandboxChannelOutput

SetAPNSSandboxChannelResponse sets the APNSSandboxChannelResponse field's value.

func (GetApnsSandboxChannelOutput) String added in v1.8.38 

func (s GetApnsSandboxChannelOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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 {

	// Provides information about the status and settings of the APNs (Apple Push
	// Notification service) VoIP channel for an application.
	//
	// APNSVoipChannelResponse is a required field
	APNSVoipChannelResponse *APNSVoipChannelResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (GetApnsVoipChannelOutput) GoString added in v1.12.17 

func (s GetApnsVoipChannelOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetApnsVoipChannelOutput) SetAPNSVoipChannelResponse added in v1.12.17 

func (s *GetApnsVoipChannelOutput) SetAPNSVoipChannelResponse(v *APNSVoipChannelResponse) *GetApnsVoipChannelOutput

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type 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 

func (s GetApnsVoipSandboxChannelInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetApnsVoipSandboxChannelInput) SetApplicationId added in v1.12.17 

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

SetApplicationId sets the ApplicationId field's value.

func (GetApnsVoipSandboxChannelInput) String added in v1.12.17 

func (s GetApnsVoipSandboxChannelInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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 {

	// Provides information about the status and settings of the APNs (Apple Push
	// Notification service) VoIP sandbox channel for an application.
	//
	// APNSVoipSandboxChannelResponse is a required field
	APNSVoipSandboxChannelResponse *APNSVoipSandboxChannelResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (GetApnsVoipSandboxChannelOutput) GoString added in v1.12.17 

func (s GetApnsVoipSandboxChannelOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetApnsVoipSandboxChannelOutput) SetAPNSVoipSandboxChannelResponse added in v1.12.17 

func (s *GetApnsVoipSandboxChannelOutput) SetAPNSVoipSandboxChannelResponse(v *APNSVoipSandboxChannelResponse) *GetApnsVoipSandboxChannelOutput

SetAPNSVoipSandboxChannelResponse sets the APNSVoipSandboxChannelResponse field's value.

func (GetApnsVoipSandboxChannelOutput) String added in v1.12.17 

func (s GetApnsVoipSandboxChannelOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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 {

	// Provides information about an application.
	//
	// 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetApplicationDateRangeKpiInput added in v1.21.4 

type GetApplicationDateRangeKpiInput struct {

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

	EndTime *time.Time `location:"querystring" locationName:"end-time" type:"timestamp" timestampFormat:"iso8601"`

	// KpiName is a required field
	KpiName *string `location:"uri" locationName:"kpi-name" type:"string" required:"true"`

	NextToken *string `location:"querystring" locationName:"next-token" type:"string"`

	PageSize *string `location:"querystring" locationName:"page-size" type:"string"`

	StartTime *time.Time `location:"querystring" locationName:"start-time" type:"timestamp" timestampFormat:"iso8601"`
	// contains filtered or unexported fields
}

func (GetApplicationDateRangeKpiInput) GoString added in v1.21.4 

func (s GetApplicationDateRangeKpiInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetApplicationDateRangeKpiInput) SetApplicationId added in v1.21.4 

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

SetApplicationId sets the ApplicationId field's value.

func (*GetApplicationDateRangeKpiInput) SetEndTime added in v1.21.4 

func (s *GetApplicationDateRangeKpiInput) SetEndTime(v time.Time) *GetApplicationDateRangeKpiInput

SetEndTime sets the EndTime field's value.

func (*GetApplicationDateRangeKpiInput) SetKpiName added in v1.21.4 

func (s *GetApplicationDateRangeKpiInput) SetKpiName(v string) *GetApplicationDateRangeKpiInput

SetKpiName sets the KpiName field's value.

func (*GetApplicationDateRangeKpiInput) SetNextToken added in v1.21.4 

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

SetNextToken sets the NextToken field's value.

func (*GetApplicationDateRangeKpiInput) SetPageSize added in v1.21.4 

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

SetPageSize sets the PageSize field's value.

func (*GetApplicationDateRangeKpiInput) SetStartTime added in v1.21.4 

func (s *GetApplicationDateRangeKpiInput) SetStartTime(v time.Time) *GetApplicationDateRangeKpiInput

SetStartTime sets the StartTime field's value.

func (GetApplicationDateRangeKpiInput) String added in v1.21.4 

func (s GetApplicationDateRangeKpiInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetApplicationDateRangeKpiInput) Validate added in v1.21.4 

func (s *GetApplicationDateRangeKpiInput) Validate() error

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

type GetApplicationDateRangeKpiOutput added in v1.21.4 

type GetApplicationDateRangeKpiOutput struct {

	// Provides the results of a query that retrieved the data for a standard metric
	// that applies to an application, and provides information about that query.
	//
	// ApplicationDateRangeKpiResponse is a required field
	ApplicationDateRangeKpiResponse *ApplicationDateRangeKpiResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (GetApplicationDateRangeKpiOutput) GoString added in v1.21.4 

func (s GetApplicationDateRangeKpiOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetApplicationDateRangeKpiOutput) SetApplicationDateRangeKpiResponse added in v1.21.4 

func (s *GetApplicationDateRangeKpiOutput) SetApplicationDateRangeKpiResponse(v *ApplicationDateRangeKpiResponse) *GetApplicationDateRangeKpiOutput

SetApplicationDateRangeKpiResponse sets the ApplicationDateRangeKpiResponse field's value.

func (GetApplicationDateRangeKpiOutput) String added in v1.21.4 

func (s GetApplicationDateRangeKpiOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetApplicationSettingsInput) SetApplicationId 

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

SetApplicationId sets the ApplicationId field's value.

func (GetApplicationSettingsInput) String 

func (s GetApplicationSettingsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetApplicationSettingsInput) Validate 

func (s *GetApplicationSettingsInput) Validate() error

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

type GetApplicationSettingsOutput 

type GetApplicationSettingsOutput struct {

	// Provides information about an application, including the default settings
	// for an application.
	//
	// ApplicationSettingsResource is a required field
	ApplicationSettingsResource *ApplicationSettingsResource `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (GetApplicationSettingsOutput) GoString 

func (s GetApplicationSettingsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetApplicationSettingsOutput) SetApplicationSettingsResource 

func (s *GetApplicationSettingsOutput) SetApplicationSettingsResource(v *ApplicationSettingsResource) *GetApplicationSettingsOutput

SetApplicationSettingsResource sets the ApplicationSettingsResource field's value.

func (GetApplicationSettingsOutput) String 

func (s GetApplicationSettingsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetAppsOutput added in v1.10.20 

type GetAppsOutput struct {

	// Provides information about all of your applications.
	//
	// ApplicationsResponse is a required field
	ApplicationsResponse *ApplicationsResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (GetAppsOutput) GoString added in v1.10.20 

func (s GetAppsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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 {

	// Provides information about the status and settings of the Baidu (Baidu Cloud
	// Push) channel for an application.
	//
	// BaiduChannelResponse is a required field
	BaiduChannelResponse *BaiduChannelResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (GetBaiduChannelOutput) GoString added in v1.12.1 

func (s GetBaiduChannelOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetCampaignActivitiesInput) SetApplicationId 

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

SetApplicationId sets the ApplicationId field's value.

func (*GetCampaignActivitiesInput) SetCampaignId 

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

SetCampaignId sets the CampaignId field's value.

func (*GetCampaignActivitiesInput) SetPageSize 

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

SetPageSize sets the PageSize field's value.

func (*GetCampaignActivitiesInput) SetToken 

func (s *GetCampaignActivitiesInput) SetToken(v string) *GetCampaignActivitiesInput

SetToken sets the Token field's value.

func (GetCampaignActivitiesInput) String 

func (s GetCampaignActivitiesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetCampaignActivitiesInput) Validate 

func (s *GetCampaignActivitiesInput) Validate() error

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

type GetCampaignActivitiesOutput 

type GetCampaignActivitiesOutput struct {

	// Provides information about the activities that were performed by a campaign.
	//
	// ActivitiesResponse is a required field
	ActivitiesResponse *ActivitiesResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (GetCampaignActivitiesOutput) GoString 

func (s GetCampaignActivitiesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetCampaignActivitiesOutput) SetActivitiesResponse 

func (s *GetCampaignActivitiesOutput) SetActivitiesResponse(v *ActivitiesResponse) *GetCampaignActivitiesOutput

SetActivitiesResponse sets the ActivitiesResponse field's value.

func (GetCampaignActivitiesOutput) String 

func (s GetCampaignActivitiesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetCampaignDateRangeKpiInput added in v1.21.4 

type GetCampaignDateRangeKpiInput struct {

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

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

	EndTime *time.Time `location:"querystring" locationName:"end-time" type:"timestamp" timestampFormat:"iso8601"`

	// KpiName is a required field
	KpiName *string `location:"uri" locationName:"kpi-name" type:"string" required:"true"`

	NextToken *string `location:"querystring" locationName:"next-token" type:"string"`

	PageSize *string `location:"querystring" locationName:"page-size" type:"string"`

	StartTime *time.Time `location:"querystring" locationName:"start-time" type:"timestamp" timestampFormat:"iso8601"`
	// contains filtered or unexported fields
}

func (GetCampaignDateRangeKpiInput) GoString added in v1.21.4 

func (s GetCampaignDateRangeKpiInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetCampaignDateRangeKpiInput) SetApplicationId added in v1.21.4 

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

SetApplicationId sets the ApplicationId field's value.

func (*GetCampaignDateRangeKpiInput) SetCampaignId added in v1.21.4 

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

SetCampaignId sets the CampaignId field's value.

func (*GetCampaignDateRangeKpiInput) SetEndTime added in v1.21.4 

func (s *GetCampaignDateRangeKpiInput) SetEndTime(v time.Time) *GetCampaignDateRangeKpiInput

SetEndTime sets the EndTime field's value.

func (*GetCampaignDateRangeKpiInput) SetKpiName added in v1.21.4 

func (s *GetCampaignDateRangeKpiInput) SetKpiName(v string) *GetCampaignDateRangeKpiInput

SetKpiName sets the KpiName field's value.

func (*GetCampaignDateRangeKpiInput) SetNextToken added in v1.21.4 

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

SetNextToken sets the NextToken field's value.

func (*GetCampaignDateRangeKpiInput) SetPageSize added in v1.21.4 

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

SetPageSize sets the PageSize field's value.

func (*GetCampaignDateRangeKpiInput) SetStartTime added in v1.21.4 

func (s *GetCampaignDateRangeKpiInput) SetStartTime(v time.Time) *GetCampaignDateRangeKpiInput

SetStartTime sets the StartTime field's value.

func (GetCampaignDateRangeKpiInput) String added in v1.21.4 

func (s GetCampaignDateRangeKpiInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetCampaignDateRangeKpiInput) Validate added in v1.21.4 

func (s *GetCampaignDateRangeKpiInput) Validate() error

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

type GetCampaignDateRangeKpiOutput added in v1.21.4 

type GetCampaignDateRangeKpiOutput struct {

	// Provides the results of a query that retrieved the data for a standard metric
	// that applies to a campaign, and provides information about that query.
	//
	// CampaignDateRangeKpiResponse is a required field
	CampaignDateRangeKpiResponse *CampaignDateRangeKpiResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (GetCampaignDateRangeKpiOutput) GoString added in v1.21.4 

func (s GetCampaignDateRangeKpiOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetCampaignDateRangeKpiOutput) SetCampaignDateRangeKpiResponse added in v1.21.4 

func (s *GetCampaignDateRangeKpiOutput) SetCampaignDateRangeKpiResponse(v *CampaignDateRangeKpiResponse) *GetCampaignDateRangeKpiOutput

SetCampaignDateRangeKpiResponse sets the CampaignDateRangeKpiResponse field's value.

func (GetCampaignDateRangeKpiOutput) String added in v1.21.4 

func (s GetCampaignDateRangeKpiOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetCampaignInput) Validate 

func (s *GetCampaignInput) Validate() error

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

type GetCampaignOutput 

type GetCampaignOutput struct {

	// Provides information about the status, configuration, and other settings
	// for a campaign.
	//
	// CampaignResponse is a required field
	CampaignResponse *CampaignResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (GetCampaignOutput) GoString 

func (s GetCampaignOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetCampaignVersionInput) SetApplicationId 

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

SetApplicationId sets the ApplicationId field's value.

func (*GetCampaignVersionInput) SetCampaignId 

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

SetCampaignId sets the CampaignId field's value.

func (*GetCampaignVersionInput) SetVersion 

func (s *GetCampaignVersionInput) SetVersion(v string) *GetCampaignVersionInput

SetVersion sets the Version field's value.

func (GetCampaignVersionInput) String 

func (s GetCampaignVersionInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetCampaignVersionInput) Validate 

func (s *GetCampaignVersionInput) Validate() error

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

type GetCampaignVersionOutput 

type GetCampaignVersionOutput struct {

	// Provides information about the status, configuration, and other settings
	// for a campaign.
	//
	// CampaignResponse is a required field
	CampaignResponse *CampaignResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (GetCampaignVersionOutput) GoString 

func (s GetCampaignVersionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetCampaignVersionOutput) SetCampaignResponse 

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

SetCampaignResponse sets the CampaignResponse field's value.

func (GetCampaignVersionOutput) String 

func (s GetCampaignVersionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetCampaignVersionsInput) SetApplicationId 

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

SetApplicationId sets the ApplicationId field's value.

func (*GetCampaignVersionsInput) SetCampaignId 

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

SetCampaignId sets the CampaignId field's value.

func (*GetCampaignVersionsInput) SetPageSize 

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

SetPageSize sets the PageSize field's value.

func (*GetCampaignVersionsInput) SetToken 

func (s *GetCampaignVersionsInput) SetToken(v string) *GetCampaignVersionsInput

SetToken sets the Token field's value.

func (GetCampaignVersionsInput) String 

func (s GetCampaignVersionsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetCampaignVersionsInput) Validate 

func (s *GetCampaignVersionsInput) Validate() error

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

type GetCampaignVersionsOutput 

type GetCampaignVersionsOutput struct {

	// Provides information about the configuration and other settings for all the
	// campaigns that are associated with an application.
	//
	// CampaignsResponse is a required field
	CampaignsResponse *CampaignsResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (GetCampaignVersionsOutput) GoString 

func (s GetCampaignVersionsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetCampaignVersionsOutput) SetCampaignsResponse 

func (s *GetCampaignVersionsOutput) SetCampaignsResponse(v *CampaignsResponse) *GetCampaignVersionsOutput

SetCampaignsResponse sets the CampaignsResponse field's value.

func (GetCampaignVersionsOutput) String 

func (s GetCampaignVersionsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetCampaignsInput) Validate 

func (s *GetCampaignsInput) Validate() error

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

type GetCampaignsOutput 

type GetCampaignsOutput struct {

	// Provides information about the configuration and other settings for all the
	// campaigns that are associated with an application.
	//
	// CampaignsResponse is a required field
	CampaignsResponse *CampaignsResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (GetCampaignsOutput) GoString 

func (s GetCampaignsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetChannelsInput added in v1.14.20 

type GetChannelsInput struct {

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

func (GetChannelsInput) GoString added in v1.14.20 

func (s GetChannelsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetChannelsInput) SetApplicationId added in v1.14.20 

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

SetApplicationId sets the ApplicationId field's value.

func (GetChannelsInput) String added in v1.14.20 

func (s GetChannelsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetChannelsInput) Validate added in v1.14.20 

func (s *GetChannelsInput) Validate() error

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

type GetChannelsOutput added in v1.14.20 

type GetChannelsOutput struct {

	// Provides information about the general settings and status of all channels
	// for an application, including channels that aren't enabled for the application.
	//
	// ChannelsResponse is a required field
	ChannelsResponse *ChannelsResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (GetChannelsOutput) GoString added in v1.14.20 

func (s GetChannelsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetChannelsOutput) SetChannelsResponse added in v1.14.20 

func (s *GetChannelsOutput) SetChannelsResponse(v *ChannelsResponse) *GetChannelsOutput

SetChannelsResponse sets the ChannelsResponse field's value.

func (GetChannelsOutput) String added in v1.14.20 

func (s GetChannelsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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 {

	// Provides information about the status and settings of the email channel for
	// an application.
	//
	// EmailChannelResponse is a required field
	EmailChannelResponse *EmailChannelResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (GetEmailChannelOutput) GoString added in v1.8.38 

func (s GetEmailChannelOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetEmailTemplateInput added in v1.25.7 

type GetEmailTemplateInput struct {

	// TemplateName is a required field
	TemplateName *string `location:"uri" locationName:"template-name" type:"string" required:"true"`

	Version *string `location:"querystring" locationName:"version" type:"string"`
	// contains filtered or unexported fields
}

func (GetEmailTemplateInput) GoString added in v1.25.7 

func (s GetEmailTemplateInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetEmailTemplateInput) SetTemplateName added in v1.25.7 

func (s *GetEmailTemplateInput) SetTemplateName(v string) *GetEmailTemplateInput

SetTemplateName sets the TemplateName field's value.

func (*GetEmailTemplateInput) SetVersion added in v1.26.7 

func (s *GetEmailTemplateInput) SetVersion(v string) *GetEmailTemplateInput

SetVersion sets the Version field's value.

func (GetEmailTemplateInput) String added in v1.25.7 

func (s GetEmailTemplateInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetEmailTemplateInput) Validate added in v1.25.7 

func (s *GetEmailTemplateInput) Validate() error

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

type GetEmailTemplateOutput added in v1.25.7 

type GetEmailTemplateOutput struct {

	// Provides information about the content and settings for a message template
	// that can be used in messages that are sent through the email channel.
	//
	// EmailTemplateResponse is a required field
	EmailTemplateResponse *EmailTemplateResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (GetEmailTemplateOutput) GoString added in v1.25.7 

func (s GetEmailTemplateOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetEmailTemplateOutput) SetEmailTemplateResponse added in v1.25.7 

func (s *GetEmailTemplateOutput) SetEmailTemplateResponse(v *EmailTemplateResponse) *GetEmailTemplateOutput

SetEmailTemplateResponse sets the EmailTemplateResponse field's value.

func (GetEmailTemplateOutput) String added in v1.25.7 

func (s GetEmailTemplateOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetEndpointInput) Validate 

func (s *GetEndpointInput) Validate() error

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

type GetEndpointOutput 

type GetEndpointOutput struct {

	// Provides information about the channel type and other settings for an endpoint.
	//
	// EndpointResponse is a required field
	EndpointResponse *EndpointResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (GetEndpointOutput) GoString 

func (s GetEndpointOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetEventStreamInput added in v1.8.0 

type GetEventStreamInput struct {

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

func (GetEventStreamInput) GoString added in v1.8.0 

func (s GetEventStreamInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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 {

	// Specifies settings for publishing event data to an Amazon Kinesis data stream
	// or an Amazon Kinesis Data Firehose delivery stream.
	//
	// EventStream is a required field
	EventStream *EventStream `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (GetEventStreamOutput) GoString added in v1.8.0 

func (s GetEventStreamOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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 {

	// Provides information about the status and settings of a job that exports
	// endpoint definitions to a file. The file can be added directly to an Amazon
	// Simple Storage Service (Amazon S3) bucket by using the Amazon Pinpoint API
	// or downloaded directly to a computer by using the Amazon Pinpoint console.
	//
	// ExportJobResponse is a required field
	ExportJobResponse *ExportJobResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (GetExportJobOutput) GoString added in v1.13.11 

func (s GetExportJobOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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 

func (s *GetExportJobsInput) SetToken(v string) *GetExportJobsInput

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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 {

	// Provides information about all the export jobs that are associated with an
	// application or segment. An export job is a job that exports endpoint definitions
	// to a file.
	//
	// ExportJobsResponse is a required field
	ExportJobsResponse *ExportJobsResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (GetExportJobsOutput) GoString added in v1.13.11 

func (s GetExportJobsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetGcmChannelInput) Validate 

func (s *GetGcmChannelInput) Validate() error

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

type GetGcmChannelOutput 

type GetGcmChannelOutput struct {

	// Provides information about the status and settings of the GCM channel for
	// an application. The GCM channel enables Amazon Pinpoint to send push notifications
	// through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging
	// (GCM), service.
	//
	// GCMChannelResponse is a required field
	GCMChannelResponse *GCMChannelResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (GetGcmChannelOutput) GoString 

func (s GetGcmChannelOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetImportJobInput) Validate 

func (s *GetImportJobInput) Validate() error

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

type GetImportJobOutput 

type GetImportJobOutput struct {

	// Provides information about the status and settings of a job that imports
	// endpoint definitions from one or more files. The files can be stored in an
	// Amazon Simple Storage Service (Amazon S3) bucket or uploaded directly from
	// a computer by using the Amazon Pinpoint console.
	//
	// ImportJobResponse is a required field
	ImportJobResponse *ImportJobResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (GetImportJobOutput) GoString 

func (s GetImportJobOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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 

func (s *GetImportJobsInput) SetToken(v string) *GetImportJobsInput

SetToken sets the Token field's value.

func (GetImportJobsInput) String 

func (s GetImportJobsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetImportJobsInput) Validate 

func (s *GetImportJobsInput) Validate() error

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

type GetImportJobsOutput 

type GetImportJobsOutput struct {

	// Provides information about the status and settings of all the import jobs
	// that are associated with an application or segment. An import job is a job
	// that imports endpoint definitions from one or more files.
	//
	// ImportJobsResponse is a required field
	ImportJobsResponse *ImportJobsResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (GetImportJobsOutput) GoString 

func (s GetImportJobsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetInAppMessagesInput added in v1.40.44 

type GetInAppMessagesInput 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 (GetInAppMessagesInput) GoString added in v1.40.44 

func (s GetInAppMessagesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetInAppMessagesInput) SetApplicationId added in v1.40.44 

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

SetApplicationId sets the ApplicationId field's value.

func (*GetInAppMessagesInput) SetEndpointId added in v1.40.44 

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

SetEndpointId sets the EndpointId field's value.

func (GetInAppMessagesInput) String added in v1.40.44 

func (s GetInAppMessagesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetInAppMessagesInput) Validate added in v1.40.44 

func (s *GetInAppMessagesInput) Validate() error

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

type GetInAppMessagesOutput added in v1.40.44 

type GetInAppMessagesOutput struct {

	// Get in-app messages response object.
	//
	// InAppMessagesResponse is a required field
	InAppMessagesResponse *InAppMessagesResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (GetInAppMessagesOutput) GoString added in v1.40.44 

func (s GetInAppMessagesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetInAppMessagesOutput) SetInAppMessagesResponse added in v1.40.44 

func (s *GetInAppMessagesOutput) SetInAppMessagesResponse(v *InAppMessagesResponse) *GetInAppMessagesOutput

SetInAppMessagesResponse sets the InAppMessagesResponse field's value.

func (GetInAppMessagesOutput) String added in v1.40.44 

func (s GetInAppMessagesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetInAppTemplateInput added in v1.40.44 

type GetInAppTemplateInput struct {

	// TemplateName is a required field
	TemplateName *string `location:"uri" locationName:"template-name" type:"string" required:"true"`

	Version *string `location:"querystring" locationName:"version" type:"string"`
	// contains filtered or unexported fields
}

func (GetInAppTemplateInput) GoString added in v1.40.44 

func (s GetInAppTemplateInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetInAppTemplateInput) SetTemplateName added in v1.40.44 

func (s *GetInAppTemplateInput) SetTemplateName(v string) *GetInAppTemplateInput

SetTemplateName sets the TemplateName field's value.

func (*GetInAppTemplateInput) SetVersion added in v1.40.44 

func (s *GetInAppTemplateInput) SetVersion(v string) *GetInAppTemplateInput

SetVersion sets the Version field's value.

func (GetInAppTemplateInput) String added in v1.40.44 

func (s GetInAppTemplateInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetInAppTemplateInput) Validate added in v1.40.44 

func (s *GetInAppTemplateInput) Validate() error

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

type GetInAppTemplateOutput added in v1.40.44 

type GetInAppTemplateOutput struct {

	// In-App Template Response.
	//
	// InAppTemplateResponse is a required field
	InAppTemplateResponse *InAppTemplateResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (GetInAppTemplateOutput) GoString added in v1.40.44 

func (s GetInAppTemplateOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetInAppTemplateOutput) SetInAppTemplateResponse added in v1.40.44 

func (s *GetInAppTemplateOutput) SetInAppTemplateResponse(v *InAppTemplateResponse) *GetInAppTemplateOutput

SetInAppTemplateResponse sets the InAppTemplateResponse field's value.

func (GetInAppTemplateOutput) String added in v1.40.44 

func (s GetInAppTemplateOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetJourneyDateRangeKpiInput added in v1.25.25 

type GetJourneyDateRangeKpiInput struct {

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

	EndTime *time.Time `location:"querystring" locationName:"end-time" type:"timestamp" timestampFormat:"iso8601"`

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

	// KpiName is a required field
	KpiName *string `location:"uri" locationName:"kpi-name" type:"string" required:"true"`

	NextToken *string `location:"querystring" locationName:"next-token" type:"string"`

	PageSize *string `location:"querystring" locationName:"page-size" type:"string"`

	StartTime *time.Time `location:"querystring" locationName:"start-time" type:"timestamp" timestampFormat:"iso8601"`
	// contains filtered or unexported fields
}

func (GetJourneyDateRangeKpiInput) GoString added in v1.25.25 

func (s GetJourneyDateRangeKpiInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetJourneyDateRangeKpiInput) SetApplicationId added in v1.25.25 

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

SetApplicationId sets the ApplicationId field's value.

func (*GetJourneyDateRangeKpiInput) SetEndTime added in v1.25.25 

func (s *GetJourneyDateRangeKpiInput) SetEndTime(v time.Time) *GetJourneyDateRangeKpiInput

SetEndTime sets the EndTime field's value.

func (*GetJourneyDateRangeKpiInput) SetJourneyId added in v1.25.25 

func (s *GetJourneyDateRangeKpiInput) SetJourneyId(v string) *GetJourneyDateRangeKpiInput

SetJourneyId sets the JourneyId field's value.

func (*GetJourneyDateRangeKpiInput) SetKpiName added in v1.25.25 

func (s *GetJourneyDateRangeKpiInput) SetKpiName(v string) *GetJourneyDateRangeKpiInput

SetKpiName sets the KpiName field's value.

func (*GetJourneyDateRangeKpiInput) SetNextToken added in v1.25.25 

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

SetNextToken sets the NextToken field's value.

func (*GetJourneyDateRangeKpiInput) SetPageSize added in v1.25.25 

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

SetPageSize sets the PageSize field's value.

func (*GetJourneyDateRangeKpiInput) SetStartTime added in v1.25.25 

func (s *GetJourneyDateRangeKpiInput) SetStartTime(v time.Time) *GetJourneyDateRangeKpiInput

SetStartTime sets the StartTime field's value.

func (GetJourneyDateRangeKpiInput) String added in v1.25.25 

func (s GetJourneyDateRangeKpiInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetJourneyDateRangeKpiInput) Validate added in v1.25.25 

func (s *GetJourneyDateRangeKpiInput) Validate() error

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

type GetJourneyDateRangeKpiOutput added in v1.25.25 

type GetJourneyDateRangeKpiOutput struct {

	// Provides the results of a query that retrieved the data for a standard engagement
	// metric that applies to a journey, and provides information about that query.
	//
	// JourneyDateRangeKpiResponse is a required field
	JourneyDateRangeKpiResponse *JourneyDateRangeKpiResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (GetJourneyDateRangeKpiOutput) GoString added in v1.25.25 

func (s GetJourneyDateRangeKpiOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetJourneyDateRangeKpiOutput) SetJourneyDateRangeKpiResponse added in v1.25.25 

func (s *GetJourneyDateRangeKpiOutput) SetJourneyDateRangeKpiResponse(v *JourneyDateRangeKpiResponse) *GetJourneyDateRangeKpiOutput

SetJourneyDateRangeKpiResponse sets the JourneyDateRangeKpiResponse field's value.

func (GetJourneyDateRangeKpiOutput) String added in v1.25.25 

func (s GetJourneyDateRangeKpiOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetJourneyExecutionActivityMetricsInput added in v1.25.25 

type GetJourneyExecutionActivityMetricsInput struct {

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

	// JourneyActivityId is a required field
	JourneyActivityId *string `location:"uri" locationName:"journey-activity-id" type:"string" required:"true"`

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

	NextToken *string `location:"querystring" locationName:"next-token" type:"string"`

	PageSize *string `location:"querystring" locationName:"page-size" type:"string"`
	// contains filtered or unexported fields
}

func (GetJourneyExecutionActivityMetricsInput) GoString added in v1.25.25 

func (s GetJourneyExecutionActivityMetricsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetJourneyExecutionActivityMetricsInput) SetApplicationId added in v1.25.25 

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

SetApplicationId sets the ApplicationId field's value.

func (*GetJourneyExecutionActivityMetricsInput) SetJourneyActivityId added in v1.25.25 

func (s *GetJourneyExecutionActivityMetricsInput) SetJourneyActivityId(v string) *GetJourneyExecutionActivityMetricsInput

SetJourneyActivityId sets the JourneyActivityId field's value.

func (*GetJourneyExecutionActivityMetricsInput) SetJourneyId added in v1.25.25 

func (s *GetJourneyExecutionActivityMetricsInput) SetJourneyId(v string) *GetJourneyExecutionActivityMetricsInput

SetJourneyId sets the JourneyId field's value.

func (*GetJourneyExecutionActivityMetricsInput) SetNextToken added in v1.25.25 

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

SetNextToken sets the NextToken field's value.

func (*GetJourneyExecutionActivityMetricsInput) SetPageSize added in v1.25.25 

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

SetPageSize sets the PageSize field's value.

func (GetJourneyExecutionActivityMetricsInput) String added in v1.25.25 

func (s GetJourneyExecutionActivityMetricsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetJourneyExecutionActivityMetricsInput) Validate added in v1.25.25 

func (s *GetJourneyExecutionActivityMetricsInput) Validate() error

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

type GetJourneyExecutionActivityMetricsOutput added in v1.25.25 

type GetJourneyExecutionActivityMetricsOutput struct {

	// Provides the results of a query that retrieved the data for a standard execution
	// metric that applies to a journey activity, and provides information about
	// that query.
	//
	// JourneyExecutionActivityMetricsResponse is a required field
	JourneyExecutionActivityMetricsResponse *JourneyExecutionActivityMetricsResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (GetJourneyExecutionActivityMetricsOutput) GoString added in v1.25.25 

func (s GetJourneyExecutionActivityMetricsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetJourneyExecutionActivityMetricsOutput) SetJourneyExecutionActivityMetricsResponse added in v1.25.25 

func (s *GetJourneyExecutionActivityMetricsOutput) SetJourneyExecutionActivityMetricsResponse(v *JourneyExecutionActivityMetricsResponse) *GetJourneyExecutionActivityMetricsOutput

SetJourneyExecutionActivityMetricsResponse sets the JourneyExecutionActivityMetricsResponse field's value.

func (GetJourneyExecutionActivityMetricsOutput) String added in v1.25.25 

func (s GetJourneyExecutionActivityMetricsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetJourneyExecutionMetricsInput added in v1.25.25 

type GetJourneyExecutionMetricsInput struct {

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

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

	NextToken *string `location:"querystring" locationName:"next-token" type:"string"`

	PageSize *string `location:"querystring" locationName:"page-size" type:"string"`
	// contains filtered or unexported fields
}

func (GetJourneyExecutionMetricsInput) GoString added in v1.25.25 

func (s GetJourneyExecutionMetricsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetJourneyExecutionMetricsInput) SetApplicationId added in v1.25.25 

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

SetApplicationId sets the ApplicationId field's value.

func (*GetJourneyExecutionMetricsInput) SetJourneyId added in v1.25.25 

func (s *GetJourneyExecutionMetricsInput) SetJourneyId(v string) *GetJourneyExecutionMetricsInput

SetJourneyId sets the JourneyId field's value.

func (*GetJourneyExecutionMetricsInput) SetNextToken added in v1.25.25 

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

SetNextToken sets the NextToken field's value.

func (*GetJourneyExecutionMetricsInput) SetPageSize added in v1.25.25 

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

SetPageSize sets the PageSize field's value.

func (GetJourneyExecutionMetricsInput) String added in v1.25.25 

func (s GetJourneyExecutionMetricsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetJourneyExecutionMetricsInput) Validate added in v1.25.25 

func (s *GetJourneyExecutionMetricsInput) Validate() error

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

type GetJourneyExecutionMetricsOutput added in v1.25.25 

type GetJourneyExecutionMetricsOutput struct {

	// Provides the results of a query that retrieved the data for a standard execution
	// metric that applies to a journey, and provides information about that query.
	//
	// JourneyExecutionMetricsResponse is a required field
	JourneyExecutionMetricsResponse *JourneyExecutionMetricsResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (GetJourneyExecutionMetricsOutput) GoString added in v1.25.25 

func (s GetJourneyExecutionMetricsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetJourneyExecutionMetricsOutput) SetJourneyExecutionMetricsResponse added in v1.25.25 

func (s *GetJourneyExecutionMetricsOutput) SetJourneyExecutionMetricsResponse(v *JourneyExecutionMetricsResponse) *GetJourneyExecutionMetricsOutput

SetJourneyExecutionMetricsResponse sets the JourneyExecutionMetricsResponse field's value.

func (GetJourneyExecutionMetricsOutput) String added in v1.25.25 

func (s GetJourneyExecutionMetricsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetJourneyInput added in v1.25.25 

type GetJourneyInput struct {

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

	// JourneyId is a required field
	JourneyId *string `location:"uri" locationName:"journey-id" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetJourneyInput) GoString added in v1.25.25 

func (s GetJourneyInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetJourneyInput) SetApplicationId added in v1.25.25 

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

SetApplicationId sets the ApplicationId field's value.

func (*GetJourneyInput) SetJourneyId added in v1.25.25 

func (s *GetJourneyInput) SetJourneyId(v string) *GetJourneyInput

SetJourneyId sets the JourneyId field's value.

func (GetJourneyInput) String added in v1.25.25 

func (s GetJourneyInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetJourneyInput) Validate added in v1.25.25 

func (s *GetJourneyInput) Validate() error

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

type GetJourneyOutput added in v1.25.25 

type GetJourneyOutput struct {

	// Provides information about the status, configuration, and other settings
	// for a journey.
	//
	// JourneyResponse is a required field
	JourneyResponse *JourneyResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (GetJourneyOutput) GoString added in v1.25.25 

func (s GetJourneyOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetJourneyOutput) SetJourneyResponse added in v1.25.25 

func (s *GetJourneyOutput) SetJourneyResponse(v *JourneyResponse) *GetJourneyOutput

SetJourneyResponse sets the JourneyResponse field's value.

func (GetJourneyOutput) String added in v1.25.25 

func (s GetJourneyOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetPushTemplateInput added in v1.25.7 

type GetPushTemplateInput struct {

	// TemplateName is a required field
	TemplateName *string `location:"uri" locationName:"template-name" type:"string" required:"true"`

	Version *string `location:"querystring" locationName:"version" type:"string"`
	// contains filtered or unexported fields
}

func (GetPushTemplateInput) GoString added in v1.25.7 

func (s GetPushTemplateInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetPushTemplateInput) SetTemplateName added in v1.25.7 

func (s *GetPushTemplateInput) SetTemplateName(v string) *GetPushTemplateInput

SetTemplateName sets the TemplateName field's value.

func (*GetPushTemplateInput) SetVersion added in v1.26.7 

func (s *GetPushTemplateInput) SetVersion(v string) *GetPushTemplateInput

SetVersion sets the Version field's value.

func (GetPushTemplateInput) String added in v1.25.7 

func (s GetPushTemplateInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetPushTemplateInput) Validate added in v1.25.7 

func (s *GetPushTemplateInput) Validate() error

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

type GetPushTemplateOutput added in v1.25.7 

type GetPushTemplateOutput struct {

	// Provides information about the content and settings for a message template
	// that can be used in messages that are sent through a push notification channel.
	//
	// PushNotificationTemplateResponse is a required field
	PushNotificationTemplateResponse *PushNotificationTemplateResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (GetPushTemplateOutput) GoString added in v1.25.7 

func (s GetPushTemplateOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetPushTemplateOutput) SetPushNotificationTemplateResponse added in v1.25.7 

func (s *GetPushTemplateOutput) SetPushNotificationTemplateResponse(v *PushNotificationTemplateResponse) *GetPushTemplateOutput

SetPushNotificationTemplateResponse sets the PushNotificationTemplateResponse field's value.

func (GetPushTemplateOutput) String added in v1.25.7 

func (s GetPushTemplateOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetRecommenderConfigurationInput added in v1.29.17 

type GetRecommenderConfigurationInput struct {

	// RecommenderId is a required field
	RecommenderId *string `location:"uri" locationName:"recommender-id" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetRecommenderConfigurationInput) GoString added in v1.29.17 

func (s GetRecommenderConfigurationInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetRecommenderConfigurationInput) SetRecommenderId added in v1.29.17 

func (s *GetRecommenderConfigurationInput) SetRecommenderId(v string) *GetRecommenderConfigurationInput

SetRecommenderId sets the RecommenderId field's value.

func (GetRecommenderConfigurationInput) String added in v1.29.17 

func (s GetRecommenderConfigurationInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetRecommenderConfigurationInput) Validate added in v1.29.17 

func (s *GetRecommenderConfigurationInput) Validate() error

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

type GetRecommenderConfigurationOutput added in v1.29.17 

type GetRecommenderConfigurationOutput struct {

	// Provides information about Amazon Pinpoint configuration settings for retrieving
	// and processing data from a recommender model.
	//
	// RecommenderConfigurationResponse is a required field
	RecommenderConfigurationResponse *RecommenderConfigurationResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (GetRecommenderConfigurationOutput) GoString added in v1.29.17 

func (s GetRecommenderConfigurationOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetRecommenderConfigurationOutput) SetRecommenderConfigurationResponse added in v1.29.17 

func (s *GetRecommenderConfigurationOutput) SetRecommenderConfigurationResponse(v *RecommenderConfigurationResponse) *GetRecommenderConfigurationOutput

SetRecommenderConfigurationResponse sets the RecommenderConfigurationResponse field's value.

func (GetRecommenderConfigurationOutput) String added in v1.29.17 

func (s GetRecommenderConfigurationOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetRecommenderConfigurationsInput added in v1.29.17 

type GetRecommenderConfigurationsInput struct {
	PageSize *string `location:"querystring" locationName:"page-size" type:"string"`

	Token *string `location:"querystring" locationName:"token" type:"string"`
	// contains filtered or unexported fields
}

func (GetRecommenderConfigurationsInput) GoString added in v1.29.17 

func (s GetRecommenderConfigurationsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetRecommenderConfigurationsInput) SetPageSize added in v1.29.17 

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

SetPageSize sets the PageSize field's value.

func (*GetRecommenderConfigurationsInput) SetToken added in v1.29.17 

func (s *GetRecommenderConfigurationsInput) SetToken(v string) *GetRecommenderConfigurationsInput

SetToken sets the Token field's value.

func (GetRecommenderConfigurationsInput) String added in v1.29.17 

func (s GetRecommenderConfigurationsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetRecommenderConfigurationsOutput added in v1.29.17 

type GetRecommenderConfigurationsOutput struct {

	// Provides information about all the recommender model configurations that
	// are associated with your Amazon Pinpoint account.
	//
	// ListRecommenderConfigurationsResponse is a required field
	ListRecommenderConfigurationsResponse *ListRecommenderConfigurationsResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (GetRecommenderConfigurationsOutput) GoString added in v1.29.17 

func (s GetRecommenderConfigurationsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetRecommenderConfigurationsOutput) SetListRecommenderConfigurationsResponse added in v1.29.17 

func (s *GetRecommenderConfigurationsOutput) SetListRecommenderConfigurationsResponse(v *ListRecommenderConfigurationsResponse) *GetRecommenderConfigurationsOutput

SetListRecommenderConfigurationsResponse sets the ListRecommenderConfigurationsResponse field's value.

func (GetRecommenderConfigurationsOutput) String added in v1.29.17 

func (s GetRecommenderConfigurationsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetSegmentExportJobsInput) SetApplicationId added in v1.13.11 

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

SetApplicationId sets the ApplicationId field's value.

func (*GetSegmentExportJobsInput) SetPageSize added in v1.13.11 

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

SetPageSize sets the PageSize field's value.

func (*GetSegmentExportJobsInput) SetSegmentId added in v1.13.11 

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

SetSegmentId sets the SegmentId field's value.

func (*GetSegmentExportJobsInput) SetToken added in v1.13.11 

func (s *GetSegmentExportJobsInput) SetToken(v string) *GetSegmentExportJobsInput

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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 {

	// Provides information about all the export jobs that are associated with an
	// application or segment. An export job is a job that exports endpoint definitions
	// to a file.
	//
	// ExportJobsResponse is a required field
	ExportJobsResponse *ExportJobsResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (GetSegmentExportJobsOutput) GoString added in v1.13.11 

func (s GetSegmentExportJobsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetSegmentExportJobsOutput) SetExportJobsResponse added in v1.13.11 

func (s *GetSegmentExportJobsOutput) SetExportJobsResponse(v *ExportJobsResponse) *GetSegmentExportJobsOutput

SetExportJobsResponse sets the ExportJobsResponse field's value.

func (GetSegmentExportJobsOutput) String added in v1.13.11 

func (s GetSegmentExportJobsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetSegmentImportJobsInput) SetApplicationId 

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

SetApplicationId sets the ApplicationId field's value.

func (*GetSegmentImportJobsInput) SetPageSize 

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

SetPageSize sets the PageSize field's value.

func (*GetSegmentImportJobsInput) SetSegmentId 

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

SetSegmentId sets the SegmentId field's value.

func (*GetSegmentImportJobsInput) SetToken 

func (s *GetSegmentImportJobsInput) SetToken(v string) *GetSegmentImportJobsInput

SetToken sets the Token field's value.

func (GetSegmentImportJobsInput) String 

func (s GetSegmentImportJobsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetSegmentImportJobsInput) Validate 

func (s *GetSegmentImportJobsInput) Validate() error

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

type GetSegmentImportJobsOutput 

type GetSegmentImportJobsOutput struct {

	// Provides information about the status and settings of all the import jobs
	// that are associated with an application or segment. An import job is a job
	// that imports endpoint definitions from one or more files.
	//
	// ImportJobsResponse is a required field
	ImportJobsResponse *ImportJobsResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (GetSegmentImportJobsOutput) GoString 

func (s GetSegmentImportJobsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetSegmentImportJobsOutput) SetImportJobsResponse 

func (s *GetSegmentImportJobsOutput) SetImportJobsResponse(v *ImportJobsResponse) *GetSegmentImportJobsOutput

SetImportJobsResponse sets the ImportJobsResponse field's value.

func (GetSegmentImportJobsOutput) String 

func (s GetSegmentImportJobsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetSegmentInput) Validate 

func (s *GetSegmentInput) Validate() error

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

type GetSegmentOutput 

type GetSegmentOutput struct {

	// Provides information about the configuration, dimension, and other settings
	// for a segment.
	//
	// SegmentResponse is a required field
	SegmentResponse *SegmentResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (GetSegmentOutput) GoString 

func (s GetSegmentOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetSegmentVersionInput) SetApplicationId 

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

SetApplicationId sets the ApplicationId field's value.

func (*GetSegmentVersionInput) SetSegmentId 

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

SetSegmentId sets the SegmentId field's value.

func (*GetSegmentVersionInput) SetVersion 

func (s *GetSegmentVersionInput) SetVersion(v string) *GetSegmentVersionInput

SetVersion sets the Version field's value.

func (GetSegmentVersionInput) String 

func (s GetSegmentVersionInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetSegmentVersionInput) Validate 

func (s *GetSegmentVersionInput) Validate() error

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

type GetSegmentVersionOutput 

type GetSegmentVersionOutput struct {

	// Provides information about the configuration, dimension, and other settings
	// for a segment.
	//
	// SegmentResponse is a required field
	SegmentResponse *SegmentResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (GetSegmentVersionOutput) GoString 

func (s GetSegmentVersionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetSegmentVersionOutput) SetSegmentResponse 

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

SetSegmentResponse sets the SegmentResponse field's value.

func (GetSegmentVersionOutput) String 

func (s GetSegmentVersionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetSegmentVersionsInput) SetApplicationId 

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

SetApplicationId sets the ApplicationId field's value.

func (*GetSegmentVersionsInput) SetPageSize 

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

SetPageSize sets the PageSize field's value.

func (*GetSegmentVersionsInput) SetSegmentId 

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

SetSegmentId sets the SegmentId field's value.

func (*GetSegmentVersionsInput) SetToken 

func (s *GetSegmentVersionsInput) SetToken(v string) *GetSegmentVersionsInput

SetToken sets the Token field's value.

func (GetSegmentVersionsInput) String 

func (s GetSegmentVersionsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetSegmentVersionsInput) Validate 

func (s *GetSegmentVersionsInput) Validate() error

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

type GetSegmentVersionsOutput 

type GetSegmentVersionsOutput struct {

	// Provides information about all the segments that are associated with an application.
	//
	// SegmentsResponse is a required field
	SegmentsResponse *SegmentsResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (GetSegmentVersionsOutput) GoString 

func (s GetSegmentVersionsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetSegmentVersionsOutput) SetSegmentsResponse 

func (s *GetSegmentVersionsOutput) SetSegmentsResponse(v *SegmentsResponse) *GetSegmentVersionsOutput

SetSegmentsResponse sets the SegmentsResponse field's value.

func (GetSegmentVersionsOutput) String 

func (s GetSegmentVersionsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetSegmentsInput) Validate 

func (s *GetSegmentsInput) Validate() error

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

type GetSegmentsOutput 

type GetSegmentsOutput struct {

	// Provides information about all the segments that are associated with an application.
	//
	// SegmentsResponse is a required field
	SegmentsResponse *SegmentsResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (GetSegmentsOutput) GoString 

func (s GetSegmentsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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 {

	// Provides information about the status and settings of the SMS channel for
	// an application.
	//
	// SMSChannelResponse is a required field
	SMSChannelResponse *SMSChannelResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (GetSmsChannelOutput) GoString added in v1.8.38 

func (s GetSmsChannelOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetSmsTemplateInput added in v1.25.7 

type GetSmsTemplateInput struct {

	// TemplateName is a required field
	TemplateName *string `location:"uri" locationName:"template-name" type:"string" required:"true"`

	Version *string `location:"querystring" locationName:"version" type:"string"`
	// contains filtered or unexported fields
}

func (GetSmsTemplateInput) GoString added in v1.25.7 

func (s GetSmsTemplateInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetSmsTemplateInput) SetTemplateName added in v1.25.7 

func (s *GetSmsTemplateInput) SetTemplateName(v string) *GetSmsTemplateInput

SetTemplateName sets the TemplateName field's value.

func (*GetSmsTemplateInput) SetVersion added in v1.26.7 

func (s *GetSmsTemplateInput) SetVersion(v string) *GetSmsTemplateInput

SetVersion sets the Version field's value.

func (GetSmsTemplateInput) String added in v1.25.7 

func (s GetSmsTemplateInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetSmsTemplateInput) Validate added in v1.25.7 

func (s *GetSmsTemplateInput) Validate() error

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

type GetSmsTemplateOutput added in v1.25.7 

type GetSmsTemplateOutput struct {

	// Provides information about the content and settings for a message template
	// that can be used in text messages that are sent through the SMS channel.
	//
	// SMSTemplateResponse is a required field
	SMSTemplateResponse *SMSTemplateResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (GetSmsTemplateOutput) GoString added in v1.25.7 

func (s GetSmsTemplateOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetSmsTemplateOutput) SetSMSTemplateResponse added in v1.25.7 

func (s *GetSmsTemplateOutput) SetSMSTemplateResponse(v *SMSTemplateResponse) *GetSmsTemplateOutput

SetSMSTemplateResponse sets the SMSTemplateResponse field's value.

func (GetSmsTemplateOutput) String added in v1.25.7 

func (s GetSmsTemplateOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetUserEndpointsInput added in v1.14.20 

type GetUserEndpointsInput struct {

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

	// UserId is a required field
	UserId *string `location:"uri" locationName:"user-id" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetUserEndpointsInput) GoString added in v1.14.20 

func (s GetUserEndpointsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetUserEndpointsInput) SetApplicationId added in v1.14.20 

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

SetApplicationId sets the ApplicationId field's value.

func (*GetUserEndpointsInput) SetUserId added in v1.14.20 

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

SetUserId sets the UserId field's value.

func (GetUserEndpointsInput) String added in v1.14.20 

func (s GetUserEndpointsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetUserEndpointsInput) Validate added in v1.14.20 

func (s *GetUserEndpointsInput) Validate() error

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

type GetUserEndpointsOutput added in v1.14.20 

type GetUserEndpointsOutput struct {

	// Provides information about all the endpoints that are associated with a user
	// ID.
	//
	// EndpointsResponse is a required field
	EndpointsResponse *EndpointsResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (GetUserEndpointsOutput) GoString added in v1.14.20 

func (s GetUserEndpointsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetUserEndpointsOutput) SetEndpointsResponse added in v1.14.20 

func (s *GetUserEndpointsOutput) SetEndpointsResponse(v *EndpointsResponse) *GetUserEndpointsOutput

SetEndpointsResponse sets the EndpointsResponse field's value.

func (GetUserEndpointsOutput) String added in v1.14.20 

func (s GetUserEndpointsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetVoiceChannelInput added in v1.15.77 

type GetVoiceChannelInput struct {

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

func (GetVoiceChannelInput) GoString added in v1.15.77 

func (s GetVoiceChannelInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetVoiceChannelInput) SetApplicationId added in v1.15.77 

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

SetApplicationId sets the ApplicationId field's value.

func (GetVoiceChannelInput) String added in v1.15.77 

func (s GetVoiceChannelInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetVoiceChannelInput) Validate added in v1.15.77 

func (s *GetVoiceChannelInput) Validate() error

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

type GetVoiceChannelOutput added in v1.15.77 

type GetVoiceChannelOutput struct {

	// Provides information about the status and settings of the voice channel for
	// an application.
	//
	// VoiceChannelResponse is a required field
	VoiceChannelResponse *VoiceChannelResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (GetVoiceChannelOutput) GoString added in v1.15.77 

func (s GetVoiceChannelOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetVoiceChannelOutput) SetVoiceChannelResponse added in v1.15.77 

func (s *GetVoiceChannelOutput) SetVoiceChannelResponse(v *VoiceChannelResponse) *GetVoiceChannelOutput

SetVoiceChannelResponse sets the VoiceChannelResponse field's value.

func (GetVoiceChannelOutput) String added in v1.15.77 

func (s GetVoiceChannelOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetVoiceTemplateInput added in v1.25.37 

type GetVoiceTemplateInput struct {

	// TemplateName is a required field
	TemplateName *string `location:"uri" locationName:"template-name" type:"string" required:"true"`

	Version *string `location:"querystring" locationName:"version" type:"string"`
	// contains filtered or unexported fields
}

func (GetVoiceTemplateInput) GoString added in v1.25.37 

func (s GetVoiceTemplateInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetVoiceTemplateInput) SetTemplateName added in v1.25.37 

func (s *GetVoiceTemplateInput) SetTemplateName(v string) *GetVoiceTemplateInput

SetTemplateName sets the TemplateName field's value.

func (*GetVoiceTemplateInput) SetVersion added in v1.26.7 

func (s *GetVoiceTemplateInput) SetVersion(v string) *GetVoiceTemplateInput

SetVersion sets the Version field's value.

func (GetVoiceTemplateInput) String added in v1.25.37 

func (s GetVoiceTemplateInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetVoiceTemplateInput) Validate added in v1.25.37 

func (s *GetVoiceTemplateInput) Validate() error

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

type GetVoiceTemplateOutput added in v1.25.37 

type GetVoiceTemplateOutput struct {

	// Provides information about the content and settings for a message template
	// that can be used in messages that are sent through the voice channel.
	//
	// VoiceTemplateResponse is a required field
	VoiceTemplateResponse *VoiceTemplateResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (GetVoiceTemplateOutput) GoString added in v1.25.37 

func (s GetVoiceTemplateOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetVoiceTemplateOutput) SetVoiceTemplateResponse added in v1.25.37 

func (s *GetVoiceTemplateOutput) SetVoiceTemplateResponse(v *VoiceTemplateResponse) *GetVoiceTemplateOutput

SetVoiceTemplateResponse sets the VoiceTemplateResponse field's value.

func (GetVoiceTemplateOutput) String added in v1.25.37 

func (s GetVoiceTemplateOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type HoldoutActivity added in v1.25.25 

type HoldoutActivity struct {

	// The unique identifier for the next activity to perform, after performing
	// the holdout activity.
	NextActivity *string `type:"string"`

	// The percentage of participants who shouldn't continue the journey.
	//
	// To determine which participants are held out, Amazon Pinpoint applies a probability-based
	// algorithm to the percentage that you specify. Therefore, the actual percentage
	// of participants who are held out may not be equal to the percentage that
	// you specify.
	//
	// Percentage is a required field
	Percentage *int64 `type:"integer" required:"true"`
	// contains filtered or unexported fields
}

Specifies the settings for a holdout activity in a journey. This type of activity stops a journey for a specified percentage of participants.

func (HoldoutActivity) GoString added in v1.25.25 

func (s HoldoutActivity) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*HoldoutActivity) SetNextActivity added in v1.25.25 

func (s *HoldoutActivity) SetNextActivity(v string) *HoldoutActivity

SetNextActivity sets the NextActivity field's value.

func (*HoldoutActivity) SetPercentage added in v1.25.25 

func (s *HoldoutActivity) SetPercentage(v int64) *HoldoutActivity

SetPercentage sets the Percentage field's value.

func (HoldoutActivity) String added in v1.25.25 

func (s HoldoutActivity) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*HoldoutActivity) Validate added in v1.25.25 

func (s *HoldoutActivity) Validate() error

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

type ImportJobRequest 

type ImportJobRequest struct {

	// Specifies whether to create a segment that contains the endpoints, when the
	// endpoint definitions are imported.
	DefineSegment *bool `type:"boolean"`

	// (Deprecated) Your AWS account ID, which you assigned to an external ID key
	// in an IAM trust policy. Amazon Pinpoint previously used this value to assume
	// an IAM role when importing endpoint definitions, but we removed this requirement.
	// We don't recommend use of external IDs for IAM roles that are assumed by
	// Amazon Pinpoint.
	ExternalId *string `type:"string"`

	// The format of the files that contain the endpoint definitions to import.
	// Valid values are: CSV, for comma-separated values format; and, JSON, for
	// newline-delimited JSON format. If the Amazon S3 location stores multiple
	// files that use different formats, Amazon Pinpoint imports data only from
	// the files that use the specified format.
	//
	// Format is a required field
	Format *string `type:"string" required:"true" enum:"Format"`

	// Specifies whether to register the endpoints with Amazon Pinpoint, when the
	// endpoint definitions are imported.
	RegisterEndpoints *bool `type:"boolean"`

	// The Amazon Resource Name (ARN) of the AWS Identity and Access Management
	// (IAM) role that authorizes Amazon Pinpoint to access the Amazon S3 location
	// to import endpoint definitions from.
	//
	// RoleArn is a required field
	RoleArn *string `type:"string" required:"true"`

	// The URL of the Amazon Simple Storage Service (Amazon S3) bucket that contains
	// the endpoint definitions to import. This location can be a folder or a single
	// file. If the location is a folder, Amazon Pinpoint imports endpoint definitions
	// from the files in this location, including any subfolders that the folder
	// contains.
	//
	// The URL should be in the following format: s3://bucket-name/folder-name/file-name.
	// The location can end with the key for an individual object or a prefix that
	// qualifies multiple objects.
	//
	// S3Url is a required field
	S3Url *string `type:"string" required:"true"`

	// The identifier for the segment to update or add the imported endpoint definitions
	// to, if the import job is meant to update an existing segment.
	SegmentId *string `type:"string"`

	// A custom name for the segment that's created by the import job, if the value
	// of the DefineSegment property is true.
	SegmentName *string `type:"string"`
	// contains filtered or unexported fields
}

Specifies the settings for a job that imports endpoint definitions from an Amazon Simple Storage Service (Amazon S3) bucket.

func (ImportJobRequest) GoString 

func (s ImportJobRequest) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ImportJobRequest) Validate added in v1.20.11 

func (s *ImportJobRequest) Validate() error

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

type ImportJobResource 

type ImportJobResource struct {

	// Specifies whether the import job creates a segment that contains the endpoints,
	// when the endpoint definitions are imported.
	DefineSegment *bool `type:"boolean"`

	// (Deprecated) Your AWS account ID, which you assigned to an external ID key
	// in an IAM trust policy. Amazon Pinpoint previously used this value to assume
	// an IAM role when importing endpoint definitions, but we removed this requirement.
	// We don't recommend use of external IDs for IAM roles that are assumed by
	// Amazon Pinpoint.
	ExternalId *string `type:"string"`

	// The format of the files that contain the endpoint definitions to import.
	// Valid values are: CSV, for comma-separated values format; and, JSON, for
	// newline-delimited JSON format.
	//
	// If the files are stored in an Amazon S3 location and that location contains
	// multiple files that use different formats, Amazon Pinpoint imports data only
	// from the files that use the specified format.
	//
	// Format is a required field
	Format *string `type:"string" required:"true" enum:"Format"`

	// Specifies whether the import job registers the endpoints with Amazon Pinpoint,
	// when the endpoint definitions are imported.
	RegisterEndpoints *bool `type:"boolean"`

	// The Amazon Resource Name (ARN) of the AWS Identity and Access Management
	// (IAM) role that authorizes Amazon Pinpoint to access the Amazon S3 location
	// to import endpoint definitions from.
	//
	// RoleArn is a required field
	RoleArn *string `type:"string" required:"true"`

	// The URL of the Amazon Simple Storage Service (Amazon S3) bucket that contains
	// the endpoint definitions to import. This location can be a folder or a single
	// file. If the location is a folder, Amazon Pinpoint imports endpoint definitions
	// from the files in this location, including any subfolders that the folder
	// contains.
	//
	// The URL should be in the following format: s3://bucket-name/folder-name/file-name.
	// The location can end with the key for an individual object or a prefix that
	// qualifies multiple objects.
	//
	// S3Url is a required field
	S3Url *string `type:"string" required:"true"`

	// The identifier for the segment that the import job updates or adds endpoint
	// definitions to, if the import job updates an existing segment.
	SegmentId *string `type:"string"`

	// The custom name for the segment that's created by the import job, if the
	// value of the DefineSegment property is true.
	SegmentName *string `type:"string"`
	// contains filtered or unexported fields
}

Provides information about the resource settings for a job that imports endpoint definitions from one or more files. The files can be stored in an Amazon Simple Storage Service (Amazon S3) bucket or uploaded directly from a computer by using the Amazon Pinpoint console.

func (ImportJobResource) GoString 

func (s ImportJobResource) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ImportJobResponse 

type ImportJobResponse struct {

	// The unique identifier for the application that's associated with the import
	// job.
	//
	// ApplicationId is a required field
	ApplicationId *string `type:"string" required:"true"`

	// The number of pieces that were processed successfully (completed) by the
	// import job, as of the time of the request.
	CompletedPieces *int64 `type:"integer"`

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

	// The date, in ISO 8601 format, when the import job was created.
	//
	// CreationDate is a required field
	CreationDate *string `type:"string" required:"true"`

	// The resource settings that apply to the import job.
	//
	// Definition is a required field
	Definition *ImportJobResource `type:"structure" required:"true"`

	// The number of pieces that weren't processed successfully (failed) by the
	// import job, as of the time of the request.
	FailedPieces *int64 `type:"integer"`

	// An array of entries, one for each of the first 100 entries that weren't processed
	// successfully (failed) by the import job, if any.
	Failures []*string `type:"list"`

	// The unique identifier for the import job.
	//
	// Id is a required field
	Id *string `type:"string" required:"true"`

	// The status of the import job. The job status is FAILED if Amazon Pinpoint
	// wasn't able to process one or more pieces in the job.
	//
	// JobStatus is a required field
	JobStatus *string `type:"string" required:"true" enum:"JobStatus"`

	// The total number of endpoint definitions that weren't processed successfully
	// (failed) by the import job, typically because an error, such as a syntax
	// error, occurred.
	TotalFailures *int64 `type:"integer"`

	// The total number of pieces that must be processed to complete the import
	// job. Each piece consists of an approximately equal portion of the endpoint
	// definitions that are part of the import job.
	TotalPieces *int64 `type:"integer"`

	// The total number of endpoint definitions that were processed by the import
	// job.
	TotalProcessed *int64 `type:"integer"`

	// The job type. This value is IMPORT for import jobs.
	//
	// Type is a required field
	Type *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Provides information about the status and settings of a job that imports endpoint definitions from one or more files. The files can be stored in an Amazon Simple Storage Service (Amazon S3) bucket or uploaded directly from a computer by using the Amazon Pinpoint console.

func (ImportJobResponse) GoString 

func (s ImportJobResponse) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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 

func (s *ImportJobResponse) SetDefinition(v *ImportJobResource) *ImportJobResponse

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 

func (s *ImportJobResponse) SetId(v string) *ImportJobResponse

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 

func (s *ImportJobResponse) SetType(v string) *ImportJobResponse

SetType sets the Type field's value.

func (ImportJobResponse) String 

func (s ImportJobResponse) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ImportJobsResponse 

type ImportJobsResponse struct {

	// An array of responses, one for each import job that's associated with the
	// application (Import Jobs resource) or segment (Segment Import Jobs resource).
	//
	// Item is a required field
	Item []*ImportJobResponse `type:"list" required:"true"`

	// The string to use in a subsequent request to get the next page of results
	// in a paginated response. This value is null if there are no additional pages.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

Provides information about the status and settings of all the import jobs that are associated with an application or segment. An import job is a job that imports endpoint definitions from one or more files.

func (ImportJobsResponse) GoString 

func (s ImportJobsResponse) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ImportJobsResponse) SetItem 

func (s *ImportJobsResponse) SetItem(v []*ImportJobResponse) *ImportJobsResponse

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InAppCampaignSchedule added in v1.40.44 

type InAppCampaignSchedule struct {

	// The scheduled time after which the in-app message should not be shown. Timestamp
	// is in ISO 8601 format.
	EndDate *string `type:"string"`

	// The event filter the SDK has to use to show the in-app message in the application.
	EventFilter *CampaignEventFilter `type:"structure"`

	// Time during which the in-app message should not be shown to the user.
	QuietTime *QuietTime `type:"structure"`
	// contains filtered or unexported fields
}

func (InAppCampaignSchedule) GoString added in v1.40.44 

func (s InAppCampaignSchedule) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InAppCampaignSchedule) SetEndDate added in v1.40.44 

func (s *InAppCampaignSchedule) SetEndDate(v string) *InAppCampaignSchedule

SetEndDate sets the EndDate field's value.

func (*InAppCampaignSchedule) SetEventFilter added in v1.40.44 

func (s *InAppCampaignSchedule) SetEventFilter(v *CampaignEventFilter) *InAppCampaignSchedule

SetEventFilter sets the EventFilter field's value.

func (*InAppCampaignSchedule) SetQuietTime added in v1.40.44 

func (s *InAppCampaignSchedule) SetQuietTime(v *QuietTime) *InAppCampaignSchedule

SetQuietTime sets the QuietTime field's value.

func (InAppCampaignSchedule) String added in v1.40.44 

func (s InAppCampaignSchedule) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InAppMessage added in v1.40.44 

type InAppMessage struct {

	// In-app message content.
	Content []*InAppMessageContent `type:"list"`

	// Custom config to be sent to SDK.
	CustomConfig map[string]*string `type:"map"`

	// The layout of the message.
	Layout *string `type:"string" enum:"Layout"`
	// contains filtered or unexported fields
}

Provides all fields required for building an in-app message.

func (InAppMessage) GoString added in v1.40.44 

func (s InAppMessage) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InAppMessage) SetContent added in v1.40.44 

func (s *InAppMessage) SetContent(v []*InAppMessageContent) *InAppMessage

SetContent sets the Content field's value.

func (*InAppMessage) SetCustomConfig added in v1.40.44 

func (s *InAppMessage) SetCustomConfig(v map[string]*string) *InAppMessage

SetCustomConfig sets the CustomConfig field's value.

func (*InAppMessage) SetLayout added in v1.40.44 

func (s *InAppMessage) SetLayout(v string) *InAppMessage

SetLayout sets the Layout field's value.

func (InAppMessage) String added in v1.40.44 

func (s InAppMessage) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InAppMessageBodyConfig added in v1.40.44 

type InAppMessageBodyConfig struct {

	// The alignment of the text. Valid values: LEFT, CENTER, RIGHT.
	//
	// Alignment is a required field
	Alignment *string `type:"string" required:"true" enum:"Alignment"`

	// Message Body.
	//
	// Body is a required field
	Body *string `type:"string" required:"true"`

	// The text color.
	//
	// TextColor is a required field
	TextColor *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Text config for Message Body.

func (InAppMessageBodyConfig) GoString added in v1.40.44 

func (s InAppMessageBodyConfig) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InAppMessageBodyConfig) SetAlignment added in v1.40.44 

func (s *InAppMessageBodyConfig) SetAlignment(v string) *InAppMessageBodyConfig

SetAlignment sets the Alignment field's value.

func (*InAppMessageBodyConfig) SetBody added in v1.40.44 

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

SetBody sets the Body field's value.

func (*InAppMessageBodyConfig) SetTextColor added in v1.40.44 

func (s *InAppMessageBodyConfig) SetTextColor(v string) *InAppMessageBodyConfig

SetTextColor sets the TextColor field's value.

func (InAppMessageBodyConfig) String added in v1.40.44 

func (s InAppMessageBodyConfig) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InAppMessageBodyConfig) Validate added in v1.40.44 

func (s *InAppMessageBodyConfig) Validate() error

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

type InAppMessageButton added in v1.40.44 

type InAppMessageButton struct {

	// Default button content.
	Android *OverrideButtonConfiguration `type:"structure"`

	// Default button content.
	DefaultConfig *DefaultButtonConfiguration `type:"structure"`

	// Default button content.
	IOS *OverrideButtonConfiguration `type:"structure"`

	// Default button content.
	Web *OverrideButtonConfiguration `type:"structure"`
	// contains filtered or unexported fields
}

Button Config for an in-app message.

func (InAppMessageButton) GoString added in v1.40.44 

func (s InAppMessageButton) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InAppMessageButton) SetAndroid added in v1.40.44 

func (s *InAppMessageButton) SetAndroid(v *OverrideButtonConfiguration) *InAppMessageButton

SetAndroid sets the Android field's value.

func (*InAppMessageButton) SetDefaultConfig added in v1.40.44 

func (s *InAppMessageButton) SetDefaultConfig(v *DefaultButtonConfiguration) *InAppMessageButton

SetDefaultConfig sets the DefaultConfig field's value.

func (*InAppMessageButton) SetIOS added in v1.40.44 

func (s *InAppMessageButton) SetIOS(v *OverrideButtonConfiguration) *InAppMessageButton

SetIOS sets the IOS field's value.

func (*InAppMessageButton) SetWeb added in v1.40.44 

func (s *InAppMessageButton) SetWeb(v *OverrideButtonConfiguration) *InAppMessageButton

SetWeb sets the Web field's value.

func (InAppMessageButton) String added in v1.40.44 

func (s InAppMessageButton) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InAppMessageButton) Validate added in v1.40.44 

func (s *InAppMessageButton) Validate() error

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

type InAppMessageCampaign added in v1.40.44 

type InAppMessageCampaign struct {

	// Campaign id of the corresponding campaign.
	CampaignId *string `type:"string"`

	// Daily cap which controls the number of times any in-app messages can be shown
	// to the endpoint during a day.
	DailyCap *int64 `type:"integer"`

	// In-app message content with all fields required for rendering an in-app message.
	InAppMessage *InAppMessage `type:"structure"`

	// Priority of the in-app message.
	Priority *int64 `type:"integer"`

	// Schedule of the campaign.
	Schedule *InAppCampaignSchedule `type:"structure"`

	// Session cap which controls the number of times an in-app message can be shown
	// to the endpoint during an application session.
	SessionCap *int64 `type:"integer"`

	// Total cap which controls the number of times an in-app message can be shown
	// to the endpoint.
	TotalCap *int64 `type:"integer"`

	// Treatment id of the campaign.
	TreatmentId *string `type:"string"`
	// contains filtered or unexported fields
}

func (InAppMessageCampaign) GoString added in v1.40.44 

func (s InAppMessageCampaign) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InAppMessageCampaign) SetCampaignId added in v1.40.44 

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

SetCampaignId sets the CampaignId field's value.

func (*InAppMessageCampaign) SetDailyCap added in v1.40.44 

func (s *InAppMessageCampaign) SetDailyCap(v int64) *InAppMessageCampaign

SetDailyCap sets the DailyCap field's value.

func (*InAppMessageCampaign) SetInAppMessage added in v1.40.44 

func (s *InAppMessageCampaign) SetInAppMessage(v *InAppMessage) *InAppMessageCampaign

SetInAppMessage sets the InAppMessage field's value.

func (*InAppMessageCampaign) SetPriority added in v1.40.44 

func (s *InAppMessageCampaign) SetPriority(v int64) *InAppMessageCampaign

SetPriority sets the Priority field's value.

func (*InAppMessageCampaign) SetSchedule added in v1.40.44 

func (s *InAppMessageCampaign) SetSchedule(v *InAppCampaignSchedule) *InAppMessageCampaign

SetSchedule sets the Schedule field's value.

func (*InAppMessageCampaign) SetSessionCap added in v1.40.44 

func (s *InAppMessageCampaign) SetSessionCap(v int64) *InAppMessageCampaign

SetSessionCap sets the SessionCap field's value.

func (*InAppMessageCampaign) SetTotalCap added in v1.40.44 

func (s *InAppMessageCampaign) SetTotalCap(v int64) *InAppMessageCampaign

SetTotalCap sets the TotalCap field's value.

func (*InAppMessageCampaign) SetTreatmentId added in v1.40.44 

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

SetTreatmentId sets the TreatmentId field's value.

func (InAppMessageCampaign) String added in v1.40.44 

func (s InAppMessageCampaign) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InAppMessageContent added in v1.40.44 

type InAppMessageContent struct {

	// The background color for the message.
	BackgroundColor *string `type:"string"`

	// The configuration for the message body.
	BodyConfig *InAppMessageBodyConfig `type:"structure"`

	// The configuration for the message header.
	HeaderConfig *InAppMessageHeaderConfig `type:"structure"`

	// The image url for the background of message.
	ImageUrl *string `type:"string"`

	// The first button inside the message.
	PrimaryBtn *InAppMessageButton `type:"structure"`

	// The second button inside message.
	SecondaryBtn *InAppMessageButton `type:"structure"`
	// contains filtered or unexported fields
}

The configuration for the message content.

func (InAppMessageContent) GoString added in v1.40.44 

func (s InAppMessageContent) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InAppMessageContent) SetBackgroundColor added in v1.40.44 

func (s *InAppMessageContent) SetBackgroundColor(v string) *InAppMessageContent

SetBackgroundColor sets the BackgroundColor field's value.

func (*InAppMessageContent) SetBodyConfig added in v1.40.44 

func (s *InAppMessageContent) SetBodyConfig(v *InAppMessageBodyConfig) *InAppMessageContent

SetBodyConfig sets the BodyConfig field's value.

func (*InAppMessageContent) SetHeaderConfig added in v1.40.44 

func (s *InAppMessageContent) SetHeaderConfig(v *InAppMessageHeaderConfig) *InAppMessageContent

SetHeaderConfig sets the HeaderConfig field's value.

func (*InAppMessageContent) SetImageUrl added in v1.40.44 

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

SetImageUrl sets the ImageUrl field's value.

func (*InAppMessageContent) SetPrimaryBtn added in v1.40.44 

func (s *InAppMessageContent) SetPrimaryBtn(v *InAppMessageButton) *InAppMessageContent

SetPrimaryBtn sets the PrimaryBtn field's value.

func (*InAppMessageContent) SetSecondaryBtn added in v1.40.44 

func (s *InAppMessageContent) SetSecondaryBtn(v *InAppMessageButton) *InAppMessageContent

SetSecondaryBtn sets the SecondaryBtn field's value.

func (InAppMessageContent) String added in v1.40.44 

func (s InAppMessageContent) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InAppMessageContent) Validate added in v1.40.44 

func (s *InAppMessageContent) Validate() error

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

type InAppMessageHeaderConfig added in v1.40.44 

type InAppMessageHeaderConfig struct {

	// The alignment of the text. Valid values: LEFT, CENTER, RIGHT.
	//
	// Alignment is a required field
	Alignment *string `type:"string" required:"true" enum:"Alignment"`

	// Message Header.
	//
	// Header is a required field
	Header *string `type:"string" required:"true"`

	// The text color.
	//
	// TextColor is a required field
	TextColor *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Text config for Message Header.

func (InAppMessageHeaderConfig) GoString added in v1.40.44 

func (s InAppMessageHeaderConfig) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InAppMessageHeaderConfig) SetAlignment added in v1.40.44 

func (s *InAppMessageHeaderConfig) SetAlignment(v string) *InAppMessageHeaderConfig

SetAlignment sets the Alignment field's value.

func (*InAppMessageHeaderConfig) SetHeader added in v1.40.44 

func (s *InAppMessageHeaderConfig) SetHeader(v string) *InAppMessageHeaderConfig

SetHeader sets the Header field's value.

func (*InAppMessageHeaderConfig) SetTextColor added in v1.40.44 

func (s *InAppMessageHeaderConfig) SetTextColor(v string) *InAppMessageHeaderConfig

SetTextColor sets the TextColor field's value.

func (InAppMessageHeaderConfig) String added in v1.40.44 

func (s InAppMessageHeaderConfig) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InAppMessageHeaderConfig) Validate added in v1.40.44 

func (s *InAppMessageHeaderConfig) Validate() error

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

type InAppMessagesResponse added in v1.40.44 

type InAppMessagesResponse struct {

	// List of targeted in-app message campaigns.
	InAppMessageCampaigns []*InAppMessageCampaign `type:"list"`
	// contains filtered or unexported fields
}

Get in-app messages response object.

func (InAppMessagesResponse) GoString added in v1.40.44 

func (s InAppMessagesResponse) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InAppMessagesResponse) SetInAppMessageCampaigns added in v1.40.44 

func (s *InAppMessagesResponse) SetInAppMessageCampaigns(v []*InAppMessageCampaign) *InAppMessagesResponse

SetInAppMessageCampaigns sets the InAppMessageCampaigns field's value.

func (InAppMessagesResponse) String added in v1.40.44 

func (s InAppMessagesResponse) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InAppTemplateRequest added in v1.40.44 

type InAppTemplateRequest struct {

	// The content of the message, can include up to 5 modals. Each modal must contain
	// a message, a header, and background color. ImageUrl and buttons are optional.
	Content []*InAppMessageContent `type:"list"`

	// Custom config to be sent to client.
	CustomConfig map[string]*string `type:"map"`

	// The layout of the message.
	Layout *string `type:"string" enum:"Layout"`

	// A string-to-string map of key-value pairs that defines the tags to associate
	// with the message template. Each tag consists of a required tag key and an
	// associated tag value.
	Tags map[string]*string `locationName:"tags" type:"map"`

	// The description of the template.
	TemplateDescription *string `type:"string"`
	// contains filtered or unexported fields
}

In-App Template Request.

func (InAppTemplateRequest) GoString added in v1.40.44 

func (s InAppTemplateRequest) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InAppTemplateRequest) SetContent added in v1.40.44 

func (s *InAppTemplateRequest) SetContent(v []*InAppMessageContent) *InAppTemplateRequest

SetContent sets the Content field's value.

func (*InAppTemplateRequest) SetCustomConfig added in v1.40.44 

func (s *InAppTemplateRequest) SetCustomConfig(v map[string]*string) *InAppTemplateRequest

SetCustomConfig sets the CustomConfig field's value.

func (*InAppTemplateRequest) SetLayout added in v1.40.44 

func (s *InAppTemplateRequest) SetLayout(v string) *InAppTemplateRequest

SetLayout sets the Layout field's value.

func (*InAppTemplateRequest) SetTags added in v1.40.44 

func (s *InAppTemplateRequest) SetTags(v map[string]*string) *InAppTemplateRequest

SetTags sets the Tags field's value.

func (*InAppTemplateRequest) SetTemplateDescription added in v1.40.44 

func (s *InAppTemplateRequest) SetTemplateDescription(v string) *InAppTemplateRequest

SetTemplateDescription sets the TemplateDescription field's value.

func (InAppTemplateRequest) String added in v1.40.44 

func (s InAppTemplateRequest) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InAppTemplateRequest) Validate added in v1.40.44 

func (s *InAppTemplateRequest) Validate() error

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

type InAppTemplateResponse added in v1.40.44 

type InAppTemplateResponse struct {

	// The resource arn of the template.
	Arn *string `type:"string"`

	// The content of the message, can include up to 5 modals. Each modal must contain
	// a message, a header, and background color. ImageUrl and buttons are optional.
	Content []*InAppMessageContent `type:"list"`

	// The creation date of the template.
	//
	// CreationDate is a required field
	CreationDate *string `type:"string" required:"true"`

	// Custom config to be sent to client.
	CustomConfig map[string]*string `type:"map"`

	// The last modified date of the template.
	//
	// LastModifiedDate is a required field
	LastModifiedDate *string `type:"string" required:"true"`

	// The layout of the message.
	Layout *string `type:"string" enum:"Layout"`

	// Tags map that contains arn and InternalId for API GW.
	Tags map[string]*string `locationName:"tags" type:"map"`

	// The description of the template.
	TemplateDescription *string `type:"string"`

	// The name of the template.
	//
	// TemplateName is a required field
	TemplateName *string `type:"string" required:"true"`

	// The type of the template.
	//
	// TemplateType is a required field
	TemplateType *string `type:"string" required:"true" enum:"TemplateType"`

	// The version id of the template.
	Version *string `type:"string"`
	// contains filtered or unexported fields
}

In-App Template Response.

func (InAppTemplateResponse) GoString added in v1.40.44 

func (s InAppTemplateResponse) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InAppTemplateResponse) SetArn added in v1.40.44 

func (s *InAppTemplateResponse) SetArn(v string) *InAppTemplateResponse

SetArn sets the Arn field's value.

func (*InAppTemplateResponse) SetContent added in v1.40.44 

func (s *InAppTemplateResponse) SetContent(v []*InAppMessageContent) *InAppTemplateResponse

SetContent sets the Content field's value.

func (*InAppTemplateResponse) SetCreationDate added in v1.40.44 

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

SetCreationDate sets the CreationDate field's value.

func (*InAppTemplateResponse) SetCustomConfig added in v1.40.44 

func (s *InAppTemplateResponse) SetCustomConfig(v map[string]*string) *InAppTemplateResponse

SetCustomConfig sets the CustomConfig field's value.

func (*InAppTemplateResponse) SetLastModifiedDate added in v1.40.44 

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

SetLastModifiedDate sets the LastModifiedDate field's value.

func (*InAppTemplateResponse) SetLayout added in v1.40.44 

func (s *InAppTemplateResponse) SetLayout(v string) *InAppTemplateResponse

SetLayout sets the Layout field's value.

func (*InAppTemplateResponse) SetTags added in v1.40.44 

func (s *InAppTemplateResponse) SetTags(v map[string]*string) *InAppTemplateResponse

SetTags sets the Tags field's value.

func (*InAppTemplateResponse) SetTemplateDescription added in v1.40.44 

func (s *InAppTemplateResponse) SetTemplateDescription(v string) *InAppTemplateResponse

SetTemplateDescription sets the TemplateDescription field's value.

func (*InAppTemplateResponse) SetTemplateName added in v1.40.44 

func (s *InAppTemplateResponse) SetTemplateName(v string) *InAppTemplateResponse

SetTemplateName sets the TemplateName field's value.

func (*InAppTemplateResponse) SetTemplateType added in v1.40.44 

func (s *InAppTemplateResponse) SetTemplateType(v string) *InAppTemplateResponse

SetTemplateType sets the TemplateType field's value.

func (*InAppTemplateResponse) SetVersion added in v1.40.44 

func (s *InAppTemplateResponse) SetVersion(v string) *InAppTemplateResponse

SetVersion sets the Version field's value.

func (InAppTemplateResponse) String added in v1.40.44 

func (s InAppTemplateResponse) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InternalServerErrorException added in v1.28.0 

type InternalServerErrorException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`

	RequestID_ *string `locationName:"RequestID" type:"string"`
	// contains filtered or unexported fields
}

Provides information about an API request or response.

func (*InternalServerErrorException) Code added in v1.28.0 

func (s *InternalServerErrorException) Code() string

Code returns the exception type name.

func (*InternalServerErrorException) Error added in v1.28.0 

func (s *InternalServerErrorException) Error() string

func (InternalServerErrorException) GoString added in v1.28.0 

func (s InternalServerErrorException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InternalServerErrorException) Message added in v1.28.0 

func (s *InternalServerErrorException) Message() string

Message returns the exception's message.

func (*InternalServerErrorException) OrigErr added in v1.28.0 

func (s *InternalServerErrorException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InternalServerErrorException) RequestID added in v1.28.0 

func (s *InternalServerErrorException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InternalServerErrorException) StatusCode added in v1.28.0 

func (s *InternalServerErrorException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InternalServerErrorException) String added in v1.28.0 

func (s InternalServerErrorException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ItemResponse added in v1.15.7 

type ItemResponse struct {

	// The response that was received after the endpoint data was accepted.
	EndpointItemResponse *EndpointItemResponse `type:"structure"`

	// A multipart response object that contains a key and a value for each event
	// in the request. In each object, the event ID is the key and an EventItemResponse
	// object is the value.
	EventsItemResponse map[string]*EventItemResponse `type:"map"`
	// contains filtered or unexported fields
}

Provides information about the results of a request to create or update an endpoint that's associated with an event.

func (ItemResponse) GoString added in v1.15.7 

func (s ItemResponse) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ItemResponse) SetEndpointItemResponse added in v1.15.7 

func (s *ItemResponse) SetEndpointItemResponse(v *EndpointItemResponse) *ItemResponse

SetEndpointItemResponse sets the EndpointItemResponse field's value.

func (*ItemResponse) SetEventsItemResponse added in v1.15.7 

func (s *ItemResponse) SetEventsItemResponse(v map[string]*EventItemResponse) *ItemResponse

SetEventsItemResponse sets the EventsItemResponse field's value.

func (ItemResponse) String added in v1.15.7 

func (s ItemResponse) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type JourneyChannelSettings added in v1.40.50 

type JourneyChannelSettings struct {

	// Amazon Resource Name (ARN) of the Connect Campaign.
	ConnectCampaignArn *string `type:"string"`

	// IAM role ARN to be assumed when invoking Connect campaign execution APIs
	// for dialing.
	ConnectCampaignExecutionRoleArn *string `type:"string"`
	// contains filtered or unexported fields
}

The channel-specific configurations for the journey.

func (JourneyChannelSettings) GoString added in v1.40.50 

func (s JourneyChannelSettings) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*JourneyChannelSettings) SetConnectCampaignArn added in v1.40.50 

func (s *JourneyChannelSettings) SetConnectCampaignArn(v string) *JourneyChannelSettings

SetConnectCampaignArn sets the ConnectCampaignArn field's value.

func (*JourneyChannelSettings) SetConnectCampaignExecutionRoleArn added in v1.40.50 

func (s *JourneyChannelSettings) SetConnectCampaignExecutionRoleArn(v string) *JourneyChannelSettings

SetConnectCampaignExecutionRoleArn sets the ConnectCampaignExecutionRoleArn field's value.

func (JourneyChannelSettings) String added in v1.40.50 

func (s JourneyChannelSettings) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type JourneyCustomMessage added in v1.31.12 

type JourneyCustomMessage struct {

	// The message content that's passed to an AWS Lambda function or to a web hook.
	Data *string `type:"string"`
	// contains filtered or unexported fields
}

Specifies the message content for a custom channel message that's sent to participants in a journey.

func (JourneyCustomMessage) GoString added in v1.31.12 

func (s JourneyCustomMessage) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*JourneyCustomMessage) SetData added in v1.31.12 

func (s *JourneyCustomMessage) SetData(v string) *JourneyCustomMessage

SetData sets the Data field's value.

func (JourneyCustomMessage) String added in v1.31.12 

func (s JourneyCustomMessage) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type JourneyDateRangeKpiResponse added in v1.25.25 

type JourneyDateRangeKpiResponse struct {

	// The unique identifier for the application that the metric applies to.
	//
	// ApplicationId is a required field
	ApplicationId *string `type:"string" required:"true"`

	// EndTime is a required field
	EndTime *time.Time `type:"timestamp" timestampFormat:"iso8601" required:"true"`

	// The unique identifier for the journey that the metric applies to.
	//
	// JourneyId is a required field
	JourneyId *string `type:"string" required:"true"`

	// The name of the metric, also referred to as a key performance indicator (KPI),
	// that the data was retrieved for. This value describes the associated metric
	// and consists of two or more terms, which are comprised of lowercase alphanumeric
	// characters, separated by a hyphen. For a list of possible values, see the
	// Amazon Pinpoint Developer Guide (https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html).
	//
	// KpiName is a required field
	KpiName *string `type:"string" required:"true"`

	// An array of objects that contains the results of the query. Each object contains
	// the value for the metric and metadata about that value.
	//
	// KpiResult is a required field
	KpiResult *BaseKpiResult `type:"structure" required:"true"`

	// The string to use in a subsequent request to get the next page of results
	// in a paginated response. This value is null for the Journey Engagement Metrics
	// resource because the resource returns all results in a single page.
	NextToken *string `type:"string"`

	// StartTime is a required field
	StartTime *time.Time `type:"timestamp" timestampFormat:"iso8601" required:"true"`
	// contains filtered or unexported fields
}

Provides the results of a query that retrieved the data for a standard engagement metric that applies to a journey, and provides information about that query.

func (JourneyDateRangeKpiResponse) GoString added in v1.25.25 

func (s JourneyDateRangeKpiResponse) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*JourneyDateRangeKpiResponse) SetApplicationId added in v1.25.25 

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

SetApplicationId sets the ApplicationId field's value.

func (*JourneyDateRangeKpiResponse) SetEndTime added in v1.25.25 

func (s *JourneyDateRangeKpiResponse) SetEndTime(v time.Time) *JourneyDateRangeKpiResponse

SetEndTime sets the EndTime field's value.

func (*JourneyDateRangeKpiResponse) SetJourneyId added in v1.25.25 

func (s *JourneyDateRangeKpiResponse) SetJourneyId(v string) *JourneyDateRangeKpiResponse

SetJourneyId sets the JourneyId field's value.

func (*JourneyDateRangeKpiResponse) SetKpiName added in v1.25.25 

func (s *JourneyDateRangeKpiResponse) SetKpiName(v string) *JourneyDateRangeKpiResponse

SetKpiName sets the KpiName field's value.

func (*JourneyDateRangeKpiResponse) SetKpiResult added in v1.25.25 

func (s *JourneyDateRangeKpiResponse) SetKpiResult(v *BaseKpiResult) *JourneyDateRangeKpiResponse

SetKpiResult sets the KpiResult field's value.

func (*JourneyDateRangeKpiResponse) SetNextToken added in v1.25.25 

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

SetNextToken sets the NextToken field's value.

func (*JourneyDateRangeKpiResponse) SetStartTime added in v1.25.25 

func (s *JourneyDateRangeKpiResponse) SetStartTime(v time.Time) *JourneyDateRangeKpiResponse

SetStartTime sets the StartTime field's value.

func (JourneyDateRangeKpiResponse) String added in v1.25.25 

func (s JourneyDateRangeKpiResponse) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type JourneyEmailMessage added in v1.25.25 

type JourneyEmailMessage struct {

	// The verified email address to send the email message from. The default address
	// is the FromAddress specified for the email channel for the application.
	FromAddress *string `type:"string"`
	// contains filtered or unexported fields
}

Specifies the "From" address for an email message that's sent to participants in a journey.

func (JourneyEmailMessage) GoString added in v1.25.25 

func (s JourneyEmailMessage) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*JourneyEmailMessage) SetFromAddress added in v1.25.25 

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

SetFromAddress sets the FromAddress field's value.

func (JourneyEmailMessage) String added in v1.25.25 

func (s JourneyEmailMessage) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type JourneyExecutionActivityMetricsResponse added in v1.25.25 

type JourneyExecutionActivityMetricsResponse struct {

	// The type of activity that the metric applies to. Possible values are:
	//
	//    * CONDITIONAL_SPLIT - For a yes/no split activity, which is an activity
	//    that sends participants down one of two paths in a journey.
	//
	//    * HOLDOUT - For a holdout activity, which is an activity that stops a
	//    journey for a specified percentage of participants.
	//
	//    * MESSAGE - For an email activity, which is an activity that sends an
	//    email message to participants.
	//
	//    * MULTI_CONDITIONAL_SPLIT - For a multivariate split activity, which is
	//    an activity that sends participants down one of as many as five paths
	//    in a journey.
	//
	//    * RANDOM_SPLIT - For a random split activity, which is an activity that
	//    sends specified percentages of participants down one of as many as five
	//    paths in a journey.
	//
	//    * WAIT - For a wait activity, which is an activity that waits for a certain
	//    amount of time or until a specific date and time before moving participants
	//    to the next activity in a journey.
	//
	// ActivityType is a required field
	ActivityType *string `type:"string" required:"true"`

	// The unique identifier for the application that the metric applies to.
	//
	// ApplicationId is a required field
	ApplicationId *string `type:"string" required:"true"`

	// The unique identifier for the activity that the metric applies to.
	//
	// JourneyActivityId is a required field
	JourneyActivityId *string `type:"string" required:"true"`

	// The unique identifier for the journey that the metric applies to.
	//
	// JourneyId is a required field
	JourneyId *string `type:"string" required:"true"`

	// The date and time, in ISO 8601 format, when Amazon Pinpoint last evaluated
	// the execution status of the activity and updated the data for the metric.
	//
	// LastEvaluatedTime is a required field
	LastEvaluatedTime *string `type:"string" required:"true"`

	// A JSON object that contains the results of the query. The results vary depending
	// on the type of activity (ActivityType). For information about the structure
	// and contents of the results, see the Amazon Pinpoint Developer Guide (https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html).
	//
	// Metrics is a required field
	Metrics map[string]*string `type:"map" required:"true"`
	// contains filtered or unexported fields
}

Provides the results of a query that retrieved the data for a standard execution metric that applies to a journey activity, and provides information about that query.

func (JourneyExecutionActivityMetricsResponse) GoString added in v1.25.25 

func (s JourneyExecutionActivityMetricsResponse) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*JourneyExecutionActivityMetricsResponse) SetActivityType added in v1.25.25 

func (s *JourneyExecutionActivityMetricsResponse) SetActivityType(v string) *JourneyExecutionActivityMetricsResponse

SetActivityType sets the ActivityType field's value.

func (*JourneyExecutionActivityMetricsResponse) SetApplicationId added in v1.25.25 

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

SetApplicationId sets the ApplicationId field's value.

func (*JourneyExecutionActivityMetricsResponse) SetJourneyActivityId added in v1.25.25 

func (s *JourneyExecutionActivityMetricsResponse) SetJourneyActivityId(v string) *JourneyExecutionActivityMetricsResponse

SetJourneyActivityId sets the JourneyActivityId field's value.

func (*JourneyExecutionActivityMetricsResponse) SetJourneyId added in v1.25.25 

func (s *JourneyExecutionActivityMetricsResponse) SetJourneyId(v string) *JourneyExecutionActivityMetricsResponse

SetJourneyId sets the JourneyId field's value.

func (*JourneyExecutionActivityMetricsResponse) SetLastEvaluatedTime added in v1.25.25 

func (s *JourneyExecutionActivityMetricsResponse) SetLastEvaluatedTime(v string) *JourneyExecutionActivityMetricsResponse

SetLastEvaluatedTime sets the LastEvaluatedTime field's value.

func (*JourneyExecutionActivityMetricsResponse) SetMetrics added in v1.25.25 

func (s *JourneyExecutionActivityMetricsResponse) SetMetrics(v map[string]*string) *JourneyExecutionActivityMetricsResponse

SetMetrics sets the Metrics field's value.

func (JourneyExecutionActivityMetricsResponse) String added in v1.25.25 

func (s JourneyExecutionActivityMetricsResponse) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type JourneyExecutionMetricsResponse added in v1.25.25 

type JourneyExecutionMetricsResponse struct {

	// The unique identifier for the application that the metric applies to.
	//
	// ApplicationId is a required field
	ApplicationId *string `type:"string" required:"true"`

	// The unique identifier for the journey that the metric applies to.
	//
	// JourneyId is a required field
	JourneyId *string `type:"string" required:"true"`

	// The date and time, in ISO 8601 format, when Amazon Pinpoint last evaluated
	// the journey and updated the data for the metric.
	//
	// LastEvaluatedTime is a required field
	LastEvaluatedTime *string `type:"string" required:"true"`

	// A JSON object that contains the results of the query. For information about
	// the structure and contents of the results, see the Amazon Pinpoint Developer
	// Guide (https://docs.aws.amazon.com//pinpoint/latest/developerguide/analytics-standard-metrics.html).
	//
	// Metrics is a required field
	Metrics map[string]*string `type:"map" required:"true"`
	// contains filtered or unexported fields
}

Provides the results of a query that retrieved the data for a standard execution metric that applies to a journey, and provides information about that query.

func (JourneyExecutionMetricsResponse) GoString added in v1.25.25 

func (s JourneyExecutionMetricsResponse) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*JourneyExecutionMetricsResponse) SetApplicationId added in v1.25.25 

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

SetApplicationId sets the ApplicationId field's value.

func (*JourneyExecutionMetricsResponse) SetJourneyId added in v1.25.25 

func (s *JourneyExecutionMetricsResponse) SetJourneyId(v string) *JourneyExecutionMetricsResponse

SetJourneyId sets the JourneyId field's value.

func (*JourneyExecutionMetricsResponse) SetLastEvaluatedTime added in v1.25.25 

func (s *JourneyExecutionMetricsResponse) SetLastEvaluatedTime(v string) *JourneyExecutionMetricsResponse

SetLastEvaluatedTime sets the LastEvaluatedTime field's value.

func (*JourneyExecutionMetricsResponse) SetMetrics added in v1.25.25 

func (s *JourneyExecutionMetricsResponse) SetMetrics(v map[string]*string) *JourneyExecutionMetricsResponse

SetMetrics sets the Metrics field's value.

func (JourneyExecutionMetricsResponse) String added in v1.25.25 

func (s JourneyExecutionMetricsResponse) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type JourneyLimits added in v1.25.25 

type JourneyLimits struct {

	// The maximum number of messages that the journey can send to a single participant
	// during a 24-hour period. The maximum value is 100.
	DailyCap *int64 `type:"integer"`

	// The maximum number of times that a participant can enter the journey. The
	// maximum value is 100. To allow participants to enter the journey an unlimited
	// number of times, set this value to 0.
	EndpointReentryCap *int64 `type:"integer"`

	EndpointReentryInterval *string `type:"string"`

	// The maximum number of messages that the journey can send each second.
	MessagesPerSecond *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Specifies limits on the messages that a journey can send and the number of times participants can enter a journey.

func (JourneyLimits) GoString added in v1.25.25 

func (s JourneyLimits) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*JourneyLimits) SetDailyCap added in v1.25.25 

func (s *JourneyLimits) SetDailyCap(v int64) *JourneyLimits

SetDailyCap sets the DailyCap field's value.

func (*JourneyLimits) SetEndpointReentryCap added in v1.25.25 

func (s *JourneyLimits) SetEndpointReentryCap(v int64) *JourneyLimits

SetEndpointReentryCap sets the EndpointReentryCap field's value.

func (*JourneyLimits) SetEndpointReentryInterval added in v1.38.9 

func (s *JourneyLimits) SetEndpointReentryInterval(v string) *JourneyLimits

SetEndpointReentryInterval sets the EndpointReentryInterval field's value.

func (*JourneyLimits) SetMessagesPerSecond added in v1.25.25 

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

SetMessagesPerSecond sets the MessagesPerSecond field's value.

func (JourneyLimits) String added in v1.25.25 

func (s JourneyLimits) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type JourneyPushMessage added in v1.31.12 

type JourneyPushMessage struct {

	// The number of seconds that the push notification service should keep the
	// message, if the service is unable to deliver the notification the first time.
	// This value is converted to an expiration value when it's sent to a push-notification
	// service. If this value is 0, the service treats the notification as if it
	// expires immediately and the service doesn't store or try to deliver the notification
	// again.
	//
	// This value doesn't apply to messages that are sent through the Amazon Device
	// Messaging (ADM) service.
	TimeToLive *string `type:"string"`
	// contains filtered or unexported fields
}

Specifies the message configuration for a push notification that's sent to participants in a journey.

func (JourneyPushMessage) GoString added in v1.31.12 

func (s JourneyPushMessage) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*JourneyPushMessage) SetTimeToLive added in v1.31.12 

func (s *JourneyPushMessage) SetTimeToLive(v string) *JourneyPushMessage

SetTimeToLive sets the TimeToLive field's value.

func (JourneyPushMessage) String added in v1.31.12 

func (s JourneyPushMessage) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type JourneyResponse added in v1.25.25 

type JourneyResponse struct {

	// A map that contains a set of Activity objects, one object for each activity
	// in the journey. For each Activity object, the key is the unique identifier
	// (string) for an activity and the value is the settings for the activity.
	Activities map[string]*Activity `type:"map"`

	// The unique identifier for the application that the journey applies to.
	//
	// ApplicationId is a required field
	ApplicationId *string `type:"string" required:"true"`

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

	// The unique identifier for the journey.
	//
	// Id is a required field
	Id *string `type:"string" required:"true"`

	// Amazon Resource Name (ARN) of the Connect Campaign.
	JourneyChannelSettings *JourneyChannelSettings `type:"structure"`

	// The date, in ISO 8601 format, when the journey was last modified.
	LastModifiedDate *string `type:"string"`

	// The messaging and entry limits for the journey.
	Limits *JourneyLimits `type:"structure"`

	// Specifies whether the journey's scheduled start and end times use each participant's
	// local time. If this value is true, the schedule uses each participant's local
	// time.
	LocalTime *bool `type:"boolean"`

	// The name of the journey.
	//
	// Name is a required field
	Name *string `type:"string" required:"true"`

	// The quiet time settings for the journey. Quiet time is a specific time range
	// when a journey doesn't send messages to participants, if all the following
	// conditions are met:
	//
	//    * The EndpointDemographic.Timezone property of the endpoint for the participant
	//    is set to a valid value.
	//
	//    * The current time in the participant's time zone is later than or equal
	//    to the time specified by the QuietTime.Start property for the journey.
	//
	//    * The current time in the participant's time zone is earlier than or equal
	//    to the time specified by the QuietTime.End property for the journey.
	//
	// If any of the preceding conditions isn't met, the participant will receive
	// messages from the journey, even if quiet time is enabled.
	QuietTime *QuietTime `type:"structure"`

	// The frequency with which Amazon Pinpoint evaluates segment and event data
	// for the journey, as a duration in ISO 8601 format.
	RefreshFrequency *string `type:"string"`

	// The schedule settings for the journey.
	Schedule *JourneySchedule `type:"structure"`

	// The unique identifier for the first activity in the journey.
	StartActivity *string `type:"string"`

	// The segment that defines which users are participants in the journey.
	StartCondition *StartCondition `type:"structure"`

	// The current status of the journey. Possible values are:
	//
	//    * DRAFT - The journey is being developed and hasn't been published yet.
	//
	//    * ACTIVE - The journey has been developed and published. Depending on
	//    the journey's schedule, the journey may currently be running or scheduled
	//    to start running at a later time. If a journey's status is ACTIVE, you
	//    can't add, change, or remove activities from it.
	//
	//    * PAUSED - The journey has been paused. Amazon Pinpoint continues to perform
	//    activities that are currently in progress, until those activities are
	//    complete.
	//
	//    * COMPLETED - The journey has been published and has finished running.
	//    All participants have entered the journey and no participants are waiting
	//    to complete the journey or any activities in the journey.
	//
	//    * CANCELLED - The journey has been stopped. If a journey's status is CANCELLED,
	//    you can't add, change, or remove activities or segment settings from the
	//    journey.
	//
	//    * CLOSED - The journey has been published and has started running. It
	//    may have also passed its scheduled end time, or passed its scheduled start
	//    time and a refresh frequency hasn't been specified for it. If a journey's
	//    status is CLOSED, you can't add participants to it, and no existing participants
	//    can enter the journey for the first time. However, any existing participants
	//    who are currently waiting to start an activity may continue the journey.
	State *string `type:"string" enum:"State"`

	// This object is not used or supported.
	Tags map[string]*string `locationName:"tags" type:"map"`
	// contains filtered or unexported fields
}

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

func (JourneyResponse) GoString added in v1.25.25 

func (s JourneyResponse) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*JourneyResponse) SetActivities added in v1.25.25 

func (s *JourneyResponse) SetActivities(v map[string]*Activity) *JourneyResponse

SetActivities sets the Activities field's value.

func (*JourneyResponse) SetApplicationId added in v1.25.25 

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

SetApplicationId sets the ApplicationId field's value.

func (*JourneyResponse) SetCreationDate added in v1.25.25 

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

SetCreationDate sets the CreationDate field's value.

func (*JourneyResponse) SetId added in v1.25.25 

func (s *JourneyResponse) SetId(v string) *JourneyResponse

SetId sets the Id field's value.

func (*JourneyResponse) SetJourneyChannelSettings added in v1.40.50 

func (s *JourneyResponse) SetJourneyChannelSettings(v *JourneyChannelSettings) *JourneyResponse

SetJourneyChannelSettings sets the JourneyChannelSettings field's value.

func (*JourneyResponse) SetLastModifiedDate added in v1.25.25 

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

SetLastModifiedDate sets the LastModifiedDate field's value.

func (*JourneyResponse) SetLimits added in v1.25.25 

func (s *JourneyResponse) SetLimits(v *JourneyLimits) *JourneyResponse

SetLimits sets the Limits field's value.

func (*JourneyResponse) SetLocalTime added in v1.25.25 

func (s *JourneyResponse) SetLocalTime(v bool) *JourneyResponse

SetLocalTime sets the LocalTime field's value.

func (*JourneyResponse) SetName added in v1.25.25 

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

SetName sets the Name field's value.

func (*JourneyResponse) SetQuietTime added in v1.25.25 

func (s *JourneyResponse) SetQuietTime(v *QuietTime) *JourneyResponse

SetQuietTime sets the QuietTime field's value.

func (*JourneyResponse) SetRefreshFrequency added in v1.25.25 

func (s *JourneyResponse) SetRefreshFrequency(v string) *JourneyResponse

SetRefreshFrequency sets the RefreshFrequency field's value.

func (*JourneyResponse) SetSchedule added in v1.25.25 

func (s *JourneyResponse) SetSchedule(v *JourneySchedule) *JourneyResponse

SetSchedule sets the Schedule field's value.

func (*JourneyResponse) SetStartActivity added in v1.25.25 

func (s *JourneyResponse) SetStartActivity(v string) *JourneyResponse

SetStartActivity sets the StartActivity field's value.

func (*JourneyResponse) SetStartCondition added in v1.25.25 

func (s *JourneyResponse) SetStartCondition(v *StartCondition) *JourneyResponse

SetStartCondition sets the StartCondition field's value.

func (*JourneyResponse) SetState added in v1.25.25 

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

SetState sets the State field's value.

func (*JourneyResponse) SetTags added in v1.25.25 

func (s *JourneyResponse) SetTags(v map[string]*string) *JourneyResponse

SetTags sets the Tags field's value.

func (JourneyResponse) String added in v1.25.25 

func (s JourneyResponse) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type JourneySMSMessage added in v1.31.12 

type JourneySMSMessage struct {

	// The entity ID or Principal Entity (PE) id received from the regulatory body
	// for sending SMS in your country.
	EntityId *string `type:"string"`

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

	// The long code to send the SMS message from. This value should be one of the
	// dedicated long codes that's assigned to your AWS account. Although it isn't
	// required, we recommend that you specify the long code using an E.164 format
	// to ensure prompt and accurate delivery of the message. For example, +12065550100.
	OriginationNumber *string `type:"string"`

	// The sender ID to display as the sender of the message on a recipient's device.
	// Support for sender IDs varies by country or region. For more information,
	// see Supported Countries and Regions (https://docs.aws.amazon.com/pinpoint/latest/userguide/channels-sms-countries.html)
	// in the Amazon Pinpoint User Guide.
	SenderId *string `type:"string"`

	// The template ID received from the regulatory body for sending SMS in your
	// country.
	TemplateId *string `type:"string"`
	// contains filtered or unexported fields
}

Specifies the sender ID and message type for an SMS message that's sent to participants in a journey.

func (JourneySMSMessage) GoString added in v1.31.12 

func (s JourneySMSMessage) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*JourneySMSMessage) SetEntityId added in v1.37.17 

func (s *JourneySMSMessage) SetEntityId(v string) *JourneySMSMessage

SetEntityId sets the EntityId field's value.

func (*JourneySMSMessage) SetMessageType added in v1.31.12 

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

SetMessageType sets the MessageType field's value.

func (*JourneySMSMessage) SetOriginationNumber added in v1.37.11 

func (s *JourneySMSMessage) SetOriginationNumber(v string) *JourneySMSMessage

SetOriginationNumber sets the OriginationNumber field's value.

func (*JourneySMSMessage) SetSenderId added in v1.31.12 

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

SetSenderId sets the SenderId field's value.

func (*JourneySMSMessage) SetTemplateId added in v1.37.17 

func (s *JourneySMSMessage) SetTemplateId(v string) *JourneySMSMessage

SetTemplateId sets the TemplateId field's value.

func (JourneySMSMessage) String added in v1.31.12 

func (s JourneySMSMessage) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type JourneySchedule added in v1.25.25 

type JourneySchedule struct {
	EndTime *time.Time `type:"timestamp" timestampFormat:"iso8601"`

	StartTime *time.Time `type:"timestamp" timestampFormat:"iso8601"`

	// The starting UTC offset for the journey schedule, if the value of the journey's
	// LocalTime property is true. Valid values are: UTC, UTC+01, UTC+02, UTC+03,
	// UTC+03:30, UTC+04, UTC+04:30, UTC+05, UTC+05:30, UTC+05:45, UTC+06, UTC+06:30,
	// UTC+07, UTC+08, UTC+08:45, UTC+09, UTC+09:30, UTC+10, UTC+10:30, UTC+11,
	// UTC+12, UTC+12:45, UTC+13, UTC+13:45, UTC-02, UTC-02:30, UTC-03, UTC-03:30,
	// UTC-04, UTC-05, UTC-06, UTC-07, UTC-08, UTC-09, UTC-09:30, UTC-10, and UTC-11.
	Timezone *string `type:"string"`
	// contains filtered or unexported fields
}

Specifies the schedule settings for a journey.

func (JourneySchedule) GoString added in v1.25.25 

func (s JourneySchedule) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*JourneySchedule) SetEndTime added in v1.25.25 

func (s *JourneySchedule) SetEndTime(v time.Time) *JourneySchedule

SetEndTime sets the EndTime field's value.

func (*JourneySchedule) SetStartTime added in v1.25.25 

func (s *JourneySchedule) SetStartTime(v time.Time) *JourneySchedule

SetStartTime sets the StartTime field's value.

func (*JourneySchedule) SetTimezone added in v1.25.25 

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

SetTimezone sets the Timezone field's value.

func (JourneySchedule) String added in v1.25.25 

func (s JourneySchedule) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type JourneyStateRequest added in v1.25.25 

type JourneyStateRequest struct {

	// The status of the journey. Currently, Supported values are ACTIVE, PAUSED,
	// and CANCELLED
	//
	// If you cancel a journey, Amazon Pinpoint continues to perform activities
	// that are currently in progress, until those activities are complete. Amazon
	// Pinpoint also continues to collect and aggregate analytics data for those
	// activities, until they are complete, and any activities that were complete
	// when you cancelled the journey.
	//
	// After you cancel a journey, you can't add, change, or remove any activities
	// from the journey. In addition, Amazon Pinpoint stops evaluating the journey
	// and doesn't perform any activities that haven't started.
	//
	// When the journey is paused, Amazon Pinpoint continues to perform activities
	// that are currently in progress, until those activities are complete. Endpoints
	// will stop entering journeys when the journey is paused and will resume entering
	// the journey after the journey is resumed. For wait activities, wait time
	// is paused when the journey is paused. Currently, PAUSED only supports journeys
	// with a segment refresh interval.
	State *string `type:"string" enum:"State"`
	// contains filtered or unexported fields
}

Changes the status of a journey.

func (JourneyStateRequest) GoString added in v1.25.25 

func (s JourneyStateRequest) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*JourneyStateRequest) SetState added in v1.25.25 

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

SetState sets the State field's value.

func (JourneyStateRequest) String added in v1.25.25 

func (s JourneyStateRequest) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type JourneysResponse added in v1.25.25 

type JourneysResponse struct {

	// An array of responses, one for each journey that's associated with the application.
	//
	// Item is a required field
	Item []*JourneyResponse `type:"list" required:"true"`

	// The string to use in a subsequent request to get the next page of results
	// in a paginated response. This value is null if there are no additional pages.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

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

func (JourneysResponse) GoString added in v1.25.25 

func (s JourneysResponse) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*JourneysResponse) SetItem added in v1.25.25 

func (s *JourneysResponse) SetItem(v []*JourneyResponse) *JourneysResponse

SetItem sets the Item field's value.

func (*JourneysResponse) SetNextToken added in v1.25.25 

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

SetNextToken sets the NextToken field's value.

func (JourneysResponse) String added in v1.25.25 

func (s JourneysResponse) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListJourneysInput added in v1.25.25 

type ListJourneysInput struct {

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

	PageSize *string `location:"querystring" locationName:"page-size" type:"string"`

	Token *string `location:"querystring" locationName:"token" type:"string"`
	// contains filtered or unexported fields
}

func (ListJourneysInput) GoString added in v1.25.25 

func (s ListJourneysInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListJourneysInput) SetApplicationId added in v1.25.25 

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

SetApplicationId sets the ApplicationId field's value.

func (*ListJourneysInput) SetPageSize added in v1.25.25 

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

SetPageSize sets the PageSize field's value.

func (*ListJourneysInput) SetToken added in v1.25.25 

func (s *ListJourneysInput) SetToken(v string) *ListJourneysInput

SetToken sets the Token field's value.

func (ListJourneysInput) String added in v1.25.25 

func (s ListJourneysInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListJourneysInput) Validate added in v1.25.25 

func (s *ListJourneysInput) Validate() error

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

type ListJourneysOutput added in v1.25.25 

type ListJourneysOutput struct {

	// Provides information about the status, configuration, and other settings
	// for all the journeys that are associated with an application.
	//
	// JourneysResponse is a required field
	JourneysResponse *JourneysResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (ListJourneysOutput) GoString added in v1.25.25 

func (s ListJourneysOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListJourneysOutput) SetJourneysResponse added in v1.25.25 

func (s *ListJourneysOutput) SetJourneysResponse(v *JourneysResponse) *ListJourneysOutput

SetJourneysResponse sets the JourneysResponse field's value.

func (ListJourneysOutput) String added in v1.25.25 

func (s ListJourneysOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListRecommenderConfigurationsResponse added in v1.29.17 

type ListRecommenderConfigurationsResponse struct {

	// An array of responses, one for each recommender model configuration that's
	// associated with your Amazon Pinpoint account.
	//
	// Item is a required field
	Item []*RecommenderConfigurationResponse `type:"list" required:"true"`

	// The string to use in a subsequent request to get the next page of results
	// in a paginated response. This value is null if there are no additional pages.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

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

func (ListRecommenderConfigurationsResponse) GoString added in v1.29.17 

func (s ListRecommenderConfigurationsResponse) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListRecommenderConfigurationsResponse) SetItem added in v1.29.17 

func (s *ListRecommenderConfigurationsResponse) SetItem(v []*RecommenderConfigurationResponse) *ListRecommenderConfigurationsResponse

SetItem sets the Item field's value.

func (*ListRecommenderConfigurationsResponse) SetNextToken added in v1.29.17 

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

SetNextToken sets the NextToken field's value.

func (ListRecommenderConfigurationsResponse) String added in v1.29.17 

func (s ListRecommenderConfigurationsResponse) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListTagsForResourceInput added in v1.17.6 

type ListTagsForResourceInput struct {

	// ResourceArn is a required field
	ResourceArn *string `location:"uri" locationName:"resource-arn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceInput) GoString added in v1.17.6 

func (s ListTagsForResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceInput) SetResourceArn added in v1.17.6 

func (s *ListTagsForResourceInput) SetResourceArn(v string) *ListTagsForResourceInput

SetResourceArn sets the ResourceArn field's value.

func (ListTagsForResourceInput) String added in v1.17.6 

func (s ListTagsForResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceInput) Validate added in v1.17.6 

func (s *ListTagsForResourceInput) Validate() error

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

type ListTagsForResourceOutput added in v1.17.6 

type ListTagsForResourceOutput struct {

	// Specifies the tags (keys and values) for an application, campaign, message
	// template, or segment.
	//
	// TagsModel is a required field
	TagsModel *TagsModel `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceOutput) GoString added in v1.17.6 

func (s ListTagsForResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceOutput) SetTagsModel added in v1.17.6 

func (s *ListTagsForResourceOutput) SetTagsModel(v *TagsModel) *ListTagsForResourceOutput

SetTagsModel sets the TagsModel field's value.

func (ListTagsForResourceOutput) String added in v1.17.6 

func (s ListTagsForResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListTemplateVersionsInput added in v1.26.7 

type ListTemplateVersionsInput struct {
	NextToken *string `location:"querystring" locationName:"next-token" type:"string"`

	PageSize *string `location:"querystring" locationName:"page-size" type:"string"`

	// TemplateName is a required field
	TemplateName *string `location:"uri" locationName:"template-name" type:"string" required:"true"`

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

func (ListTemplateVersionsInput) GoString added in v1.26.7 

func (s ListTemplateVersionsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTemplateVersionsInput) SetNextToken added in v1.26.7 

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

SetNextToken sets the NextToken field's value.

func (*ListTemplateVersionsInput) SetPageSize added in v1.26.7 

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

SetPageSize sets the PageSize field's value.

func (*ListTemplateVersionsInput) SetTemplateName added in v1.26.7 

func (s *ListTemplateVersionsInput) SetTemplateName(v string) *ListTemplateVersionsInput

SetTemplateName sets the TemplateName field's value.

func (*ListTemplateVersionsInput) SetTemplateType added in v1.26.7 

func (s *ListTemplateVersionsInput) SetTemplateType(v string) *ListTemplateVersionsInput

SetTemplateType sets the TemplateType field's value.

func (ListTemplateVersionsInput) String added in v1.26.7 

func (s ListTemplateVersionsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTemplateVersionsInput) Validate added in v1.26.7 

func (s *ListTemplateVersionsInput) Validate() error

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

type ListTemplateVersionsOutput added in v1.26.7 

type ListTemplateVersionsOutput struct {

	// Provides information about all the versions of a specific message template.
	//
	// TemplateVersionsResponse is a required field
	TemplateVersionsResponse *TemplateVersionsResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (ListTemplateVersionsOutput) GoString added in v1.26.7 

func (s ListTemplateVersionsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTemplateVersionsOutput) SetTemplateVersionsResponse added in v1.26.7 

func (s *ListTemplateVersionsOutput) SetTemplateVersionsResponse(v *TemplateVersionsResponse) *ListTemplateVersionsOutput

SetTemplateVersionsResponse sets the TemplateVersionsResponse field's value.

func (ListTemplateVersionsOutput) String added in v1.26.7 

func (s ListTemplateVersionsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListTemplatesInput added in v1.25.7 

type ListTemplatesInput struct {
	NextToken *string `location:"querystring" locationName:"next-token" type:"string"`

	PageSize *string `location:"querystring" locationName:"page-size" type:"string"`

	Prefix *string `location:"querystring" locationName:"prefix" type:"string"`

	TemplateType *string `location:"querystring" locationName:"template-type" type:"string"`
	// contains filtered or unexported fields
}

func (ListTemplatesInput) GoString added in v1.25.7 

func (s ListTemplatesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTemplatesInput) SetNextToken added in v1.25.7 

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

SetNextToken sets the NextToken field's value.

func (*ListTemplatesInput) SetPageSize added in v1.25.7 

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

SetPageSize sets the PageSize field's value.

func (*ListTemplatesInput) SetPrefix added in v1.25.7 

func (s *ListTemplatesInput) SetPrefix(v string) *ListTemplatesInput

SetPrefix sets the Prefix field's value.

func (*ListTemplatesInput) SetTemplateType added in v1.25.7 

func (s *ListTemplatesInput) SetTemplateType(v string) *ListTemplatesInput

SetTemplateType sets the TemplateType field's value.

func (ListTemplatesInput) String added in v1.25.7 

func (s ListTemplatesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListTemplatesOutput added in v1.25.7 

type ListTemplatesOutput struct {

	// Provides information about all the message templates that are associated
	// with your Amazon Pinpoint account.
	//
	// TemplatesResponse is a required field
	TemplatesResponse *TemplatesResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (ListTemplatesOutput) GoString added in v1.25.7 

func (s ListTemplatesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTemplatesOutput) SetTemplatesResponse added in v1.25.7 

func (s *ListTemplatesOutput) SetTemplatesResponse(v *TemplatesResponse) *ListTemplatesOutput

SetTemplatesResponse sets the TemplatesResponse field's value.

func (ListTemplatesOutput) String added in v1.25.7 

func (s ListTemplatesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Message 

type Message struct {

	// The action to occur if a recipient taps the push notification. Valid values
	// are:
	//
	//    * OPEN_APP - Your app opens or it becomes the foreground app if it was
	//    sent to the background. This is the default action.
	//
	//    * DEEP_LINK - Your app opens and displays a designated user interface
	//    in the app. This setting uses the deep-linking features of iOS and Android.
	//
	//    * URL - The default mobile browser on the recipient's device opens and
	//    loads the web page at a URL that you specify.
	Action *string `type:"string" enum:"Action"`

	// The body of the notification message. The maximum number of characters is
	// 200.
	Body *string `type:"string"`

	// The URL of the image to display as the push-notification icon, such as the
	// icon for the app.
	ImageIconUrl *string `type:"string"`

	// The URL of the image to display as the small, push-notification icon, such
	// as a small version of the icon for the app.
	ImageSmallIconUrl *string `type:"string"`

	// The URL of an image to display in the push notification.
	ImageUrl *string `type:"string"`

	// The JSON payload to use for a silent push notification.
	JsonBody *string `type:"string"`

	// The URL of the image or video to display in the push notification.
	MediaUrl *string `type:"string"`

	// The raw, JSON-formatted string to use as the payload for the notification
	// message. If specified, this value overrides all other content for the message.
	RawContent *string `type:"string"`

	// Specifies whether the notification is a silent push notification, which is
	// a push notification that doesn't display on a recipient's device. Silent
	// push notifications can be used for cases such as updating an app's configuration,
	// displaying messages in an in-app message center, or supporting phone home
	// functionality.
	SilentPush *bool `type:"boolean"`

	// The number of seconds that the push-notification service should keep the
	// message, if the service is unable to deliver the notification the first time.
	// This value is converted to an expiration value when it's sent to a push-notification
	// service. If this value is 0, the service treats the notification as if it
	// expires immediately and the service doesn't store or try to deliver the notification
	// again.
	//
	// This value doesn't apply to messages that are sent through the Amazon Device
	// Messaging (ADM) service.
	TimeToLive *int64 `type:"integer"`

	// The title to display above the notification message on a recipient's device.
	Title *string `type:"string"`

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

Specifies the content and settings for a push notification that's sent to recipients of a campaign.

func (Message) GoString 

func (s Message) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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) SetTimeToLive added in v1.14.20 

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

SetTimeToLive sets the TimeToLive 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type MessageBody 

type MessageBody struct {

	// The message that's returned from the API.
	Message *string `type:"string"`

	// The unique identifier for the request or response.
	RequestID *string `type:"string"`
	// contains filtered or unexported fields
}

Provides information about an API request or response.

func (MessageBody) GoString 

func (s MessageBody) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type MessageConfiguration 

type MessageConfiguration struct {

	// The message that the campaign sends through the ADM (Amazon Device Messaging)
	// channel. If specified, this message overrides the default message.
	ADMMessage *Message `type:"structure"`

	// The message that the campaign sends through the APNs (Apple Push Notification
	// service) channel. If specified, this message overrides the default message.
	APNSMessage *Message `type:"structure"`

	// The message that the campaign sends through the Baidu (Baidu Cloud Push)
	// channel. If specified, this message overrides the default message.
	BaiduMessage *Message `type:"structure"`

	// The message that the campaign sends through a custom channel, as specified
	// by the delivery configuration (CustomDeliveryConfiguration) settings for
	// the campaign. If specified, this message overrides the default message.
	CustomMessage *CampaignCustomMessage `type:"structure"`

	// The default message that the campaign sends through all the channels that
	// are configured for the campaign.
	DefaultMessage *Message `type:"structure"`

	// The message that the campaign sends through the email channel. If specified,
	// this message overrides the default message.
	EmailMessage *CampaignEmailMessage `type:"structure"`

	// The message that the campaign sends through the GCM channel, which enables
	// Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging
	// (FCM), formerly Google Cloud Messaging (GCM), service. If specified, this
	// message overrides the default message.
	GCMMessage *Message `type:"structure"`

	// The in-app message configuration.
	InAppMessage *CampaignInAppMessage `type:"structure"`

	// The message that the campaign sends through the SMS channel. If specified,
	// this message overrides the default message.
	SMSMessage *CampaignSmsMessage `type:"structure"`
	// contains filtered or unexported fields
}

Specifies the message configuration settings for a campaign.

func (MessageConfiguration) GoString 

func (s MessageConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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) SetCustomMessage added in v1.30.13 

func (s *MessageConfiguration) SetCustomMessage(v *CampaignCustomMessage) *MessageConfiguration

SetCustomMessage sets the CustomMessage 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 

func (s *MessageConfiguration) SetEmailMessage(v *CampaignEmailMessage) *MessageConfiguration

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) SetInAppMessage added in v1.40.44 

func (s *MessageConfiguration) SetInAppMessage(v *CampaignInAppMessage) *MessageConfiguration

SetInAppMessage sets the InAppMessage field's value.

func (*MessageConfiguration) SetSMSMessage added in v1.8.38 

func (s *MessageConfiguration) SetSMSMessage(v *CampaignSmsMessage) *MessageConfiguration

SetSMSMessage sets the SMSMessage field's value.

func (MessageConfiguration) String 

func (s MessageConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MessageConfiguration) Validate added in v1.20.11 

func (s *MessageConfiguration) Validate() error

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

type MessageRequest added in v1.8.38 

type MessageRequest struct {

	// A map of key-value pairs, where each key is an address and each value is
	// an AddressConfiguration (https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-messages.html#apps-application-id-messages-model-addressconfiguration)
	// object. An address can be a push notification token, a phone number, or an
	// email address. You can use an AddressConfiguration (https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-messages.html#apps-application-id-messages-model-addressconfiguration)
	// object to tailor the message for an address by specifying settings such as
	// content overrides and message variables.
	Addresses map[string]*AddressConfiguration `type:"map"`

	// A map of custom attributes to attach to the message. For a push notification,
	// this payload is added to the data.pinpoint object. For an email or text message,
	// this payload is added to email/SMS delivery receipt event attributes.
	Context map[string]*string `type:"map"`

	// A map of key-value pairs, where each key is an endpoint ID and each value
	// is an EndpointSendConfiguration (https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-messages.html#apps-application-id-messages-model-endpointsendconfiguration)
	// object. You can use an EndpointSendConfiguration (https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-messages.html#apps-application-id-messages-model-endpointsendconfiguration)
	// object to tailor the message for an endpoint by specifying settings such
	// as content overrides and message variables.
	Endpoints map[string]*EndpointSendConfiguration `type:"map"`

	// The settings and content for the default message and any default messages
	// that you defined for specific channels.
	//
	// MessageConfiguration is a required field
	MessageConfiguration *DirectMessageConfiguration `type:"structure" required:"true"`

	// The message template to use for the message.
	TemplateConfiguration *TemplateConfiguration `type:"structure"`

	// The unique identifier for tracing the message. This identifier is visible
	// to message recipients.
	TraceId *string `type:"string"`
	// contains filtered or unexported fields
}

Specifies the configuration and other settings for a message.

func (MessageRequest) GoString added in v1.8.38 

func (s MessageRequest) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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 

func (s *MessageRequest) SetEndpoints(v map[string]*EndpointSendConfiguration) *MessageRequest

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) SetTemplateConfiguration added in v1.25.7 

func (s *MessageRequest) SetTemplateConfiguration(v *TemplateConfiguration) *MessageRequest

SetTemplateConfiguration sets the TemplateConfiguration field's value.

func (*MessageRequest) SetTraceId added in v1.15.7 

func (s *MessageRequest) SetTraceId(v string) *MessageRequest

SetTraceId sets the TraceId field's value.

func (MessageRequest) String added in v1.8.38 

func (s MessageRequest) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MessageRequest) Validate added in v1.20.11 

func (s *MessageRequest) Validate() error

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

type MessageResponse added in v1.8.38 

type MessageResponse struct {

	// The unique identifier for the application that was used to send the message.
	//
	// ApplicationId is a required field
	ApplicationId *string `type:"string" required:"true"`

	// A map that contains a multipart response for each address that the message
	// was sent to. In the map, the endpoint ID is the key and the result is the
	// value.
	EndpointResult map[string]*EndpointMessageResult `type:"map"`

	// The identifier for the original request that the message was delivered for.
	RequestId *string `type:"string"`

	// A map that contains a multipart response for each address (email address,
	// phone number, or push notification token) that the message was sent to. In
	// the map, the address is the key and the result is the value.
	Result map[string]*MessageResult `type:"map"`
	// contains filtered or unexported fields
}

Provides information about the results of a request to send a message to an endpoint address.

func (MessageResponse) GoString added in v1.8.38 

func (s MessageResponse) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type MessageResult added in v1.8.38 

type MessageResult struct {

	// The delivery status of the message. Possible values are:
	//
	//    * DUPLICATE - The endpoint address is a duplicate of another endpoint
	//    address. Amazon Pinpoint won't attempt to send the message again.
	//
	//    * OPT_OUT - The user who's associated with the endpoint address has opted
	//    out of receiving messages from you. Amazon Pinpoint won't attempt to send
	//    the message again.
	//
	//    * PERMANENT_FAILURE - An error occurred when delivering the message to
	//    the endpoint address. Amazon Pinpoint won't attempt to send the message
	//    again.
	//
	//    * SUCCESSFUL - The message was successfully delivered to the endpoint
	//    address.
	//
	//    * TEMPORARY_FAILURE - A temporary error occurred. Amazon Pinpoint won't
	//    attempt to send the message again.
	//
	//    * THROTTLED - Amazon Pinpoint throttled the operation to send the message
	//    to the endpoint address.
	//
	//    * TIMEOUT - The message couldn't be sent within the timeout period.
	//
	//    * UNKNOWN_FAILURE - An unknown error occurred.
	//
	// DeliveryStatus is a required field
	DeliveryStatus *string `type:"string" required:"true" enum:"DeliveryStatus"`

	// The unique identifier for the message that was sent.
	MessageId *string `type:"string"`

	// The downstream service status code for delivering the message.
	//
	// StatusCode is a required field
	StatusCode *int64 `type:"integer" required:"true"`

	// The status message for delivering the message.
	StatusMessage *string `type:"string"`

	// For push notifications that are sent through the GCM channel, specifies whether
	// the endpoint's device registration token was updated as part of delivering
	// the message.
	UpdatedToken *string `type:"string"`
	// contains filtered or unexported fields
}

Provides information about the results of sending a message directly to an endpoint address.

func (MessageResult) GoString added in v1.8.38 

func (s MessageResult) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MessageResult) SetDeliveryStatus added in v1.8.38 

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

SetDeliveryStatus sets the DeliveryStatus field's value.

func (*MessageResult) SetMessageId added in v1.14.20 

func (s *MessageResult) SetMessageId(v string) *MessageResult

SetMessageId sets the MessageId 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type MethodNotAllowedException added in v1.28.0 

type MethodNotAllowedException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`

	RequestID_ *string `locationName:"RequestID" type:"string"`
	// contains filtered or unexported fields
}

Provides information about an API request or response.

func (*MethodNotAllowedException) Code added in v1.28.0 

func (s *MethodNotAllowedException) Code() string

Code returns the exception type name.

func (*MethodNotAllowedException) Error added in v1.28.0 

func (s *MethodNotAllowedException) Error() string

func (MethodNotAllowedException) GoString added in v1.28.0 

func (s MethodNotAllowedException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MethodNotAllowedException) Message added in v1.28.0 

func (s *MethodNotAllowedException) Message() string

Message returns the exception's message.

func (*MethodNotAllowedException) OrigErr added in v1.28.0 

func (s *MethodNotAllowedException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*MethodNotAllowedException) RequestID added in v1.28.0 

func (s *MethodNotAllowedException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*MethodNotAllowedException) StatusCode added in v1.28.0 

func (s *MethodNotAllowedException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (MethodNotAllowedException) String added in v1.28.0 

func (s MethodNotAllowedException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type MetricDimension added in v1.14.20 

type MetricDimension struct {

	// The operator to use when comparing metric values. Valid values are: GREATER_THAN,
	// LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.
	//
	// ComparisonOperator is a required field
	ComparisonOperator *string `type:"string" required:"true"`

	// The value to compare.
	//
	// Value is a required field
	Value *float64 `type:"double" required:"true"`
	// contains filtered or unexported fields
}

Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.

func (MetricDimension) GoString added in v1.14.20 

func (s MetricDimension) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MetricDimension) SetComparisonOperator added in v1.14.20 

func (s *MetricDimension) SetComparisonOperator(v string) *MetricDimension

SetComparisonOperator sets the ComparisonOperator field's value.

func (*MetricDimension) SetValue added in v1.14.20 

func (s *MetricDimension) SetValue(v float64) *MetricDimension

SetValue sets the Value field's value.

func (MetricDimension) String added in v1.14.20 

func (s MetricDimension) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MetricDimension) Validate added in v1.20.11 

func (s *MetricDimension) Validate() error

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

type MultiConditionalBranch added in v1.25.25 

type MultiConditionalBranch struct {

	// The condition to evaluate for the activity path.
	Condition *SimpleCondition `type:"structure"`

	// The unique identifier for the next activity to perform, after completing
	// the activity for the path.
	NextActivity *string `type:"string"`
	// contains filtered or unexported fields
}

Specifies a condition to evaluate for an activity path in a journey.

func (MultiConditionalBranch) GoString added in v1.25.25 

func (s MultiConditionalBranch) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MultiConditionalBranch) SetCondition added in v1.25.25 

func (s *MultiConditionalBranch) SetCondition(v *SimpleCondition) *MultiConditionalBranch

SetCondition sets the Condition field's value.

func (*MultiConditionalBranch) SetNextActivity added in v1.25.25 

func (s *MultiConditionalBranch) SetNextActivity(v string) *MultiConditionalBranch

SetNextActivity sets the NextActivity field's value.

func (MultiConditionalBranch) String added in v1.25.25 

func (s MultiConditionalBranch) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MultiConditionalBranch) Validate added in v1.25.25 

func (s *MultiConditionalBranch) Validate() error

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

type MultiConditionalSplitActivity added in v1.25.25 

type MultiConditionalSplitActivity struct {

	// The paths for the activity, including the conditions for entering each path
	// and the activity to perform for each path.
	Branches []*MultiConditionalBranch `type:"list"`

	// The unique identifier for the activity to perform for participants who don't
	// meet any of the conditions specified for other paths in the activity.
	DefaultActivity *string `type:"string"`

	// The amount of time to wait or the date and time when Amazon Pinpoint determines
	// whether the conditions are met.
	EvaluationWaitTime *WaitTime `type:"structure"`
	// contains filtered or unexported fields
}

Specifies the settings for a multivariate split activity in a journey. This type of activity sends participants down one of as many as five paths (including a default Else path) in a journey, based on conditions that you specify.

To create multivariate split activities that send participants down different paths based on push notification events (such as Open or Received events), your mobile app has to specify the User ID and Endpoint ID values. For more information, see Integrating Amazon Pinpoint with your application (https://docs.aws.amazon.com/pinpoint/latest/developerguide/integrate.html) in the Amazon Pinpoint Developer Guide.

func (MultiConditionalSplitActivity) GoString added in v1.25.25 

func (s MultiConditionalSplitActivity) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MultiConditionalSplitActivity) SetBranches added in v1.25.25 

func (s *MultiConditionalSplitActivity) SetBranches(v []*MultiConditionalBranch) *MultiConditionalSplitActivity

SetBranches sets the Branches field's value.

func (*MultiConditionalSplitActivity) SetDefaultActivity added in v1.25.25 

func (s *MultiConditionalSplitActivity) SetDefaultActivity(v string) *MultiConditionalSplitActivity

SetDefaultActivity sets the DefaultActivity field's value.

func (*MultiConditionalSplitActivity) SetEvaluationWaitTime added in v1.25.25 

func (s *MultiConditionalSplitActivity) SetEvaluationWaitTime(v *WaitTime) *MultiConditionalSplitActivity

SetEvaluationWaitTime sets the EvaluationWaitTime field's value.

func (MultiConditionalSplitActivity) String added in v1.25.25 

func (s MultiConditionalSplitActivity) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MultiConditionalSplitActivity) Validate added in v1.25.25 

func (s *MultiConditionalSplitActivity) Validate() error

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

type NotFoundException added in v1.28.0 

type NotFoundException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`

	RequestID_ *string `locationName:"RequestID" type:"string"`
	// contains filtered or unexported fields
}

Provides information about an API request or response.

func (*NotFoundException) Code added in v1.28.0 

func (s *NotFoundException) Code() string

Code returns the exception type name.

func (*NotFoundException) Error added in v1.28.0 

func (s *NotFoundException) Error() string

func (NotFoundException) GoString added in v1.28.0 

func (s NotFoundException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*NotFoundException) Message added in v1.28.0 

func (s *NotFoundException) Message() string

Message returns the exception's message.

func (*NotFoundException) OrigErr added in v1.28.0 

func (s *NotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*NotFoundException) RequestID added in v1.28.0 

func (s *NotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*NotFoundException) StatusCode added in v1.28.0 

func (s *NotFoundException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (NotFoundException) String added in v1.28.0 

func (s NotFoundException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type NumberValidateRequest added in v1.14.20 

type NumberValidateRequest struct {

	// The two-character code, in ISO 3166-1 alpha-2 format, for the country or
	// region where the phone number was originally registered.
	IsoCountryCode *string `type:"string"`

	// The phone number to retrieve information about. The phone number that you
	// provide should include a valid numeric country code. Otherwise, the operation
	// might result in an error.
	PhoneNumber *string `type:"string"`
	// contains filtered or unexported fields
}

Specifies a phone number to validate and retrieve information about.

func (NumberValidateRequest) GoString added in v1.14.20 

func (s NumberValidateRequest) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*NumberValidateRequest) SetIsoCountryCode added in v1.14.20 

func (s *NumberValidateRequest) SetIsoCountryCode(v string) *NumberValidateRequest

SetIsoCountryCode sets the IsoCountryCode field's value.

func (*NumberValidateRequest) SetPhoneNumber added in v1.14.20 

func (s *NumberValidateRequest) SetPhoneNumber(v string) *NumberValidateRequest

SetPhoneNumber sets the PhoneNumber field's value.

func (NumberValidateRequest) String added in v1.14.20 

func (s NumberValidateRequest) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type NumberValidateResponse added in v1.14.20 

type NumberValidateResponse struct {

	// The carrier or service provider that the phone number is currently registered
	// with. In some countries and regions, this value may be the carrier or service
	// provider that the phone number was originally registered with.
	Carrier *string `type:"string"`

	// The name of the city where the phone number was originally registered.
	City *string `type:"string"`

	// The cleansed phone number, in E.164 format, for the location where the phone
	// number was originally registered.
	CleansedPhoneNumberE164 *string `type:"string"`

	// The cleansed phone number, in the format for the location where the phone
	// number was originally registered.
	CleansedPhoneNumberNational *string `type:"string"`

	// The name of the country or region where the phone number was originally registered.
	Country *string `type:"string"`

	// The two-character code, in ISO 3166-1 alpha-2 format, for the country or
	// region where the phone number was originally registered.
	CountryCodeIso2 *string `type:"string"`

	// The numeric code for the country or region where the phone number was originally
	// registered.
	CountryCodeNumeric *string `type:"string"`

	// The name of the county where the phone number was originally registered.
	County *string `type:"string"`

	// The two-character code, in ISO 3166-1 alpha-2 format, that was sent in the
	// request body.
	OriginalCountryCodeIso2 *string `type:"string"`

	// The phone number that was sent in the request body.
	OriginalPhoneNumber *string `type:"string"`

	// The description of the phone type. Valid values are: MOBILE, LANDLINE, VOIP,
	// INVALID, PREPAID, and OTHER.
	PhoneType *string `type:"string"`

	// The phone type, represented by an integer. Valid values are: 0 (mobile),
	// 1 (landline), 2 (VoIP), 3 (invalid), 4 (other), and 5 (prepaid).
	PhoneTypeCode *int64 `type:"integer"`

	// The time zone for the location where the phone number was originally registered.
	Timezone *string `type:"string"`

	// The postal or ZIP code for the location where the phone number was originally
	// registered.
	ZipCode *string `type:"string"`
	// contains filtered or unexported fields
}

Provides information about a phone number.

func (NumberValidateResponse) GoString added in v1.14.20 

func (s NumberValidateResponse) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*NumberValidateResponse) SetCarrier added in v1.14.20 

func (s *NumberValidateResponse) SetCarrier(v string) *NumberValidateResponse

SetCarrier sets the Carrier field's value.

func (*NumberValidateResponse) SetCity added in v1.14.20 

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

SetCity sets the City field's value.

func (*NumberValidateResponse) SetCleansedPhoneNumberE164 added in v1.14.20 

func (s *NumberValidateResponse) SetCleansedPhoneNumberE164(v string) *NumberValidateResponse

SetCleansedPhoneNumberE164 sets the CleansedPhoneNumberE164 field's value.

func (*NumberValidateResponse) SetCleansedPhoneNumberNational added in v1.14.20 

func (s *NumberValidateResponse) SetCleansedPhoneNumberNational(v string) *NumberValidateResponse

SetCleansedPhoneNumberNational sets the CleansedPhoneNumberNational field's value.

func (*NumberValidateResponse) SetCountry added in v1.14.20 

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

SetCountry sets the Country field's value.

func (*NumberValidateResponse) SetCountryCodeIso2 added in v1.14.20 

func (s *NumberValidateResponse) SetCountryCodeIso2(v string) *NumberValidateResponse

SetCountryCodeIso2 sets the CountryCodeIso2 field's value.

func (*NumberValidateResponse) SetCountryCodeNumeric added in v1.14.20 

func (s *NumberValidateResponse) SetCountryCodeNumeric(v string) *NumberValidateResponse

SetCountryCodeNumeric sets the CountryCodeNumeric field's value.

func (*NumberValidateResponse) SetCounty added in v1.14.20 

func (s *NumberValidateResponse) SetCounty(v string) *NumberValidateResponse

SetCounty sets the County field's value.

func (*NumberValidateResponse) SetOriginalCountryCodeIso2 added in v1.14.20 

func (s *NumberValidateResponse) SetOriginalCountryCodeIso2(v string) *NumberValidateResponse

SetOriginalCountryCodeIso2 sets the OriginalCountryCodeIso2 field's value.

func (*NumberValidateResponse) SetOriginalPhoneNumber added in v1.14.20 

func (s *NumberValidateResponse) SetOriginalPhoneNumber(v string) *NumberValidateResponse

SetOriginalPhoneNumber sets the OriginalPhoneNumber field's value.

func (*NumberValidateResponse) SetPhoneType added in v1.14.20 

func (s *NumberValidateResponse) SetPhoneType(v string) *NumberValidateResponse

SetPhoneType sets the PhoneType field's value.

func (*NumberValidateResponse) SetPhoneTypeCode added in v1.14.20 

func (s *NumberValidateResponse) SetPhoneTypeCode(v int64) *NumberValidateResponse

SetPhoneTypeCode sets the PhoneTypeCode field's value.

func (*NumberValidateResponse) SetTimezone added in v1.14.20 

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

SetTimezone sets the Timezone field's value.

func (*NumberValidateResponse) SetZipCode added in v1.14.20 

func (s *NumberValidateResponse) SetZipCode(v string) *NumberValidateResponse

SetZipCode sets the ZipCode field's value.

func (NumberValidateResponse) String added in v1.14.20 

func (s NumberValidateResponse) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type OverrideButtonConfiguration added in v1.40.44 

type OverrideButtonConfiguration struct {

	// Action triggered by the button.
	//
	// ButtonAction is a required field
	ButtonAction *string `type:"string" required:"true" enum:"ButtonAction"`

	// Button destination.
	Link *string `type:"string"`
	// contains filtered or unexported fields
}

Override button configuration.

func (OverrideButtonConfiguration) GoString added in v1.40.44 

func (s OverrideButtonConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*OverrideButtonConfiguration) SetButtonAction added in v1.40.44 

func (s *OverrideButtonConfiguration) SetButtonAction(v string) *OverrideButtonConfiguration

SetButtonAction sets the ButtonAction field's value. 

func (s *OverrideButtonConfiguration) SetLink(v string) *OverrideButtonConfiguration

SetLink sets the Link field's value.

func (OverrideButtonConfiguration) String added in v1.40.44 

func (s OverrideButtonConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*OverrideButtonConfiguration) Validate added in v1.40.44 

func (s *OverrideButtonConfiguration) Validate() error

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

type PayloadTooLargeException added in v1.29.17 

type PayloadTooLargeException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`

	RequestID_ *string `locationName:"RequestID" type:"string"`
	// contains filtered or unexported fields
}

Provides information about an API request or response.

func (*PayloadTooLargeException) Code added in v1.29.17 

func (s *PayloadTooLargeException) Code() string

Code returns the exception type name.

func (*PayloadTooLargeException) Error added in v1.29.17 

func (s *PayloadTooLargeException) Error() string

func (PayloadTooLargeException) GoString added in v1.29.17 

func (s PayloadTooLargeException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PayloadTooLargeException) Message added in v1.29.17 

func (s *PayloadTooLargeException) Message() string

Message returns the exception's message.

func (*PayloadTooLargeException) OrigErr added in v1.29.17 

func (s *PayloadTooLargeException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*PayloadTooLargeException) RequestID added in v1.29.17 

func (s *PayloadTooLargeException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*PayloadTooLargeException) StatusCode added in v1.29.17 

func (s *PayloadTooLargeException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (PayloadTooLargeException) String added in v1.29.17 

func (s PayloadTooLargeException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PhoneNumberValidateInput added in v1.14.20 

type PhoneNumberValidateInput struct {

	// Specifies a phone number to validate and retrieve information about.
	//
	// NumberValidateRequest is a required field
	NumberValidateRequest *NumberValidateRequest `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (PhoneNumberValidateInput) GoString added in v1.14.20 

func (s PhoneNumberValidateInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PhoneNumberValidateInput) SetNumberValidateRequest added in v1.14.20 

func (s *PhoneNumberValidateInput) SetNumberValidateRequest(v *NumberValidateRequest) *PhoneNumberValidateInput

SetNumberValidateRequest sets the NumberValidateRequest field's value.

func (PhoneNumberValidateInput) String added in v1.14.20 

func (s PhoneNumberValidateInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PhoneNumberValidateInput) Validate added in v1.14.20 

func (s *PhoneNumberValidateInput) Validate() error

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

type PhoneNumberValidateOutput added in v1.14.20 

type PhoneNumberValidateOutput struct {

	// Provides information about a phone number.
	//
	// NumberValidateResponse is a required field
	NumberValidateResponse *NumberValidateResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (PhoneNumberValidateOutput) GoString added in v1.14.20 

func (s PhoneNumberValidateOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PhoneNumberValidateOutput) SetNumberValidateResponse added in v1.14.20 

func (s *PhoneNumberValidateOutput) SetNumberValidateResponse(v *NumberValidateResponse) *PhoneNumberValidateOutput

SetNumberValidateResponse sets the NumberValidateResponse field's value.

func (PhoneNumberValidateOutput) String added in v1.14.20 

func (s PhoneNumberValidateOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type 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: 

mySession := session.Must(session.NewSession())

// 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 an application.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint's API operation CreateApp for usage and error information.

Returned Error Types:

  • BadRequestException Provides information about an API request or response.

  • InternalServerErrorException Provides information about an API request or response.

  • PayloadTooLargeException Provides information about an API request or response.

  • ForbiddenException Provides information about an API request or response.

  • NotFoundException Provides information about an API request or response.

  • MethodNotAllowedException Provides information about an API request or response.

  • TooManyRequestsException Provides information about an API request or response.

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 successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateApp for more information on using the CreateApp API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CreateAppRequest method.
req, resp := client.CreateAppRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*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 a new campaign for an application or updates the settings of an existing campaign for an application.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint's API operation CreateCampaign for usage and error information.

Returned Error Types:

  • BadRequestException Provides information about an API request or response.

  • InternalServerErrorException Provides information about an API request or response.

  • PayloadTooLargeException Provides information about an API request or response.

  • ForbiddenException Provides information about an API request or response.

  • NotFoundException Provides information about an API request or response.

  • MethodNotAllowedException Provides information about an API request or response.

  • TooManyRequestsException Provides information about an API request or response.

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 successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateCampaign for more information on using the CreateCampaign API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CreateCampaignRequest method.
req, resp := client.CreateCampaignRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*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) CreateEmailTemplate added in v1.25.7 

func (c *Pinpoint) CreateEmailTemplate(input *CreateEmailTemplateInput) (*CreateEmailTemplateOutput, error)

CreateEmailTemplate API operation for Amazon Pinpoint.

Creates a message template for messages that are sent through the 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 CreateEmailTemplate for usage and error information.

Returned Error Types:

  • MethodNotAllowedException Provides information about an API request or response.

  • TooManyRequestsException Provides information about an API request or response.

  • BadRequestException Provides information about an API request or response.

  • InternalServerErrorException Provides information about an API request or response.

  • ForbiddenException Provides information about an API request or response.

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

func (*Pinpoint) CreateEmailTemplateRequest added in v1.25.7 

func (c *Pinpoint) CreateEmailTemplateRequest(input *CreateEmailTemplateInput) (req *request.Request, output *CreateEmailTemplateOutput)

CreateEmailTemplateRequest generates a "aws/request.Request" representing the client's request for the CreateEmailTemplate operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateEmailTemplate for more information on using the CreateEmailTemplate 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 CreateEmailTemplateRequest method.
req, resp := client.CreateEmailTemplateRequest(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/CreateEmailTemplate

func (*Pinpoint) CreateEmailTemplateWithContext added in v1.25.7 

func (c *Pinpoint) CreateEmailTemplateWithContext(ctx aws.Context, input *CreateEmailTemplateInput, opts ...request.Option) (*CreateEmailTemplateOutput, error)

CreateEmailTemplateWithContext is the same as CreateEmailTemplate with the addition of the ability to pass a context and additional request options.

See CreateEmailTemplate 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 for an application.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint's API operation CreateExportJob for usage and error information.

Returned Error Types:

  • BadRequestException Provides information about an API request or response.

  • InternalServerErrorException Provides information about an API request or response.

  • PayloadTooLargeException Provides information about an API request or response.

  • ForbiddenException Provides information about an API request or response.

  • NotFoundException Provides information about an API request or response.

  • MethodNotAllowedException Provides information about an API request or response.

  • TooManyRequestsException Provides information about an API request or response.

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 successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateExportJob for more information on using the CreateExportJob API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CreateExportJobRequest method.
req, resp := client.CreateExportJobRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*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 an import job for an application.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint's API operation CreateImportJob for usage and error information.

Returned Error Types:

  • BadRequestException Provides information about an API request or response.

  • InternalServerErrorException Provides information about an API request or response.

  • PayloadTooLargeException Provides information about an API request or response.

  • ForbiddenException Provides information about an API request or response.

  • NotFoundException Provides information about an API request or response.

  • MethodNotAllowedException Provides information about an API request or response.

  • TooManyRequestsException Provides information about an API request or response.

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 successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateImportJob for more information on using the CreateImportJob API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CreateImportJobRequest method.
req, resp := client.CreateImportJobRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*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) CreateInAppTemplate added in v1.40.44 

func (c *Pinpoint) CreateInAppTemplate(input *CreateInAppTemplateInput) (*CreateInAppTemplateOutput, error)

CreateInAppTemplate API operation for Amazon Pinpoint.

Creates a new message template for messages using the in-app message 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 CreateInAppTemplate for usage and error information.

Returned Error Types:

  • MethodNotAllowedException Provides information about an API request or response.

  • TooManyRequestsException Provides information about an API request or response.

  • BadRequestException Provides information about an API request or response.

  • InternalServerErrorException Provides information about an API request or response.

  • ForbiddenException Provides information about an API request or response.

See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/CreateInAppTemplate

func (*Pinpoint) CreateInAppTemplateRequest added in v1.40.44 

func (c *Pinpoint) CreateInAppTemplateRequest(input *CreateInAppTemplateInput) (req *request.Request, output *CreateInAppTemplateOutput)

CreateInAppTemplateRequest generates a "aws/request.Request" representing the client's request for the CreateInAppTemplate operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateInAppTemplate for more information on using the CreateInAppTemplate 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 CreateInAppTemplateRequest method.
req, resp := client.CreateInAppTemplateRequest(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/CreateInAppTemplate

func (*Pinpoint) CreateInAppTemplateWithContext added in v1.40.44 

func (c *Pinpoint) CreateInAppTemplateWithContext(ctx aws.Context, input *CreateInAppTemplateInput, opts ...request.Option) (*CreateInAppTemplateOutput, error)

CreateInAppTemplateWithContext is the same as CreateInAppTemplate with the addition of the ability to pass a context and additional request options.

See CreateInAppTemplate 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) CreateJourney added in v1.25.25 

func (c *Pinpoint) CreateJourney(input *CreateJourneyInput) (*CreateJourneyOutput, error)

CreateJourney API operation for Amazon Pinpoint.

Creates a journey for an application.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint's API operation CreateJourney for usage and error information.

Returned Error Types:

  • BadRequestException Provides information about an API request or response.

  • InternalServerErrorException Provides information about an API request or response.

  • PayloadTooLargeException Provides information about an API request or response.

  • ForbiddenException Provides information about an API request or response.

  • NotFoundException Provides information about an API request or response.

  • MethodNotAllowedException Provides information about an API request or response.

  • TooManyRequestsException Provides information about an API request or response.

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

func (*Pinpoint) CreateJourneyRequest added in v1.25.25 

func (c *Pinpoint) CreateJourneyRequest(input *CreateJourneyInput) (req *request.Request, output *CreateJourneyOutput)

CreateJourneyRequest generates a "aws/request.Request" representing the client's request for the CreateJourney operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateJourney for more information on using the CreateJourney 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 CreateJourneyRequest method.
req, resp := client.CreateJourneyRequest(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/CreateJourney

func (*Pinpoint) CreateJourneyWithContext added in v1.25.25 

func (c *Pinpoint) CreateJourneyWithContext(ctx aws.Context, input *CreateJourneyInput, opts ...request.Option) (*CreateJourneyOutput, error)

CreateJourneyWithContext is the same as CreateJourney with the addition of the ability to pass a context and additional request options.

See CreateJourney 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) CreatePushTemplate added in v1.25.7 

func (c *Pinpoint) CreatePushTemplate(input *CreatePushTemplateInput) (*CreatePushTemplateOutput, error)

CreatePushTemplate API operation for Amazon Pinpoint.

Creates a message template for messages that are sent through a push notification 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 CreatePushTemplate for usage and error information.

Returned Error Types:

  • MethodNotAllowedException Provides information about an API request or response.

  • TooManyRequestsException Provides information about an API request or response.

  • BadRequestException Provides information about an API request or response.

  • InternalServerErrorException Provides information about an API request or response.

  • ForbiddenException Provides information about an API request or response.

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

func (*Pinpoint) CreatePushTemplateRequest added in v1.25.7 

func (c *Pinpoint) CreatePushTemplateRequest(input *CreatePushTemplateInput) (req *request.Request, output *CreatePushTemplateOutput)

CreatePushTemplateRequest generates a "aws/request.Request" representing the client's request for the CreatePushTemplate operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreatePushTemplate for more information on using the CreatePushTemplate 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 CreatePushTemplateRequest method.
req, resp := client.CreatePushTemplateRequest(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/CreatePushTemplate

func (*Pinpoint) CreatePushTemplateWithContext added in v1.25.7 

func (c *Pinpoint) CreatePushTemplateWithContext(ctx aws.Context, input *CreatePushTemplateInput, opts ...request.Option) (*CreatePushTemplateOutput, error)

CreatePushTemplateWithContext is the same as CreatePushTemplate with the addition of the ability to pass a context and additional request options.

See CreatePushTemplate 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) CreateRecommenderConfiguration added in v1.29.17 

func (c *Pinpoint) CreateRecommenderConfiguration(input *CreateRecommenderConfigurationInput) (*CreateRecommenderConfigurationOutput, error)

CreateRecommenderConfiguration API operation for Amazon Pinpoint.

Creates an Amazon Pinpoint configuration for a recommender model.

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 CreateRecommenderConfiguration for usage and error information.

Returned Error Types:

  • BadRequestException Provides information about an API request or response.

  • InternalServerErrorException Provides information about an API request or response.

  • PayloadTooLargeException Provides information about an API request or response.

  • ForbiddenException Provides information about an API request or response.

  • NotFoundException Provides information about an API request or response.

  • MethodNotAllowedException Provides information about an API request or response.

  • TooManyRequestsException Provides information about an API request or response.

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

func (*Pinpoint) CreateRecommenderConfigurationRequest added in v1.29.17 

func (c *Pinpoint) CreateRecommenderConfigurationRequest(input *CreateRecommenderConfigurationInput) (req *request.Request, output *CreateRecommenderConfigurationOutput)

CreateRecommenderConfigurationRequest generates a "aws/request.Request" representing the client's request for the CreateRecommenderConfiguration operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateRecommenderConfiguration for more information on using the CreateRecommenderConfiguration 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 CreateRecommenderConfigurationRequest method.
req, resp := client.CreateRecommenderConfigurationRequest(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/CreateRecommenderConfiguration

func (*Pinpoint) CreateRecommenderConfigurationWithContext added in v1.29.17 

func (c *Pinpoint) CreateRecommenderConfigurationWithContext(ctx aws.Context, input *CreateRecommenderConfigurationInput, opts ...request.Option) (*CreateRecommenderConfigurationOutput, error)

CreateRecommenderConfigurationWithContext is the same as CreateRecommenderConfiguration with the addition of the ability to pass a context and additional request options.

See CreateRecommenderConfiguration 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.

Creates a new segment for an application or updates the configuration, dimension, and other settings for an existing segment that's associated with an application.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint's API operation CreateSegment for usage and error information.

Returned Error Types:

  • BadRequestException Provides information about an API request or response.

  • InternalServerErrorException Provides information about an API request or response.

  • PayloadTooLargeException Provides information about an API request or response.

  • ForbiddenException Provides information about an API request or response.

  • NotFoundException Provides information about an API request or response.

  • MethodNotAllowedException Provides information about an API request or response.

  • TooManyRequestsException Provides information about an API request or response.

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 successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateSegment for more information on using the CreateSegment API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CreateSegmentRequest method.
req, resp := client.CreateSegmentRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*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) CreateSmsTemplate added in v1.25.7 

func (c *Pinpoint) CreateSmsTemplate(input *CreateSmsTemplateInput) (*CreateSmsTemplateOutput, error)

CreateSmsTemplate API operation for Amazon Pinpoint.

Creates a message template for messages that are sent through the 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 CreateSmsTemplate for usage and error information.

Returned Error Types:

  • MethodNotAllowedException Provides information about an API request or response.

  • TooManyRequestsException Provides information about an API request or response.

  • BadRequestException Provides information about an API request or response.

  • InternalServerErrorException Provides information about an API request or response.

  • ForbiddenException Provides information about an API request or response.

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

func (*Pinpoint) CreateSmsTemplateRequest added in v1.25.7 

func (c *Pinpoint) CreateSmsTemplateRequest(input *CreateSmsTemplateInput) (req *request.Request, output *CreateSmsTemplateOutput)

CreateSmsTemplateRequest generates a "aws/request.Request" representing the client's request for the CreateSmsTemplate operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateSmsTemplate for more information on using the CreateSmsTemplate 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 CreateSmsTemplateRequest method.
req, resp := client.CreateSmsTemplateRequest(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/CreateSmsTemplate

func (*Pinpoint) CreateSmsTemplateWithContext added in v1.25.7 

func (c *Pinpoint) CreateSmsTemplateWithContext(ctx aws.Context, input *CreateSmsTemplateInput, opts ...request.Option) (*CreateSmsTemplateOutput, error)

CreateSmsTemplateWithContext is the same as CreateSmsTemplate with the addition of the ability to pass a context and additional request options.

See CreateSmsTemplate 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) CreateVoiceTemplate added in v1.25.37 

func (c *Pinpoint) CreateVoiceTemplate(input *CreateVoiceTemplateInput) (*CreateVoiceTemplateOutput, error)

CreateVoiceTemplate API operation for Amazon Pinpoint.

Creates a message template for messages that are sent through the voice 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 CreateVoiceTemplate for usage and error information.

Returned Error Types:

  • MethodNotAllowedException Provides information about an API request or response.

  • TooManyRequestsException Provides information about an API request or response.

  • BadRequestException Provides information about an API request or response.

  • InternalServerErrorException Provides information about an API request or response.

  • ForbiddenException Provides information about an API request or response.

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

func (*Pinpoint) CreateVoiceTemplateRequest added in v1.25.37 

func (c *Pinpoint) CreateVoiceTemplateRequest(input *CreateVoiceTemplateInput) (req *request.Request, output *CreateVoiceTemplateOutput)

CreateVoiceTemplateRequest generates a "aws/request.Request" representing the client's request for the CreateVoiceTemplate operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateVoiceTemplate for more information on using the CreateVoiceTemplate 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 CreateVoiceTemplateRequest method.
req, resp := client.CreateVoiceTemplateRequest(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/CreateVoiceTemplate

func (*Pinpoint) CreateVoiceTemplateWithContext added in v1.25.37 

func (c *Pinpoint) CreateVoiceTemplateWithContext(ctx aws.Context, input *CreateVoiceTemplateInput, opts ...request.Option) (*CreateVoiceTemplateOutput, error)

CreateVoiceTemplateWithContext is the same as CreateVoiceTemplate with the addition of the ability to pass a context and additional request options.

See CreateVoiceTemplate 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.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint's API operation DeleteAdmChannel for usage and error information.

Returned Error Types:

  • BadRequestException Provides information about an API request or response.

  • InternalServerErrorException Provides information about an API request or response.

  • PayloadTooLargeException Provides information about an API request or response.

  • ForbiddenException Provides information about an API request or response.

  • NotFoundException Provides information about an API request or response.

  • MethodNotAllowedException Provides information about an API request or response.

  • TooManyRequestsException Provides information about an API request or response.

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 successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteAdmChannel for more information on using the DeleteAdmChannel API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteAdmChannelRequest method.
req, resp := client.DeleteAdmChannelRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*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.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint's API operation DeleteApnsChannel for usage and error information.

Returned Error Types:

  • BadRequestException Provides information about an API request or response.

  • InternalServerErrorException Provides information about an API request or response.

  • PayloadTooLargeException Provides information about an API request or response.

  • ForbiddenException Provides information about an API request or response.

  • NotFoundException Provides information about an API request or response.

  • MethodNotAllowedException Provides information about an API request or response.

  • TooManyRequestsException Provides information about an API request or response.

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 successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteApnsChannel for more information on using the DeleteApnsChannel API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteApnsChannelRequest method.
req, resp := client.DeleteApnsChannelRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*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.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint's API operation DeleteApnsSandboxChannel for usage and error information.

Returned Error Types:

  • BadRequestException Provides information about an API request or response.

  • InternalServerErrorException Provides information about an API request or response.

  • PayloadTooLargeException Provides information about an API request or response.

  • ForbiddenException Provides information about an API request or response.

  • NotFoundException Provides information about an API request or response.

  • MethodNotAllowedException Provides information about an API request or response.

  • TooManyRequestsException Provides information about an API request or response.

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 successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteApnsSandboxChannel for more information on using the DeleteApnsSandboxChannel API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteApnsSandboxChannelRequest method.
req, resp := client.DeleteApnsSandboxChannelRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*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.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint's API operation DeleteApnsVoipChannel for usage and error information.

Returned Error Types:

  • BadRequestException Provides information about an API request or response.

  • InternalServerErrorException Provides information about an API request or response.

  • PayloadTooLargeException Provides information about an API request or response.

  • ForbiddenException Provides information about an API request or response.

  • NotFoundException Provides information about an API request or response.

  • MethodNotAllowedException Provides information about an API request or response.

  • TooManyRequestsException Provides information about an API request or response.

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 successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteApnsVoipChannel for more information on using the DeleteApnsVoipChannel API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteApnsVoipChannelRequest method.
req, resp := client.DeleteApnsVoipChannelRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*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.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint's API operation DeleteApnsVoipSandboxChannel for usage and error information.

Returned Error Types:

  • BadRequestException Provides information about an API request or response.

  • InternalServerErrorException Provides information about an API request or response.

  • PayloadTooLargeException Provides information about an API request or response.

  • ForbiddenException Provides information about an API request or response.

  • NotFoundException Provides information about an API request or response.

  • MethodNotAllowedException Provides information about an API request or response.

  • TooManyRequestsException Provides information about an API request or response.

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 successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteApnsVoipSandboxChannel for more information on using the DeleteApnsVoipSandboxChannel API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteApnsVoipSandboxChannelRequest method.
req, resp := client.DeleteApnsVoipSandboxChannelRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*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 application.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint's API operation DeleteApp for usage and error information.

Returned Error Types:

  • BadRequestException Provides information about an API request or response.

  • InternalServerErrorException Provides information about an API request or response.

  • PayloadTooLargeException Provides information about an API request or response.

  • ForbiddenException Provides information about an API request or response.

  • NotFoundException Provides information about an API request or response.

  • MethodNotAllowedException Provides information about an API request or response.

  • TooManyRequestsException Provides information about an API request or response.

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 successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteApp for more information on using the DeleteApp API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteAppRequest method.
req, resp := client.DeleteAppRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*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.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint's API operation DeleteBaiduChannel for usage and error information.

Returned Error Types:

  • BadRequestException Provides information about an API request or response.

  • InternalServerErrorException Provides information about an API request or response.

  • PayloadTooLargeException Provides information about an API request or response.

  • ForbiddenException Provides information about an API request or response.

  • NotFoundException Provides information about an API request or response.

  • MethodNotAllowedException Provides information about an API request or response.

  • TooManyRequestsException Provides information about an API request or response.

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 successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteBaiduChannel for more information on using the DeleteBaiduChannel API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteBaiduChannelRequest method.
req, resp := client.DeleteBaiduChannelRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*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 from an application.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint's API operation DeleteCampaign for usage and error information.

Returned Error Types:

  • BadRequestException Provides information about an API request or response.

  • InternalServerErrorException Provides information about an API request or response.

  • PayloadTooLargeException Provides information about an API request or response.

  • ForbiddenException Provides information about an API request or response.

  • NotFoundException Provides information about an API request or response.

  • MethodNotAllowedException Provides information about an API request or response.

  • TooManyRequestsException Provides information about an API request or response.

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 successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteCampaign for more information on using the DeleteCampaign API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteCampaignRequest method.
req, resp := client.DeleteCampaignRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*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.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint's API operation DeleteEmailChannel for usage and error information.

Returned Error Types:

  • BadRequestException Provides information about an API request or response.

  • InternalServerErrorException Provides information about an API request or response.

  • PayloadTooLargeException Provides information about an API request or response.

  • ForbiddenException Provides information about an API request or response.

  • NotFoundException Provides information about an API request or response.

  • MethodNotAllowedException Provides information about an API request or response.

  • TooManyRequestsException Provides information about an API request or response.

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 successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteEmailChannel for more information on using the DeleteEmailChannel API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteEmailChannelRequest method.
req, resp := client.DeleteEmailChannelRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*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) DeleteEmailTemplate added in v1.25.7 

func (c *Pinpoint) DeleteEmailTemplate(input *DeleteEmailTemplateInput) (*DeleteEmailTemplateOutput, error)

DeleteEmailTemplate API operation for Amazon Pinpoint.

Deletes a message template for messages that were sent through the 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 DeleteEmailTemplate for usage and error information.

Returned Error Types:

  • BadRequestException Provides information about an API request or response.

  • InternalServerErrorException Provides information about an API request or response.

  • PayloadTooLargeException Provides information about an API request or response.

  • ForbiddenException Provides information about an API request or response.

  • NotFoundException Provides information about an API request or response.

  • MethodNotAllowedException Provides information about an API request or response.

  • TooManyRequestsException Provides information about an API request or response.

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

func (*Pinpoint) DeleteEmailTemplateRequest added in v1.25.7 

func (c *Pinpoint) DeleteEmailTemplateRequest(input *DeleteEmailTemplateInput) (req *request.Request, output *DeleteEmailTemplateOutput)

DeleteEmailTemplateRequest generates a "aws/request.Request" representing the client's request for the DeleteEmailTemplate operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteEmailTemplate for more information on using the DeleteEmailTemplate 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 DeleteEmailTemplateRequest method.
req, resp := client.DeleteEmailTemplateRequest(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/DeleteEmailTemplate

func (*Pinpoint) DeleteEmailTemplateWithContext added in v1.25.7 

func (c *Pinpoint) DeleteEmailTemplateWithContext(ctx aws.Context, input *DeleteEmailTemplateInput, opts ...request.Option) (*DeleteEmailTemplateOutput, error)

DeleteEmailTemplateWithContext is the same as DeleteEmailTemplate with the addition of the ability to pass a context and additional request options.

See DeleteEmailTemplate 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 from an application.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint's API operation DeleteEndpoint for usage and error information.

Returned Error Types:

  • BadRequestException Provides information about an API request or response.

  • InternalServerErrorException Provides information about an API request or response.

  • PayloadTooLargeException Provides information about an API request or response.

  • ForbiddenException Provides information about an API request or response.

  • NotFoundException Provides information about an API request or response.

  • MethodNotAllowedException Provides information about an API request or response.

  • TooManyRequestsException Provides information about an API request or response.

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 successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteEndpoint for more information on using the DeleteEndpoint API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteEndpointRequest method.
req, resp := client.DeleteEndpointRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*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 application.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint's API operation DeleteEventStream for usage and error information.

Returned Error Types:

  • BadRequestException Provides information about an API request or response.

  • InternalServerErrorException Provides information about an API request or response.

  • PayloadTooLargeException Provides information about an API request or response.

  • ForbiddenException Provides information about an API request or response.

  • NotFoundException Provides information about an API request or response.

  • MethodNotAllowedException Provides information about an API request or response.

  • TooManyRequestsException Provides information about an API request or response.

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 successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteEventStream for more information on using the DeleteEventStream API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteEventStreamRequest method.
req, resp := client.DeleteEventStreamRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*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.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint's API operation DeleteGcmChannel for usage and error information.

Returned Error Types:

  • BadRequestException Provides information about an API request or response.

  • InternalServerErrorException Provides information about an API request or response.

  • PayloadTooLargeException Provides information about an API request or response.

  • ForbiddenException Provides information about an API request or response.

  • NotFoundException Provides information about an API request or response.

  • MethodNotAllowedException Provides information about an API request or response.

  • TooManyRequestsException Provides information about an API request or response.

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 successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteGcmChannel for more information on using the DeleteGcmChannel API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteGcmChannelRequest method.
req, resp := client.DeleteGcmChannelRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*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) DeleteInAppTemplate added in v1.40.44 

func (c *Pinpoint) DeleteInAppTemplate(input *DeleteInAppTemplateInput) (*DeleteInAppTemplateOutput, error)

DeleteInAppTemplate API operation for Amazon Pinpoint.

Deletes a message template for messages sent using the in-app message 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 DeleteInAppTemplate for usage and error information.

Returned Error Types:

  • BadRequestException Provides information about an API request or response.

  • InternalServerErrorException Provides information about an API request or response.

  • PayloadTooLargeException Provides information about an API request or response.

  • ForbiddenException Provides information about an API request or response.

  • NotFoundException Provides information about an API request or response.

  • MethodNotAllowedException Provides information about an API request or response.

  • TooManyRequestsException Provides information about an API request or response.

See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/DeleteInAppTemplate

func (*Pinpoint) DeleteInAppTemplateRequest added in v1.40.44 

func (c *Pinpoint) DeleteInAppTemplateRequest(input *DeleteInAppTemplateInput) (req *request.Request, output *DeleteInAppTemplateOutput)

DeleteInAppTemplateRequest generates a "aws/request.Request" representing the client's request for the DeleteInAppTemplate operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteInAppTemplate for more information on using the DeleteInAppTemplate 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 DeleteInAppTemplateRequest method.
req, resp := client.DeleteInAppTemplateRequest(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/DeleteInAppTemplate

func (*Pinpoint) DeleteInAppTemplateWithContext added in v1.40.44 

func (c *Pinpoint) DeleteInAppTemplateWithContext(ctx aws.Context, input *DeleteInAppTemplateInput, opts ...request.Option) (*DeleteInAppTemplateOutput, error)

DeleteInAppTemplateWithContext is the same as DeleteInAppTemplate with the addition of the ability to pass a context and additional request options.

See DeleteInAppTemplate 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) DeleteJourney added in v1.25.25 

func (c *Pinpoint) DeleteJourney(input *DeleteJourneyInput) (*DeleteJourneyOutput, error)

DeleteJourney API operation for Amazon Pinpoint.

Deletes a journey from an application.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint's API operation DeleteJourney for usage and error information.

Returned Error Types:

  • BadRequestException Provides information about an API request or response.

  • InternalServerErrorException Provides information about an API request or response.

  • PayloadTooLargeException Provides information about an API request or response.

  • ForbiddenException Provides information about an API request or response.

  • NotFoundException Provides information about an API request or response.

  • MethodNotAllowedException Provides information about an API request or response.

  • TooManyRequestsException Provides information about an API request or response.

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

func (*Pinpoint) DeleteJourneyRequest added in v1.25.25 

func (c *Pinpoint) DeleteJourneyRequest(input *DeleteJourneyInput) (req *request.Request, output *DeleteJourneyOutput)

DeleteJourneyRequest generates a "aws/request.Request" representing the client's request for the DeleteJourney operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteJourney for more information on using the DeleteJourney 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 DeleteJourneyRequest method.
req, resp := client.DeleteJourneyRequest(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/DeleteJourney

func (*Pinpoint) DeleteJourneyWithContext added in v1.25.25 

func (c *Pinpoint) DeleteJourneyWithContext(ctx aws.Context, input *DeleteJourneyInput, opts ...request.Option) (*DeleteJourneyOutput, error)

DeleteJourneyWithContext is the same as DeleteJourney with the addition of the ability to pass a context and additional request options.

See DeleteJourney 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) DeletePushTemplate added in v1.25.7 

func (c *Pinpoint) DeletePushTemplate(input *DeletePushTemplateInput) (*DeletePushTemplateOutput, error)

DeletePushTemplate API operation for Amazon Pinpoint.

Deletes a message template for messages that were sent through a push notification 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 DeletePushTemplate for usage and error information.

Returned Error Types:

  • BadRequestException Provides information about an API request or response.

  • InternalServerErrorException Provides information about an API request or response.

  • PayloadTooLargeException Provides information about an API request or response.

  • ForbiddenException Provides information about an API request or response.

  • NotFoundException Provides information about an API request or response.

  • MethodNotAllowedException Provides information about an API request or response.

  • TooManyRequestsException Provides information about an API request or response.

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

func (*Pinpoint) DeletePushTemplateRequest added in v1.25.7 

func (c *Pinpoint) DeletePushTemplateRequest(input *DeletePushTemplateInput) (req *request.Request, output *DeletePushTemplateOutput)

DeletePushTemplateRequest generates a "aws/request.Request" representing the client's request for the DeletePushTemplate operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeletePushTemplate for more information on using the DeletePushTemplate 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 DeletePushTemplateRequest method.
req, resp := client.DeletePushTemplateRequest(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/DeletePushTemplate

func (*Pinpoint) DeletePushTemplateWithContext added in v1.25.7 

func (c *Pinpoint) DeletePushTemplateWithContext(ctx aws.Context, input *DeletePushTemplateInput, opts ...request.Option) (*DeletePushTemplateOutput, error)

DeletePushTemplateWithContext is the same as DeletePushTemplate with the addition of the ability to pass a context and additional request options.

See DeletePushTemplate 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) DeleteRecommenderConfiguration added in v1.29.17 

func (c *Pinpoint) DeleteRecommenderConfiguration(input *DeleteRecommenderConfigurationInput) (*DeleteRecommenderConfigurationOutput, error)

DeleteRecommenderConfiguration API operation for Amazon Pinpoint.

Deletes an Amazon Pinpoint configuration for a recommender model.

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 DeleteRecommenderConfiguration for usage and error information.

Returned Error Types:

  • BadRequestException Provides information about an API request or response.

  • InternalServerErrorException Provides information about an API request or response.

  • PayloadTooLargeException Provides information about an API request or response.

  • ForbiddenException Provides information about an API request or response.

  • NotFoundException Provides information about an API request or response.

  • MethodNotAllowedException Provides information about an API request or response.

  • TooManyRequestsException Provides information about an API request or response.

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

func (*Pinpoint) DeleteRecommenderConfigurationRequest added in v1.29.17 

func (c *Pinpoint) DeleteRecommenderConfigurationRequest(input *DeleteRecommenderConfigurationInput) (req *request.Request, output *DeleteRecommenderConfigurationOutput)

DeleteRecommenderConfigurationRequest generates a "aws/request.Request" representing the client's request for the DeleteRecommenderConfiguration operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteRecommenderConfiguration for more information on using the DeleteRecommenderConfiguration 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 DeleteRecommenderConfigurationRequest method.
req, resp := client.DeleteRecommenderConfigurationRequest(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/DeleteRecommenderConfiguration

func (*Pinpoint) DeleteRecommenderConfigurationWithContext added in v1.29.17 

func (c *Pinpoint) DeleteRecommenderConfigurationWithContext(ctx aws.Context, input *DeleteRecommenderConfigurationInput, opts ...request.Option) (*DeleteRecommenderConfigurationOutput, error)

DeleteRecommenderConfigurationWithContext is the same as DeleteRecommenderConfiguration with the addition of the ability to pass a context and additional request options.

See DeleteRecommenderConfiguration 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 from an application.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint's API operation DeleteSegment for usage and error information.

Returned Error Types:

  • BadRequestException Provides information about an API request or response.

  • InternalServerErrorException Provides information about an API request or response.

  • PayloadTooLargeException Provides information about an API request or response.

  • ForbiddenException Provides information about an API request or response.

  • NotFoundException Provides information about an API request or response.

  • MethodNotAllowedException Provides information about an API request or response.

  • TooManyRequestsException Provides information about an API request or response.

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 successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteSegment for more information on using the DeleteSegment API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteSegmentRequest method.
req, resp := client.DeleteSegmentRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*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.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint's API operation DeleteSmsChannel for usage and error information.

Returned Error Types:

  • BadRequestException Provides information about an API request or response.

  • InternalServerErrorException Provides information about an API request or response.

  • PayloadTooLargeException Provides information about an API request or response.

  • ForbiddenException Provides information about an API request or response.

  • NotFoundException Provides information about an API request or response.

  • MethodNotAllowedException Provides information about an API request or response.

  • TooManyRequestsException Provides information about an API request or response.

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 successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteSmsChannel for more information on using the DeleteSmsChannel API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteSmsChannelRequest method.
req, resp := client.DeleteSmsChannelRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*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) DeleteSmsTemplate added in v1.25.7 

func (c *Pinpoint) DeleteSmsTemplate(input *DeleteSmsTemplateInput) (*DeleteSmsTemplateOutput, error)

DeleteSmsTemplate API operation for Amazon Pinpoint.

Deletes a message template for messages that were sent through the 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 DeleteSmsTemplate for usage and error information.

Returned Error Types:

  • BadRequestException Provides information about an API request or response.

  • InternalServerErrorException Provides information about an API request or response.

  • PayloadTooLargeException Provides information about an API request or response.

  • ForbiddenException Provides information about an API request or response.

  • NotFoundException Provides information about an API request or response.

  • MethodNotAllowedException Provides information about an API request or response.

  • TooManyRequestsException Provides information about an API request or response.

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

func (*Pinpoint) DeleteSmsTemplateRequest added in v1.25.7 

func (c *Pinpoint) DeleteSmsTemplateRequest(input *DeleteSmsTemplateInput) (req *request.Request, output *DeleteSmsTemplateOutput)

DeleteSmsTemplateRequest generates a "aws/request.Request" representing the client's request for the DeleteSmsTemplate operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteSmsTemplate for more information on using the DeleteSmsTemplate 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 DeleteSmsTemplateRequest method.
req, resp := client.DeleteSmsTemplateRequest(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/DeleteSmsTemplate

func (*Pinpoint) DeleteSmsTemplateWithContext added in v1.25.7 

func (c *Pinpoint) DeleteSmsTemplateWithContext(ctx aws.Context, input *DeleteSmsTemplateInput, opts ...request.Option) (*DeleteSmsTemplateOutput, error)

DeleteSmsTemplateWithContext is the same as DeleteSmsTemplate with the addition of the ability to pass a context and additional request options.

See DeleteSmsTemplate 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) DeleteUserEndpoints added in v1.14.20 

func (c *Pinpoint) DeleteUserEndpoints(input *DeleteUserEndpointsInput) (*DeleteUserEndpointsOutput, error)

DeleteUserEndpoints API operation for Amazon Pinpoint.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint's API operation DeleteUserEndpoints for usage and error information.

Returned Error Types:

  • BadRequestException Provides information about an API request or response.

  • InternalServerErrorException Provides information about an API request or response.

  • PayloadTooLargeException Provides information about an API request or response.

  • ForbiddenException Provides information about an API request or response.

  • NotFoundException Provides information about an API request or response.

  • MethodNotAllowedException Provides information about an API request or response.

  • TooManyRequestsException Provides information about an API request or response.

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

func (*Pinpoint) DeleteUserEndpointsRequest added in v1.14.20 

func (c *Pinpoint) DeleteUserEndpointsRequest(input *DeleteUserEndpointsInput) (req *request.Request, output *DeleteUserEndpointsOutput)

DeleteUserEndpointsRequest generates a "aws/request.Request" representing the client's request for the DeleteUserEndpoints operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteUserEndpoints for more information on using the DeleteUserEndpoints API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteUserEndpointsRequest method.
req, resp := client.DeleteUserEndpointsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*Pinpoint) DeleteUserEndpointsWithContext added in v1.14.20 

func (c *Pinpoint) DeleteUserEndpointsWithContext(ctx aws.Context, input *DeleteUserEndpointsInput, opts ...request.Option) (*DeleteUserEndpointsOutput, error)

DeleteUserEndpointsWithContext is the same as DeleteUserEndpoints with the addition of the ability to pass a context and additional request options.

See DeleteUserEndpoints for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Pinpoint) DeleteVoiceChannel added in v1.15.77 

func (c *Pinpoint) DeleteVoiceChannel(input *DeleteVoiceChannelInput) (*DeleteVoiceChannelOutput, error)

DeleteVoiceChannel API operation for Amazon Pinpoint.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint's API operation DeleteVoiceChannel for usage and error information.

Returned Error Types:

  • BadRequestException Provides information about an API request or response.

  • InternalServerErrorException Provides information about an API request or response.

  • PayloadTooLargeException Provides information about an API request or response.

  • ForbiddenException Provides information about an API request or response.

  • NotFoundException Provides information about an API request or response.

  • MethodNotAllowedException Provides information about an API request or response.

  • TooManyRequestsException Provides information about an API request or response.

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

func (*Pinpoint) DeleteVoiceChannelRequest added in v1.15.77 

func (c *Pinpoint) DeleteVoiceChannelRequest(input *DeleteVoiceChannelInput) (req *request.Request, output *DeleteVoiceChannelOutput)

DeleteVoiceChannelRequest generates a "aws/request.Request" representing the client's request for the DeleteVoiceChannel operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteVoiceChannel for more information on using the DeleteVoiceChannel API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteVoiceChannelRequest method.
req, resp := client.DeleteVoiceChannelRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*Pinpoint) DeleteVoiceChannelWithContext added in v1.15.77 

func (c *Pinpoint) DeleteVoiceChannelWithContext(ctx aws.Context, input *DeleteVoiceChannelInput, opts ...request.Option) (*DeleteVoiceChannelOutput, error)

DeleteVoiceChannelWithContext is the same as DeleteVoiceChannel with the addition of the ability to pass a context and additional request options.

See DeleteVoiceChannel for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Pinpoint) DeleteVoiceTemplate added in v1.25.37 

func (c *Pinpoint) DeleteVoiceTemplate(input *DeleteVoiceTemplateInput) (*DeleteVoiceTemplateOutput, error)

DeleteVoiceTemplate API operation for Amazon Pinpoint.

Deletes a message template for messages that were sent through the voice 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 DeleteVoiceTemplate for usage and error information.

Returned Error Types:

  • BadRequestException Provides information about an API request or response.

  • InternalServerErrorException Provides information about an API request or response.

  • PayloadTooLargeException Provides information about an API request or response.

  • ForbiddenException Provides information about an API request or response.

  • NotFoundException Provides information about an API request or response.

  • MethodNotAllowedException Provides information about an API request or response.

  • TooManyRequestsException Provides information about an API request or response.

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

func (*Pinpoint) DeleteVoiceTemplateRequest added in v1.25.37 

func (c *Pinpoint) DeleteVoiceTemplateRequest(input *DeleteVoiceTemplateInput) (req *request.Request, output *DeleteVoiceTemplateOutput)

DeleteVoiceTemplateRequest generates a "aws/request.Request" representing the client's request for the DeleteVoiceTemplate operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteVoiceTemplate for more information on using the DeleteVoiceTemplate 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 DeleteVoiceTemplateRequest method.
req, resp := client.DeleteVoiceTemplateRequest(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/DeleteVoiceTemplate

func (*Pinpoint) DeleteVoiceTemplateWithContext added in v1.25.37 

func (c *Pinpoint) DeleteVoiceTemplateWithContext(ctx aws.Context, input *DeleteVoiceTemplateInput, opts ...request.Option) (*DeleteVoiceTemplateOutput, error)

DeleteVoiceTemplateWithContext is the same as DeleteVoiceTemplate with the addition of the ability to pass a context and additional request options.

See DeleteVoiceTemplate 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.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint's API operation GetAdmChannel for usage and error information.

Returned Error Types:

  • BadRequestException Provides information about an API request or response.

  • InternalServerErrorException Provides information about an API request or response.

  • PayloadTooLargeException Provides information about an API request or response.

  • ForbiddenException Provides information about an API request or response.

  • NotFoundException Provides information about an API request or response.

  • MethodNotAllowedException Provides information about an API request or response.

  • TooManyRequestsException Provides information about an API request or response.

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 successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetAdmChannel for more information on using the GetAdmChannel API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetAdmChannelRequest method.
req, resp := client.GetAdmChannelRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*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.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint's API operation GetApnsChannel for usage and error information.

Returned Error Types:

  • BadRequestException Provides information about an API request or response.

  • InternalServerErrorException Provides information about an API request or response.

  • PayloadTooLargeException Provides information about an API request or response.

  • ForbiddenException Provides information about an API request or response.

  • NotFoundException Provides information about an API request or response.

  • MethodNotAllowedException Provides information about an API request or response.

  • TooManyRequestsException Provides information about an API request or response.

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 successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetApnsChannel for more information on using the GetApnsChannel API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetApnsChannelRequest method.
req, resp := client.GetApnsChannelRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*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.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint's API operation GetApnsSandboxChannel for usage and error information.

Returned Error Types:

  • BadRequestException Provides information about an API request or response.

  • InternalServerErrorException Provides information about an API request or response.

  • PayloadTooLargeException Provides information about an API request or response.

  • ForbiddenException Provides information about an API request or response.

  • NotFoundException Provides information about an API request or response.

  • MethodNotAllowedException Provides information about an API request or response.

  • TooManyRequestsException Provides information about an API request or response.

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 successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetApnsSandboxChannel for more information on using the GetApnsSandboxChannel API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetApnsSandboxChannelRequest method.
req, resp := client.GetApnsSandboxChannelRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*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.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint's API operation GetApnsVoipChannel for usage and error information.

Returned Error Types:

  • BadRequestException Provides information about an API request or response.

  • InternalServerErrorException Provides information about an API request or response.

  • PayloadTooLargeException Provides information about an API request or response.

  • ForbiddenException Provides information about an API request or response.

  • NotFoundException Provides information about an API request or response.

  • MethodNotAllowedException Provides information about an API request or response.

  • TooManyRequestsException Provides information about an API request or response.

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 successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetApnsVoipChannel for more information on using the GetApnsVoipChannel API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetApnsVoipChannelRequest method.
req, resp := client.GetApnsVoipChannelRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*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.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint's API operation GetApnsVoipSandboxChannel for usage and error information.

Returned Error Types:

  • BadRequestException Provides information about an API request or response.

  • InternalServerErrorException Provides information about an API request or response.

  • PayloadTooLargeException Provides information about an API request or response.

  • ForbiddenException Provides information about an API request or response.

  • NotFoundException Provides information about an API request or response.

  • MethodNotAllowedException Provides information about an API request or response.

  • TooManyRequestsException Provides information about an API request or response.

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 successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetApnsVoipSandboxChannel for more information on using the GetApnsVoipSandboxChannel API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetApnsVoipSandboxChannelRequest method.
req, resp := client.GetApnsVoipSandboxChannelRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*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.

Retrieves information about an application.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint's API operation GetApp for usage and error information.

Returned Error Types:

  • BadRequestException Provides information about an API request or response.

  • InternalServerErrorException Provides information about an API request or response.

  • PayloadTooLargeException Provides information about an API request or response.

  • ForbiddenException Provides information about an API request or response.

  • NotFoundException Provides information about an API request or response.

  • MethodNotAllowedException Provides information about an API request or response.

  • TooManyRequestsException Provides information about an API request or response.

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 successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetApp for more information on using the GetApp API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetAppRequest method.
req, resp := client.GetAppRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*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) GetApplicationDateRangeKpi added in v1.21.4 

func (c *Pinpoint) GetApplicationDateRangeKpi(input *GetApplicationDateRangeKpiInput) (*GetApplicationDateRangeKpiOutput, error)

GetApplicationDateRangeKpi API operation for Amazon Pinpoint.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint's API operation GetApplicationDateRangeKpi for usage and error information.

Returned Error Types:

  • BadRequestException Provides information about an API request or response.

  • InternalServerErrorException Provides information about an API request or response.

  • PayloadTooLargeException Provides information about an API request or response.

  • ForbiddenException Provides information about an API request or response.

  • NotFoundException Provides information about an API request or response.

  • MethodNotAllowedException Provides information about an API request or response.

  • TooManyRequestsException Provides information about an API request or response.

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

func (*Pinpoint) GetApplicationDateRangeKpiRequest added in v1.21.4 

func (c *Pinpoint) GetApplicationDateRangeKpiRequest(input *GetApplicationDateRangeKpiInput) (req *request.Request, output *GetApplicationDateRangeKpiOutput)

GetApplicationDateRangeKpiRequest generates a "aws/request.Request" representing the client's request for the GetApplicationDateRangeKpi operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetApplicationDateRangeKpi for more information on using the GetApplicationDateRangeKpi 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 GetApplicationDateRangeKpiRequest method.
req, resp := client.GetApplicationDateRangeKpiRequest(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/GetApplicationDateRangeKpi

func (*Pinpoint) GetApplicationDateRangeKpiWithContext added in v1.21.4 

func (c *Pinpoint) GetApplicationDateRangeKpiWithContext(ctx aws.Context, input *GetApplicationDateRangeKpiInput, opts ...request.Option) (*GetApplicationDateRangeKpiOutput, error)

GetApplicationDateRangeKpiWithContext is the same as GetApplicationDateRangeKpi with the addition of the ability to pass a context and additional request options.

See GetApplicationDateRangeKpi 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.

Retrieves information about the settings for an application.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint's API operation GetApplicationSettings for usage and error information.

Returned Error Types:

  • BadRequestException Provides information about an API request or response.

  • InternalServerErrorException Provides information about an API request or response.

  • PayloadTooLargeException Provides information about an API request or response.

  • ForbiddenException Provides information about an API request or response.

  • NotFoundException Provides information about an API request or response.

  • MethodNotAllowedException Provides information about an API request or response.

  • TooManyRequestsException Provides information about an API request or response.

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 successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetApplicationSettings for more information on using the GetApplicationSettings API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetApplicationSettingsRequest method.
req, resp := client.GetApplicationSettingsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*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.

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

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 Types:

  • BadRequestException Provides information about an API request or response.

  • InternalServerErrorException Provides information about an API request or response.

  • PayloadTooLargeException Provides information about an API request or response.

  • ForbiddenException Provides information about an API request or response.

  • NotFoundException Provides information about an API request or response.

  • MethodNotAllowedException Provides information about an API request or response.

  • TooManyRequestsException Provides information about an API request or response.

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 successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See 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.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint's API operation GetBaiduChannel for usage and error information.

Returned Error Types:

  • BadRequestException Provides information about an API request or response.

  • InternalServerErrorException Provides information about an API request or response.

  • PayloadTooLargeException Provides information about an API request or response.

  • ForbiddenException Provides information about an API request or response.

  • NotFoundException Provides information about an API request or response.

  • MethodNotAllowedException Provides information about an API request or response.

  • TooManyRequestsException Provides information about an API request or response.

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 successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See 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.

Retrieves information about the status, configuration, and other settings for 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 Types:

  • BadRequestException Provides information about an API request or response.

  • InternalServerErrorException Provides information about an API request or response.

  • PayloadTooLargeException Provides information about an API request or response.

  • ForbiddenException Provides information about an API request or response.

  • NotFoundException Provides information about an API request or response.

  • MethodNotAllowedException Provides information about an API request or response.

  • TooManyRequestsException Provides information about an API request or response.

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.

Retrieves information about all the activities for 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 Types:

  • BadRequestException Provides information about an API request or response.

  • InternalServerErrorException Provides information about an API request or response.

  • PayloadTooLargeException Provides information about an API request or response.

  • ForbiddenException Provides information about an API request or response.

  • NotFoundException Provides information about an API request or response.

  • MethodNotAllowedException Provides information about an API request or response.

  • TooManyRequestsException Provides information about an API request or response.

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 successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See 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) GetCampaignDateRangeKpi added in v1.21.4 

func (c *Pinpoint) GetCampaignDateRangeKpi(input *GetCampaignDateRangeKpiInput) (*GetCampaignDateRangeKpiOutput, error)

GetCampaignDateRangeKpi API operation for Amazon Pinpoint.

Retrieves (queries) pre-aggregated data for a standard metric that applies to 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 GetCampaignDateRangeKpi for usage and error information.

Returned Error Types:

  • BadRequestException Provides information about an API request or response.

  • InternalServerErrorException Provides information about an API request or response.

  • PayloadTooLargeException Provides information about an API request or response.

  • ForbiddenException Provides information about an API request or response.

  • NotFoundException Provides information about an API request or response.

  • MethodNotAllowedException Provides information about an API request or response.

  • TooManyRequestsException Provides information about an API request or response.

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

func (*Pinpoint) GetCampaignDateRangeKpiRequest added in v1.21.4 

func (c *Pinpoint) GetCampaignDateRangeKpiRequest(input *GetCampaignDateRangeKpiInput) (req *request.Request, output *GetCampaignDateRangeKpiOutput)

GetCampaignDateRangeKpiRequest generates a "aws/request.Request" representing the client's request for the GetCampaignDateRangeKpi operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetCampaignDateRangeKpi for more information on using the GetCampaignDateRangeKpi 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 GetCampaignDateRangeKpiRequest method.
req, resp := client.GetCampaignDateRangeKpiRequest(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/GetCampaignDateRangeKpi

func (*Pinpoint) GetCampaignDateRangeKpiWithContext added in v1.21.4 

func (c *Pinpoint) GetCampaignDateRangeKpiWithContext(ctx aws.Context, input *GetCampaignDateRangeKpiInput, opts ...request.Option) (*GetCampaignDateRangeKpiOutput, error)

GetCampaignDateRangeKpiWithContext is the same as GetCampaignDateRangeKpi with the addition of the ability to pass a context and additional request options.

See GetCampaignDateRangeKpi 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 successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See 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.

Retrieves information about the status, configuration, and other settings for 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 Types:

  • BadRequestException Provides information about an API request or response.

  • InternalServerErrorException Provides information about an API request or response.

  • PayloadTooLargeException Provides information about an API request or response.

  • ForbiddenException Provides information about an API request or response.

  • NotFoundException Provides information about an API request or response.

  • MethodNotAllowedException Provides information about an API request or response.

  • TooManyRequestsException Provides information about an API request or response.

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 successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See 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.

Retrieves information about the status, configuration, and other settings for all versions 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 GetCampaignVersions for usage and error information.

Returned Error Types:

  • BadRequestException Provides information about an API request or response.

  • InternalServerErrorException Provides information about an API request or response.

  • PayloadTooLargeException Provides information about an API request or response.

  • ForbiddenException Provides information about an API request or response.

  • NotFoundException Provides information about an API request or response.

  • MethodNotAllowedException Provides information about an API request or response.

  • TooManyRequestsException Provides information about an API request or response.

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 successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See 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.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint's API operation GetCampaigns for usage and error information.

Returned Error Types:

  • BadRequestException Provides information about an API request or response.

  • InternalServerErrorException Provides information about an API request or response.

  • PayloadTooLargeException Provides information about an API request or response.

  • ForbiddenException Provides information about an API request or response.

  • NotFoundException Provides information about an API request or response.

  • MethodNotAllowedException Provides information about an API request or response.

  • TooManyRequestsException Provides information about an API request or response.

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 successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See 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) GetChannels added in v1.14.20 

func (c *Pinpoint) GetChannels(input *GetChannelsInput) (*GetChannelsOutput, error)

GetChannels API operation for Amazon Pinpoint.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint's API operation GetChannels for usage and error information.

Returned Error Types:

  • BadRequestException Provides information about an API request or response.

  • InternalServerErrorException Provides information about an API request or response.

  • PayloadTooLargeException Provides information about an API request or response.

  • ForbiddenException Provides information about an API request or response.

  • NotFoundException Provides information about an API request or response.

  • MethodNotAllowedException Provides information about an API request or response.

  • TooManyRequestsException Provides information about an API request or response.

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

func (*Pinpoint) GetChannelsRequest added in v1.14.20 

func (c *Pinpoint) GetChannelsRequest(input *GetChannelsInput) (req *request.Request, output *GetChannelsOutput)

GetChannelsRequest generates a "aws/request.Request" representing the client's request for the GetChannels operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetChannels for more information on using the GetChannels 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 GetChannelsRequest method.
req, resp := client.GetChannelsRequest(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/GetChannels

func (*Pinpoint) GetChannelsWithContext added in v1.14.20 

func (c *Pinpoint) GetChannelsWithContext(ctx aws.Context, input *GetChannelsInput, opts ...request.Option) (*GetChannelsOutput, error)

GetChannelsWithContext is the same as GetChannels with the addition of the ability to pass a context and additional request options.

See GetChannels 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.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint's API operation GetEmailChannel for usage and error information.

Returned Error Types:

  • BadRequestException Provides information about an API request or response.

  • InternalServerErrorException Provides information about an API request or response.

  • PayloadTooLargeException Provides information about an API request or response.

  • ForbiddenException Provides information about an API request or response.

  • NotFoundException Provides information about an API request or response.

  • MethodNotAllowedException Provides information about an API request or response.

  • TooManyRequestsException Provides information about an API request or response.

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 successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See 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) GetEmailTemplate added in v1.25.7 

func (c *Pinpoint) GetEmailTemplate(input *GetEmailTemplateInput) (*GetEmailTemplateOutput, error)

GetEmailTemplate API operation for Amazon Pinpoint.

Retrieves the content and settings of a message template for messages that are sent through the 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 GetEmailTemplate for usage and error information.

Returned Error Types:

  • BadRequestException Provides information about an API request or response.

  • InternalServerErrorException Provides information about an API request or response.

  • PayloadTooLargeException Provides information about an API request or response.

  • ForbiddenException Provides information about an API request or response.

  • NotFoundException Provides information about an API request or response.

  • MethodNotAllowedException Provides information about an API request or response.

  • TooManyRequestsException Provides information about an API request or response.

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

func (*Pinpoint) GetEmailTemplateRequest added in v1.25.7 

func (c *Pinpoint) GetEmailTemplateRequest(input *GetEmailTemplateInput) (req *request.Request, output *GetEmailTemplateOutput)

GetEmailTemplateRequest generates a "aws/request.Request" representing the client's request for the GetEmailTemplate operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetEmailTemplate for more information on using the GetEmailTemplate 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 GetEmailTemplateRequest method.
req, resp := client.GetEmailTemplateRequest(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/GetEmailTemplate

func (*Pinpoint) GetEmailTemplateWithContext added in v1.25.7 

func (c *Pinpoint) GetEmailTemplateWithContext(ctx aws.Context, input *GetEmailTemplateInput, opts ...request.Option) (*GetEmailTemplateOutput, error)

GetEmailTemplateWithContext is the same as GetEmailTemplate with the addition of the ability to pass a context and additional request options.

See GetEmailTemplate 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.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint's API operation GetEndpoint for usage and error information.

Returned Error Types:

  • BadRequestException Provides information about an API request or response.

  • InternalServerErrorException Provides information about an API request or response.

  • PayloadTooLargeException Provides information about an API request or response.

  • ForbiddenException Provides information about an API request or response.

  • NotFoundException Provides information about an API request or response.

  • MethodNotAllowedException Provides information about an API request or response.

  • TooManyRequestsException Provides information about an API request or response.

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 successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See 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.

Retrieves information about the event stream settings for an application.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint's API operation GetEventStream for usage and error information.

Returned Error Types:

  • BadRequestException Provides information about an API request or response.

  • InternalServerErrorException Provides information about an API request or response.

  • PayloadTooLargeException Provides information about an API request or response.

  • ForbiddenException Provides information about an API request or response.

  • NotFoundException Provides information about an API request or response.

  • MethodNotAllowedException Provides information about an API request or response.

  • TooManyRequestsException Provides information about an API request or response.

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 successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See 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.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint's API operation GetExportJob for usage and error information.

Returned Error Types:

  • BadRequestException Provides information about an API request or response.

  • InternalServerErrorException Provides information about an API request or response.

  • PayloadTooLargeException Provides information about an API request or response.

  • ForbiddenException Provides information about an API request or response.

  • NotFoundException Provides information about an API request or response.

  • MethodNotAllowedException Provides information about an API request or response.

  • TooManyRequestsException Provides information about an API request or response.

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 successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See 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.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint's API operation GetExportJobs for usage and error information.

Returned Error Types:

  • BadRequestException Provides information about an API request or response.

  • InternalServerErrorException Provides information about an API request or response.

  • PayloadTooLargeException Provides information about an API request or response.

  • ForbiddenException Provides information about an API request or response.

  • NotFoundException Provides information about an API request or response.

  • MethodNotAllowedException Provides information about an API request or response.

  • TooManyRequestsException Provides information about an API request or response.

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 successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See 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.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint's API operation GetGcmChannel for usage and error information.

Returned Error Types:

  • BadRequestException Provides information about an API request or response.

  • InternalServerErrorException Provides information about an API request or response.

  • PayloadTooLargeException Provides information about an API request or response.

  • ForbiddenException Provides information about an API request or response.

  • NotFoundException Provides information about an API request or response.

  • MethodNotAllowedException Provides information about an API request or response.

  • TooManyRequestsException Provides information about an API request or response.

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 successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See 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.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint's API operation GetImportJob for usage and error information.

Returned Error Types:

  • BadRequestException Provides information about an API request or response.

  • InternalServerErrorException Provides information about an API request or response.

  • PayloadTooLargeException Provides information about an API request or response.

  • ForbiddenException Provides information about an API request or response.

  • NotFoundException Provides information about an API request or response.

  • MethodNotAllowedException Provides information about an API request or response.

  • TooManyRequestsException Provides information about an API request or response.

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 successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See 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.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint's API operation GetImportJobs for usage and error information.

Returned Error Types:

  • BadRequestException Provides information about an API request or response.

  • InternalServerErrorException Provides information about an API request or response.

  • PayloadTooLargeException Provides information about an API request or response.

  • ForbiddenException Provides information about an API request or response.

  • NotFoundException Provides information about an API request or response.

  • MethodNotAllowedException Provides information about an API request or response.

  • TooManyRequestsException Provides information about an API request or response.

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 successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See 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) GetInAppMessages added in v1.40.44 

func (c *Pinpoint) GetInAppMessages(input *GetInAppMessagesInput) (*GetInAppMessagesOutput, error)

GetInAppMessages API operation for Amazon Pinpoint.

Retrieves the in-app messages targeted for the provided endpoint ID.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint's API operation GetInAppMessages for usage and error information.

Returned Error Types:

  • BadRequestException Provides information about an API request or response.

  • InternalServerErrorException Provides information about an API request or response.

  • PayloadTooLargeException Provides information about an API request or response.

  • ForbiddenException Provides information about an API request or response.

  • NotFoundException Provides information about an API request or response.

  • MethodNotAllowedException Provides information about an API request or response.

  • TooManyRequestsException Provides information about an API request or response.

See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetInAppMessages

func (*Pinpoint) GetInAppMessagesRequest added in v1.40.44 

func (c *Pinpoint) GetInAppMessagesRequest(input *GetInAppMessagesInput) (req *request.Request, output *GetInAppMessagesOutput)

GetInAppMessagesRequest generates a "aws/request.Request" representing the client's request for the GetInAppMessages operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetInAppMessages for more information on using the GetInAppMessages 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 GetInAppMessagesRequest method.
req, resp := client.GetInAppMessagesRequest(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/GetInAppMessages

func (*Pinpoint) GetInAppMessagesWithContext added in v1.40.44 

func (c *Pinpoint) GetInAppMessagesWithContext(ctx aws.Context, input *GetInAppMessagesInput, opts ...request.Option) (*GetInAppMessagesOutput, error)

GetInAppMessagesWithContext is the same as GetInAppMessages with the addition of the ability to pass a context and additional request options.

See GetInAppMessages 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) GetInAppTemplate added in v1.40.44 

func (c *Pinpoint) GetInAppTemplate(input *GetInAppTemplateInput) (*GetInAppTemplateOutput, error)

GetInAppTemplate API operation for Amazon Pinpoint.

Retrieves the content and settings of a message template for messages sent through the in-app 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 GetInAppTemplate for usage and error information.

Returned Error Types:

  • BadRequestException Provides information about an API request or response.

  • InternalServerErrorException Provides information about an API request or response.

  • PayloadTooLargeException Provides information about an API request or response.

  • ForbiddenException Provides information about an API request or response.

  • NotFoundException Provides information about an API request or response.

  • MethodNotAllowedException Provides information about an API request or response.

  • TooManyRequestsException Provides information about an API request or response.

See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetInAppTemplate

func (*Pinpoint) GetInAppTemplateRequest added in v1.40.44 

func (c *Pinpoint) GetInAppTemplateRequest(input *GetInAppTemplateInput) (req *request.Request, output *GetInAppTemplateOutput)

GetInAppTemplateRequest generates a "aws/request.Request" representing the client's request for the GetInAppTemplate operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetInAppTemplate for more information on using the GetInAppTemplate 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 GetInAppTemplateRequest method.
req, resp := client.GetInAppTemplateRequest(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/GetInAppTemplate

func (*Pinpoint) GetInAppTemplateWithContext added in v1.40.44 

func (c *Pinpoint) GetInAppTemplateWithContext(ctx aws.Context, input *GetInAppTemplateInput, opts ...request.Option) (*GetInAppTemplateOutput, error)

GetInAppTemplateWithContext is the same as GetInAppTemplate with the addition of the ability to pass a context and additional request options.

See GetInAppTemplate 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) GetJourney added in v1.25.25 

func (c *Pinpoint) GetJourney(input *GetJourneyInput) (*GetJourneyOutput, error)

GetJourney API operation for Amazon Pinpoint.

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

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 GetJourney for usage and error information.

Returned Error Types:

  • BadRequestException Provides information about an API request or response.

  • InternalServerErrorException Provides information about an API request or response.

  • PayloadTooLargeException Provides information about an API request or response.

  • ForbiddenException Provides information about an API request or response.

  • NotFoundException Provides information about an API request or response.

  • MethodNotAllowedException Provides information about an API request or response.

  • TooManyRequestsException Provides information about an API request or response.

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

func (*Pinpoint) GetJourneyDateRangeKpi added in v1.25.25 

func (c *Pinpoint) GetJourneyDateRangeKpi(input *GetJourneyDateRangeKpiInput) (*GetJourneyDateRangeKpiOutput, error)

GetJourneyDateRangeKpi API operation for Amazon Pinpoint.

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

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 GetJourneyDateRangeKpi for usage and error information.

Returned Error Types:

  • BadRequestException Provides information about an API request or response.

  • InternalServerErrorException Provides information about an API request or response.

  • PayloadTooLargeException Provides information about an API request or response.

  • ForbiddenException Provides information about an API request or response.

  • NotFoundException Provides information about an API request or response.

  • MethodNotAllowedException Provides information about an API request or response.

  • TooManyRequestsException Provides information about an API request or response.

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

func (*Pinpoint) GetJourneyDateRangeKpiRequest added in v1.25.25 

func (c *Pinpoint) GetJourneyDateRangeKpiRequest(input *GetJourneyDateRangeKpiInput) (req *request.Request, output *GetJourneyDateRangeKpiOutput)

GetJourneyDateRangeKpiRequest generates a "aws/request.Request" representing the client's request for the GetJourneyDateRangeKpi operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetJourneyDateRangeKpi for more information on using the GetJourneyDateRangeKpi 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 GetJourneyDateRangeKpiRequest method.
req, resp := client.GetJourneyDateRangeKpiRequest(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/GetJourneyDateRangeKpi

func (*Pinpoint) GetJourneyDateRangeKpiWithContext added in v1.25.25 

func (c *Pinpoint) GetJourneyDateRangeKpiWithContext(ctx aws.Context, input *GetJourneyDateRangeKpiInput, opts ...request.Option) (*GetJourneyDateRangeKpiOutput, error)

GetJourneyDateRangeKpiWithContext is the same as GetJourneyDateRangeKpi with the addition of the ability to pass a context and additional request options.

See GetJourneyDateRangeKpi 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) GetJourneyExecutionActivityMetrics added in v1.25.25 

func (c *Pinpoint) GetJourneyExecutionActivityMetrics(input *GetJourneyExecutionActivityMetricsInput) (*GetJourneyExecutionActivityMetricsOutput, error)

GetJourneyExecutionActivityMetrics API operation for Amazon Pinpoint.

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

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 GetJourneyExecutionActivityMetrics for usage and error information.

Returned Error Types:

  • BadRequestException Provides information about an API request or response.

  • InternalServerErrorException Provides information about an API request or response.

  • PayloadTooLargeException Provides information about an API request or response.

  • ForbiddenException Provides information about an API request or response.

  • NotFoundException Provides information about an API request or response.

  • MethodNotAllowedException Provides information about an API request or response.

  • TooManyRequestsException Provides information about an API request or response.

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

func (*Pinpoint) GetJourneyExecutionActivityMetricsRequest added in v1.25.25 

func (c *Pinpoint) GetJourneyExecutionActivityMetricsRequest(input *GetJourneyExecutionActivityMetricsInput) (req *request.Request, output *GetJourneyExecutionActivityMetricsOutput)

GetJourneyExecutionActivityMetricsRequest generates a "aws/request.Request" representing the client's request for the GetJourneyExecutionActivityMetrics operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetJourneyExecutionActivityMetrics for more information on using the GetJourneyExecutionActivityMetrics 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 GetJourneyExecutionActivityMetricsRequest method.
req, resp := client.GetJourneyExecutionActivityMetricsRequest(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/GetJourneyExecutionActivityMetrics

func (*Pinpoint) GetJourneyExecutionActivityMetricsWithContext added in v1.25.25 

func (c *Pinpoint) GetJourneyExecutionActivityMetricsWithContext(ctx aws.Context, input *GetJourneyExecutionActivityMetricsInput, opts ...request.Option) (*GetJourneyExecutionActivityMetricsOutput, error)

GetJourneyExecutionActivityMetricsWithContext is the same as GetJourneyExecutionActivityMetrics with the addition of the ability to pass a context and additional request options.

See GetJourneyExecutionActivityMetrics 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) GetJourneyExecutionMetrics added in v1.25.25 

func (c *Pinpoint) GetJourneyExecutionMetrics(input *GetJourneyExecutionMetricsInput) (*GetJourneyExecutionMetricsOutput, error)

GetJourneyExecutionMetrics API operation for Amazon Pinpoint.

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

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 GetJourneyExecutionMetrics for usage and error information.

Returned Error Types:

  • BadRequestException Provides information about an API request or response.

  • InternalServerErrorException Provides information about an API request or response.

  • PayloadTooLargeException Provides information about an API request or response.

  • ForbiddenException Provides information about an API request or response.

  • NotFoundException Provides information about an API request or response.

  • MethodNotAllowedException Provides information about an API request or response.

  • TooManyRequestsException Provides information about an API request or response.

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

func (*Pinpoint) GetJourneyExecutionMetricsRequest added in v1.25.25 

func (c *Pinpoint) GetJourneyExecutionMetricsRequest(input *GetJourneyExecutionMetricsInput) (req *request.Request, output *GetJourneyExecutionMetricsOutput)

GetJourneyExecutionMetricsRequest generates a "aws/request.Request" representing the client's request for the GetJourneyExecutionMetrics operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetJourneyExecutionMetrics for more information on using the GetJourneyExecutionMetrics 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 GetJourneyExecutionMetricsRequest method.
req, resp := client.GetJourneyExecutionMetricsRequest(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/GetJourneyExecutionMetrics

func (*Pinpoint) GetJourneyExecutionMetricsWithContext added in v1.25.25 

func (c *Pinpoint) GetJourneyExecutionMetricsWithContext(ctx aws.Context, input *GetJourneyExecutionMetricsInput, opts ...request.Option) (*GetJourneyExecutionMetricsOutput, error)

GetJourneyExecutionMetricsWithContext is the same as GetJourneyExecutionMetrics with the addition of the ability to pass a context and additional request options.

See GetJourneyExecutionMetrics 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) GetJourneyRequest added in v1.25.25 

func (c *Pinpoint) GetJourneyRequest(input *GetJourneyInput) (req *request.Request, output *GetJourneyOutput)

GetJourneyRequest generates a "aws/request.Request" representing the client's request for the GetJourney operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetJourney for more information on using the GetJourney 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 GetJourneyRequest method.
req, resp := client.GetJourneyRequest(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/GetJourney

func (*Pinpoint) GetJourneyWithContext added in v1.25.25 

func (c *Pinpoint) GetJourneyWithContext(ctx aws.Context, input *GetJourneyInput, opts ...request.Option) (*GetJourneyOutput, error)

GetJourneyWithContext is the same as GetJourney with the addition of the ability to pass a context and additional request options.

See GetJourney 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) GetPushTemplate added in v1.25.7 

func (c *Pinpoint) GetPushTemplate(input *GetPushTemplateInput) (*GetPushTemplateOutput, error)

GetPushTemplate API operation for Amazon Pinpoint.

Retrieves the content and settings of a message template for messages that are sent through a push notification 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 GetPushTemplate for usage and error information.

Returned Error Types:

  • BadRequestException Provides information about an API request or response.

  • InternalServerErrorException Provides information about an API request or response.

  • PayloadTooLargeException Provides information about an API request or response.

  • ForbiddenException Provides information about an API request or response.

  • NotFoundException Provides information about an API request or response.

  • MethodNotAllowedException Provides information about an API request or response.

  • TooManyRequestsException Provides information about an API request or response.

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

func (*Pinpoint) GetPushTemplateRequest added in v1.25.7 

func (c *Pinpoint) GetPushTemplateRequest(input *GetPushTemplateInput) (req *request.Request, output *GetPushTemplateOutput)

GetPushTemplateRequest generates a "aws/request.Request" representing the client's request for the GetPushTemplate operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetPushTemplate for more information on using the GetPushTemplate 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 GetPushTemplateRequest method.
req, resp := client.GetPushTemplateRequest(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/GetPushTemplate

func (*Pinpoint) GetPushTemplateWithContext added in v1.25.7 

func (c *Pinpoint) GetPushTemplateWithContext(ctx aws.Context, input *GetPushTemplateInput, opts ...request.Option) (*GetPushTemplateOutput, error)

GetPushTemplateWithContext is the same as GetPushTemplate with the addition of the ability to pass a context and additional request options.

See GetPushTemplate 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) GetRecommenderConfiguration added in v1.29.17 

func (c *Pinpoint) GetRecommenderConfiguration(input *GetRecommenderConfigurationInput) (*GetRecommenderConfigurationOutput, error)

GetRecommenderConfiguration API operation for Amazon Pinpoint.

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

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 GetRecommenderConfiguration for usage and error information.

Returned Error Types:

  • BadRequestException Provides information about an API request or response.

  • InternalServerErrorException Provides information about an API request or response.

  • PayloadTooLargeException Provides information about an API request or response.

  • ForbiddenException Provides information about an API request or response.

  • NotFoundException Provides information about an API request or response.

  • MethodNotAllowedException Provides information about an API request or response.

  • TooManyRequestsException Provides information about an API request or response.

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

func (*Pinpoint) GetRecommenderConfigurationRequest added in v1.29.17 

func (c *Pinpoint) GetRecommenderConfigurationRequest(input *GetRecommenderConfigurationInput) (req *request.Request, output *GetRecommenderConfigurationOutput)

GetRecommenderConfigurationRequest generates a "aws/request.Request" representing the client's request for the GetRecommenderConfiguration operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetRecommenderConfiguration for more information on using the GetRecommenderConfiguration 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 GetRecommenderConfigurationRequest method.
req, resp := client.GetRecommenderConfigurationRequest(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/GetRecommenderConfiguration

func (*Pinpoint) GetRecommenderConfigurationWithContext added in v1.29.17 

func (c *Pinpoint) GetRecommenderConfigurationWithContext(ctx aws.Context, input *GetRecommenderConfigurationInput, opts ...request.Option) (*GetRecommenderConfigurationOutput, error)

GetRecommenderConfigurationWithContext is the same as GetRecommenderConfiguration with the addition of the ability to pass a context and additional request options.

See GetRecommenderConfiguration 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) GetRecommenderConfigurations added in v1.29.17 

func (c *Pinpoint) GetRecommenderConfigurations(input *GetRecommenderConfigurationsInput) (*GetRecommenderConfigurationsOutput, error)

GetRecommenderConfigurations API operation for Amazon Pinpoint.

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

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 GetRecommenderConfigurations for usage and error information.

Returned Error Types:

  • BadRequestException Provides information about an API request or response.

  • InternalServerErrorException Provides information about an API request or response.

  • PayloadTooLargeException Provides information about an API request or response.

  • ForbiddenException Provides information about an API request or response.

  • NotFoundException Provides information about an API request or response.

  • MethodNotAllowedException Provides information about an API request or response.

  • TooManyRequestsException Provides information about an API request or response.

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

func (*Pinpoint) GetRecommenderConfigurationsRequest added in v1.29.17 

func (c *Pinpoint) GetRecommenderConfigurationsRequest(input *GetRecommenderConfigurationsInput) (req *request.Request, output *GetRecommenderConfigurationsOutput)

GetRecommenderConfigurationsRequest generates a "aws/request.Request" representing the client's request for the GetRecommenderConfigurations operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetRecommenderConfigurations for more information on using the GetRecommenderConfigurations 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 GetRecommenderConfigurationsRequest method.
req, resp := client.GetRecommenderConfigurationsRequest(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/GetRecommenderConfigurations

func (*Pinpoint) GetRecommenderConfigurationsWithContext added in v1.29.17 

func (c *Pinpoint) GetRecommenderConfigurationsWithContext(ctx aws.Context, input *GetRecommenderConfigurationsInput, opts ...request.Option) (*GetRecommenderConfigurationsOutput, error)

GetRecommenderConfigurationsWithContext is the same as GetRecommenderConfigurations with the addition of the ability to pass a context and additional request options.

See GetRecommenderConfigurations 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.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint's API operation GetSegment for usage and error information.

Returned Error Types:

  • BadRequestException Provides information about an API request or response.

  • InternalServerErrorException Provides information about an API request or response.

  • PayloadTooLargeException Provides information about an API request or response.

  • ForbiddenException Provides information about an API request or response.

  • NotFoundException Provides information about an API request or response.

  • MethodNotAllowedException Provides information about an API request or response.

  • TooManyRequestsException Provides information about an API request or response.

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.

Retrieves information about the status and settings of the export jobs for 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 GetSegmentExportJobs for usage and error information.

Returned Error Types:

  • BadRequestException Provides information about an API request or response.

  • InternalServerErrorException Provides information about an API request or response.

  • PayloadTooLargeException Provides information about an API request or response.

  • ForbiddenException Provides information about an API request or response.

  • NotFoundException Provides information about an API request or response.

  • MethodNotAllowedException Provides information about an API request or response.

  • TooManyRequestsException Provides information about an API request or response.

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 successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See 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.

Retrieves information about the status and settings of the import jobs for 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 GetSegmentImportJobs for usage and error information.

Returned Error Types:

  • BadRequestException Provides information about an API request or response.

  • InternalServerErrorException Provides information about an API request or response.

  • PayloadTooLargeException Provides information about an API request or response.

  • ForbiddenException Provides information about an API request or response.

  • NotFoundException Provides information about an API request or response.

  • MethodNotAllowedException Provides information about an API request or response.

  • TooManyRequestsException Provides information about an API request or response.

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 successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See 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 successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See 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.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint's API operation GetSegmentVersion for usage and error information.

Returned Error Types:

  • BadRequestException Provides information about an API request or response.

  • InternalServerErrorException Provides information about an API request or response.

  • PayloadTooLargeException Provides information about an API request or response.

  • ForbiddenException Provides information about an API request or response.

  • NotFoundException Provides information about an API request or response.

  • MethodNotAllowedException Provides information about an API request or response.

  • TooManyRequestsException Provides information about an API request or response.

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 successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See 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.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint's API operation GetSegmentVersions for usage and error information.

Returned Error Types:

  • BadRequestException Provides information about an API request or response.

  • InternalServerErrorException Provides information about an API request or response.

  • PayloadTooLargeException Provides information about an API request or response.

  • ForbiddenException Provides information about an API request or response.

  • NotFoundException Provides information about an API request or response.

  • MethodNotAllowedException Provides information about an API request or response.

  • TooManyRequestsException Provides information about an API request or response.

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 successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See 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.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint's API operation GetSegments for usage and error information.

Returned Error Types:

  • BadRequestException Provides information about an API request or response.

  • InternalServerErrorException Provides information about an API request or response.

  • PayloadTooLargeException Provides information about an API request or response.

  • ForbiddenException Provides information about an API request or response.

  • NotFoundException Provides information about an API request or response.

  • MethodNotAllowedException Provides information about an API request or response.

  • TooManyRequestsException Provides information about an API request or response.

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 successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See 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.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint's API operation GetSmsChannel for usage and error information.

Returned Error Types:

  • BadRequestException Provides information about an API request or response.

  • InternalServerErrorException Provides information about an API request or response.

  • PayloadTooLargeException Provides information about an API request or response.

  • ForbiddenException Provides information about an API request or response.

  • NotFoundException Provides information about an API request or response.

  • MethodNotAllowedException Provides information about an API request or response.

  • TooManyRequestsException Provides information about an API request or response.

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 successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See 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) GetSmsTemplate added in v1.25.7 

func (c *Pinpoint) GetSmsTemplate(input *GetSmsTemplateInput) (*GetSmsTemplateOutput, error)

GetSmsTemplate API operation for Amazon Pinpoint.

Retrieves the content and settings of a message template for messages that are sent through the 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 GetSmsTemplate for usage and error information.

Returned Error Types:

  • BadRequestException Provides information about an API request or response.

  • InternalServerErrorException Provides information about an API request or response.

  • PayloadTooLargeException Provides information about an API request or response.

  • ForbiddenException Provides information about an API request or response.

  • NotFoundException Provides information about an API request or response.

  • MethodNotAllowedException Provides information about an API request or response.

  • TooManyRequestsException Provides information about an API request or response.

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

func (*Pinpoint) GetSmsTemplateRequest added in v1.25.7 

func (c *Pinpoint) GetSmsTemplateRequest(input *GetSmsTemplateInput) (req *request.Request, output *GetSmsTemplateOutput)

GetSmsTemplateRequest generates a "aws/request.Request" representing the client's request for the GetSmsTemplate operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetSmsTemplate for more information on using the GetSmsTemplate 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 GetSmsTemplateRequest method.
req, resp := client.GetSmsTemplateRequest(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/GetSmsTemplate

func (*Pinpoint) GetSmsTemplateWithContext added in v1.25.7 

func (c *Pinpoint) GetSmsTemplateWithContext(ctx aws.Context, input *GetSmsTemplateInput, opts ...request.Option) (*GetSmsTemplateOutput, error)

GetSmsTemplateWithContext is the same as GetSmsTemplate with the addition of the ability to pass a context and additional request options.

See GetSmsTemplate 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) GetUserEndpoints added in v1.14.20 

func (c *Pinpoint) GetUserEndpoints(input *GetUserEndpointsInput) (*GetUserEndpointsOutput, error)

GetUserEndpoints API operation for Amazon Pinpoint.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint's API operation GetUserEndpoints for usage and error information.

Returned Error Types:

  • BadRequestException Provides information about an API request or response.

  • InternalServerErrorException Provides information about an API request or response.

  • PayloadTooLargeException Provides information about an API request or response.

  • ForbiddenException Provides information about an API request or response.

  • NotFoundException Provides information about an API request or response.

  • MethodNotAllowedException Provides information about an API request or response.

  • TooManyRequestsException Provides information about an API request or response.

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

func (*Pinpoint) GetUserEndpointsRequest added in v1.14.20 

func (c *Pinpoint) GetUserEndpointsRequest(input *GetUserEndpointsInput) (req *request.Request, output *GetUserEndpointsOutput)

GetUserEndpointsRequest generates a "aws/request.Request" representing the client's request for the GetUserEndpoints operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetUserEndpoints for more information on using the GetUserEndpoints 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 GetUserEndpointsRequest method.
req, resp := client.GetUserEndpointsRequest(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/GetUserEndpoints

func (*Pinpoint) GetUserEndpointsWithContext added in v1.14.20 

func (c *Pinpoint) GetUserEndpointsWithContext(ctx aws.Context, input *GetUserEndpointsInput, opts ...request.Option) (*GetUserEndpointsOutput, error)

GetUserEndpointsWithContext is the same as GetUserEndpoints with the addition of the ability to pass a context and additional request options.

See GetUserEndpoints 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) GetVoiceChannel added in v1.15.77 

func (c *Pinpoint) GetVoiceChannel(input *GetVoiceChannelInput) (*GetVoiceChannelOutput, error)

GetVoiceChannel API operation for Amazon Pinpoint.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint's API operation GetVoiceChannel for usage and error information.

Returned Error Types:

  • BadRequestException Provides information about an API request or response.

  • InternalServerErrorException Provides information about an API request or response.

  • PayloadTooLargeException Provides information about an API request or response.

  • ForbiddenException Provides information about an API request or response.

  • NotFoundException Provides information about an API request or response.

  • MethodNotAllowedException Provides information about an API request or response.

  • TooManyRequestsException Provides information about an API request or response.

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

func (*Pinpoint) GetVoiceChannelRequest added in v1.15.77 

func (c *Pinpoint) GetVoiceChannelRequest(input *GetVoiceChannelInput) (req *request.Request, output *GetVoiceChannelOutput)

GetVoiceChannelRequest generates a "aws/request.Request" representing the client's request for the GetVoiceChannel operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetVoiceChannel for more information on using the GetVoiceChannel 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 GetVoiceChannelRequest method.
req, resp := client.GetVoiceChannelRequest(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/GetVoiceChannel

func (*Pinpoint) GetVoiceChannelWithContext added in v1.15.77 

func (c *Pinpoint) GetVoiceChannelWithContext(ctx aws.Context, input *GetVoiceChannelInput, opts ...request.Option) (*GetVoiceChannelOutput, error)

GetVoiceChannelWithContext is the same as GetVoiceChannel with the addition of the ability to pass a context and additional request options.

See GetVoiceChannel 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) GetVoiceTemplate added in v1.25.37 

func (c *Pinpoint) GetVoiceTemplate(input *GetVoiceTemplateInput) (*GetVoiceTemplateOutput, error)

GetVoiceTemplate API operation for Amazon Pinpoint.

Retrieves the content and settings of a message template for messages that are sent through the voice 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 GetVoiceTemplate for usage and error information.

Returned Error Types:

  • BadRequestException Provides information about an API request or response.

  • InternalServerErrorException Provides information about an API request or response.

  • PayloadTooLargeException Provides information about an API request or response.

  • ForbiddenException Provides information about an API request or response.

  • NotFoundException Provides information about an API request or response.

  • MethodNotAllowedException Provides information about an API request or response.

  • TooManyRequestsException Provides information about an API request or response.

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

func (*Pinpoint) GetVoiceTemplateRequest added in v1.25.37 

func (c *Pinpoint) GetVoiceTemplateRequest(input *GetVoiceTemplateInput) (req *request.Request, output *GetVoiceTemplateOutput)

GetVoiceTemplateRequest generates a "aws/request.Request" representing the client's request for the GetVoiceTemplate operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetVoiceTemplate for more information on using the GetVoiceTemplate 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 GetVoiceTemplateRequest method.
req, resp := client.GetVoiceTemplateRequest(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/GetVoiceTemplate

func (*Pinpoint) GetVoiceTemplateWithContext added in v1.25.37 

func (c *Pinpoint) GetVoiceTemplateWithContext(ctx aws.Context, input *GetVoiceTemplateInput, opts ...request.Option) (*GetVoiceTemplateOutput, error)

GetVoiceTemplateWithContext is the same as GetVoiceTemplate with the addition of the ability to pass a context and additional request options.

See GetVoiceTemplate 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) ListJourneys added in v1.25.25 

func (c *Pinpoint) ListJourneys(input *ListJourneysInput) (*ListJourneysOutput, error)

ListJourneys API operation for Amazon Pinpoint.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint's API operation ListJourneys for usage and error information.

Returned Error Types:

  • BadRequestException Provides information about an API request or response.

  • InternalServerErrorException Provides information about an API request or response.

  • PayloadTooLargeException Provides information about an API request or response.

  • ForbiddenException Provides information about an API request or response.

  • NotFoundException Provides information about an API request or response.

  • MethodNotAllowedException Provides information about an API request or response.

  • TooManyRequestsException Provides information about an API request or response.

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

func (*Pinpoint) ListJourneysRequest added in v1.25.25 

func (c *Pinpoint) ListJourneysRequest(input *ListJourneysInput) (req *request.Request, output *ListJourneysOutput)

ListJourneysRequest generates a "aws/request.Request" representing the client's request for the ListJourneys operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListJourneys for more information on using the ListJourneys 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 ListJourneysRequest method.
req, resp := client.ListJourneysRequest(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/ListJourneys

func (*Pinpoint) ListJourneysWithContext added in v1.25.25 

func (c *Pinpoint) ListJourneysWithContext(ctx aws.Context, input *ListJourneysInput, opts ...request.Option) (*ListJourneysOutput, error)

ListJourneysWithContext is the same as ListJourneys with the addition of the ability to pass a context and additional request options.

See ListJourneys 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) ListTagsForResource added in v1.17.6 

func (c *Pinpoint) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error)

ListTagsForResource API operation for Amazon Pinpoint.

Retrieves all the tags (keys and values) that are associated with an application, campaign, message template, or 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 ListTagsForResource for usage and error information. See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/ListTagsForResource

func (*Pinpoint) ListTagsForResourceRequest added in v1.17.6 

func (c *Pinpoint) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput)

ListTagsForResourceRequest generates a "aws/request.Request" representing the client's request for the ListTagsForResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListTagsForResource for more information on using the ListTagsForResource 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 ListTagsForResourceRequest method.
req, resp := client.ListTagsForResourceRequest(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/ListTagsForResource

func (*Pinpoint) ListTagsForResourceWithContext added in v1.17.6 

func (c *Pinpoint) ListTagsForResourceWithContext(ctx aws.Context, input *ListTagsForResourceInput, opts ...request.Option) (*ListTagsForResourceOutput, error)

ListTagsForResourceWithContext is the same as ListTagsForResource with the addition of the ability to pass a context and additional request options.

See ListTagsForResource 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) ListTemplateVersions added in v1.26.7 

func (c *Pinpoint) ListTemplateVersions(input *ListTemplateVersionsInput) (*ListTemplateVersionsOutput, error)

ListTemplateVersions API operation for Amazon Pinpoint.

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

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 ListTemplateVersions for usage and error information.

Returned Error Types:

  • BadRequestException Provides information about an API request or response.

  • InternalServerErrorException Provides information about an API request or response.

  • PayloadTooLargeException Provides information about an API request or response.

  • ForbiddenException Provides information about an API request or response.

  • NotFoundException Provides information about an API request or response.

  • MethodNotAllowedException Provides information about an API request or response.

  • TooManyRequestsException Provides information about an API request or response.

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

func (*Pinpoint) ListTemplateVersionsRequest added in v1.26.7 

func (c *Pinpoint) ListTemplateVersionsRequest(input *ListTemplateVersionsInput) (req *request.Request, output *ListTemplateVersionsOutput)

ListTemplateVersionsRequest generates a "aws/request.Request" representing the client's request for the ListTemplateVersions operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListTemplateVersions for more information on using the ListTemplateVersions 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 ListTemplateVersionsRequest method.
req, resp := client.ListTemplateVersionsRequest(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/ListTemplateVersions

func (*Pinpoint) ListTemplateVersionsWithContext added in v1.26.7 

func (c *Pinpoint) ListTemplateVersionsWithContext(ctx aws.Context, input *ListTemplateVersionsInput, opts ...request.Option) (*ListTemplateVersionsOutput, error)

ListTemplateVersionsWithContext is the same as ListTemplateVersions with the addition of the ability to pass a context and additional request options.

See ListTemplateVersions 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) ListTemplates added in v1.25.7 

func (c *Pinpoint) ListTemplates(input *ListTemplatesInput) (*ListTemplatesOutput, error)

ListTemplates API operation for Amazon Pinpoint.

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

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 ListTemplates for usage and error information.

Returned Error Types:

  • MethodNotAllowedException Provides information about an API request or response.

  • TooManyRequestsException Provides information about an API request or response.

  • BadRequestException Provides information about an API request or response.

  • InternalServerErrorException Provides information about an API request or response.

  • ForbiddenException Provides information about an API request or response.

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

func (*Pinpoint) ListTemplatesRequest added in v1.25.7 

func (c *Pinpoint) ListTemplatesRequest(input *ListTemplatesInput) (req *request.Request, output *ListTemplatesOutput)

ListTemplatesRequest generates a "aws/request.Request" representing the client's request for the ListTemplates operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListTemplates for more information on using the ListTemplates 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 ListTemplatesRequest method.
req, resp := client.ListTemplatesRequest(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/ListTemplates

func (*Pinpoint) ListTemplatesWithContext added in v1.25.7 

func (c *Pinpoint) ListTemplatesWithContext(ctx aws.Context, input *ListTemplatesInput, opts ...request.Option) (*ListTemplatesOutput, error)

ListTemplatesWithContext is the same as ListTemplates with the addition of the ability to pass a context and additional request options.

See ListTemplates 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) PhoneNumberValidate added in v1.14.20 

func (c *Pinpoint) PhoneNumberValidate(input *PhoneNumberValidateInput) (*PhoneNumberValidateOutput, error)

PhoneNumberValidate API operation for Amazon Pinpoint.

Retrieves information about a phone number.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint's API operation PhoneNumberValidate for usage and error information.

Returned Error Types:

  • BadRequestException Provides information about an API request or response.

  • InternalServerErrorException Provides information about an API request or response.

  • PayloadTooLargeException Provides information about an API request or response.

  • ForbiddenException Provides information about an API request or response.

  • NotFoundException Provides information about an API request or response.

  • MethodNotAllowedException Provides information about an API request or response.

  • TooManyRequestsException Provides information about an API request or response.

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

func (*Pinpoint) PhoneNumberValidateRequest added in v1.14.20 

func (c *Pinpoint) PhoneNumberValidateRequest(input *PhoneNumberValidateInput) (req *request.Request, output *PhoneNumberValidateOutput)

PhoneNumberValidateRequest generates a "aws/request.Request" representing the client's request for the PhoneNumberValidate operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See PhoneNumberValidate for more information on using the PhoneNumberValidate 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 PhoneNumberValidateRequest method.
req, resp := client.PhoneNumberValidateRequest(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/PhoneNumberValidate

func (*Pinpoint) PhoneNumberValidateWithContext added in v1.14.20 

func (c *Pinpoint) PhoneNumberValidateWithContext(ctx aws.Context, input *PhoneNumberValidateInput, opts ...request.Option) (*PhoneNumberValidateOutput, error)

PhoneNumberValidateWithContext is the same as PhoneNumberValidate with the addition of the ability to pass a context and additional request options.

See PhoneNumberValidate 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.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint's API operation PutEventStream for usage and error information.

Returned Error Types:

  • BadRequestException Provides information about an API request or response.

  • InternalServerErrorException Provides information about an API request or response.

  • PayloadTooLargeException Provides information about an API request or response.

  • ForbiddenException Provides information about an API request or response.

  • NotFoundException Provides information about an API request or response.

  • MethodNotAllowedException Provides information about an API request or response.

  • TooManyRequestsException Provides information about an API request or response.

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 successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See 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) PutEvents added in v1.15.7 

func (c *Pinpoint) PutEvents(input *PutEventsInput) (*PutEventsOutput, error)

PutEvents API operation for Amazon Pinpoint.

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

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 PutEvents for usage and error information.

Returned Error Types:

  • BadRequestException Provides information about an API request or response.

  • InternalServerErrorException Provides information about an API request or response.

  • PayloadTooLargeException Provides information about an API request or response.

  • ForbiddenException Provides information about an API request or response.

  • NotFoundException Provides information about an API request or response.

  • MethodNotAllowedException Provides information about an API request or response.

  • TooManyRequestsException Provides information about an API request or response.

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

func (*Pinpoint) PutEventsRequest added in v1.15.7 

func (c *Pinpoint) PutEventsRequest(input *PutEventsInput) (req *request.Request, output *PutEventsOutput)

PutEventsRequest generates a "aws/request.Request" representing the client's request for the PutEvents operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See PutEvents for more information on using the PutEvents 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 PutEventsRequest method.
req, resp := client.PutEventsRequest(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/PutEvents

func (*Pinpoint) PutEventsWithContext added in v1.15.7 

func (c *Pinpoint) PutEventsWithContext(ctx aws.Context, input *PutEventsInput, opts ...request.Option) (*PutEventsOutput, error)

PutEventsWithContext is the same as PutEvents with the addition of the ability to pass a context and additional request options.

See PutEvents 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) RemoveAttributes added in v1.14.20 

func (c *Pinpoint) RemoveAttributes(input *RemoveAttributesInput) (*RemoveAttributesOutput, error)

RemoveAttributes API operation for Amazon Pinpoint.

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

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 RemoveAttributes for usage and error information.

Returned Error Types:

  • BadRequestException Provides information about an API request or response.

  • InternalServerErrorException Provides information about an API request or response.

  • PayloadTooLargeException Provides information about an API request or response.

  • ForbiddenException Provides information about an API request or response.

  • NotFoundException Provides information about an API request or response.

  • MethodNotAllowedException Provides information about an API request or response.

  • TooManyRequestsException Provides information about an API request or response.

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

func (*Pinpoint) RemoveAttributesRequest added in v1.14.20 

func (c *Pinpoint) RemoveAttributesRequest(input *RemoveAttributesInput) (req *request.Request, output *RemoveAttributesOutput)

RemoveAttributesRequest generates a "aws/request.Request" representing the client's request for the RemoveAttributes operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See RemoveAttributes for more information on using the RemoveAttributes 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 RemoveAttributesRequest method.
req, resp := client.RemoveAttributesRequest(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/RemoveAttributes

func (*Pinpoint) RemoveAttributesWithContext added in v1.14.20 

func (c *Pinpoint) RemoveAttributesWithContext(ctx aws.Context, input *RemoveAttributesInput, opts ...request.Option) (*RemoveAttributesOutput, error)

RemoveAttributesWithContext is the same as RemoveAttributes with the addition of the ability to pass a context and additional request options.

See RemoveAttributes 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.

Creates and sends a direct message.

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 Types:

  • BadRequestException Provides information about an API request or response.

  • InternalServerErrorException Provides information about an API request or response.

  • PayloadTooLargeException Provides information about an API request or response.

  • ForbiddenException Provides information about an API request or response.

  • NotFoundException Provides information about an API request or response.

  • MethodNotAllowedException Provides information about an API request or response.

  • TooManyRequestsException Provides information about an API request or response.

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 successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See 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) SendOTPMessage added in v1.42.13 

func (c *Pinpoint) SendOTPMessage(input *SendOTPMessageInput) (*SendOTPMessageOutput, error)

SendOTPMessage API operation for Amazon Pinpoint.

Send an OTP message

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 SendOTPMessage for usage and error information.

Returned Error Types:

  • BadRequestException Provides information about an API request or response.

  • InternalServerErrorException Provides information about an API request or response.

  • PayloadTooLargeException Provides information about an API request or response.

  • ForbiddenException Provides information about an API request or response.

  • NotFoundException Provides information about an API request or response.

  • MethodNotAllowedException Provides information about an API request or response.

  • TooManyRequestsException Provides information about an API request or response.

See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/SendOTPMessage

func (*Pinpoint) SendOTPMessageRequest added in v1.42.13 

func (c *Pinpoint) SendOTPMessageRequest(input *SendOTPMessageInput) (req *request.Request, output *SendOTPMessageOutput)

SendOTPMessageRequest generates a "aws/request.Request" representing the client's request for the SendOTPMessage operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See SendOTPMessage for more information on using the SendOTPMessage 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 SendOTPMessageRequest method.
req, resp := client.SendOTPMessageRequest(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/SendOTPMessage

func (*Pinpoint) SendOTPMessageWithContext added in v1.42.13 

func (c *Pinpoint) SendOTPMessageWithContext(ctx aws.Context, input *SendOTPMessageInput, opts ...request.Option) (*SendOTPMessageOutput, error)

SendOTPMessageWithContext is the same as SendOTPMessage with the addition of the ability to pass a context and additional request options.

See SendOTPMessage 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.

Creates and sends a message to a list of 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 Types:

  • BadRequestException Provides information about an API request or response.

  • InternalServerErrorException Provides information about an API request or response.

  • PayloadTooLargeException Provides information about an API request or response.

  • ForbiddenException Provides information about an API request or response.

  • NotFoundException Provides information about an API request or response.

  • MethodNotAllowedException Provides information about an API request or response.

  • TooManyRequestsException Provides information about an API request or response.

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 successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See 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) TagResource added in v1.17.6 

func (c *Pinpoint) TagResource(input *TagResourceInput) (*TagResourceOutput, error)

TagResource API operation for Amazon Pinpoint.

Adds one or more tags (keys and values) to an application, campaign, message template, or 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 TagResource for usage and error information. See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/TagResource

func (*Pinpoint) TagResourceRequest added in v1.17.6 

func (c *Pinpoint) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput)

TagResourceRequest generates a "aws/request.Request" representing the client's request for the TagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See TagResource for more information on using the TagResource 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 TagResourceRequest method.
req, resp := client.TagResourceRequest(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/TagResource

func (*Pinpoint) TagResourceWithContext added in v1.17.6 

func (c *Pinpoint) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error)

TagResourceWithContext is the same as TagResource with the addition of the ability to pass a context and additional request options.

See TagResource 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) UntagResource added in v1.17.6 

func (c *Pinpoint) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error)

UntagResource API operation for Amazon Pinpoint.

Removes one or more tags (keys and values) from an application, campaign, message template, or 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 UntagResource for usage and error information. See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/UntagResource

func (*Pinpoint) UntagResourceRequest added in v1.17.6 

func (c *Pinpoint) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput)

UntagResourceRequest generates a "aws/request.Request" representing the client's request for the UntagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UntagResource for more information on using the UntagResource 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 UntagResourceRequest method.
req, resp := client.UntagResourceRequest(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/UntagResource

func (*Pinpoint) UntagResourceWithContext added in v1.17.6 

func (c *Pinpoint) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error)

UntagResourceWithContext is the same as UntagResource with the addition of the ability to pass a context and additional request options.

See UntagResource 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.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint's API operation UpdateAdmChannel for usage and error information.

Returned Error Types:

  • BadRequestException Provides information about an API request or response.

  • InternalServerErrorException Provides information about an API request or response.

  • PayloadTooLargeException Provides information about an API request or response.

  • ForbiddenException Provides information about an API request or response.

  • NotFoundException Provides information about an API request or response.

  • MethodNotAllowedException Provides information about an API request or response.

  • TooManyRequestsException Provides information about an API request or response.

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 successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See 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.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint's API operation UpdateApnsChannel for usage and error information.

Returned Error Types:

  • BadRequestException Provides information about an API request or response.

  • InternalServerErrorException Provides information about an API request or response.

  • PayloadTooLargeException Provides information about an API request or response.

  • ForbiddenException Provides information about an API request or response.

  • NotFoundException Provides information about an API request or response.

  • MethodNotAllowedException Provides information about an API request or response.

  • TooManyRequestsException Provides information about an API request or response.

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 successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See 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.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint's API operation UpdateApnsSandboxChannel for usage and error information.

Returned Error Types:

  • BadRequestException Provides information about an API request or response.

  • InternalServerErrorException Provides information about an API request or response.

  • PayloadTooLargeException Provides information about an API request or response.

  • ForbiddenException Provides information about an API request or response.

  • NotFoundException Provides information about an API request or response.

  • MethodNotAllowedException Provides information about an API request or response.

  • TooManyRequestsException Provides information about an API request or response.

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 successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See 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.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint's API operation UpdateApnsVoipChannel for usage and error information.

Returned Error Types:

  • BadRequestException Provides information about an API request or response.

  • InternalServerErrorException Provides information about an API request or response.

  • PayloadTooLargeException Provides information about an API request or response.

  • ForbiddenException Provides information about an API request or response.

  • NotFoundException Provides information about an API request or response.

  • MethodNotAllowedException Provides information about an API request or response.

  • TooManyRequestsException Provides information about an API request or response.

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 successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See 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.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint's API operation UpdateApnsVoipSandboxChannel for usage and error information.

Returned Error Types:

  • BadRequestException Provides information about an API request or response.

  • InternalServerErrorException Provides information about an API request or response.

  • PayloadTooLargeException Provides information about an API request or response.

  • ForbiddenException Provides information about an API request or response.

  • NotFoundException Provides information about an API request or response.

  • MethodNotAllowedException Provides information about an API request or response.

  • TooManyRequestsException Provides information about an API request or response.

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 successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See 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.

Updates the settings for an application.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint's API operation UpdateApplicationSettings for usage and error information.

Returned Error Types:

  • BadRequestException Provides information about an API request or response.

  • InternalServerErrorException Provides information about an API request or response.

  • PayloadTooLargeException Provides information about an API request or response.

  • ForbiddenException Provides information about an API request or response.

  • NotFoundException Provides information about an API request or response.

  • MethodNotAllowedException Provides information about an API request or response.

  • TooManyRequestsException Provides information about an API request or response.

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 successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See 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.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint's API operation UpdateBaiduChannel for usage and error information.

Returned Error Types:

  • BadRequestException Provides information about an API request or response.

  • InternalServerErrorException Provides information about an API request or response.

  • PayloadTooLargeException Provides information about an API request or response.

  • ForbiddenException Provides information about an API request or response.

  • NotFoundException Provides information about an API request or response.

  • MethodNotAllowedException Provides information about an API request or response.

  • TooManyRequestsException Provides information about an API request or response.

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 successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See 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.

Updates the configuration and other settings for 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 Types:

  • BadRequestException Provides information about an API request or response.

  • InternalServerErrorException Provides information about an API request or response.

  • PayloadTooLargeException Provides information about an API request or response.

  • ForbiddenException Provides information about an API request or response.

  • NotFoundException Provides information about an API request or response.

  • MethodNotAllowedException Provides information about an API request or response.

  • TooManyRequestsException Provides information about an API request or response.

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 successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See 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.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint's API operation UpdateEmailChannel for usage and error information.

Returned Error Types:

  • BadRequestException Provides information about an API request or response.

  • InternalServerErrorException Provides information about an API request or response.

  • PayloadTooLargeException Provides information about an API request or response.

  • ForbiddenException Provides information about an API request or response.

  • NotFoundException Provides information about an API request or response.

  • MethodNotAllowedException Provides information about an API request or response.

  • TooManyRequestsException Provides information about an API request or response.

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 successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See 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) UpdateEmailTemplate added in v1.25.7 

func (c *Pinpoint) UpdateEmailTemplate(input *UpdateEmailTemplateInput) (*UpdateEmailTemplateOutput, error)

UpdateEmailTemplate API operation for Amazon Pinpoint.

Updates an existing message template for messages that are sent through the 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 UpdateEmailTemplate for usage and error information.

Returned Error Types:

  • BadRequestException Provides information about an API request or response.

  • InternalServerErrorException Provides information about an API request or response.

  • PayloadTooLargeException Provides information about an API request or response.

  • ForbiddenException Provides information about an API request or response.

  • NotFoundException Provides information about an API request or response.

  • MethodNotAllowedException Provides information about an API request or response.

  • TooManyRequestsException Provides information about an API request or response.

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

func (*Pinpoint) UpdateEmailTemplateRequest added in v1.25.7 

func (c *Pinpoint) UpdateEmailTemplateRequest(input *UpdateEmailTemplateInput) (req *request.Request, output *UpdateEmailTemplateOutput)

UpdateEmailTemplateRequest generates a "aws/request.Request" representing the client's request for the UpdateEmailTemplate operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateEmailTemplate for more information on using the UpdateEmailTemplate 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 UpdateEmailTemplateRequest method.
req, resp := client.UpdateEmailTemplateRequest(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/UpdateEmailTemplate

func (*Pinpoint) UpdateEmailTemplateWithContext added in v1.25.7 

func (c *Pinpoint) UpdateEmailTemplateWithContext(ctx aws.Context, input *UpdateEmailTemplateInput, opts ...request.Option) (*UpdateEmailTemplateOutput, error)

UpdateEmailTemplateWithContext is the same as UpdateEmailTemplate with the addition of the ability to pass a context and additional request options.

See UpdateEmailTemplate 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.

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

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 Types:

  • BadRequestException Provides information about an API request or response.

  • InternalServerErrorException Provides information about an API request or response.

  • PayloadTooLargeException Provides information about an API request or response.

  • ForbiddenException Provides information about an API request or response.

  • NotFoundException Provides information about an API request or response.

  • MethodNotAllowedException Provides information about an API request or response.

  • TooManyRequestsException Provides information about an API request or response.

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 successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See 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.

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

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 Types:

  • BadRequestException Provides information about an API request or response.

  • InternalServerErrorException Provides information about an API request or response.

  • PayloadTooLargeException Provides information about an API request or response.

  • ForbiddenException Provides information about an API request or response.

  • NotFoundException Provides information about an API request or response.

  • MethodNotAllowedException Provides information about an API request or response.

  • TooManyRequestsException Provides information about an API request or response.

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 successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See 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.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint's API operation UpdateGcmChannel for usage and error information.

Returned Error Types:

  • BadRequestException Provides information about an API request or response.

  • InternalServerErrorException Provides information about an API request or response.

  • PayloadTooLargeException Provides information about an API request or response.

  • ForbiddenException Provides information about an API request or response.

  • NotFoundException Provides information about an API request or response.

  • MethodNotAllowedException Provides information about an API request or response.

  • TooManyRequestsException Provides information about an API request or response.

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 successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See 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) UpdateInAppTemplate added in v1.40.44 

func (c *Pinpoint) UpdateInAppTemplate(input *UpdateInAppTemplateInput) (*UpdateInAppTemplateOutput, error)

UpdateInAppTemplate API operation for Amazon Pinpoint.

Updates an existing message template for messages sent through the in-app message 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 UpdateInAppTemplate for usage and error information.

Returned Error Types:

  • BadRequestException Provides information about an API request or response.

  • InternalServerErrorException Provides information about an API request or response.

  • PayloadTooLargeException Provides information about an API request or response.

  • ForbiddenException Provides information about an API request or response.

  • NotFoundException Provides information about an API request or response.

  • MethodNotAllowedException Provides information about an API request or response.

  • TooManyRequestsException Provides information about an API request or response.

See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/UpdateInAppTemplate

func (*Pinpoint) UpdateInAppTemplateRequest added in v1.40.44 

func (c *Pinpoint) UpdateInAppTemplateRequest(input *UpdateInAppTemplateInput) (req *request.Request, output *UpdateInAppTemplateOutput)

UpdateInAppTemplateRequest generates a "aws/request.Request" representing the client's request for the UpdateInAppTemplate operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateInAppTemplate for more information on using the UpdateInAppTemplate 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 UpdateInAppTemplateRequest method.
req, resp := client.UpdateInAppTemplateRequest(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/UpdateInAppTemplate

func (*Pinpoint) UpdateInAppTemplateWithContext added in v1.40.44 

func (c *Pinpoint) UpdateInAppTemplateWithContext(ctx aws.Context, input *UpdateInAppTemplateInput, opts ...request.Option) (*UpdateInAppTemplateOutput, error)

UpdateInAppTemplateWithContext is the same as UpdateInAppTemplate with the addition of the ability to pass a context and additional request options.

See UpdateInAppTemplate 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) UpdateJourney added in v1.25.25 

func (c *Pinpoint) UpdateJourney(input *UpdateJourneyInput) (*UpdateJourneyOutput, error)

UpdateJourney API operation for Amazon Pinpoint.

Updates the configuration and other settings for a journey.

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 UpdateJourney for usage and error information.

Returned Error Types:

  • BadRequestException Provides information about an API request or response.

  • InternalServerErrorException Provides information about an API request or response.

  • PayloadTooLargeException Provides information about an API request or response.

  • ForbiddenException Provides information about an API request or response.

  • NotFoundException Provides information about an API request or response.

  • MethodNotAllowedException Provides information about an API request or response.

  • TooManyRequestsException Provides information about an API request or response.

  • ConflictException Provides information about an API request or response.

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

func (*Pinpoint) UpdateJourneyRequest added in v1.25.25 

func (c *Pinpoint) UpdateJourneyRequest(input *UpdateJourneyInput) (req *request.Request, output *UpdateJourneyOutput)

UpdateJourneyRequest generates a "aws/request.Request" representing the client's request for the UpdateJourney operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateJourney for more information on using the UpdateJourney 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 UpdateJourneyRequest method.
req, resp := client.UpdateJourneyRequest(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/UpdateJourney

func (*Pinpoint) UpdateJourneyState added in v1.25.25 

func (c *Pinpoint) UpdateJourneyState(input *UpdateJourneyStateInput) (*UpdateJourneyStateOutput, error)

UpdateJourneyState API operation for Amazon Pinpoint.

Pause, resume or cancels (stops) a journey.

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 UpdateJourneyState for usage and error information.

Returned Error Types:

  • BadRequestException Provides information about an API request or response.

  • InternalServerErrorException Provides information about an API request or response.

  • PayloadTooLargeException Provides information about an API request or response.

  • ForbiddenException Provides information about an API request or response.

  • NotFoundException Provides information about an API request or response.

  • MethodNotAllowedException Provides information about an API request or response.

  • TooManyRequestsException Provides information about an API request or response.

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

func (*Pinpoint) UpdateJourneyStateRequest added in v1.25.25 

func (c *Pinpoint) UpdateJourneyStateRequest(input *UpdateJourneyStateInput) (req *request.Request, output *UpdateJourneyStateOutput)

UpdateJourneyStateRequest generates a "aws/request.Request" representing the client's request for the UpdateJourneyState operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateJourneyState for more information on using the UpdateJourneyState 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 UpdateJourneyStateRequest method.
req, resp := client.UpdateJourneyStateRequest(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/UpdateJourneyState

func (*Pinpoint) UpdateJourneyStateWithContext added in v1.25.25 

func (c *Pinpoint) UpdateJourneyStateWithContext(ctx aws.Context, input *UpdateJourneyStateInput, opts ...request.Option) (*UpdateJourneyStateOutput, error)

UpdateJourneyStateWithContext is the same as UpdateJourneyState with the addition of the ability to pass a context and additional request options.

See UpdateJourneyState 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) UpdateJourneyWithContext added in v1.25.25 

func (c *Pinpoint) UpdateJourneyWithContext(ctx aws.Context, input *UpdateJourneyInput, opts ...request.Option) (*UpdateJourneyOutput, error)

UpdateJourneyWithContext is the same as UpdateJourney with the addition of the ability to pass a context and additional request options.

See UpdateJourney 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) UpdatePushTemplate added in v1.25.7 

func (c *Pinpoint) UpdatePushTemplate(input *UpdatePushTemplateInput) (*UpdatePushTemplateOutput, error)

UpdatePushTemplate API operation for Amazon Pinpoint.

Updates an existing message template for messages that are sent through a push notification 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 UpdatePushTemplate for usage and error information.

Returned Error Types:

  • BadRequestException Provides information about an API request or response.

  • InternalServerErrorException Provides information about an API request or response.

  • PayloadTooLargeException Provides information about an API request or response.

  • ForbiddenException Provides information about an API request or response.

  • NotFoundException Provides information about an API request or response.

  • MethodNotAllowedException Provides information about an API request or response.

  • TooManyRequestsException Provides information about an API request or response.

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

func (*Pinpoint) UpdatePushTemplateRequest added in v1.25.7 

func (c *Pinpoint) UpdatePushTemplateRequest(input *UpdatePushTemplateInput) (req *request.Request, output *UpdatePushTemplateOutput)

UpdatePushTemplateRequest generates a "aws/request.Request" representing the client's request for the UpdatePushTemplate operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdatePushTemplate for more information on using the UpdatePushTemplate 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 UpdatePushTemplateRequest method.
req, resp := client.UpdatePushTemplateRequest(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/UpdatePushTemplate

func (*Pinpoint) UpdatePushTemplateWithContext added in v1.25.7 

func (c *Pinpoint) UpdatePushTemplateWithContext(ctx aws.Context, input *UpdatePushTemplateInput, opts ...request.Option) (*UpdatePushTemplateOutput, error)

UpdatePushTemplateWithContext is the same as UpdatePushTemplate with the addition of the ability to pass a context and additional request options.

See UpdatePushTemplate 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) UpdateRecommenderConfiguration added in v1.29.17 

func (c *Pinpoint) UpdateRecommenderConfiguration(input *UpdateRecommenderConfigurationInput) (*UpdateRecommenderConfigurationOutput, error)

UpdateRecommenderConfiguration API operation for Amazon Pinpoint.

Updates an Amazon Pinpoint configuration for a recommender model.

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 UpdateRecommenderConfiguration for usage and error information.

Returned Error Types:

  • BadRequestException Provides information about an API request or response.

  • InternalServerErrorException Provides information about an API request or response.

  • PayloadTooLargeException Provides information about an API request or response.

  • ForbiddenException Provides information about an API request or response.

  • NotFoundException Provides information about an API request or response.

  • MethodNotAllowedException Provides information about an API request or response.

  • TooManyRequestsException Provides information about an API request or response.

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

func (*Pinpoint) UpdateRecommenderConfigurationRequest added in v1.29.17 

func (c *Pinpoint) UpdateRecommenderConfigurationRequest(input *UpdateRecommenderConfigurationInput) (req *request.Request, output *UpdateRecommenderConfigurationOutput)

UpdateRecommenderConfigurationRequest generates a "aws/request.Request" representing the client's request for the UpdateRecommenderConfiguration operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateRecommenderConfiguration for more information on using the UpdateRecommenderConfiguration 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 UpdateRecommenderConfigurationRequest method.
req, resp := client.UpdateRecommenderConfigurationRequest(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/UpdateRecommenderConfiguration

func (*Pinpoint) UpdateRecommenderConfigurationWithContext added in v1.29.17 

func (c *Pinpoint) UpdateRecommenderConfigurationWithContext(ctx aws.Context, input *UpdateRecommenderConfigurationInput, opts ...request.Option) (*UpdateRecommenderConfigurationOutput, error)

UpdateRecommenderConfigurationWithContext is the same as UpdateRecommenderConfiguration with the addition of the ability to pass a context and additional request options.

See UpdateRecommenderConfiguration 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.

Creates a new segment for an application or updates the configuration, dimension, and other settings for an existing segment that's associated with an application.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint's API operation UpdateSegment for usage and error information.

Returned Error Types:

  • BadRequestException Provides information about an API request or response.

  • InternalServerErrorException Provides information about an API request or response.

  • PayloadTooLargeException Provides information about an API request or response.

  • ForbiddenException Provides information about an API request or response.

  • NotFoundException Provides information about an API request or response.

  • MethodNotAllowedException Provides information about an API request or response.

  • TooManyRequestsException Provides information about an API request or response.

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 successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See 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.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint's API operation UpdateSmsChannel for usage and error information.

Returned Error Types:

  • BadRequestException Provides information about an API request or response.

  • InternalServerErrorException Provides information about an API request or response.

  • PayloadTooLargeException Provides information about an API request or response.

  • ForbiddenException Provides information about an API request or response.

  • NotFoundException Provides information about an API request or response.

  • MethodNotAllowedException Provides information about an API request or response.

  • TooManyRequestsException Provides information about an API request or response.

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 successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See 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.

func (*Pinpoint) UpdateSmsTemplate added in v1.25.7 

func (c *Pinpoint) UpdateSmsTemplate(input *UpdateSmsTemplateInput) (*UpdateSmsTemplateOutput, error)

UpdateSmsTemplate API operation for Amazon Pinpoint.

Updates an existing message template for messages that are sent through the 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 UpdateSmsTemplate for usage and error information.

Returned Error Types:

  • BadRequestException Provides information about an API request or response.

  • InternalServerErrorException Provides information about an API request or response.

  • PayloadTooLargeException Provides information about an API request or response.

  • ForbiddenException Provides information about an API request or response.

  • NotFoundException Provides information about an API request or response.

  • MethodNotAllowedException Provides information about an API request or response.

  • TooManyRequestsException Provides information about an API request or response.

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

func (*Pinpoint) UpdateSmsTemplateRequest added in v1.25.7 

func (c *Pinpoint) UpdateSmsTemplateRequest(input *UpdateSmsTemplateInput) (req *request.Request, output *UpdateSmsTemplateOutput)

UpdateSmsTemplateRequest generates a "aws/request.Request" representing the client's request for the UpdateSmsTemplate operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateSmsTemplate for more information on using the UpdateSmsTemplate 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 UpdateSmsTemplateRequest method.
req, resp := client.UpdateSmsTemplateRequest(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/UpdateSmsTemplate

func (*Pinpoint) UpdateSmsTemplateWithContext added in v1.25.7 

func (c *Pinpoint) UpdateSmsTemplateWithContext(ctx aws.Context, input *UpdateSmsTemplateInput, opts ...request.Option) (*UpdateSmsTemplateOutput, error)

UpdateSmsTemplateWithContext is the same as UpdateSmsTemplate with the addition of the ability to pass a context and additional request options.

See UpdateSmsTemplate 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) UpdateTemplateActiveVersion added in v1.26.7 

func (c *Pinpoint) UpdateTemplateActiveVersion(input *UpdateTemplateActiveVersionInput) (*UpdateTemplateActiveVersionOutput, error)

UpdateTemplateActiveVersion API operation for Amazon Pinpoint.

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

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 UpdateTemplateActiveVersion for usage and error information.

Returned Error Types:

  • BadRequestException Provides information about an API request or response.

  • InternalServerErrorException Provides information about an API request or response.

  • PayloadTooLargeException Provides information about an API request or response.

  • ForbiddenException Provides information about an API request or response.

  • NotFoundException Provides information about an API request or response.

  • MethodNotAllowedException Provides information about an API request or response.

  • TooManyRequestsException Provides information about an API request or response.

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

func (*Pinpoint) UpdateTemplateActiveVersionRequest added in v1.26.7 

func (c *Pinpoint) UpdateTemplateActiveVersionRequest(input *UpdateTemplateActiveVersionInput) (req *request.Request, output *UpdateTemplateActiveVersionOutput)

UpdateTemplateActiveVersionRequest generates a "aws/request.Request" representing the client's request for the UpdateTemplateActiveVersion operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateTemplateActiveVersion for more information on using the UpdateTemplateActiveVersion 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 UpdateTemplateActiveVersionRequest method.
req, resp := client.UpdateTemplateActiveVersionRequest(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/UpdateTemplateActiveVersion

func (*Pinpoint) UpdateTemplateActiveVersionWithContext added in v1.26.7 

func (c *Pinpoint) UpdateTemplateActiveVersionWithContext(ctx aws.Context, input *UpdateTemplateActiveVersionInput, opts ...request.Option) (*UpdateTemplateActiveVersionOutput, error)

UpdateTemplateActiveVersionWithContext is the same as UpdateTemplateActiveVersion with the addition of the ability to pass a context and additional request options.

See UpdateTemplateActiveVersion 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) UpdateVoiceChannel added in v1.15.77 

func (c *Pinpoint) UpdateVoiceChannel(input *UpdateVoiceChannelInput) (*UpdateVoiceChannelOutput, error)

UpdateVoiceChannel API operation for Amazon Pinpoint.

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

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 UpdateVoiceChannel for usage and error information.

Returned Error Types:

  • BadRequestException Provides information about an API request or response.

  • InternalServerErrorException Provides information about an API request or response.

  • PayloadTooLargeException Provides information about an API request or response.

  • ForbiddenException Provides information about an API request or response.

  • NotFoundException Provides information about an API request or response.

  • MethodNotAllowedException Provides information about an API request or response.

  • TooManyRequestsException Provides information about an API request or response.

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

func (*Pinpoint) UpdateVoiceChannelRequest added in v1.15.77 

func (c *Pinpoint) UpdateVoiceChannelRequest(input *UpdateVoiceChannelInput) (req *request.Request, output *UpdateVoiceChannelOutput)

UpdateVoiceChannelRequest generates a "aws/request.Request" representing the client's request for the UpdateVoiceChannel operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateVoiceChannel for more information on using the UpdateVoiceChannel 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 UpdateVoiceChannelRequest method.
req, resp := client.UpdateVoiceChannelRequest(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/UpdateVoiceChannel

func (*Pinpoint) UpdateVoiceChannelWithContext added in v1.15.77 

func (c *Pinpoint) UpdateVoiceChannelWithContext(ctx aws.Context, input *UpdateVoiceChannelInput, opts ...request.Option) (*UpdateVoiceChannelOutput, error)

UpdateVoiceChannelWithContext is the same as UpdateVoiceChannel with the addition of the ability to pass a context and additional request options.

See UpdateVoiceChannel 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) UpdateVoiceTemplate added in v1.25.37 

func (c *Pinpoint) UpdateVoiceTemplate(input *UpdateVoiceTemplateInput) (*UpdateVoiceTemplateOutput, error)

UpdateVoiceTemplate API operation for Amazon Pinpoint.

Updates an existing message template for messages that are sent through the voice 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 UpdateVoiceTemplate for usage and error information.

Returned Error Types:

  • BadRequestException Provides information about an API request or response.

  • InternalServerErrorException Provides information about an API request or response.

  • PayloadTooLargeException Provides information about an API request or response.

  • ForbiddenException Provides information about an API request or response.

  • NotFoundException Provides information about an API request or response.

  • MethodNotAllowedException Provides information about an API request or response.

  • TooManyRequestsException Provides information about an API request or response.

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

func (*Pinpoint) UpdateVoiceTemplateRequest added in v1.25.37 

func (c *Pinpoint) UpdateVoiceTemplateRequest(input *UpdateVoiceTemplateInput) (req *request.Request, output *UpdateVoiceTemplateOutput)

UpdateVoiceTemplateRequest generates a "aws/request.Request" representing the client's request for the UpdateVoiceTemplate operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateVoiceTemplate for more information on using the UpdateVoiceTemplate 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 UpdateVoiceTemplateRequest method.
req, resp := client.UpdateVoiceTemplateRequest(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/UpdateVoiceTemplate

func (*Pinpoint) UpdateVoiceTemplateWithContext added in v1.25.37 

func (c *Pinpoint) UpdateVoiceTemplateWithContext(ctx aws.Context, input *UpdateVoiceTemplateInput, opts ...request.Option) (*UpdateVoiceTemplateOutput, error)

UpdateVoiceTemplateWithContext is the same as UpdateVoiceTemplate with the addition of the ability to pass a context and additional request options.

See UpdateVoiceTemplate 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) VerifyOTPMessage added in v1.42.34 

func (c *Pinpoint) VerifyOTPMessage(input *VerifyOTPMessageInput) (*VerifyOTPMessageOutput, error)

VerifyOTPMessage API operation for Amazon Pinpoint.

Verify an OTP

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 VerifyOTPMessage for usage and error information.

Returned Error Types:

  • BadRequestException Provides information about an API request or response.

  • InternalServerErrorException Provides information about an API request or response.

  • PayloadTooLargeException Provides information about an API request or response.

  • ForbiddenException Provides information about an API request or response.

  • NotFoundException Provides information about an API request or response.

  • MethodNotAllowedException Provides information about an API request or response.

  • TooManyRequestsException Provides information about an API request or response.

See also, https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/VerifyOTPMessage

func (*Pinpoint) VerifyOTPMessageRequest added in v1.42.34 

func (c *Pinpoint) VerifyOTPMessageRequest(input *VerifyOTPMessageInput) (req *request.Request, output *VerifyOTPMessageOutput)

VerifyOTPMessageRequest generates a "aws/request.Request" representing the client's request for the VerifyOTPMessage operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See VerifyOTPMessage for more information on using the VerifyOTPMessage 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 VerifyOTPMessageRequest method.
req, resp := client.VerifyOTPMessageRequest(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/VerifyOTPMessage

func (*Pinpoint) VerifyOTPMessageWithContext added in v1.42.34 

func (c *Pinpoint) VerifyOTPMessageWithContext(ctx aws.Context, input *VerifyOTPMessageInput, opts ...request.Option) (*VerifyOTPMessageOutput, error)

VerifyOTPMessageWithContext is the same as VerifyOTPMessage with the addition of the ability to pass a context and additional request options.

See VerifyOTPMessage 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 PublicEndpoint added in v1.15.7 

type PublicEndpoint struct {

	// The unique identifier for the recipient, such as a device token, email address,
	// or mobile phone number.
	Address *string `type:"string"`

	// One or more custom attributes that describe the endpoint by associating a
	// name with an array of values. You can use these attributes as filter criteria
	// when you create segments.
	Attributes map[string][]*string `type:"map"`

	// The channel that's used when sending messages or push notifications to the
	// endpoint.
	ChannelType *string `type:"string" enum:"ChannelType"`

	// The demographic information for the endpoint, such as the time zone and platform.
	Demographic *EndpointDemographic `type:"structure"`

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

	// Specifies whether to send messages or push notifications to the endpoint.
	// Valid values are: ACTIVE, messages are sent to the endpoint; and, INACTIVE,
	// messages aren’t sent to the endpoint.
	//
	// Amazon Pinpoint automatically sets this value to ACTIVE when you create an
	// endpoint or update an existing endpoint. Amazon Pinpoint automatically sets
	// this value to INACTIVE if you update another endpoint that has the same address
	// specified by the Address property.
	EndpointStatus *string `type:"string"`

	// The geographic information for the endpoint.
	Location *EndpointLocation `type:"structure"`

	// One or more custom metrics that your app reports to Amazon Pinpoint for the
	// endpoint.
	Metrics map[string]*float64 `type:"map"`

	// Specifies whether the user who's associated with the endpoint has opted out
	// of receiving messages and push notifications from you. Possible values are:
	// ALL, the user has opted out and doesn't want to receive any messages or push
	// notifications; and, NONE, the user hasn't opted out and wants to receive
	// all messages and push notifications.
	OptOut *string `type:"string"`

	// A unique identifier that's generated each time the endpoint is updated.
	RequestId *string `type:"string"`

	// One or more custom user attributes that your app reports to Amazon Pinpoint
	// for the user who's associated with the endpoint.
	User *EndpointUser `type:"structure"`
	// contains filtered or unexported fields
}

Specifies the properties and attributes of an endpoint that's associated with an event.

func (PublicEndpoint) GoString added in v1.15.7 

func (s PublicEndpoint) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PublicEndpoint) SetAddress added in v1.15.7 

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

SetAddress sets the Address field's value.

func (*PublicEndpoint) SetAttributes added in v1.15.7 

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

SetAttributes sets the Attributes field's value.

func (*PublicEndpoint) SetChannelType added in v1.15.7 

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

SetChannelType sets the ChannelType field's value.

func (*PublicEndpoint) SetDemographic added in v1.15.7 

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

SetDemographic sets the Demographic field's value.

func (*PublicEndpoint) SetEffectiveDate added in v1.15.7 

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

SetEffectiveDate sets the EffectiveDate field's value.

func (*PublicEndpoint) SetEndpointStatus added in v1.15.7 

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

SetEndpointStatus sets the EndpointStatus field's value.

func (*PublicEndpoint) SetLocation added in v1.15.7 

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

SetLocation sets the Location field's value.

func (*PublicEndpoint) SetMetrics added in v1.15.7 

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

SetMetrics sets the Metrics field's value.

func (*PublicEndpoint) SetOptOut added in v1.15.7 

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

SetOptOut sets the OptOut field's value.

func (*PublicEndpoint) SetRequestId added in v1.15.7 

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

SetRequestId sets the RequestId field's value.

func (*PublicEndpoint) SetUser added in v1.15.7 

func (s *PublicEndpoint) SetUser(v *EndpointUser) *PublicEndpoint

SetUser sets the User field's value.

func (PublicEndpoint) String added in v1.15.7 

func (s PublicEndpoint) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PushMessageActivity added in v1.31.12 

type PushMessageActivity struct {

	// Specifies the time to live (TTL) value for push notifications that are sent
	// to participants in a journey.
	MessageConfig *JourneyPushMessage `type:"structure"`

	// The unique identifier for the next activity to perform, after the message
	// is sent.
	NextActivity *string `type:"string"`

	// The name of the push notification template to use for the message. If specified,
	// this value must match the name of an existing message template.
	TemplateName *string `type:"string"`

	// The unique identifier for the version of the push notification template to
	// use for the message. If specified, this value must match the identifier for
	// an existing template version. To retrieve a list of versions and version
	// identifiers for a template, use the Template Versions resource.
	//
	// If you don't specify a value for this property, Amazon Pinpoint uses the
	// active version of the template. The active version is typically the version
	// of a template that's been most recently reviewed and approved for use, depending
	// on your workflow. It isn't necessarily the latest version of a template.
	TemplateVersion *string `type:"string"`
	// contains filtered or unexported fields
}

Specifies the settings for a push notification activity in a journey. This type of activity sends a push notification to participants.

func (PushMessageActivity) GoString added in v1.31.12 

func (s PushMessageActivity) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PushMessageActivity) SetMessageConfig added in v1.31.12 

func (s *PushMessageActivity) SetMessageConfig(v *JourneyPushMessage) *PushMessageActivity

SetMessageConfig sets the MessageConfig field's value.

func (*PushMessageActivity) SetNextActivity added in v1.31.12 

func (s *PushMessageActivity) SetNextActivity(v string) *PushMessageActivity

SetNextActivity sets the NextActivity field's value.

func (*PushMessageActivity) SetTemplateName added in v1.31.12 

func (s *PushMessageActivity) SetTemplateName(v string) *PushMessageActivity

SetTemplateName sets the TemplateName field's value.

func (*PushMessageActivity) SetTemplateVersion added in v1.31.12 

func (s *PushMessageActivity) SetTemplateVersion(v string) *PushMessageActivity

SetTemplateVersion sets the TemplateVersion field's value.

func (PushMessageActivity) String added in v1.31.12 

func (s PushMessageActivity) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PushNotificationTemplateRequest added in v1.25.7 

type PushNotificationTemplateRequest struct {

	// The message template to use for the ADM (Amazon Device Messaging) channel.
	// This message template overrides the default template for push notification
	// channels (DefaultPushNotificationTemplate).
	ADM *AndroidPushNotificationTemplate `type:"structure"`

	// The message template to use for the APNs (Apple Push Notification service)
	// channel. This message template overrides the default template for push notification
	// channels (DefaultPushNotificationTemplate).
	APNS *APNSPushNotificationTemplate `type:"structure"`

	// The message template to use for the Baidu (Baidu Cloud Push) channel. This
	// message template overrides the default template for push notification channels
	// (DefaultPushNotificationTemplate).
	Baidu *AndroidPushNotificationTemplate `type:"structure"`

	// The default message template to use for push notification channels.
	Default *DefaultPushNotificationTemplate `type:"structure"`

	// A JSON object that specifies the default values to use for message variables
	// in the message template. This object is a set of key-value pairs. Each key
	// defines a message variable in the template. The corresponding value defines
	// the default value for that variable. When you create a message that's based
	// on the template, you can override these defaults with message-specific and
	// address-specific variables and values.
	DefaultSubstitutions *string `type:"string"`

	// The message template to use for the GCM channel, which is used to send notifications
	// through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging
	// (GCM), service. This message template overrides the default template for
	// push notification channels (DefaultPushNotificationTemplate).
	GCM *AndroidPushNotificationTemplate `type:"structure"`

	// The unique identifier for the recommender model to use for the message template.
	// Amazon Pinpoint uses this value to determine how to retrieve and process
	// data from a recommender model when it sends messages that use the template,
	// if the template contains message variables for recommendation data.
	RecommenderId *string `type:"string"`

	// A string-to-string map of key-value pairs that defines the tags to associate
	// with the message template. Each tag consists of a required tag key and an
	// associated tag value.
	Tags map[string]*string `locationName:"tags" type:"map"`

	// A custom description of the message template.
	TemplateDescription *string `type:"string"`
	// contains filtered or unexported fields
}

Specifies the content and settings for a message template that can be used in messages that are sent through a push notification channel.

func (PushNotificationTemplateRequest) GoString added in v1.25.7 

func (s PushNotificationTemplateRequest) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PushNotificationTemplateRequest) SetADM added in v1.25.7 

func (s *PushNotificationTemplateRequest) SetADM(v *AndroidPushNotificationTemplate) *PushNotificationTemplateRequest

SetADM sets the ADM field's value.

func (*PushNotificationTemplateRequest) SetAPNS added in v1.25.7 

func (s *PushNotificationTemplateRequest) SetAPNS(v *APNSPushNotificationTemplate) *PushNotificationTemplateRequest

SetAPNS sets the APNS field's value.

func (*PushNotificationTemplateRequest) SetBaidu added in v1.25.7 

func (s *PushNotificationTemplateRequest) SetBaidu(v *AndroidPushNotificationTemplate) *PushNotificationTemplateRequest

SetBaidu sets the Baidu field's value.

func (*PushNotificationTemplateRequest) SetDefault added in v1.25.7 

func (s *PushNotificationTemplateRequest) SetDefault(v *DefaultPushNotificationTemplate) *PushNotificationTemplateRequest

SetDefault sets the Default field's value.

func (*PushNotificationTemplateRequest) SetDefaultSubstitutions added in v1.25.37 

func (s *PushNotificationTemplateRequest) SetDefaultSubstitutions(v string) *PushNotificationTemplateRequest

SetDefaultSubstitutions sets the DefaultSubstitutions field's value.

func (*PushNotificationTemplateRequest) SetGCM added in v1.25.7 

func (s *PushNotificationTemplateRequest) SetGCM(v *AndroidPushNotificationTemplate) *PushNotificationTemplateRequest

SetGCM sets the GCM field's value.

func (*PushNotificationTemplateRequest) SetRecommenderId added in v1.29.17 

func (s *PushNotificationTemplateRequest) SetRecommenderId(v string) *PushNotificationTemplateRequest

SetRecommenderId sets the RecommenderId field's value.

func (*PushNotificationTemplateRequest) SetTags added in v1.25.7 

func (s *PushNotificationTemplateRequest) SetTags(v map[string]*string) *PushNotificationTemplateRequest

SetTags sets the Tags field's value.

func (*PushNotificationTemplateRequest) SetTemplateDescription added in v1.25.37 

func (s *PushNotificationTemplateRequest) SetTemplateDescription(v string) *PushNotificationTemplateRequest

SetTemplateDescription sets the TemplateDescription field's value.

func (PushNotificationTemplateRequest) String added in v1.25.7 

func (s PushNotificationTemplateRequest) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PushNotificationTemplateResponse added in v1.25.7 

type PushNotificationTemplateResponse struct {

	// The message template that's used for the ADM (Amazon Device Messaging) channel.
	// This message template overrides the default template for push notification
	// channels (DefaultPushNotificationTemplate).
	ADM *AndroidPushNotificationTemplate `type:"structure"`

	// The message template that's used for the APNs (Apple Push Notification service)
	// channel. This message template overrides the default template for push notification
	// channels (DefaultPushNotificationTemplate).
	APNS *APNSPushNotificationTemplate `type:"structure"`

	// The Amazon Resource Name (ARN) of the message template.
	Arn *string `type:"string"`

	// The message template that's used for the Baidu (Baidu Cloud Push) channel.
	// This message template overrides the default template for push notification
	// channels (DefaultPushNotificationTemplate).
	Baidu *AndroidPushNotificationTemplate `type:"structure"`

	// The date, in ISO 8601 format, when the message template was created.
	//
	// CreationDate is a required field
	CreationDate *string `type:"string" required:"true"`

	// The default message template that's used for push notification channels.
	Default *DefaultPushNotificationTemplate `type:"structure"`

	// The JSON object that specifies the default values that are used for message
	// variables in the message template. This object is a set of key-value pairs.
	// Each key defines a message variable in the template. The corresponding value
	// defines the default value for that variable.
	DefaultSubstitutions *string `type:"string"`

	// The message template that's used for the GCM channel, which is used to send
	// notifications through the Firebase Cloud Messaging (FCM), formerly Google
	// Cloud Messaging (GCM), service. This message template overrides the default
	// template for push notification channels (DefaultPushNotificationTemplate).
	GCM *AndroidPushNotificationTemplate `type:"structure"`

	// The date, in ISO 8601 format, when the message template was last modified.
	//
	// LastModifiedDate is a required field
	LastModifiedDate *string `type:"string" required:"true"`

	// The unique identifier for the recommender model that's used by the message
	// template.
	RecommenderId *string `type:"string"`

	// A string-to-string map of key-value pairs that identifies the tags that are
	// associated with the message template. Each tag consists of a required tag
	// key and an associated tag value.
	Tags map[string]*string `locationName:"tags" type:"map"`

	// The custom description of the message template.
	TemplateDescription *string `type:"string"`

	// The name of the message template.
	//
	// TemplateName is a required field
	TemplateName *string `type:"string" required:"true"`

	// The type of channel that the message template is designed for. For a push
	// notification template, this value is PUSH.
	//
	// TemplateType is a required field
	TemplateType *string `type:"string" required:"true" enum:"TemplateType"`

	// The unique identifier, as an integer, for the active version of the message
	// template, or the version of the template that you specified by using the
	// version parameter in your request.
	Version *string `type:"string"`
	// contains filtered or unexported fields
}

Provides information about the content and settings for a message template that can be used in messages that are sent through a push notification channel.

func (PushNotificationTemplateResponse) GoString added in v1.25.7 

func (s PushNotificationTemplateResponse) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PushNotificationTemplateResponse) SetADM added in v1.25.7 

func (s *PushNotificationTemplateResponse) SetADM(v *AndroidPushNotificationTemplate) *PushNotificationTemplateResponse

SetADM sets the ADM field's value.

func (*PushNotificationTemplateResponse) SetAPNS added in v1.25.7 

func (s *PushNotificationTemplateResponse) SetAPNS(v *APNSPushNotificationTemplate) *PushNotificationTemplateResponse

SetAPNS sets the APNS field's value.

func (*PushNotificationTemplateResponse) SetArn added in v1.25.7 

func (s *PushNotificationTemplateResponse) SetArn(v string) *PushNotificationTemplateResponse

SetArn sets the Arn field's value.

func (*PushNotificationTemplateResponse) SetBaidu added in v1.25.7 

func (s *PushNotificationTemplateResponse) SetBaidu(v *AndroidPushNotificationTemplate) *PushNotificationTemplateResponse

SetBaidu sets the Baidu field's value.

func (*PushNotificationTemplateResponse) SetCreationDate added in v1.25.7 

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

SetCreationDate sets the CreationDate field's value.

func (*PushNotificationTemplateResponse) SetDefault added in v1.25.7 

func (s *PushNotificationTemplateResponse) SetDefault(v *DefaultPushNotificationTemplate) *PushNotificationTemplateResponse

SetDefault sets the Default field's value.

func (*PushNotificationTemplateResponse) SetDefaultSubstitutions added in v1.25.37 

func (s *PushNotificationTemplateResponse) SetDefaultSubstitutions(v string) *PushNotificationTemplateResponse

SetDefaultSubstitutions sets the DefaultSubstitutions field's value.

func (*PushNotificationTemplateResponse) SetGCM added in v1.25.7 

func (s *PushNotificationTemplateResponse) SetGCM(v *AndroidPushNotificationTemplate) *PushNotificationTemplateResponse

SetGCM sets the GCM field's value.

func (*PushNotificationTemplateResponse) SetLastModifiedDate added in v1.25.7 

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

SetLastModifiedDate sets the LastModifiedDate field's value.

func (*PushNotificationTemplateResponse) SetRecommenderId added in v1.29.17 

func (s *PushNotificationTemplateResponse) SetRecommenderId(v string) *PushNotificationTemplateResponse

SetRecommenderId sets the RecommenderId field's value.

func (*PushNotificationTemplateResponse) SetTags added in v1.25.7 

func (s *PushNotificationTemplateResponse) SetTags(v map[string]*string) *PushNotificationTemplateResponse

SetTags sets the Tags field's value.

func (*PushNotificationTemplateResponse) SetTemplateDescription added in v1.25.37 

func (s *PushNotificationTemplateResponse) SetTemplateDescription(v string) *PushNotificationTemplateResponse

SetTemplateDescription sets the TemplateDescription field's value.

func (*PushNotificationTemplateResponse) SetTemplateName added in v1.25.7 

func (s *PushNotificationTemplateResponse) SetTemplateName(v string) *PushNotificationTemplateResponse

SetTemplateName sets the TemplateName field's value.

func (*PushNotificationTemplateResponse) SetTemplateType added in v1.25.7 

func (s *PushNotificationTemplateResponse) SetTemplateType(v string) *PushNotificationTemplateResponse

SetTemplateType sets the TemplateType field's value.

func (*PushNotificationTemplateResponse) SetVersion added in v1.26.7 

func (s *PushNotificationTemplateResponse) SetVersion(v string) *PushNotificationTemplateResponse

SetVersion sets the Version field's value.

func (PushNotificationTemplateResponse) String added in v1.25.7 

func (s PushNotificationTemplateResponse) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PutEventStreamInput added in v1.8.0 

type PutEventStreamInput struct {

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

	// Specifies the Amazon Resource Name (ARN) of an event stream to publish events
	// to and the AWS Identity and Access Management (IAM) role to use when publishing
	// those events.
	//
	// WriteEventStream is a required field
	WriteEventStream *WriteEventStream `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (PutEventStreamInput) GoString added in v1.8.0 

func (s PutEventStreamInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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 {

	// Specifies settings for publishing event data to an Amazon Kinesis data stream
	// or an Amazon Kinesis Data Firehose delivery stream.
	//
	// EventStream is a required field
	EventStream *EventStream `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (PutEventStreamOutput) GoString added in v1.8.0 

func (s PutEventStreamOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PutEventsInput added in v1.15.7 

type PutEventsInput struct {

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

	// Specifies a batch of events to process.
	//
	// EventsRequest is a required field
	EventsRequest *EventsRequest `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (PutEventsInput) GoString added in v1.15.7 

func (s PutEventsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutEventsInput) SetApplicationId added in v1.15.7 

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

SetApplicationId sets the ApplicationId field's value.

func (*PutEventsInput) SetEventsRequest added in v1.15.7 

func (s *PutEventsInput) SetEventsRequest(v *EventsRequest) *PutEventsInput

SetEventsRequest sets the EventsRequest field's value.

func (PutEventsInput) String added in v1.15.7 

func (s PutEventsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutEventsInput) Validate added in v1.15.7 

func (s *PutEventsInput) Validate() error

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

type PutEventsOutput added in v1.15.7 

type PutEventsOutput struct {

	// Provides information about endpoints and the events that they're associated
	// with.
	//
	// EventsResponse is a required field
	EventsResponse *EventsResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (PutEventsOutput) GoString added in v1.15.7 

func (s PutEventsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutEventsOutput) SetEventsResponse added in v1.15.7 

func (s *PutEventsOutput) SetEventsResponse(v *EventsResponse) *PutEventsOutput

SetEventsResponse sets the EventsResponse field's value.

func (PutEventsOutput) String added in v1.15.7 

func (s PutEventsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type QuietTime 

type QuietTime struct {

	// The specific time when quiet time ends. This value has to use 24-hour notation
	// and be in HH:MM format, where HH is the hour (with a leading zero, if applicable)
	// and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30
	// to represent 2:30 PM.
	End *string `type:"string"`

	// The specific time when quiet time begins. This value has to use 24-hour notation
	// and be in HH:MM format, where HH is the hour (with a leading zero, if applicable)
	// and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30
	// to represent 2:30 PM.
	Start *string `type:"string"`
	// contains filtered or unexported fields
}

Specifies the start and end times that define a time range when messages aren't sent to endpoints.

func (QuietTime) GoString 

func (s QuietTime) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RandomSplitActivity added in v1.25.25 

type RandomSplitActivity struct {

	// The paths for the activity, including the percentage of participants to enter
	// each path and the activity to perform for each path.
	Branches []*RandomSplitEntry `type:"list"`
	// contains filtered or unexported fields
}

Specifies the settings for a random split activity in a journey. This type of activity randomly sends specified percentages of participants down one of as many as five paths in a journey, based on conditions that you specify.

func (RandomSplitActivity) GoString added in v1.25.25 

func (s RandomSplitActivity) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RandomSplitActivity) SetBranches added in v1.25.25 

func (s *RandomSplitActivity) SetBranches(v []*RandomSplitEntry) *RandomSplitActivity

SetBranches sets the Branches field's value.

func (RandomSplitActivity) String added in v1.25.25 

func (s RandomSplitActivity) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RandomSplitEntry added in v1.25.25 

type RandomSplitEntry struct {

	// The unique identifier for the next activity to perform, after completing
	// the activity for the path.
	NextActivity *string `type:"string"`

	// The percentage of participants to send down the activity path.
	//
	// To determine which participants are sent down each path, Amazon Pinpoint
	// applies a probability-based algorithm to the percentages that you specify
	// for the paths. Therefore, the actual percentage of participants who are sent
	// down a path may not be equal to the percentage that you specify.
	Percentage *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Specifies the settings for a path in a random split activity in a journey.

func (RandomSplitEntry) GoString added in v1.25.25 

func (s RandomSplitEntry) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RandomSplitEntry) SetNextActivity added in v1.25.25 

func (s *RandomSplitEntry) SetNextActivity(v string) *RandomSplitEntry

SetNextActivity sets the NextActivity field's value.

func (*RandomSplitEntry) SetPercentage added in v1.25.25 

func (s *RandomSplitEntry) SetPercentage(v int64) *RandomSplitEntry

SetPercentage sets the Percentage field's value.

func (RandomSplitEntry) String added in v1.25.25 

func (s RandomSplitEntry) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RawEmail added in v1.15.70 

type RawEmail struct {

	// Data is automatically base64 encoded/decoded by the SDK.
	Data []byte `type:"blob"`
	// contains filtered or unexported fields
}

Specifies the contents of an email message, represented as a raw MIME message.

func (RawEmail) GoString added in v1.15.70 

func (s RawEmail) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RawEmail) SetData added in v1.15.70 

func (s *RawEmail) SetData(v []byte) *RawEmail

SetData sets the Data field's value.

func (RawEmail) String added in v1.15.70 

func (s RawEmail) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RecencyDimension 

type RecencyDimension struct {

	// The duration to use when determining whether an endpoint is active or inactive.
	//
	// Duration is a required field
	Duration *string `type:"string" required:"true" enum:"Duration"`

	// The type of recency dimension to use for the segment. Valid values are: ACTIVE,
	// endpoints that were active within the specified duration are included in
	// the segment; and, INACTIVE, endpoints that weren't active within the specified
	// duration are included in the segment.
	//
	// RecencyType is a required field
	RecencyType *string `type:"string" required:"true" enum:"RecencyType"`
	// contains filtered or unexported fields
}

Specifies criteria for including or excluding endpoints from a segment based on how recently an endpoint was active.

func (RecencyDimension) GoString 

func (s RecencyDimension) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RecencyDimension) Validate added in v1.20.11 

func (s *RecencyDimension) Validate() error

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

type RecommenderConfigurationResponse added in v1.29.17 

type RecommenderConfigurationResponse struct {

	// A map that defines 1-10 custom endpoint or user attributes, depending on
	// the value for the RecommendationProviderIdType property. Each of these attributes
	// temporarily stores a recommended item that's retrieved from the recommender
	// model and sent to an AWS Lambda function for additional processing. Each
	// attribute can be used as a message variable in a message template.
	//
	// This value is null if the configuration doesn't invoke an AWS Lambda function
	// (RecommendationTransformerUri) to perform additional processing of recommendation
	// data.
	Attributes map[string]*string `type:"map"`

	// The date, in extended ISO 8601 format, when the configuration was created
	// for the recommender model.
	//
	// CreationDate is a required field
	CreationDate *string `type:"string" required:"true"`

	// The custom description of the configuration for the recommender model.
	Description *string `type:"string"`

	// The unique identifier for the recommender model configuration.
	//
	// Id is a required field
	Id *string `type:"string" required:"true"`

	// The date, in extended ISO 8601 format, when the configuration for the recommender
	// model was last modified.
	//
	// LastModifiedDate is a required field
	LastModifiedDate *string `type:"string" required:"true"`

	// The custom name of the configuration for the recommender model.
	Name *string `type:"string"`

	// The type of Amazon Pinpoint ID that's associated with unique user IDs in
	// the recommender model. This value enables the model to use attribute and
	// event data that’s specific to a particular endpoint or user in an Amazon
	// Pinpoint application. Possible values are:
	//
	//    * PINPOINT_ENDPOINT_ID - Each user in the model is associated with a particular
	//    endpoint in Amazon Pinpoint. The data is correlated based on endpoint
	//    IDs in Amazon Pinpoint. This is the default value.
	//
	//    * PINPOINT_USER_ID - Each user in the model is associated with a particular
	//    user and endpoint in Amazon Pinpoint. The data is correlated based on
	//    user IDs in Amazon Pinpoint. If this value is specified, an endpoint definition
	//    in Amazon Pinpoint has to specify both a user ID (UserId) and an endpoint
	//    ID. Otherwise, messages won’t be sent to the user's endpoint.
	RecommendationProviderIdType *string `type:"string"`

	// The Amazon Resource Name (ARN) of the AWS Identity and Access Management
	// (IAM) role that authorizes Amazon Pinpoint to retrieve recommendation data
	// from the recommender model.
	//
	// RecommendationProviderRoleArn is a required field
	RecommendationProviderRoleArn *string `type:"string" required:"true"`

	// The Amazon Resource Name (ARN) of the recommender model that Amazon Pinpoint
	// retrieves the recommendation data from. This value is the ARN of an Amazon
	// Personalize campaign.
	//
	// RecommendationProviderUri is a required field
	RecommendationProviderUri *string `type:"string" required:"true"`

	// The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon
	// Pinpoint invokes to perform additional processing of recommendation data
	// that it retrieves from the recommender model.
	RecommendationTransformerUri *string `type:"string"`

	// The custom display name for the standard endpoint or user attribute (RecommendationItems)
	// that temporarily stores recommended items for each endpoint or user, depending
	// on the value for the RecommendationProviderIdType property. This name appears
	// in the Attribute finder of the template editor on the Amazon Pinpoint console.
	//
	// This value is null if the configuration doesn't invoke an AWS Lambda function
	// (RecommendationTransformerUri) to perform additional processing of recommendation
	// data.
	RecommendationsDisplayName *string `type:"string"`

	// The number of recommended items that are retrieved from the model for each
	// endpoint or user, depending on the value for the RecommendationProviderIdType
	// property. This number determines how many recommended items are available
	// for use in message variables.
	RecommendationsPerMessage *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Provides information about Amazon Pinpoint configuration settings for retrieving and processing data from a recommender model.

func (RecommenderConfigurationResponse) GoString added in v1.29.17 

func (s RecommenderConfigurationResponse) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RecommenderConfigurationResponse) SetAttributes added in v1.29.17 

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

SetAttributes sets the Attributes field's value.

func (*RecommenderConfigurationResponse) SetCreationDate added in v1.29.17 

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

SetCreationDate sets the CreationDate field's value.

func (*RecommenderConfigurationResponse) SetDescription added in v1.29.17 

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

SetDescription sets the Description field's value.

func (*RecommenderConfigurationResponse) SetId added in v1.29.17 

func (s *RecommenderConfigurationResponse) SetId(v string) *RecommenderConfigurationResponse

SetId sets the Id field's value.

func (*RecommenderConfigurationResponse) SetLastModifiedDate added in v1.29.17 

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

SetLastModifiedDate sets the LastModifiedDate field's value.

func (*RecommenderConfigurationResponse) SetName added in v1.29.17 

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

SetName sets the Name field's value.

func (*RecommenderConfigurationResponse) SetRecommendationProviderIdType added in v1.29.17 

func (s *RecommenderConfigurationResponse) SetRecommendationProviderIdType(v string) *RecommenderConfigurationResponse

SetRecommendationProviderIdType sets the RecommendationProviderIdType field's value.

func (*RecommenderConfigurationResponse) SetRecommendationProviderRoleArn added in v1.29.17 

func (s *RecommenderConfigurationResponse) SetRecommendationProviderRoleArn(v string) *RecommenderConfigurationResponse

SetRecommendationProviderRoleArn sets the RecommendationProviderRoleArn field's value.

func (*RecommenderConfigurationResponse) SetRecommendationProviderUri added in v1.29.17 

func (s *RecommenderConfigurationResponse) SetRecommendationProviderUri(v string) *RecommenderConfigurationResponse

SetRecommendationProviderUri sets the RecommendationProviderUri field's value.

func (*RecommenderConfigurationResponse) SetRecommendationTransformerUri added in v1.29.17 

func (s *RecommenderConfigurationResponse) SetRecommendationTransformerUri(v string) *RecommenderConfigurationResponse

SetRecommendationTransformerUri sets the RecommendationTransformerUri field's value.

func (*RecommenderConfigurationResponse) SetRecommendationsDisplayName added in v1.29.17 

func (s *RecommenderConfigurationResponse) SetRecommendationsDisplayName(v string) *RecommenderConfigurationResponse

SetRecommendationsDisplayName sets the RecommendationsDisplayName field's value.

func (*RecommenderConfigurationResponse) SetRecommendationsPerMessage added in v1.29.17 

func (s *RecommenderConfigurationResponse) SetRecommendationsPerMessage(v int64) *RecommenderConfigurationResponse

SetRecommendationsPerMessage sets the RecommendationsPerMessage field's value.

func (RecommenderConfigurationResponse) String added in v1.29.17 

func (s RecommenderConfigurationResponse) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RemoveAttributesInput added in v1.14.20 

type RemoveAttributesInput struct {

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

	// AttributeType is a required field
	AttributeType *string `location:"uri" locationName:"attribute-type" type:"string" required:"true"`

	// Specifies one or more attributes to remove from all the endpoints that are
	// associated with an application.
	//
	// UpdateAttributesRequest is a required field
	UpdateAttributesRequest *UpdateAttributesRequest `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (RemoveAttributesInput) GoString added in v1.14.20 

func (s RemoveAttributesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RemoveAttributesInput) SetApplicationId added in v1.14.20 

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

SetApplicationId sets the ApplicationId field's value.

func (*RemoveAttributesInput) SetAttributeType added in v1.14.20 

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

SetAttributeType sets the AttributeType field's value.

func (*RemoveAttributesInput) SetUpdateAttributesRequest added in v1.14.20 

func (s *RemoveAttributesInput) SetUpdateAttributesRequest(v *UpdateAttributesRequest) *RemoveAttributesInput

SetUpdateAttributesRequest sets the UpdateAttributesRequest field's value.

func (RemoveAttributesInput) String added in v1.14.20 

func (s RemoveAttributesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RemoveAttributesInput) Validate added in v1.14.20 

func (s *RemoveAttributesInput) Validate() error

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

type RemoveAttributesOutput added in v1.14.20 

type RemoveAttributesOutput struct {

	// Provides information about the type and the names of attributes that were
	// removed from all the endpoints that are associated with an application.
	//
	// AttributesResource is a required field
	AttributesResource *AttributesResource `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (RemoveAttributesOutput) GoString added in v1.14.20 

func (s RemoveAttributesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RemoveAttributesOutput) SetAttributesResource added in v1.14.20 

func (s *RemoveAttributesOutput) SetAttributesResource(v *AttributesResource) *RemoveAttributesOutput

SetAttributesResource sets the AttributesResource field's value.

func (RemoveAttributesOutput) String added in v1.14.20 

func (s RemoveAttributesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ResultRow added in v1.21.4 

type ResultRow struct {

	// An array of objects that defines the field and field values that were used
	// to group data in a result set that contains multiple results. This value
	// is null if the data in a result set isn’t grouped.
	//
	// GroupedBys is a required field
	GroupedBys []*ResultRowValue `type:"list" required:"true"`

	// An array of objects that provides pre-aggregated values for a standard metric
	// that applies to an application, campaign, or journey.
	//
	// Values is a required field
	Values []*ResultRowValue `type:"list" required:"true"`
	// contains filtered or unexported fields
}

Provides the results of a query that retrieved the data for a standard metric that applies to an application, campaign, or journey.

func (ResultRow) GoString added in v1.21.4 

func (s ResultRow) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResultRow) SetGroupedBys added in v1.21.4 

func (s *ResultRow) SetGroupedBys(v []*ResultRowValue) *ResultRow

SetGroupedBys sets the GroupedBys field's value.

func (*ResultRow) SetValues added in v1.21.4 

func (s *ResultRow) SetValues(v []*ResultRowValue) *ResultRow

SetValues sets the Values field's value.

func (ResultRow) String added in v1.21.4 

func (s ResultRow) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ResultRowValue added in v1.21.4 

type ResultRowValue struct {

	// The friendly name of the metric whose value is specified by the Value property.
	//
	// Key is a required field
	Key *string `type:"string" required:"true"`

	// The data type of the value specified by the Value property.
	//
	// Type is a required field
	Type *string `type:"string" required:"true"`

	// In a Values object, the value for the metric that the query retrieved data
	// for. In a GroupedBys object, the value for the field that was used to group
	// data in a result set that contains multiple results (Values objects).
	//
	// Value is a required field
	Value *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Provides a single value and metadata about that value as part of an array of query results for a standard metric that applies to an application, campaign, or journey.

func (ResultRowValue) GoString added in v1.21.4 

func (s ResultRowValue) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResultRowValue) SetKey added in v1.21.4 

func (s *ResultRowValue) SetKey(v string) *ResultRowValue

SetKey sets the Key field's value.

func (*ResultRowValue) SetType added in v1.21.4 

func (s *ResultRowValue) SetType(v string) *ResultRowValue

SetType sets the Type field's value.

func (*ResultRowValue) SetValue added in v1.21.4 

func (s *ResultRowValue) SetValue(v string) *ResultRowValue

SetValue sets the Value field's value.

func (ResultRowValue) String added in v1.21.4 

func (s ResultRowValue) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SMSChannelRequest added in v1.8.38 

type SMSChannelRequest struct {

	// Specifies whether to enable the SMS channel for the application.
	Enabled *bool `type:"boolean"`

	// The identity that you want to display on recipients' devices when they receive
	// messages from the SMS channel.
	SenderId *string `type:"string"`

	// The registered short code that you want to use when you send messages through
	// the SMS channel.
	ShortCode *string `type:"string"`
	// contains filtered or unexported fields
}

Specifies the status and settings of the SMS channel for an application.

func (SMSChannelRequest) GoString added in v1.8.38 

func (s SMSChannelRequest) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SMSChannelResponse added in v1.8.38 

type SMSChannelResponse struct {

	// The unique identifier for the application that the SMS channel applies to.
	ApplicationId *string `type:"string"`

	// The date and time, in ISO 8601 format, when the SMS channel was enabled.
	CreationDate *string `type:"string"`

	// Specifies whether the SMS channel is enabled for the application.
	Enabled *bool `type:"boolean"`

	// (Not used) This property is retained only for backward compatibility.
	HasCredential *bool `type:"boolean"`

	// (Deprecated) An identifier for the SMS channel. This property is retained
	// only for backward compatibility.
	Id *string `type:"string"`

	// Specifies whether the SMS channel is archived.
	IsArchived *bool `type:"boolean"`

	// The user who last modified the SMS channel.
	LastModifiedBy *string `type:"string"`

	// The date and time, in ISO 8601 format, when the SMS channel was last modified.
	LastModifiedDate *string `type:"string"`

	// The type of messaging or notification platform for the channel. For the SMS
	// channel, this value is SMS.
	//
	// Platform is a required field
	Platform *string `type:"string" required:"true"`

	// The maximum number of promotional messages that you can send through the
	// SMS channel each second.
	PromotionalMessagesPerSecond *int64 `type:"integer"`

	// The identity that displays on recipients' devices when they receive messages
	// from the SMS channel.
	SenderId *string `type:"string"`

	// The registered short code to use when you send messages through the SMS channel.
	ShortCode *string `type:"string"`

	// The maximum number of transactional messages that you can send through the
	// SMS channel each second.
	TransactionalMessagesPerSecond *int64 `type:"integer"`

	// The current version of the SMS channel.
	Version *int64 `type:"integer"`
	// contains filtered or unexported fields
}

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

func (SMSChannelResponse) GoString added in v1.8.38 

func (s SMSChannelResponse) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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 

func (s *SMSChannelResponse) SetId(v string) *SMSChannelResponse

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) SetPromotionalMessagesPerSecond added in v1.14.20 

func (s *SMSChannelResponse) SetPromotionalMessagesPerSecond(v int64) *SMSChannelResponse

SetPromotionalMessagesPerSecond sets the PromotionalMessagesPerSecond 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) SetTransactionalMessagesPerSecond added in v1.14.20 

func (s *SMSChannelResponse) SetTransactionalMessagesPerSecond(v int64) *SMSChannelResponse

SetTransactionalMessagesPerSecond sets the TransactionalMessagesPerSecond 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SMSMessage added in v1.8.38 

type SMSMessage struct {

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

	// The entity ID or Principal Entity (PE) id received from the regulatory body
	// for sending SMS in your country.
	EntityId *string `type:"string"`

	// The SMS program name that you provided to AWS Support when you requested
	// your dedicated number.
	Keyword *string `type:"string"`

	// This field is reserved for future use.
	MediaUrl *string `type:"string"`

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

	// The number to send the SMS message from. This value should be one of the
	// dedicated long or short codes that's assigned to your AWS account. If you
	// don't specify a long or short code, Amazon Pinpoint assigns a random long
	// code to the SMS message and sends the message from that code.
	OriginationNumber *string `type:"string"`

	// The sender ID to display as the sender of the message on a recipient's device.
	// Support for sender IDs varies by country or region.
	SenderId *string `type:"string"`

	// The message variables to use in the SMS message. You can override the default
	// variables with individual address variables.
	Substitutions map[string][]*string `type:"map"`

	// The template ID received from the regulatory body for sending SMS in your
	// country.
	TemplateId *string `type:"string"`
	// contains filtered or unexported fields
}

Specifies the default settings for a one-time SMS message that's sent directly to an endpoint.

func (SMSMessage) GoString added in v1.8.38 

func (s SMSMessage) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SMSMessage) SetBody added in v1.8.38 

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

SetBody sets the Body field's value.

func (*SMSMessage) SetEntityId added in v1.37.17 

func (s *SMSMessage) SetEntityId(v string) *SMSMessage

SetEntityId sets the EntityId field's value.

func (*SMSMessage) SetKeyword added in v1.14.20 

func (s *SMSMessage) SetKeyword(v string) *SMSMessage

SetKeyword sets the Keyword field's value.

func (*SMSMessage) SetMediaUrl added in v1.30.1 

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

SetMediaUrl sets the MediaUrl 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) SetTemplateId added in v1.37.17 

func (s *SMSMessage) SetTemplateId(v string) *SMSMessage

SetTemplateId sets the TemplateId field's value.

func (SMSMessage) String added in v1.8.38 

func (s SMSMessage) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SMSMessageActivity added in v1.31.12 

type SMSMessageActivity struct {

	// Specifies the sender ID and message type for an SMS message that's sent to
	// participants in a journey.
	MessageConfig *JourneySMSMessage `type:"structure"`

	// The unique identifier for the next activity to perform, after the message
	// is sent.
	NextActivity *string `type:"string"`

	// The name of the SMS message template to use for the message. If specified,
	// this value must match the name of an existing message template.
	TemplateName *string `type:"string"`

	// The unique identifier for the version of the SMS template to use for the
	// message. If specified, this value must match the identifier for an existing
	// template version. To retrieve a list of versions and version identifiers
	// for a template, use the Template Versions resource.
	//
	// If you don't specify a value for this property, Amazon Pinpoint uses the
	// active version of the template. The active version is typically the version
	// of a template that's been most recently reviewed and approved for use, depending
	// on your workflow. It isn't necessarily the latest version of a template.
	TemplateVersion *string `type:"string"`
	// contains filtered or unexported fields
}

Specifies the settings for an SMS activity in a journey. This type of activity sends a text message to participants.

func (SMSMessageActivity) GoString added in v1.31.12 

func (s SMSMessageActivity) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SMSMessageActivity) SetMessageConfig added in v1.31.12 

func (s *SMSMessageActivity) SetMessageConfig(v *JourneySMSMessage) *SMSMessageActivity

SetMessageConfig sets the MessageConfig field's value.

func (*SMSMessageActivity) SetNextActivity added in v1.31.12 

func (s *SMSMessageActivity) SetNextActivity(v string) *SMSMessageActivity

SetNextActivity sets the NextActivity field's value.

func (*SMSMessageActivity) SetTemplateName added in v1.31.12 

func (s *SMSMessageActivity) SetTemplateName(v string) *SMSMessageActivity

SetTemplateName sets the TemplateName field's value.

func (*SMSMessageActivity) SetTemplateVersion added in v1.31.12 

func (s *SMSMessageActivity) SetTemplateVersion(v string) *SMSMessageActivity

SetTemplateVersion sets the TemplateVersion field's value.

func (SMSMessageActivity) String added in v1.31.12 

func (s SMSMessageActivity) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SMSTemplateRequest added in v1.25.7 

type SMSTemplateRequest struct {

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

	// A JSON object that specifies the default values to use for message variables
	// in the message template. This object is a set of key-value pairs. Each key
	// defines a message variable in the template. The corresponding value defines
	// the default value for that variable. When you create a message that's based
	// on the template, you can override these defaults with message-specific and
	// address-specific variables and values.
	DefaultSubstitutions *string `type:"string"`

	// The unique identifier for the recommender model to use for the message template.
	// Amazon Pinpoint uses this value to determine how to retrieve and process
	// data from a recommender model when it sends messages that use the template,
	// if the template contains message variables for recommendation data.
	RecommenderId *string `type:"string"`

	// A string-to-string map of key-value pairs that defines the tags to associate
	// with the message template. Each tag consists of a required tag key and an
	// associated tag value.
	Tags map[string]*string `locationName:"tags" type:"map"`

	// A custom description of the message template.
	TemplateDescription *string `type:"string"`
	// contains filtered or unexported fields
}

Specifies the content and settings for a message template that can be used in text messages that are sent through the SMS channel.

func (SMSTemplateRequest) GoString added in v1.25.7 

func (s SMSTemplateRequest) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SMSTemplateRequest) SetBody added in v1.25.7 

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

SetBody sets the Body field's value.

func (*SMSTemplateRequest) SetDefaultSubstitutions added in v1.25.37 

func (s *SMSTemplateRequest) SetDefaultSubstitutions(v string) *SMSTemplateRequest

SetDefaultSubstitutions sets the DefaultSubstitutions field's value.

func (*SMSTemplateRequest) SetRecommenderId added in v1.29.17 

func (s *SMSTemplateRequest) SetRecommenderId(v string) *SMSTemplateRequest

SetRecommenderId sets the RecommenderId field's value.

func (*SMSTemplateRequest) SetTags added in v1.25.7 

func (s *SMSTemplateRequest) SetTags(v map[string]*string) *SMSTemplateRequest

SetTags sets the Tags field's value.

func (*SMSTemplateRequest) SetTemplateDescription added in v1.25.37 

func (s *SMSTemplateRequest) SetTemplateDescription(v string) *SMSTemplateRequest

SetTemplateDescription sets the TemplateDescription field's value.

func (SMSTemplateRequest) String added in v1.25.7 

func (s SMSTemplateRequest) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SMSTemplateResponse added in v1.25.7 

type SMSTemplateResponse struct {

	// The Amazon Resource Name (ARN) of the message template.
	Arn *string `type:"string"`

	// The message body that's used in text messages that are based on the message
	// template.
	Body *string `type:"string"`

	// The date, in ISO 8601 format, when the message template was created.
	//
	// CreationDate is a required field
	CreationDate *string `type:"string" required:"true"`

	// The JSON object that specifies the default values that are used for message
	// variables in the message template. This object is a set of key-value pairs.
	// Each key defines a message variable in the template. The corresponding value
	// defines the default value for that variable.
	DefaultSubstitutions *string `type:"string"`

	// The date, in ISO 8601 format, when the message template was last modified.
	//
	// LastModifiedDate is a required field
	LastModifiedDate *string `type:"string" required:"true"`

	// The unique identifier for the recommender model that's used by the message
	// template.
	RecommenderId *string `type:"string"`

	// A string-to-string map of key-value pairs that identifies the tags that are
	// associated with the message template. Each tag consists of a required tag
	// key and an associated tag value.
	Tags map[string]*string `locationName:"tags" type:"map"`

	// The custom description of the message template.
	TemplateDescription *string `type:"string"`

	// The name of the message template.
	//
	// TemplateName is a required field
	TemplateName *string `type:"string" required:"true"`

	// The type of channel that the message template is designed for. For an SMS
	// template, this value is SMS.
	//
	// TemplateType is a required field
	TemplateType *string `type:"string" required:"true" enum:"TemplateType"`

	// The unique identifier, as an integer, for the active version of the message
	// template, or the version of the template that you specified by using the
	// version parameter in your request.
	Version *string `type:"string"`
	// contains filtered or unexported fields
}

Provides information about the content and settings for a message template that can be used in text messages that are sent through the SMS channel.

func (SMSTemplateResponse) GoString added in v1.25.7 

func (s SMSTemplateResponse) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SMSTemplateResponse) SetArn added in v1.25.7 

func (s *SMSTemplateResponse) SetArn(v string) *SMSTemplateResponse

SetArn sets the Arn field's value.

func (*SMSTemplateResponse) SetBody added in v1.25.7 

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

SetBody sets the Body field's value.

func (*SMSTemplateResponse) SetCreationDate added in v1.25.7 

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

SetCreationDate sets the CreationDate field's value.

func (*SMSTemplateResponse) SetDefaultSubstitutions added in v1.25.37 

func (s *SMSTemplateResponse) SetDefaultSubstitutions(v string) *SMSTemplateResponse

SetDefaultSubstitutions sets the DefaultSubstitutions field's value.

func (*SMSTemplateResponse) SetLastModifiedDate added in v1.25.7 

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

SetLastModifiedDate sets the LastModifiedDate field's value.

func (*SMSTemplateResponse) SetRecommenderId added in v1.29.17 

func (s *SMSTemplateResponse) SetRecommenderId(v string) *SMSTemplateResponse

SetRecommenderId sets the RecommenderId field's value.

func (*SMSTemplateResponse) SetTags added in v1.25.7 

func (s *SMSTemplateResponse) SetTags(v map[string]*string) *SMSTemplateResponse

SetTags sets the Tags field's value.

func (*SMSTemplateResponse) SetTemplateDescription added in v1.25.37 

func (s *SMSTemplateResponse) SetTemplateDescription(v string) *SMSTemplateResponse

SetTemplateDescription sets the TemplateDescription field's value.

func (*SMSTemplateResponse) SetTemplateName added in v1.25.7 

func (s *SMSTemplateResponse) SetTemplateName(v string) *SMSTemplateResponse

SetTemplateName sets the TemplateName field's value.

func (*SMSTemplateResponse) SetTemplateType added in v1.25.7 

func (s *SMSTemplateResponse) SetTemplateType(v string) *SMSTemplateResponse

SetTemplateType sets the TemplateType field's value.

func (*SMSTemplateResponse) SetVersion added in v1.26.7 

func (s *SMSTemplateResponse) SetVersion(v string) *SMSTemplateResponse

SetVersion sets the Version field's value.

func (SMSTemplateResponse) String added in v1.25.7 

func (s SMSTemplateResponse) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Schedule 

type Schedule struct {

	// The scheduled time, in ISO 8601 format, when the campaign ended or will end.
	EndTime *string `type:"string"`

	// The type of event that causes the campaign to be sent, if the value of the
	// Frequency property is EVENT.
	EventFilter *CampaignEventFilter `type:"structure"`

	// Specifies how often the campaign is sent or whether the campaign is sent
	// in response to a specific event.
	Frequency *string `type:"string" enum:"Frequency"`

	// Specifies whether the start and end times for the campaign schedule use each
	// recipient's local time. To base the schedule on each recipient's local time,
	// set this value to true.
	IsLocalTime *bool `type:"boolean"`

	// The default quiet time for the campaign. Quiet time is a specific time range
	// when a campaign doesn't send messages to endpoints, if all the following
	// conditions are met:
	//
	//    * The EndpointDemographic.Timezone property of the endpoint is set to
	//    a valid value.
	//
	//    * The current time in the endpoint's time zone is later than or equal
	//    to the time specified by the QuietTime.Start property for the campaign.
	//
	//    * The current time in the endpoint's time zone is earlier than or equal
	//    to the time specified by the QuietTime.End property for the campaign.
	//
	// If any of the preceding conditions isn't met, the endpoint will receive messages
	// from the campaign, even if quiet time is enabled.
	QuietTime *QuietTime `type:"structure"`

	// The scheduled time when the campaign began or will begin. Valid values are:
	// IMMEDIATE, to start the campaign immediately; or, a specific time in ISO
	// 8601 format.
	//
	// StartTime is a required field
	StartTime *string `type:"string" required:"true"`

	// The starting UTC offset for the campaign schedule, if the value of the IsLocalTime
	// property is true. Valid values are: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30,
	// UTC+04, UTC+04:30, UTC+05, UTC+05:30, UTC+05:45, UTC+06, UTC+06:30, UTC+07,
	// UTC+08, UTC+09, UTC+09:30, UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+13, UTC-02,
	// UTC-03, UTC-04, UTC-05, UTC-06, UTC-07, UTC-08, UTC-09, UTC-10, and UTC-11.
	Timezone *string `type:"string"`
	// contains filtered or unexported fields
}

Specifies the schedule settings for a campaign.

func (Schedule) GoString 

func (s Schedule) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Schedule) SetEndTime 

func (s *Schedule) SetEndTime(v string) *Schedule

SetEndTime sets the EndTime field's value.

func (*Schedule) SetEventFilter added in v1.15.77 

func (s *Schedule) SetEventFilter(v *CampaignEventFilter) *Schedule

SetEventFilter sets the EventFilter 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Schedule) Validate added in v1.20.11 

func (s *Schedule) Validate() error

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

type SegmentBehaviors 

type SegmentBehaviors struct {

	// The dimension settings that are based on how recently an endpoint was active.
	Recency *RecencyDimension `type:"structure"`
	// contains filtered or unexported fields
}

Specifies dimension settings for including or excluding endpoints from a segment based on how recently an endpoint was active.

func (SegmentBehaviors) GoString 

func (s SegmentBehaviors) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SegmentBehaviors) SetRecency 

func (s *SegmentBehaviors) SetRecency(v *RecencyDimension) *SegmentBehaviors

SetRecency sets the Recency field's value.

func (SegmentBehaviors) String 

func (s SegmentBehaviors) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SegmentBehaviors) Validate added in v1.20.11 

func (s *SegmentBehaviors) Validate() error

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

type SegmentCondition added in v1.25.25 

type SegmentCondition struct {

	// The unique identifier for the segment to associate with the activity.
	//
	// SegmentId is a required field
	SegmentId *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Specifies a segment to associate with an activity in a journey.

func (SegmentCondition) GoString added in v1.25.25 

func (s SegmentCondition) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SegmentCondition) SetSegmentId added in v1.25.25 

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

SetSegmentId sets the SegmentId field's value.

func (SegmentCondition) String added in v1.25.25 

func (s SegmentCondition) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SegmentCondition) Validate added in v1.25.25 

func (s *SegmentCondition) Validate() error

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

type SegmentDemographics 

type SegmentDemographics struct {

	// The app version criteria for the segment.
	AppVersion *SetDimension `type:"structure"`

	// The channel criteria for the segment.
	Channel *SetDimension `type:"structure"`

	// The device type criteria for the segment.
	DeviceType *SetDimension `type:"structure"`

	// The device make criteria for the segment.
	Make *SetDimension `type:"structure"`

	// The device model criteria for the segment.
	Model *SetDimension `type:"structure"`

	// The device platform criteria for the segment.
	Platform *SetDimension `type:"structure"`
	// contains filtered or unexported fields
}

Specifies demographic-based dimension settings for including or excluding endpoints from a segment. These settings derive from characteristics of endpoint devices, such as platform, make, and model.

func (SegmentDemographics) GoString 

func (s SegmentDemographics) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SegmentDemographics) SetAppVersion 

func (s *SegmentDemographics) SetAppVersion(v *SetDimension) *SegmentDemographics

SetAppVersion sets the AppVersion field's value.

func (*SegmentDemographics) SetChannel added in v1.8.38 

func (s *SegmentDemographics) SetChannel(v *SetDimension) *SegmentDemographics

SetChannel sets the Channel field's value.

func (*SegmentDemographics) SetDeviceType 

func (s *SegmentDemographics) SetDeviceType(v *SetDimension) *SegmentDemographics

SetDeviceType sets the DeviceType field's value.

func (*SegmentDemographics) SetMake 

func (s *SegmentDemographics) SetMake(v *SetDimension) *SegmentDemographics

SetMake sets the Make field's value.

func (*SegmentDemographics) SetModel 

func (s *SegmentDemographics) SetModel(v *SetDimension) *SegmentDemographics

SetModel sets the Model field's value.

func (*SegmentDemographics) SetPlatform 

func (s *SegmentDemographics) SetPlatform(v *SetDimension) *SegmentDemographics

SetPlatform sets the Platform field's value.

func (SegmentDemographics) String 

func (s SegmentDemographics) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SegmentDemographics) Validate added in v1.20.11 

func (s *SegmentDemographics) Validate() error

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

type SegmentDimensions 

type SegmentDimensions struct {

	// One or more custom attributes to use as criteria for the segment.
	Attributes map[string]*AttributeDimension `type:"map"`

	// The behavior-based criteria, such as how recently users have used your app,
	// for the segment.
	Behavior *SegmentBehaviors `type:"structure"`

	// The demographic-based criteria, such as device platform, for the segment.
	Demographic *SegmentDemographics `type:"structure"`

	// The location-based criteria, such as region or GPS coordinates, for the segment.
	Location *SegmentLocation `type:"structure"`

	// One or more custom metrics to use as criteria for the segment.
	Metrics map[string]*MetricDimension `type:"map"`

	// One or more custom user attributes to use as criteria for the segment.
	UserAttributes map[string]*AttributeDimension `type:"map"`
	// contains filtered or unexported fields
}

Specifies the dimension settings for a segment.

func (SegmentDimensions) GoString 

func (s SegmentDimensions) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SegmentDimensions) SetAttributes 

func (s *SegmentDimensions) SetAttributes(v map[string]*AttributeDimension) *SegmentDimensions

SetAttributes sets the Attributes field's value.

func (*SegmentDimensions) SetBehavior 

func (s *SegmentDimensions) SetBehavior(v *SegmentBehaviors) *SegmentDimensions

SetBehavior sets the Behavior field's value.

func (*SegmentDimensions) SetDemographic 

func (s *SegmentDimensions) SetDemographic(v *SegmentDemographics) *SegmentDimensions

SetDemographic sets the Demographic field's value.

func (*SegmentDimensions) SetLocation 

func (s *SegmentDimensions) SetLocation(v *SegmentLocation) *SegmentDimensions

SetLocation sets the Location field's value.

func (*SegmentDimensions) SetMetrics added in v1.14.20 

func (s *SegmentDimensions) SetMetrics(v map[string]*MetricDimension) *SegmentDimensions

SetMetrics sets the Metrics 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SegmentDimensions) Validate added in v1.20.11 

func (s *SegmentDimensions) Validate() error

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

type SegmentGroup added in v1.14.20 

type SegmentGroup struct {

	// An array that defines the dimensions for the segment.
	Dimensions []*SegmentDimensions `type:"list"`

	// The base segment to build the segment on. A base segment, also referred to
	// as a source segment, defines the initial population of endpoints for a segment.
	// When you add dimensions to a segment, Amazon Pinpoint filters the base segment
	// by using the dimensions that you specify.
	//
	// You can specify more than one dimensional segment or only one imported segment.
	// If you specify an imported segment, the Amazon Pinpoint console displays
	// a segment size estimate that indicates the size of the imported segment without
	// any filters applied to it.
	SourceSegments []*SegmentReference `type:"list"`

	// Specifies how to handle multiple base segments for the segment. For example,
	// if you specify three base segments for the segment, whether the resulting
	// segment is based on all, any, or none of the base segments.
	SourceType *string `type:"string" enum:"SourceType"`

	// Specifies how to handle multiple dimensions for the segment. For example,
	// if you specify three dimensions for the segment, whether the resulting segment
	// includes endpoints that match all, any, or none of the dimensions.
	Type *string `type:"string" enum:"Type"`
	// contains filtered or unexported fields
}

Specifies the base segments and dimensions for a segment, and the relationships between these base segments and dimensions.

func (SegmentGroup) GoString added in v1.14.20 

func (s SegmentGroup) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SegmentGroup) SetDimensions added in v1.14.20 

func (s *SegmentGroup) SetDimensions(v []*SegmentDimensions) *SegmentGroup

SetDimensions sets the Dimensions field's value.

func (*SegmentGroup) SetSourceSegments added in v1.14.20 

func (s *SegmentGroup) SetSourceSegments(v []*SegmentReference) *SegmentGroup

SetSourceSegments sets the SourceSegments field's value.

func (*SegmentGroup) SetSourceType added in v1.14.20 

func (s *SegmentGroup) SetSourceType(v string) *SegmentGroup

SetSourceType sets the SourceType field's value.

func (*SegmentGroup) SetType added in v1.14.20 

func (s *SegmentGroup) SetType(v string) *SegmentGroup

SetType sets the Type field's value.

func (SegmentGroup) String added in v1.14.20 

func (s SegmentGroup) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SegmentGroup) Validate added in v1.20.11 

func (s *SegmentGroup) Validate() error

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

type SegmentGroupList added in v1.14.20 

type SegmentGroupList struct {

	// An array that defines the set of segment criteria to evaluate when handling
	// segment groups for the segment.
	Groups []*SegmentGroup `type:"list"`

	// Specifies how to handle multiple segment groups for the segment. For example,
	// if the segment includes three segment groups, whether the resulting segment
	// includes endpoints that match all, any, or none of the segment groups.
	Include *string `type:"string" enum:"Include"`
	// contains filtered or unexported fields
}

Specifies the settings that define the relationships between segment groups for a segment.

func (SegmentGroupList) GoString added in v1.14.20 

func (s SegmentGroupList) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SegmentGroupList) SetGroups added in v1.14.20 

func (s *SegmentGroupList) SetGroups(v []*SegmentGroup) *SegmentGroupList

SetGroups sets the Groups field's value.

func (*SegmentGroupList) SetInclude added in v1.14.20 

func (s *SegmentGroupList) SetInclude(v string) *SegmentGroupList

SetInclude sets the Include field's value.

func (SegmentGroupList) String added in v1.14.20 

func (s SegmentGroupList) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SegmentGroupList) Validate added in v1.20.11 

func (s *SegmentGroupList) Validate() error

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

type SegmentImportResource 

type SegmentImportResource struct {

	// The number of channel types in the endpoint definitions that were imported
	// to create the segment.
	ChannelCounts map[string]*int64 `type:"map"`

	// (Deprecated) Your AWS account ID, which you assigned to an external ID key
	// in an IAM trust policy. Amazon Pinpoint previously used this value to assume
	// an IAM role when importing endpoint definitions, but we removed this requirement.
	// We don't recommend use of external IDs for IAM roles that are assumed by
	// Amazon Pinpoint.
	//
	// ExternalId is a required field
	ExternalId *string `type:"string" required:"true"`

	// The format of the files that were imported to create the segment. Valid values
	// are: CSV, for comma-separated values format; and, JSON, for newline-delimited
	// JSON format.
	//
	// Format is a required field
	Format *string `type:"string" required:"true" enum:"Format"`

	// The Amazon Resource Name (ARN) of the AWS Identity and Access Management
	// (IAM) role that authorized Amazon Pinpoint to access the Amazon S3 location
	// to import endpoint definitions from.
	//
	// RoleArn is a required field
	RoleArn *string `type:"string" required:"true"`

	// The URL of the Amazon Simple Storage Service (Amazon S3) bucket that the
	// endpoint definitions were imported from to create the segment.
	//
	// S3Url is a required field
	S3Url *string `type:"string" required:"true"`

	// The number of endpoint definitions that were imported successfully to create
	// the segment.
	//
	// Size is a required field
	Size *int64 `type:"integer" required:"true"`
	// contains filtered or unexported fields
}

Provides information about the import job that created a segment. An import job is a job that creates a user segment by importing endpoint definitions.

func (SegmentImportResource) GoString 

func (s SegmentImportResource) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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 

func (s *SegmentImportResource) SetFormat(v string) *SegmentImportResource

SetFormat sets the Format field's value.

func (*SegmentImportResource) SetRoleArn 

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

SetRoleArn sets the RoleArn field's value.

func (*SegmentImportResource) SetS3Url 

func (s *SegmentImportResource) SetS3Url(v string) *SegmentImportResource

SetS3Url sets the S3Url field's value.

func (*SegmentImportResource) SetSize 

func (s *SegmentImportResource) SetSize(v int64) *SegmentImportResource

SetSize sets the Size field's value.

func (SegmentImportResource) String 

func (s SegmentImportResource) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SegmentLocation 

type SegmentLocation struct {

	// The country or region code, in ISO 3166-1 alpha-2 format, for the segment.
	Country *SetDimension `type:"structure"`

	// The GPS location and range for the segment.
	GPSPoint *GPSPointDimension `type:"structure"`
	// contains filtered or unexported fields
}

Specifies geographical dimension settings for a segment.

func (SegmentLocation) GoString 

func (s SegmentLocation) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SegmentLocation) SetCountry 

func (s *SegmentLocation) SetCountry(v *SetDimension) *SegmentLocation

SetCountry sets the Country field's value.

func (*SegmentLocation) SetGPSPoint added in v1.14.20 

func (s *SegmentLocation) SetGPSPoint(v *GPSPointDimension) *SegmentLocation

SetGPSPoint sets the GPSPoint field's value.

func (SegmentLocation) String 

func (s SegmentLocation) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SegmentLocation) Validate added in v1.20.11 

func (s *SegmentLocation) Validate() error

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

type SegmentReference added in v1.14.20 

type SegmentReference struct {

	// The unique identifier for the segment.
	//
	// Id is a required field
	Id *string `type:"string" required:"true"`

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

Specifies the segment identifier and version of a segment.

func (SegmentReference) GoString added in v1.14.20 

func (s SegmentReference) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SegmentReference) SetId added in v1.14.20 

func (s *SegmentReference) SetId(v string) *SegmentReference

SetId sets the Id field's value.

func (*SegmentReference) SetVersion added in v1.14.20 

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

SetVersion sets the Version field's value.

func (SegmentReference) String added in v1.14.20 

func (s SegmentReference) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SegmentReference) Validate added in v1.20.11 

func (s *SegmentReference) Validate() error

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

type SegmentResponse 

type SegmentResponse struct {

	// The unique identifier for the application that the segment is associated
	// with.
	//
	// ApplicationId is a required field
	ApplicationId *string `type:"string" required:"true"`

	// The Amazon Resource Name (ARN) of the segment.
	//
	// Arn is a required field
	Arn *string `type:"string" required:"true"`

	// The date and time when the segment was created.
	//
	// CreationDate is a required field
	CreationDate *string `type:"string" required:"true"`

	// The dimension settings for the segment.
	Dimensions *SegmentDimensions `type:"structure"`

	// The unique identifier for the segment.
	//
	// Id is a required field
	Id *string `type:"string" required:"true"`

	// The settings for the import job that's associated with the segment.
	ImportDefinition *SegmentImportResource `type:"structure"`

	// The date and time when the segment was last modified.
	LastModifiedDate *string `type:"string"`

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

	// A list of one or more segment groups that apply to the segment. Each segment
	// group consists of zero or more base segments and the dimensions that are
	// applied to those base segments.
	SegmentGroups *SegmentGroupList `type:"structure"`

	// The segment type. Valid values are:
	//
	//    * DIMENSIONAL - A dynamic segment, which is a segment that uses selection
	//    criteria that you specify and is based on endpoint data that's reported
	//    by your app. Dynamic segments can change over time.
	//
	//    * IMPORT - A static segment, which is a segment that uses selection criteria
	//    that you specify and is based on endpoint definitions that you import
	//    from a file. Imported segments are static; they don't change over time.
	//
	// SegmentType is a required field
	SegmentType *string `type:"string" required:"true" enum:"SegmentType"`

	// A string-to-string map of key-value pairs that identifies the tags that are
	// associated with the segment. Each tag consists of a required tag key and
	// an associated tag value.
	Tags map[string]*string `locationName:"tags" type:"map"`

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

Provides information about the configuration, dimension, and other settings for a segment.

func (SegmentResponse) GoString 

func (s SegmentResponse) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SegmentResponse) SetApplicationId 

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

SetApplicationId sets the ApplicationId field's value.

func (*SegmentResponse) SetArn added in v1.17.6 

func (s *SegmentResponse) SetArn(v string) *SegmentResponse

SetArn sets the Arn 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) SetSegmentGroups added in v1.14.20 

func (s *SegmentResponse) SetSegmentGroups(v *SegmentGroupList) *SegmentResponse

SetSegmentGroups sets the SegmentGroups field's value.

func (*SegmentResponse) SetSegmentType 

func (s *SegmentResponse) SetSegmentType(v string) *SegmentResponse

SetSegmentType sets the SegmentType field's value.

func (*SegmentResponse) SetTags added in v1.17.6 

func (s *SegmentResponse) SetTags(v map[string]*string) *SegmentResponse

SetTags sets the Tags 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SegmentsResponse 

type SegmentsResponse struct {

	// An array of responses, one for each segment that's associated with the application
	// (Segments resource) or each version of a segment that's associated with the
	// application (Segment Versions resource).
	//
	// Item is a required field
	Item []*SegmentResponse `type:"list" required:"true"`

	// The string to use in a subsequent request to get the next page of results
	// in a paginated response. This value is null if there are no additional pages.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

Provides information about all the segments that are associated with an application.

func (SegmentsResponse) GoString 

func (s SegmentsResponse) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SegmentsResponse) SetItem 

func (s *SegmentsResponse) SetItem(v []*SegmentResponse) *SegmentsResponse

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type 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"`

	// Specifies the configuration and other settings for a message.
	//
	// MessageRequest is a required field
	MessageRequest *MessageRequest `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (SendMessagesInput) GoString added in v1.8.38 

func (s SendMessagesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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 {

	// Provides information about the results of a request to send a message to
	// an endpoint address.
	//
	// MessageResponse is a required field
	MessageResponse *MessageResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (SendMessagesOutput) GoString added in v1.8.38 

func (s SendMessagesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SendOTPMessageInput added in v1.42.13 

type SendOTPMessageInput struct {

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

	// Send OTP message request parameters.
	//
	// SendOTPMessageRequestParameters is a required field
	SendOTPMessageRequestParameters *SendOTPMessageRequestParameters `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (SendOTPMessageInput) GoString added in v1.42.13 

func (s SendOTPMessageInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SendOTPMessageInput) SetApplicationId added in v1.42.13 

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

SetApplicationId sets the ApplicationId field's value.

func (*SendOTPMessageInput) SetSendOTPMessageRequestParameters added in v1.42.13 

func (s *SendOTPMessageInput) SetSendOTPMessageRequestParameters(v *SendOTPMessageRequestParameters) *SendOTPMessageInput

SetSendOTPMessageRequestParameters sets the SendOTPMessageRequestParameters field's value.

func (SendOTPMessageInput) String added in v1.42.13 

func (s SendOTPMessageInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SendOTPMessageInput) Validate added in v1.42.13 

func (s *SendOTPMessageInput) Validate() error

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

type SendOTPMessageOutput added in v1.42.13 

type SendOTPMessageOutput struct {

	// Provides information about the results of a request to send a message to
	// an endpoint address.
	//
	// MessageResponse is a required field
	MessageResponse *MessageResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (SendOTPMessageOutput) GoString added in v1.42.13 

func (s SendOTPMessageOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SendOTPMessageOutput) SetMessageResponse added in v1.42.13 

func (s *SendOTPMessageOutput) SetMessageResponse(v *MessageResponse) *SendOTPMessageOutput

SetMessageResponse sets the MessageResponse field's value.

func (SendOTPMessageOutput) String added in v1.42.13 

func (s SendOTPMessageOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SendOTPMessageRequestParameters added in v1.42.13 

type SendOTPMessageRequestParameters struct {

	// The attempts allowed to validate an OTP.
	AllowedAttempts *int64 `type:"integer"`

	// The brand name that will be substituted into the OTP message body. Should
	// be owned by calling AWS account.
	//
	// BrandName is a required field
	BrandName *string `type:"string" required:"true"`

	// Channel type for the OTP message. Supported values: [SMS].
	//
	// Channel is a required field
	Channel *string `type:"string" required:"true"`

	// The number of characters in the generated OTP.
	CodeLength *int64 `type:"integer"`

	// The destination identity to send OTP to.
	//
	// DestinationIdentity is a required field
	DestinationIdentity *string `type:"string" required:"true"`

	// A unique Entity ID received from DLT after entity registration is approved.
	EntityId *string `type:"string"`

	// The language to be used for the outgoing message body containing the OTP.
	Language *string `type:"string"`

	// The origination identity used to send OTP from.
	//
	// OriginationIdentity is a required field
	OriginationIdentity *string `type:"string" required:"true"`

	// Developer-specified reference identifier. Required to match during OTP verification.
	//
	// ReferenceId is a required field
	ReferenceId *string `type:"string" required:"true"`

	// A unique Template ID received from DLT after entity registration is approved.
	TemplateId *string `type:"string"`

	// The time in minutes before the OTP is no longer valid.
	ValidityPeriod *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Send OTP message request parameters.

func (SendOTPMessageRequestParameters) GoString added in v1.42.13 

func (s SendOTPMessageRequestParameters) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SendOTPMessageRequestParameters) SetAllowedAttempts added in v1.42.13 

func (s *SendOTPMessageRequestParameters) SetAllowedAttempts(v int64) *SendOTPMessageRequestParameters

SetAllowedAttempts sets the AllowedAttempts field's value.

func (*SendOTPMessageRequestParameters) SetBrandName added in v1.42.13 

func (s *SendOTPMessageRequestParameters) SetBrandName(v string) *SendOTPMessageRequestParameters

SetBrandName sets the BrandName field's value.

func (*SendOTPMessageRequestParameters) SetChannel added in v1.42.13 

func (s *SendOTPMessageRequestParameters) SetChannel(v string) *SendOTPMessageRequestParameters

SetChannel sets the Channel field's value.

func (*SendOTPMessageRequestParameters) SetCodeLength added in v1.42.13 

func (s *SendOTPMessageRequestParameters) SetCodeLength(v int64) *SendOTPMessageRequestParameters

SetCodeLength sets the CodeLength field's value.

func (*SendOTPMessageRequestParameters) SetDestinationIdentity added in v1.42.13 

func (s *SendOTPMessageRequestParameters) SetDestinationIdentity(v string) *SendOTPMessageRequestParameters

SetDestinationIdentity sets the DestinationIdentity field's value.

func (*SendOTPMessageRequestParameters) SetEntityId added in v1.42.13 

func (s *SendOTPMessageRequestParameters) SetEntityId(v string) *SendOTPMessageRequestParameters

SetEntityId sets the EntityId field's value.

func (*SendOTPMessageRequestParameters) SetLanguage added in v1.42.13 

func (s *SendOTPMessageRequestParameters) SetLanguage(v string) *SendOTPMessageRequestParameters

SetLanguage sets the Language field's value.

func (*SendOTPMessageRequestParameters) SetOriginationIdentity added in v1.42.13 

func (s *SendOTPMessageRequestParameters) SetOriginationIdentity(v string) *SendOTPMessageRequestParameters

SetOriginationIdentity sets the OriginationIdentity field's value.

func (*SendOTPMessageRequestParameters) SetReferenceId added in v1.42.13 

func (s *SendOTPMessageRequestParameters) SetReferenceId(v string) *SendOTPMessageRequestParameters

SetReferenceId sets the ReferenceId field's value.

func (*SendOTPMessageRequestParameters) SetTemplateId added in v1.42.13 

func (s *SendOTPMessageRequestParameters) SetTemplateId(v string) *SendOTPMessageRequestParameters

SetTemplateId sets the TemplateId field's value.

func (*SendOTPMessageRequestParameters) SetValidityPeriod added in v1.42.13 

func (s *SendOTPMessageRequestParameters) SetValidityPeriod(v int64) *SendOTPMessageRequestParameters

SetValidityPeriod sets the ValidityPeriod field's value.

func (SendOTPMessageRequestParameters) String added in v1.42.13 

func (s SendOTPMessageRequestParameters) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SendOTPMessageRequestParameters) Validate added in v1.42.13 

func (s *SendOTPMessageRequestParameters) Validate() error

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

type SendUsersMessageRequest added in v1.12.1 

type SendUsersMessageRequest struct {

	// A map of custom attribute-value pairs. For a push notification, Amazon Pinpoint
	// adds these attributes to the data.pinpoint object in the body of the notification
	// payload. Amazon Pinpoint also provides these attributes in the events that
	// it generates for users-messages deliveries.
	Context map[string]*string `type:"map"`

	// The settings and content for the default message and any default messages
	// that you defined for specific channels.
	//
	// MessageConfiguration is a required field
	MessageConfiguration *DirectMessageConfiguration `type:"structure" required:"true"`

	// The message template to use for the message.
	TemplateConfiguration *TemplateConfiguration `type:"structure"`

	// The unique identifier for tracing the message. This identifier is visible
	// to message recipients.
	TraceId *string `type:"string"`

	// A map that associates user IDs with EndpointSendConfiguration (https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-messages.html#apps-application-id-messages-model-endpointsendconfiguration)
	// objects. You can use an EndpointSendConfiguration (https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-messages.html#apps-application-id-messages-model-endpointsendconfiguration)
	// object to tailor the message for a user by specifying settings such as content
	// overrides and message variables.
	//
	// Users is a required field
	Users map[string]*EndpointSendConfiguration `type:"map" required:"true"`
	// contains filtered or unexported fields
}

Specifies the configuration and other settings for a message to send to all the endpoints that are associated with a list of users.

func (SendUsersMessageRequest) GoString added in v1.12.1 

func (s SendUsersMessageRequest) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SendUsersMessageRequest) SetContext added in v1.12.1 

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

SetContext sets the Context field's value.

func (*SendUsersMessageRequest) SetMessageConfiguration added in v1.12.1 

func (s *SendUsersMessageRequest) SetMessageConfiguration(v *DirectMessageConfiguration) *SendUsersMessageRequest

SetMessageConfiguration sets the MessageConfiguration field's value.

func (*SendUsersMessageRequest) SetTemplateConfiguration added in v1.25.7 

func (s *SendUsersMessageRequest) SetTemplateConfiguration(v *TemplateConfiguration) *SendUsersMessageRequest

SetTemplateConfiguration sets the TemplateConfiguration field's value.

func (*SendUsersMessageRequest) SetTraceId added in v1.15.7 

func (s *SendUsersMessageRequest) SetTraceId(v string) *SendUsersMessageRequest

SetTraceId sets the TraceId field's value.

func (*SendUsersMessageRequest) SetUsers added in v1.12.1 

func (s *SendUsersMessageRequest) SetUsers(v map[string]*EndpointSendConfiguration) *SendUsersMessageRequest

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SendUsersMessageRequest) Validate added in v1.20.11 

func (s *SendUsersMessageRequest) Validate() error

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

type SendUsersMessageResponse added in v1.12.1 

type SendUsersMessageResponse struct {

	// The unique identifier for the application that was used to send the message.
	//
	// ApplicationId is a required field
	ApplicationId *string `type:"string" required:"true"`

	// The unique identifier that was assigned to the message request.
	RequestId *string `type:"string"`

	// An object that indicates which endpoints the message was sent to, for each
	// user. The object lists user IDs and, for each user ID, provides the endpoint
	// IDs that the message was sent to. For each endpoint ID, it provides an EndpointMessageResult
	// object.
	Result map[string]map[string]*EndpointMessageResult `type:"map"`
	// contains filtered or unexported fields
}

Provides information about which users and endpoints a message was sent to.

func (SendUsersMessageResponse) GoString added in v1.12.1 

func (s SendUsersMessageResponse) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SendUsersMessageResponse) SetApplicationId added in v1.12.1 

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

SetApplicationId sets the ApplicationId field's value.

func (*SendUsersMessageResponse) SetRequestId added in v1.12.1 

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

SetRequestId sets the RequestId field's value.

func (*SendUsersMessageResponse) SetResult added in v1.12.1 

func (s *SendUsersMessageResponse) SetResult(v map[string]map[string]*EndpointMessageResult) *SendUsersMessageResponse

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type 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"`

	// Specifies the configuration and other settings for a message to send to all
	// the endpoints that are associated with a list of users.
	//
	// SendUsersMessageRequest is a required field
	SendUsersMessageRequest *SendUsersMessageRequest `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (SendUsersMessagesInput) GoString added in v1.12.1 

func (s SendUsersMessagesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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 {

	// Provides information about which users and endpoints a message was sent to.
	//
	// SendUsersMessageResponse is a required field
	SendUsersMessageResponse *SendUsersMessageResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (SendUsersMessagesOutput) GoString added in v1.12.1 

func (s SendUsersMessagesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Session added in v1.15.7 

type Session struct {

	// The duration of the session, in milliseconds.
	Duration *int64 `type:"integer"`

	// The unique identifier for the session.
	//
	// Id is a required field
	Id *string `type:"string" required:"true"`

	// The date and time when the session began.
	//
	// StartTimestamp is a required field
	StartTimestamp *string `type:"string" required:"true"`

	// The date and time when the session ended.
	StopTimestamp *string `type:"string"`
	// contains filtered or unexported fields
}

Provides information about a session.

func (Session) GoString added in v1.15.7 

func (s Session) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Session) SetDuration added in v1.15.7 

func (s *Session) SetDuration(v int64) *Session

SetDuration sets the Duration field's value.

func (*Session) SetId added in v1.15.7 

func (s *Session) SetId(v string) *Session

SetId sets the Id field's value.

func (*Session) SetStartTimestamp added in v1.15.7 

func (s *Session) SetStartTimestamp(v string) *Session

SetStartTimestamp sets the StartTimestamp field's value.

func (*Session) SetStopTimestamp added in v1.15.7 

func (s *Session) SetStopTimestamp(v string) *Session

SetStopTimestamp sets the StopTimestamp field's value.

func (Session) String added in v1.15.7 

func (s Session) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Session) Validate added in v1.20.11 

func (s *Session) Validate() error

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

type SetDimension 

type SetDimension struct {

	// The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints
	// that match the criteria are included in the segment; and, EXCLUSIVE, endpoints
	// that match the criteria are excluded from the segment.
	DimensionType *string `type:"string" enum:"DimensionType"`

	// The criteria values to use for the segment dimension. Depending on the value
	// of the DimensionType property, endpoints are included or excluded from the
	// segment if their values match the criteria values.
	//
	// Values is a required field
	Values []*string `type:"list" required:"true"`
	// contains filtered or unexported fields
}

Specifies the dimension type and values for a segment dimension.

func (SetDimension) GoString 

func (s SetDimension) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SetDimension) Validate added in v1.20.11 

func (s *SetDimension) Validate() error

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

type SimpleCondition added in v1.25.25 

type SimpleCondition struct {

	// The dimension settings for the event that's associated with the activity.
	EventCondition *EventCondition `type:"structure"`

	// The segment that's associated with the activity.
	SegmentCondition *SegmentCondition `type:"structure"`

	// The dimension settings for the segment that's associated with the activity.
	SegmentDimensions *SegmentDimensions `locationName:"segmentDimensions" type:"structure"`
	// contains filtered or unexported fields
}

Specifies a condition to evaluate for an activity in a journey.

func (SimpleCondition) GoString added in v1.25.25 

func (s SimpleCondition) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SimpleCondition) SetEventCondition added in v1.25.25 

func (s *SimpleCondition) SetEventCondition(v *EventCondition) *SimpleCondition

SetEventCondition sets the EventCondition field's value.

func (*SimpleCondition) SetSegmentCondition added in v1.25.25 

func (s *SimpleCondition) SetSegmentCondition(v *SegmentCondition) *SimpleCondition

SetSegmentCondition sets the SegmentCondition field's value.

func (*SimpleCondition) SetSegmentDimensions added in v1.25.25 

func (s *SimpleCondition) SetSegmentDimensions(v *SegmentDimensions) *SimpleCondition

SetSegmentDimensions sets the SegmentDimensions field's value.

func (SimpleCondition) String added in v1.25.25 

func (s SimpleCondition) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SimpleCondition) Validate added in v1.25.25 

func (s *SimpleCondition) Validate() error

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

type SimpleEmail added in v1.15.70 

type SimpleEmail struct {

	// The body of the email message, in HTML format. We recommend using HTML format
	// for email clients that render HTML content. You can include links, formatted
	// text, and more in an HTML message.
	HtmlPart *SimpleEmailPart `type:"structure"`

	// The subject line, or title, of the email.
	Subject *SimpleEmailPart `type:"structure"`

	// The body of the email message, in plain text format. We recommend using plain
	// text format for email clients that don't render HTML content and clients
	// that are connected to high-latency networks, such as mobile devices.
	TextPart *SimpleEmailPart `type:"structure"`
	// contains filtered or unexported fields
}

Specifies the contents of an email message, composed of a subject, a text part, and an HTML part.

func (SimpleEmail) GoString added in v1.15.70 

func (s SimpleEmail) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SimpleEmail) SetHtmlPart added in v1.15.70 

func (s *SimpleEmail) SetHtmlPart(v *SimpleEmailPart) *SimpleEmail

SetHtmlPart sets the HtmlPart field's value.

func (*SimpleEmail) SetSubject added in v1.15.70 

func (s *SimpleEmail) SetSubject(v *SimpleEmailPart) *SimpleEmail

SetSubject sets the Subject field's value.

func (*SimpleEmail) SetTextPart added in v1.15.70 

func (s *SimpleEmail) SetTextPart(v *SimpleEmailPart) *SimpleEmail

SetTextPart sets the TextPart field's value.

func (SimpleEmail) String added in v1.15.70 

func (s SimpleEmail) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SimpleEmailPart added in v1.15.70 

type SimpleEmailPart struct {

	// The applicable character set for the message content.
	Charset *string `type:"string"`

	// The textual data of the message content.
	Data *string `type:"string"`
	// contains filtered or unexported fields
}

Specifies the subject or body of an email message, represented as textual email data and the applicable character set.

func (SimpleEmailPart) GoString added in v1.15.70 

func (s SimpleEmailPart) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SimpleEmailPart) SetCharset added in v1.15.70 

func (s *SimpleEmailPart) SetCharset(v string) *SimpleEmailPart

SetCharset sets the Charset field's value.

func (*SimpleEmailPart) SetData added in v1.15.70 

func (s *SimpleEmailPart) SetData(v string) *SimpleEmailPart

SetData sets the Data field's value.

func (SimpleEmailPart) String added in v1.15.70 

func (s SimpleEmailPart) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StartCondition added in v1.25.25 

type StartCondition struct {

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

	// Specifies the settings for an event that causes a journey activity to start.
	EventStartCondition *EventStartCondition `type:"structure"`

	// The segment that's associated with the first activity in the journey. This
	// segment determines which users are participants in the journey.
	SegmentStartCondition *SegmentCondition `type:"structure"`
	// contains filtered or unexported fields
}

Specifies the conditions for the first activity in a journey. This activity and its conditions determine which users are participants in a journey.

func (StartCondition) GoString added in v1.25.25 

func (s StartCondition) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartCondition) SetDescription added in v1.25.25 

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

SetDescription sets the Description field's value.

func (*StartCondition) SetEventStartCondition added in v1.35.0 

func (s *StartCondition) SetEventStartCondition(v *EventStartCondition) *StartCondition

SetEventStartCondition sets the EventStartCondition field's value.

func (*StartCondition) SetSegmentStartCondition added in v1.25.25 

func (s *StartCondition) SetSegmentStartCondition(v *SegmentCondition) *StartCondition

SetSegmentStartCondition sets the SegmentStartCondition field's value.

func (StartCondition) String added in v1.25.25 

func (s StartCondition) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartCondition) Validate added in v1.25.25 

func (s *StartCondition) Validate() error

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

type TagResourceInput added in v1.17.6 

type TagResourceInput struct {

	// ResourceArn is a required field
	ResourceArn *string `location:"uri" locationName:"resource-arn" type:"string" required:"true"`

	// Specifies the tags (keys and values) for an application, campaign, message
	// template, or segment.
	//
	// TagsModel is a required field
	TagsModel *TagsModel `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (TagResourceInput) GoString added in v1.17.6 

func (s TagResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TagResourceInput) SetResourceArn added in v1.17.6 

func (s *TagResourceInput) SetResourceArn(v string) *TagResourceInput

SetResourceArn sets the ResourceArn field's value.

func (*TagResourceInput) SetTagsModel added in v1.17.6 

func (s *TagResourceInput) SetTagsModel(v *TagsModel) *TagResourceInput

SetTagsModel sets the TagsModel field's value.

func (TagResourceInput) String added in v1.17.6 

func (s TagResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TagResourceInput) Validate added in v1.17.6 

func (s *TagResourceInput) Validate() error

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

type TagResourceOutput added in v1.17.6 

type TagResourceOutput struct {
	// contains filtered or unexported fields
}

func (TagResourceOutput) GoString added in v1.17.6 

func (s TagResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (TagResourceOutput) String added in v1.17.6 

func (s TagResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TagsModel added in v1.17.6 

type TagsModel struct {

	// A string-to-string map of key-value pairs that defines the tags for an application,
	// campaign, message template, or segment. Each of these resources can have
	// a maximum of 50 tags.
	//
	// Each tag consists of a required tag key and an associated tag value. The
	// maximum length of a tag key is 128 characters. The maximum length of a tag
	// value is 256 characters.
	//
	// Tags is a required field
	Tags map[string]*string `locationName:"tags" type:"map" required:"true"`
	// contains filtered or unexported fields
}

Specifies the tags (keys and values) for an application, campaign, message template, or segment.

func (TagsModel) GoString added in v1.17.6 

func (s TagsModel) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TagsModel) SetTags added in v1.17.6 

func (s *TagsModel) SetTags(v map[string]*string) *TagsModel

SetTags sets the Tags field's value.

func (TagsModel) String added in v1.17.6 

func (s TagsModel) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TagsModel) Validate added in v1.17.6 

func (s *TagsModel) Validate() error

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

type Template added in v1.25.7 

type Template struct {

	// The name of the message template to use for the message. If specified, this
	// value must match the name of an existing message template.
	Name *string `type:"string"`

	// The unique identifier for the version of the message template to use for
	// the message. If specified, this value must match the identifier for an existing
	// template version. To retrieve a list of versions and version identifiers
	// for a template, use the Template Versions resource.
	//
	// If you don't specify a value for this property, Amazon Pinpoint uses the
	// active version of the template. The active version is typically the version
	// of a template that's been most recently reviewed and approved for use, depending
	// on your workflow. It isn't necessarily the latest version of a template.
	Version *string `type:"string"`
	// contains filtered or unexported fields
}

Specifies the name and version of the message template to use for the message.

func (Template) GoString added in v1.25.7 

func (s Template) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Template) SetName added in v1.25.7 

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

SetName sets the Name field's value.

func (*Template) SetVersion added in v1.26.7 

func (s *Template) SetVersion(v string) *Template

SetVersion sets the Version field's value.

func (Template) String added in v1.25.7 

func (s Template) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TemplateActiveVersionRequest added in v1.26.7 

type TemplateActiveVersionRequest struct {

	// The version of the message template to use as the active version of the template.
	// Valid values are: latest, for the most recent version of the template; or,
	// the unique identifier for any existing version of the template. If you specify
	// an identifier, the value must match the identifier for an existing template
	// version. To retrieve a list of versions and version identifiers for a template,
	// use the Template Versions resource.
	Version *string `type:"string"`
	// contains filtered or unexported fields
}

Specifies which version of a message template to use as the active version of the template.

func (TemplateActiveVersionRequest) GoString added in v1.26.7 

func (s TemplateActiveVersionRequest) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TemplateActiveVersionRequest) SetVersion added in v1.26.7 

func (s *TemplateActiveVersionRequest) SetVersion(v string) *TemplateActiveVersionRequest

SetVersion sets the Version field's value.

func (TemplateActiveVersionRequest) String added in v1.26.7 

func (s TemplateActiveVersionRequest) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TemplateConfiguration added in v1.25.7 

type TemplateConfiguration struct {

	// The email template to use for the message.
	EmailTemplate *Template `type:"structure"`

	// The push notification template to use for the message.
	PushTemplate *Template `type:"structure"`

	// The SMS template to use for the message.
	SMSTemplate *Template `type:"structure"`

	// The voice template to use for the message. This object isn't supported for
	// campaigns.
	VoiceTemplate *Template `type:"structure"`
	// contains filtered or unexported fields
}

Specifies the message template to use for the message, for each type of channel.

func (TemplateConfiguration) GoString added in v1.25.7 

func (s TemplateConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TemplateConfiguration) SetEmailTemplate added in v1.25.7 

func (s *TemplateConfiguration) SetEmailTemplate(v *Template) *TemplateConfiguration

SetEmailTemplate sets the EmailTemplate field's value.

func (*TemplateConfiguration) SetPushTemplate added in v1.25.7 

func (s *TemplateConfiguration) SetPushTemplate(v *Template) *TemplateConfiguration

SetPushTemplate sets the PushTemplate field's value.

func (*TemplateConfiguration) SetSMSTemplate added in v1.25.7 

func (s *TemplateConfiguration) SetSMSTemplate(v *Template) *TemplateConfiguration

SetSMSTemplate sets the SMSTemplate field's value.

func (*TemplateConfiguration) SetVoiceTemplate added in v1.25.37 

func (s *TemplateConfiguration) SetVoiceTemplate(v *Template) *TemplateConfiguration

SetVoiceTemplate sets the VoiceTemplate field's value.

func (TemplateConfiguration) String added in v1.25.7 

func (s TemplateConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TemplateCreateMessageBody added in v1.40.44 

type TemplateCreateMessageBody struct {

	// The Amazon Resource Name (ARN) of the message template that was created.
	Arn *string `type:"string"`

	// The message that's returned from the API for the request to create the message
	// template.
	Message *string `type:"string"`

	// The unique identifier for the request to create the message template.
	RequestID *string `type:"string"`
	// contains filtered or unexported fields
}

Provides information about a request to create a message template.

func (TemplateCreateMessageBody) GoString added in v1.40.44 

func (s TemplateCreateMessageBody) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TemplateCreateMessageBody) SetArn added in v1.40.44 

func (s *TemplateCreateMessageBody) SetArn(v string) *TemplateCreateMessageBody

SetArn sets the Arn field's value.

func (*TemplateCreateMessageBody) SetMessage added in v1.40.44 

func (s *TemplateCreateMessageBody) SetMessage(v string) *TemplateCreateMessageBody

SetMessage sets the Message field's value.

func (*TemplateCreateMessageBody) SetRequestID added in v1.40.44 

func (s *TemplateCreateMessageBody) SetRequestID(v string) *TemplateCreateMessageBody

SetRequestID sets the RequestID field's value.

func (TemplateCreateMessageBody) String added in v1.40.44 

func (s TemplateCreateMessageBody) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TemplateResponse added in v1.25.7 

type TemplateResponse struct {

	// The Amazon Resource Name (ARN) of the message template. This value isn't
	// included in a TemplateResponse object. To retrieve the ARN of a template,
	// use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate
	// operation, depending on the type of template that you want to retrieve the
	// ARN for.
	Arn *string `type:"string"`

	// The date, in ISO 8601 format, when the message template was created.
	//
	// CreationDate is a required field
	CreationDate *string `type:"string" required:"true"`

	// The JSON object that specifies the default values that are used for message
	// variables in the message template. This object isn't included in a TemplateResponse
	// object. To retrieve this object for a template, use the GetEmailTemplate,
	// GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending
	// on the type of template that you want to retrieve the object for.
	DefaultSubstitutions *string `type:"string"`

	// The date, in ISO 8601 format, when the message template was last modified.
	//
	// LastModifiedDate is a required field
	LastModifiedDate *string `type:"string" required:"true"`

	// A map of key-value pairs that identifies the tags that are associated with
	// the message template. This object isn't included in a TemplateResponse object.
	// To retrieve this object for a template, use the GetEmailTemplate, GetPushTemplate,
	// GetSmsTemplate, or GetVoiceTemplate operation, depending on the type of template
	// that you want to retrieve the object for.
	Tags map[string]*string `locationName:"tags" type:"map"`

	// The custom description of the message template. This value isn't included
	// in a TemplateResponse object. To retrieve the description of a template,
	// use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate
	// operation, depending on the type of template that you want to retrieve the
	// description for.
	TemplateDescription *string `type:"string"`

	// The name of the message template.
	//
	// TemplateName is a required field
	TemplateName *string `type:"string" required:"true"`

	// The type of channel that the message template is designed for. Possible values
	// are: EMAIL, PUSH, SMS, and VOICE.
	//
	// TemplateType is a required field
	TemplateType *string `type:"string" required:"true" enum:"TemplateType"`

	// The unique identifier, as an integer, for the active version of the message
	// template.
	Version *string `type:"string"`
	// contains filtered or unexported fields
}

Provides information about a message template that's associated with your Amazon Pinpoint account.

func (TemplateResponse) GoString added in v1.25.7 

func (s TemplateResponse) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TemplateResponse) SetArn added in v1.25.7 

func (s *TemplateResponse) SetArn(v string) *TemplateResponse

SetArn sets the Arn field's value.

func (*TemplateResponse) SetCreationDate added in v1.25.7 

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

SetCreationDate sets the CreationDate field's value.

func (*TemplateResponse) SetDefaultSubstitutions added in v1.25.37 

func (s *TemplateResponse) SetDefaultSubstitutions(v string) *TemplateResponse

SetDefaultSubstitutions sets the DefaultSubstitutions field's value.

func (*TemplateResponse) SetLastModifiedDate added in v1.25.7 

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

SetLastModifiedDate sets the LastModifiedDate field's value.

func (*TemplateResponse) SetTags added in v1.25.7 

func (s *TemplateResponse) SetTags(v map[string]*string) *TemplateResponse

SetTags sets the Tags field's value.

func (*TemplateResponse) SetTemplateDescription added in v1.25.37 

func (s *TemplateResponse) SetTemplateDescription(v string) *TemplateResponse

SetTemplateDescription sets the TemplateDescription field's value.

func (*TemplateResponse) SetTemplateName added in v1.25.7 

func (s *TemplateResponse) SetTemplateName(v string) *TemplateResponse

SetTemplateName sets the TemplateName field's value.

func (*TemplateResponse) SetTemplateType added in v1.25.7 

func (s *TemplateResponse) SetTemplateType(v string) *TemplateResponse

SetTemplateType sets the TemplateType field's value.

func (*TemplateResponse) SetVersion added in v1.26.7 

func (s *TemplateResponse) SetVersion(v string) *TemplateResponse

SetVersion sets the Version field's value.

func (TemplateResponse) String added in v1.25.7 

func (s TemplateResponse) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TemplateVersionResponse added in v1.26.7 

type TemplateVersionResponse struct {

	// The date, in ISO 8601 format, when the version of the message template was
	// created.
	//
	// CreationDate is a required field
	CreationDate *string `type:"string" required:"true"`

	// A JSON object that specifies the default values that are used for message
	// variables in the version of the message template. This object is a set of
	// key-value pairs. Each key defines a message variable in the template. The
	// corresponding value defines the default value for that variable.
	DefaultSubstitutions *string `type:"string"`

	// The date, in ISO 8601 format, when the version of the message template was
	// last modified.
	//
	// LastModifiedDate is a required field
	LastModifiedDate *string `type:"string" required:"true"`

	// The custom description of the version of the message template.
	TemplateDescription *string `type:"string"`

	// The name of the message template.
	//
	// TemplateName is a required field
	TemplateName *string `type:"string" required:"true"`

	// The type of channel that the message template is designed for. Possible values
	// are: EMAIL, PUSH, SMS, and VOICE.
	//
	// TemplateType is a required field
	TemplateType *string `type:"string" required:"true"`

	// The unique identifier for the version of the message template. This value
	// is an integer that Amazon Pinpoint automatically increments and assigns to
	// each new version of a template.
	Version *string `type:"string"`
	// contains filtered or unexported fields
}

Provides information about a specific version of a message template.

func (TemplateVersionResponse) GoString added in v1.26.7 

func (s TemplateVersionResponse) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TemplateVersionResponse) SetCreationDate added in v1.26.7 

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

SetCreationDate sets the CreationDate field's value.

func (*TemplateVersionResponse) SetDefaultSubstitutions added in v1.26.7 

func (s *TemplateVersionResponse) SetDefaultSubstitutions(v string) *TemplateVersionResponse

SetDefaultSubstitutions sets the DefaultSubstitutions field's value.

func (*TemplateVersionResponse) SetLastModifiedDate added in v1.26.7 

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

SetLastModifiedDate sets the LastModifiedDate field's value.

func (*TemplateVersionResponse) SetTemplateDescription added in v1.26.7 

func (s *TemplateVersionResponse) SetTemplateDescription(v string) *TemplateVersionResponse

SetTemplateDescription sets the TemplateDescription field's value.

func (*TemplateVersionResponse) SetTemplateName added in v1.26.7 

func (s *TemplateVersionResponse) SetTemplateName(v string) *TemplateVersionResponse

SetTemplateName sets the TemplateName field's value.

func (*TemplateVersionResponse) SetTemplateType added in v1.26.7 

func (s *TemplateVersionResponse) SetTemplateType(v string) *TemplateVersionResponse

SetTemplateType sets the TemplateType field's value.

func (*TemplateVersionResponse) SetVersion added in v1.26.7 

func (s *TemplateVersionResponse) SetVersion(v string) *TemplateVersionResponse

SetVersion sets the Version field's value.

func (TemplateVersionResponse) String added in v1.26.7 

func (s TemplateVersionResponse) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TemplateVersionsResponse added in v1.26.7 

type TemplateVersionsResponse struct {

	// An array of responses, one for each version of the message template.
	//
	// Item is a required field
	Item []*TemplateVersionResponse `type:"list" required:"true"`

	// The message that's returned from the API for the request to retrieve information
	// about all the versions of the message template.
	Message *string `type:"string"`

	// The string to use in a subsequent request to get the next page of results
	// in a paginated response. This value is null if there are no additional pages.
	NextToken *string `type:"string"`

	// The unique identifier for the request to retrieve information about all the
	// versions of the message template.
	RequestID *string `type:"string"`
	// contains filtered or unexported fields
}

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

func (TemplateVersionsResponse) GoString added in v1.26.7 

func (s TemplateVersionsResponse) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TemplateVersionsResponse) SetItem added in v1.26.7 

func (s *TemplateVersionsResponse) SetItem(v []*TemplateVersionResponse) *TemplateVersionsResponse

SetItem sets the Item field's value.

func (*TemplateVersionsResponse) SetMessage added in v1.26.7 

func (s *TemplateVersionsResponse) SetMessage(v string) *TemplateVersionsResponse

SetMessage sets the Message field's value.

func (*TemplateVersionsResponse) SetNextToken added in v1.26.7 

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

SetNextToken sets the NextToken field's value.

func (*TemplateVersionsResponse) SetRequestID added in v1.26.7 

func (s *TemplateVersionsResponse) SetRequestID(v string) *TemplateVersionsResponse

SetRequestID sets the RequestID field's value.

func (TemplateVersionsResponse) String added in v1.26.7 

func (s TemplateVersionsResponse) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TemplatesResponse added in v1.25.7 

type TemplatesResponse struct {

	// An array of responses, one for each message template that's associated with
	// your Amazon Pinpoint account and meets any filter criteria that you specified
	// in the request.
	//
	// Item is a required field
	Item []*TemplateResponse `type:"list" required:"true"`

	// The string to use in a subsequent request to get the next page of results
	// in a paginated response. This value is null if there are no additional pages.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

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

func (TemplatesResponse) GoString added in v1.25.7 

func (s TemplatesResponse) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TemplatesResponse) SetItem added in v1.25.7 

func (s *TemplatesResponse) SetItem(v []*TemplateResponse) *TemplatesResponse

SetItem sets the Item field's value.

func (*TemplatesResponse) SetNextToken added in v1.25.7 

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

SetNextToken sets the NextToken field's value.

func (TemplatesResponse) String added in v1.25.7 

func (s TemplatesResponse) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TooManyRequestsException added in v1.28.0 

type TooManyRequestsException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`

	RequestID_ *string `locationName:"RequestID" type:"string"`
	// contains filtered or unexported fields
}

Provides information about an API request or response.

func (*TooManyRequestsException) Code added in v1.28.0 

func (s *TooManyRequestsException) Code() string

Code returns the exception type name.

func (*TooManyRequestsException) Error added in v1.28.0 

func (s *TooManyRequestsException) Error() string

func (TooManyRequestsException) GoString added in v1.28.0 

func (s TooManyRequestsException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TooManyRequestsException) Message added in v1.28.0 

func (s *TooManyRequestsException) Message() string

Message returns the exception's message.

func (*TooManyRequestsException) OrigErr added in v1.28.0 

func (s *TooManyRequestsException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*TooManyRequestsException) RequestID added in v1.28.0 

func (s *TooManyRequestsException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*TooManyRequestsException) StatusCode added in v1.28.0 

func (s *TooManyRequestsException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (TooManyRequestsException) String added in v1.28.0 

func (s TooManyRequestsException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TreatmentResource 

type TreatmentResource struct {

	// The delivery configuration settings for sending the treatment through a custom
	// channel. This object is required if the MessageConfiguration object for the
	// treatment specifies a CustomMessage object.
	CustomDeliveryConfiguration *CustomDeliveryConfiguration `type:"structure"`

	// The unique identifier for the treatment.
	//
	// Id is a required field
	Id *string `type:"string" required:"true"`

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

	// The schedule settings for the treatment.
	Schedule *Schedule `type:"structure"`

	// The allocated percentage of users (segment members) that the treatment is
	// sent to.
	//
	// SizePercent is a required field
	SizePercent *int64 `type:"integer" required:"true"`

	// The current status of the treatment.
	State *CampaignState `type:"structure"`

	// The message template to use for the treatment.
	TemplateConfiguration *TemplateConfiguration `type:"structure"`

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

	// The custom name of the treatment.
	TreatmentName *string `type:"string"`
	// contains filtered or unexported fields
}

Specifies the settings for a campaign treatment. A treatment is a variation of a campaign that's used for A/B testing of a campaign.

func (TreatmentResource) GoString 

func (s TreatmentResource) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TreatmentResource) SetCustomDeliveryConfiguration added in v1.30.13 

func (s *TreatmentResource) SetCustomDeliveryConfiguration(v *CustomDeliveryConfiguration) *TreatmentResource

SetCustomDeliveryConfiguration sets the CustomDeliveryConfiguration field's value.

func (*TreatmentResource) SetId 

func (s *TreatmentResource) SetId(v string) *TreatmentResource

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 

func (s *TreatmentResource) SetState(v *CampaignState) *TreatmentResource

SetState sets the State field's value.

func (*TreatmentResource) SetTemplateConfiguration added in v1.25.7 

func (s *TreatmentResource) SetTemplateConfiguration(v *TemplateConfiguration) *TreatmentResource

SetTemplateConfiguration sets the TemplateConfiguration 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UntagResourceInput added in v1.17.6 

type UntagResourceInput struct {

	// ResourceArn is a required field
	ResourceArn *string `location:"uri" locationName:"resource-arn" type:"string" required:"true"`

	// TagKeys is a required field
	TagKeys []*string `location:"querystring" locationName:"tagKeys" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (UntagResourceInput) GoString added in v1.17.6 

func (s UntagResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UntagResourceInput) SetResourceArn added in v1.17.6 

func (s *UntagResourceInput) SetResourceArn(v string) *UntagResourceInput

SetResourceArn sets the ResourceArn field's value.

func (*UntagResourceInput) SetTagKeys added in v1.17.6 

func (s *UntagResourceInput) SetTagKeys(v []*string) *UntagResourceInput

SetTagKeys sets the TagKeys field's value.

func (UntagResourceInput) String added in v1.17.6 

func (s UntagResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UntagResourceInput) Validate added in v1.17.6 

func (s *UntagResourceInput) Validate() error

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

type UntagResourceOutput added in v1.17.6 

type UntagResourceOutput struct {
	// contains filtered or unexported fields
}

func (UntagResourceOutput) GoString added in v1.17.6 

func (s UntagResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UntagResourceOutput) String added in v1.17.6 

func (s UntagResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateAdmChannelInput added in v1.12.1 

type UpdateAdmChannelInput struct {

	// Specifies the status and settings of the ADM (Amazon Device Messaging) channel
	// for an application.
	//
	// ADMChannelRequest is a required field
	ADMChannelRequest *ADMChannelRequest `type:"structure" required:"true"`

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

func (UpdateAdmChannelInput) GoString added in v1.12.1 

func (s UpdateAdmChannelInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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 {

	// Provides information about the status and settings of the ADM (Amazon Device
	// Messaging) channel for an application.
	//
	// ADMChannelResponse is a required field
	ADMChannelResponse *ADMChannelResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateAdmChannelOutput) GoString added in v1.12.1 

func (s UpdateAdmChannelOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateAdmChannelOutput) SetADMChannelResponse added in v1.12.1 

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

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateApnsChannelInput 

type UpdateApnsChannelInput struct {

	// Specifies the status and settings of the APNs (Apple Push Notification service)
	// channel for an application.
	//
	// APNSChannelRequest is a required field
	APNSChannelRequest *APNSChannelRequest `type:"structure" required:"true"`

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

func (UpdateApnsChannelInput) GoString 

func (s UpdateApnsChannelInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateApnsChannelInput) SetAPNSChannelRequest 

func (s *UpdateApnsChannelInput) SetAPNSChannelRequest(v *APNSChannelRequest) *UpdateApnsChannelInput

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateApnsChannelInput) Validate 

func (s *UpdateApnsChannelInput) Validate() error

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

type UpdateApnsChannelOutput 

type UpdateApnsChannelOutput struct {

	// Provides information about the status and settings of the APNs (Apple Push
	// Notification service) channel for an application.
	//
	// APNSChannelResponse is a required field
	APNSChannelResponse *APNSChannelResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateApnsChannelOutput) GoString 

func (s UpdateApnsChannelOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateApnsChannelOutput) SetAPNSChannelResponse 

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

SetAPNSChannelResponse sets the APNSChannelResponse field's value.

func (UpdateApnsChannelOutput) String 

func (s UpdateApnsChannelOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateApnsSandboxChannelInput added in v1.8.38 

type UpdateApnsSandboxChannelInput struct {

	// Specifies the status and settings of the APNs (Apple Push Notification service)
	// sandbox channel for an application.
	//
	// APNSSandboxChannelRequest is a required field
	APNSSandboxChannelRequest *APNSSandboxChannelRequest `type:"structure" required:"true"`

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

func (UpdateApnsSandboxChannelInput) GoString added in v1.8.38 

func (s UpdateApnsSandboxChannelInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateApnsSandboxChannelInput) SetAPNSSandboxChannelRequest added in v1.8.38 

func (s *UpdateApnsSandboxChannelInput) SetAPNSSandboxChannelRequest(v *APNSSandboxChannelRequest) *UpdateApnsSandboxChannelInput

SetAPNSSandboxChannelRequest sets the APNSSandboxChannelRequest field's value.

func (*UpdateApnsSandboxChannelInput) SetApplicationId added in v1.8.38 

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

SetApplicationId sets the ApplicationId field's value.

func (UpdateApnsSandboxChannelInput) String added in v1.8.38 

func (s UpdateApnsSandboxChannelInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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 {

	// Provides information about the status and settings of the APNs (Apple Push
	// Notification service) sandbox channel for an application.
	//
	// APNSSandboxChannelResponse is a required field
	APNSSandboxChannelResponse *APNSSandboxChannelResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateApnsSandboxChannelOutput) GoString added in v1.8.38 

func (s UpdateApnsSandboxChannelOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateApnsSandboxChannelOutput) SetAPNSSandboxChannelResponse added in v1.8.38 

func (s *UpdateApnsSandboxChannelOutput) SetAPNSSandboxChannelResponse(v *APNSSandboxChannelResponse) *UpdateApnsSandboxChannelOutput

SetAPNSSandboxChannelResponse sets the APNSSandboxChannelResponse field's value.

func (UpdateApnsSandboxChannelOutput) String added in v1.8.38 

func (s UpdateApnsSandboxChannelOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateApnsVoipChannelInput added in v1.12.17 

type UpdateApnsVoipChannelInput struct {

	// Specifies the status and settings of the APNs (Apple Push Notification service)
	// VoIP channel for an application.
	//
	// APNSVoipChannelRequest is a required field
	APNSVoipChannelRequest *APNSVoipChannelRequest `type:"structure" required:"true"`

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

func (UpdateApnsVoipChannelInput) GoString added in v1.12.17 

func (s UpdateApnsVoipChannelInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateApnsVoipChannelInput) SetAPNSVoipChannelRequest added in v1.12.17 

func (s *UpdateApnsVoipChannelInput) SetAPNSVoipChannelRequest(v *APNSVoipChannelRequest) *UpdateApnsVoipChannelInput

SetAPNSVoipChannelRequest sets the APNSVoipChannelRequest field's value.

func (*UpdateApnsVoipChannelInput) SetApplicationId added in v1.12.17 

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

SetApplicationId sets the ApplicationId field's value.

func (UpdateApnsVoipChannelInput) String added in v1.12.17 

func (s UpdateApnsVoipChannelInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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 {

	// Provides information about the status and settings of the APNs (Apple Push
	// Notification service) VoIP channel for an application.
	//
	// APNSVoipChannelResponse is a required field
	APNSVoipChannelResponse *APNSVoipChannelResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateApnsVoipChannelOutput) GoString added in v1.12.17 

func (s UpdateApnsVoipChannelOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateApnsVoipChannelOutput) SetAPNSVoipChannelResponse added in v1.12.17 

func (s *UpdateApnsVoipChannelOutput) SetAPNSVoipChannelResponse(v *APNSVoipChannelResponse) *UpdateApnsVoipChannelOutput

SetAPNSVoipChannelResponse sets the APNSVoipChannelResponse field's value.

func (UpdateApnsVoipChannelOutput) String added in v1.12.17 

func (s UpdateApnsVoipChannelOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateApnsVoipSandboxChannelInput added in v1.12.17 

type UpdateApnsVoipSandboxChannelInput struct {

	// Specifies the status and settings of the APNs (Apple Push Notification service)
	// VoIP sandbox channel for an application.
	//
	// APNSVoipSandboxChannelRequest is a required field
	APNSVoipSandboxChannelRequest *APNSVoipSandboxChannelRequest `type:"structure" required:"true"`

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

func (UpdateApnsVoipSandboxChannelInput) GoString added in v1.12.17 

func (s UpdateApnsVoipSandboxChannelInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateApnsVoipSandboxChannelInput) SetAPNSVoipSandboxChannelRequest added in v1.12.17 

func (s *UpdateApnsVoipSandboxChannelInput) SetAPNSVoipSandboxChannelRequest(v *APNSVoipSandboxChannelRequest) *UpdateApnsVoipSandboxChannelInput

SetAPNSVoipSandboxChannelRequest sets the APNSVoipSandboxChannelRequest field's value.

func (*UpdateApnsVoipSandboxChannelInput) SetApplicationId added in v1.12.17 

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

SetApplicationId sets the ApplicationId field's value.

func (UpdateApnsVoipSandboxChannelInput) String added in v1.12.17 

func (s UpdateApnsVoipSandboxChannelInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateApnsVoipSandboxChannelInput) Validate added in v1.12.17 

func (s *UpdateApnsVoipSandboxChannelInput) Validate() error

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

type UpdateApnsVoipSandboxChannelOutput added in v1.12.17 

type UpdateApnsVoipSandboxChannelOutput struct {

	// Provides information about the status and settings of the APNs (Apple Push
	// Notification service) VoIP sandbox channel for an application.
	//
	// APNSVoipSandboxChannelResponse is a required field
	APNSVoipSandboxChannelResponse *APNSVoipSandboxChannelResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateApnsVoipSandboxChannelOutput) GoString added in v1.12.17 

func (s UpdateApnsVoipSandboxChannelOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateApnsVoipSandboxChannelOutput) SetAPNSVoipSandboxChannelResponse added in v1.12.17 

func (s *UpdateApnsVoipSandboxChannelOutput) SetAPNSVoipSandboxChannelResponse(v *APNSVoipSandboxChannelResponse) *UpdateApnsVoipSandboxChannelOutput

SetAPNSVoipSandboxChannelResponse sets the APNSVoipSandboxChannelResponse field's value.

func (UpdateApnsVoipSandboxChannelOutput) String added in v1.12.17 

func (s UpdateApnsVoipSandboxChannelOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateApplicationSettingsInput 

type UpdateApplicationSettingsInput struct {

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

	// Specifies the default settings for an application.
	//
	// WriteApplicationSettingsRequest is a required field
	WriteApplicationSettingsRequest *WriteApplicationSettingsRequest `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateApplicationSettingsInput) GoString 

func (s UpdateApplicationSettingsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateApplicationSettingsInput) SetApplicationId 

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

SetApplicationId sets the ApplicationId field's value.

func (*UpdateApplicationSettingsInput) SetWriteApplicationSettingsRequest 

func (s *UpdateApplicationSettingsInput) SetWriteApplicationSettingsRequest(v *WriteApplicationSettingsRequest) *UpdateApplicationSettingsInput

SetWriteApplicationSettingsRequest sets the WriteApplicationSettingsRequest field's value.

func (UpdateApplicationSettingsInput) String 

func (s UpdateApplicationSettingsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateApplicationSettingsInput) Validate 

func (s *UpdateApplicationSettingsInput) Validate() error

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

type UpdateApplicationSettingsOutput 

type UpdateApplicationSettingsOutput struct {

	// Provides information about an application, including the default settings
	// for an application.
	//
	// ApplicationSettingsResource is a required field
	ApplicationSettingsResource *ApplicationSettingsResource `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateApplicationSettingsOutput) GoString 

func (s UpdateApplicationSettingsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateApplicationSettingsOutput) SetApplicationSettingsResource 

func (s *UpdateApplicationSettingsOutput) SetApplicationSettingsResource(v *ApplicationSettingsResource) *UpdateApplicationSettingsOutput

SetApplicationSettingsResource sets the ApplicationSettingsResource field's value.

func (UpdateApplicationSettingsOutput) String 

func (s UpdateApplicationSettingsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateAttributesRequest added in v1.14.20 

type UpdateAttributesRequest struct {

	// An array of the attributes to remove from all the endpoints that are associated
	// with the application. The array can specify the complete, exact name of each
	// attribute to remove or it can specify a glob pattern that an attribute name
	// must match in order for the attribute to be removed.
	Blacklist []*string `type:"list"`
	// contains filtered or unexported fields
}

Specifies one or more attributes to remove from all the endpoints that are associated with an application.

func (UpdateAttributesRequest) GoString added in v1.14.20 

func (s UpdateAttributesRequest) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateAttributesRequest) SetBlacklist added in v1.14.20 

func (s *UpdateAttributesRequest) SetBlacklist(v []*string) *UpdateAttributesRequest

SetBlacklist sets the Blacklist field's value.

func (UpdateAttributesRequest) String added in v1.14.20 

func (s UpdateAttributesRequest) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type 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"`

	// Specifies the status and settings of the Baidu (Baidu Cloud Push) channel
	// for an application.
	//
	// BaiduChannelRequest is a required field
	BaiduChannelRequest *BaiduChannelRequest `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateBaiduChannelInput) GoString added in v1.12.1 

func (s UpdateBaiduChannelInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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 

func (s *UpdateBaiduChannelInput) SetBaiduChannelRequest(v *BaiduChannelRequest) *UpdateBaiduChannelInput

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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 {

	// Provides information about the status and settings of the Baidu (Baidu Cloud
	// Push) channel for an application.
	//
	// BaiduChannelResponse is a required field
	BaiduChannelResponse *BaiduChannelResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateBaiduChannelOutput) GoString added in v1.12.1 

func (s UpdateBaiduChannelOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateBaiduChannelOutput) SetBaiduChannelResponse added in v1.12.1 

func (s *UpdateBaiduChannelOutput) SetBaiduChannelResponse(v *BaiduChannelResponse) *UpdateBaiduChannelOutput

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateCampaignInput 

type UpdateCampaignInput struct {

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

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

	// Specifies the configuration and other settings for a campaign.
	//
	// WriteCampaignRequest is a required field
	WriteCampaignRequest *WriteCampaignRequest `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateCampaignInput) GoString 

func (s UpdateCampaignInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateCampaignInput) Validate 

func (s *UpdateCampaignInput) Validate() error

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

type UpdateCampaignOutput 

type UpdateCampaignOutput struct {

	// Provides information about the status, configuration, and other settings
	// for a campaign.
	//
	// CampaignResponse is a required field
	CampaignResponse *CampaignResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateCampaignOutput) GoString 

func (s UpdateCampaignOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type 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"`

	// Specifies the status and settings of the email channel for an application.
	//
	// EmailChannelRequest is a required field
	EmailChannelRequest *EmailChannelRequest `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateEmailChannelInput) GoString added in v1.8.38 

func (s UpdateEmailChannelInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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 

func (s *UpdateEmailChannelInput) SetEmailChannelRequest(v *EmailChannelRequest) *UpdateEmailChannelInput

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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 {

	// Provides information about the status and settings of the email channel for
	// an application.
	//
	// EmailChannelResponse is a required field
	EmailChannelResponse *EmailChannelResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateEmailChannelOutput) GoString added in v1.8.38 

func (s UpdateEmailChannelOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateEmailChannelOutput) SetEmailChannelResponse added in v1.8.38 

func (s *UpdateEmailChannelOutput) SetEmailChannelResponse(v *EmailChannelResponse) *UpdateEmailChannelOutput

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateEmailTemplateInput added in v1.25.7 

type UpdateEmailTemplateInput struct {
	CreateNewVersion *bool `location:"querystring" locationName:"create-new-version" type:"boolean"`

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

	// TemplateName is a required field
	TemplateName *string `location:"uri" locationName:"template-name" type:"string" required:"true"`

	Version *string `location:"querystring" locationName:"version" type:"string"`
	// contains filtered or unexported fields
}

func (UpdateEmailTemplateInput) GoString added in v1.25.7 

func (s UpdateEmailTemplateInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateEmailTemplateInput) SetCreateNewVersion added in v1.26.7 

func (s *UpdateEmailTemplateInput) SetCreateNewVersion(v bool) *UpdateEmailTemplateInput

SetCreateNewVersion sets the CreateNewVersion field's value.

func (*UpdateEmailTemplateInput) SetEmailTemplateRequest added in v1.25.7 

func (s *UpdateEmailTemplateInput) SetEmailTemplateRequest(v *EmailTemplateRequest) *UpdateEmailTemplateInput

SetEmailTemplateRequest sets the EmailTemplateRequest field's value.

func (*UpdateEmailTemplateInput) SetTemplateName added in v1.25.7 

func (s *UpdateEmailTemplateInput) SetTemplateName(v string) *UpdateEmailTemplateInput

SetTemplateName sets the TemplateName field's value.

func (*UpdateEmailTemplateInput) SetVersion added in v1.26.7 

func (s *UpdateEmailTemplateInput) SetVersion(v string) *UpdateEmailTemplateInput

SetVersion sets the Version field's value.

func (UpdateEmailTemplateInput) String added in v1.25.7 

func (s UpdateEmailTemplateInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateEmailTemplateInput) Validate added in v1.25.7 

func (s *UpdateEmailTemplateInput) Validate() error

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

type UpdateEmailTemplateOutput added in v1.25.7 

type UpdateEmailTemplateOutput struct {

	// Provides information about an API request or response.
	//
	// MessageBody is a required field
	MessageBody *MessageBody `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateEmailTemplateOutput) GoString added in v1.25.7 

func (s UpdateEmailTemplateOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateEmailTemplateOutput) SetMessageBody added in v1.25.7 

func (s *UpdateEmailTemplateOutput) SetMessageBody(v *MessageBody) *UpdateEmailTemplateOutput

SetMessageBody sets the MessageBody field's value.

func (UpdateEmailTemplateOutput) String added in v1.25.7 

func (s UpdateEmailTemplateOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateEndpointInput 

type UpdateEndpointInput struct {

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

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

	// Specifies the channel type and other settings for an endpoint.
	//
	// EndpointRequest is a required field
	EndpointRequest *EndpointRequest `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateEndpointInput) GoString 

func (s UpdateEndpointInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateEndpointInput) Validate 

func (s *UpdateEndpointInput) Validate() error

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

type UpdateEndpointOutput 

type UpdateEndpointOutput struct {

	// Provides information about an API request or response.
	//
	// MessageBody is a required field
	MessageBody *MessageBody `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateEndpointOutput) GoString 

func (s UpdateEndpointOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateEndpointsBatchInput 

type UpdateEndpointsBatchInput struct {

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

	// Specifies a batch of endpoints to create or update and the settings and attributes
	// to set or change for each endpoint.
	//
	// EndpointBatchRequest is a required field
	EndpointBatchRequest *EndpointBatchRequest `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateEndpointsBatchInput) GoString 

func (s UpdateEndpointsBatchInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateEndpointsBatchInput) SetApplicationId 

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

SetApplicationId sets the ApplicationId field's value.

func (*UpdateEndpointsBatchInput) SetEndpointBatchRequest 

func (s *UpdateEndpointsBatchInput) SetEndpointBatchRequest(v *EndpointBatchRequest) *UpdateEndpointsBatchInput

SetEndpointBatchRequest sets the EndpointBatchRequest field's value.

func (UpdateEndpointsBatchInput) String 

func (s UpdateEndpointsBatchInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateEndpointsBatchInput) Validate 

func (s *UpdateEndpointsBatchInput) Validate() error

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

type UpdateEndpointsBatchOutput 

type UpdateEndpointsBatchOutput struct {

	// Provides information about an API request or response.
	//
	// MessageBody is a required field
	MessageBody *MessageBody `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateEndpointsBatchOutput) GoString 

func (s UpdateEndpointsBatchOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateEndpointsBatchOutput) SetMessageBody 

func (s *UpdateEndpointsBatchOutput) SetMessageBody(v *MessageBody) *UpdateEndpointsBatchOutput

SetMessageBody sets the MessageBody field's value.

func (UpdateEndpointsBatchOutput) String 

func (s UpdateEndpointsBatchOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateGcmChannelInput 

type UpdateGcmChannelInput struct {

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

	// Specifies the status and settings of the GCM channel for an application.
	// This channel enables Amazon Pinpoint to send push notifications through the
	// Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service.
	//
	// GCMChannelRequest is a required field
	GCMChannelRequest *GCMChannelRequest `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateGcmChannelInput) GoString 

func (s UpdateGcmChannelInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateGcmChannelInput) Validate 

func (s *UpdateGcmChannelInput) Validate() error

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

type UpdateGcmChannelOutput 

type UpdateGcmChannelOutput struct {

	// Provides information about the status and settings of the GCM channel for
	// an application. The GCM channel enables Amazon Pinpoint to send push notifications
	// through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging
	// (GCM), service.
	//
	// GCMChannelResponse is a required field
	GCMChannelResponse *GCMChannelResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateGcmChannelOutput) GoString 

func (s UpdateGcmChannelOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateGcmChannelOutput) SetGCMChannelResponse 

func (s *UpdateGcmChannelOutput) SetGCMChannelResponse(v *GCMChannelResponse) *UpdateGcmChannelOutput

SetGCMChannelResponse sets the GCMChannelResponse field's value.

func (UpdateGcmChannelOutput) String 

func (s UpdateGcmChannelOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateInAppTemplateInput added in v1.40.44 

type UpdateInAppTemplateInput struct {
	CreateNewVersion *bool `location:"querystring" locationName:"create-new-version" type:"boolean"`

	// In-App Template Request.
	//
	// InAppTemplateRequest is a required field
	InAppTemplateRequest *InAppTemplateRequest `type:"structure" required:"true"`

	// TemplateName is a required field
	TemplateName *string `location:"uri" locationName:"template-name" type:"string" required:"true"`

	Version *string `location:"querystring" locationName:"version" type:"string"`
	// contains filtered or unexported fields
}

func (UpdateInAppTemplateInput) GoString added in v1.40.44 

func (s UpdateInAppTemplateInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateInAppTemplateInput) SetCreateNewVersion added in v1.40.44 

func (s *UpdateInAppTemplateInput) SetCreateNewVersion(v bool) *UpdateInAppTemplateInput

SetCreateNewVersion sets the CreateNewVersion field's value.

func (*UpdateInAppTemplateInput) SetInAppTemplateRequest added in v1.40.44 

func (s *UpdateInAppTemplateInput) SetInAppTemplateRequest(v *InAppTemplateRequest) *UpdateInAppTemplateInput

SetInAppTemplateRequest sets the InAppTemplateRequest field's value.

func (*UpdateInAppTemplateInput) SetTemplateName added in v1.40.44 

func (s *UpdateInAppTemplateInput) SetTemplateName(v string) *UpdateInAppTemplateInput

SetTemplateName sets the TemplateName field's value.

func (*UpdateInAppTemplateInput) SetVersion added in v1.40.44 

func (s *UpdateInAppTemplateInput) SetVersion(v string) *UpdateInAppTemplateInput

SetVersion sets the Version field's value.

func (UpdateInAppTemplateInput) String added in v1.40.44 

func (s UpdateInAppTemplateInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateInAppTemplateInput) Validate added in v1.40.44 

func (s *UpdateInAppTemplateInput) Validate() error

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

type UpdateInAppTemplateOutput added in v1.40.44 

type UpdateInAppTemplateOutput struct {

	// Provides information about an API request or response.
	//
	// MessageBody is a required field
	MessageBody *MessageBody `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateInAppTemplateOutput) GoString added in v1.40.44 

func (s UpdateInAppTemplateOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateInAppTemplateOutput) SetMessageBody added in v1.40.44 

func (s *UpdateInAppTemplateOutput) SetMessageBody(v *MessageBody) *UpdateInAppTemplateOutput

SetMessageBody sets the MessageBody field's value.

func (UpdateInAppTemplateOutput) String added in v1.40.44 

func (s UpdateInAppTemplateOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateJourneyInput added in v1.25.25 

type UpdateJourneyInput struct {

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

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

	// Specifies the configuration and other settings for a journey.
	//
	// WriteJourneyRequest is a required field
	WriteJourneyRequest *WriteJourneyRequest `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateJourneyInput) GoString added in v1.25.25 

func (s UpdateJourneyInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateJourneyInput) SetApplicationId added in v1.25.25 

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

SetApplicationId sets the ApplicationId field's value.

func (*UpdateJourneyInput) SetJourneyId added in v1.25.25 

func (s *UpdateJourneyInput) SetJourneyId(v string) *UpdateJourneyInput

SetJourneyId sets the JourneyId field's value.

func (*UpdateJourneyInput) SetWriteJourneyRequest added in v1.25.25 

func (s *UpdateJourneyInput) SetWriteJourneyRequest(v *WriteJourneyRequest) *UpdateJourneyInput

SetWriteJourneyRequest sets the WriteJourneyRequest field's value.

func (UpdateJourneyInput) String added in v1.25.25 

func (s UpdateJourneyInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateJourneyInput) Validate added in v1.25.25 

func (s *UpdateJourneyInput) Validate() error

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

type UpdateJourneyOutput added in v1.25.25 

type UpdateJourneyOutput struct {

	// Provides information about the status, configuration, and other settings
	// for a journey.
	//
	// JourneyResponse is a required field
	JourneyResponse *JourneyResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateJourneyOutput) GoString added in v1.25.25 

func (s UpdateJourneyOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateJourneyOutput) SetJourneyResponse added in v1.25.25 

func (s *UpdateJourneyOutput) SetJourneyResponse(v *JourneyResponse) *UpdateJourneyOutput

SetJourneyResponse sets the JourneyResponse field's value.

func (UpdateJourneyOutput) String added in v1.25.25 

func (s UpdateJourneyOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateJourneyStateInput added in v1.25.25 

type UpdateJourneyStateInput struct {

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

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

	// Changes the status of a journey.
	//
	// JourneyStateRequest is a required field
	JourneyStateRequest *JourneyStateRequest `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateJourneyStateInput) GoString added in v1.25.25 

func (s UpdateJourneyStateInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateJourneyStateInput) SetApplicationId added in v1.25.25 

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

SetApplicationId sets the ApplicationId field's value.

func (*UpdateJourneyStateInput) SetJourneyId added in v1.25.25 

func (s *UpdateJourneyStateInput) SetJourneyId(v string) *UpdateJourneyStateInput

SetJourneyId sets the JourneyId field's value.

func (*UpdateJourneyStateInput) SetJourneyStateRequest added in v1.25.25 

func (s *UpdateJourneyStateInput) SetJourneyStateRequest(v *JourneyStateRequest) *UpdateJourneyStateInput

SetJourneyStateRequest sets the JourneyStateRequest field's value.

func (UpdateJourneyStateInput) String added in v1.25.25 

func (s UpdateJourneyStateInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateJourneyStateInput) Validate added in v1.25.25 

func (s *UpdateJourneyStateInput) Validate() error

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

type UpdateJourneyStateOutput added in v1.25.25 

type UpdateJourneyStateOutput struct {

	// Provides information about the status, configuration, and other settings
	// for a journey.
	//
	// JourneyResponse is a required field
	JourneyResponse *JourneyResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateJourneyStateOutput) GoString added in v1.25.25 

func (s UpdateJourneyStateOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateJourneyStateOutput) SetJourneyResponse added in v1.25.25 

func (s *UpdateJourneyStateOutput) SetJourneyResponse(v *JourneyResponse) *UpdateJourneyStateOutput

SetJourneyResponse sets the JourneyResponse field's value.

func (UpdateJourneyStateOutput) String added in v1.25.25 

func (s UpdateJourneyStateOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdatePushTemplateInput added in v1.25.7 

type UpdatePushTemplateInput struct {
	CreateNewVersion *bool `location:"querystring" locationName:"create-new-version" type:"boolean"`

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

	// TemplateName is a required field
	TemplateName *string `location:"uri" locationName:"template-name" type:"string" required:"true"`

	Version *string `location:"querystring" locationName:"version" type:"string"`
	// contains filtered or unexported fields
}

func (UpdatePushTemplateInput) GoString added in v1.25.7 

func (s UpdatePushTemplateInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdatePushTemplateInput) SetCreateNewVersion added in v1.26.7 

func (s *UpdatePushTemplateInput) SetCreateNewVersion(v bool) *UpdatePushTemplateInput

SetCreateNewVersion sets the CreateNewVersion field's value.

func (*UpdatePushTemplateInput) SetPushNotificationTemplateRequest added in v1.25.7 

func (s *UpdatePushTemplateInput) SetPushNotificationTemplateRequest(v *PushNotificationTemplateRequest) *UpdatePushTemplateInput

SetPushNotificationTemplateRequest sets the PushNotificationTemplateRequest field's value.

func (*UpdatePushTemplateInput) SetTemplateName added in v1.25.7 

func (s *UpdatePushTemplateInput) SetTemplateName(v string) *UpdatePushTemplateInput

SetTemplateName sets the TemplateName field's value.

func (*UpdatePushTemplateInput) SetVersion added in v1.26.7 

func (s *UpdatePushTemplateInput) SetVersion(v string) *UpdatePushTemplateInput

SetVersion sets the Version field's value.

func (UpdatePushTemplateInput) String added in v1.25.7 

func (s UpdatePushTemplateInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdatePushTemplateInput) Validate added in v1.25.7 

func (s *UpdatePushTemplateInput) Validate() error

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

type UpdatePushTemplateOutput added in v1.25.7 

type UpdatePushTemplateOutput struct {

	// Provides information about an API request or response.
	//
	// MessageBody is a required field
	MessageBody *MessageBody `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (UpdatePushTemplateOutput) GoString added in v1.25.7 

func (s UpdatePushTemplateOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdatePushTemplateOutput) SetMessageBody added in v1.25.7 

func (s *UpdatePushTemplateOutput) SetMessageBody(v *MessageBody) *UpdatePushTemplateOutput

SetMessageBody sets the MessageBody field's value.

func (UpdatePushTemplateOutput) String added in v1.25.7 

func (s UpdatePushTemplateOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateRecommenderConfiguration added in v1.29.17 

type UpdateRecommenderConfiguration struct {

	// A map of key-value pairs that defines 1-10 custom endpoint or user attributes,
	// depending on the value for the RecommendationProviderIdType property. Each
	// of these attributes temporarily stores a recommended item that's retrieved
	// from the recommender model and sent to an AWS Lambda function for additional
	// processing. Each attribute can be used as a message variable in a message
	// template.
	//
	// In the map, the key is the name of a custom attribute and the value is a
	// custom display name for that attribute. The display name appears in the Attribute
	// finder of the template editor on the Amazon Pinpoint console. The following
	// restrictions apply to these names:
	//
	//    * An attribute name must start with a letter or number and it can contain
	//    up to 50 characters. The characters can be letters, numbers, underscores
	//    (_), or hyphens (-). Attribute names are case sensitive and must be unique.
	//
	//    * An attribute display name must start with a letter or number and it
	//    can contain up to 25 characters. The characters can be letters, numbers,
	//    spaces, underscores (_), or hyphens (-).
	//
	// This object is required if the configuration invokes an AWS Lambda function
	// (RecommendationTransformerUri) to process recommendation data. Otherwise,
	// don't include this object in your request.
	Attributes map[string]*string `type:"map"`

	// A custom description of the configuration for the recommender model. The
	// description can contain up to 128 characters. The characters can be letters,
	// numbers, spaces, or the following symbols: _ ; () , ‐.
	Description *string `type:"string"`

	// A custom name of the configuration for the recommender model. The name must
	// start with a letter or number and it can contain up to 128 characters. The
	// characters can be letters, numbers, spaces, underscores (_), or hyphens (-).
	Name *string `type:"string"`

	// The type of Amazon Pinpoint ID to associate with unique user IDs in the recommender
	// model. This value enables the model to use attribute and event data that’s
	// specific to a particular endpoint or user in an Amazon Pinpoint application.
	// Valid values are:
	//
	//    * PINPOINT_ENDPOINT_ID - Associate each user in the model with a particular
	//    endpoint in Amazon Pinpoint. The data is correlated based on endpoint
	//    IDs in Amazon Pinpoint. This is the default value.
	//
	//    * PINPOINT_USER_ID - Associate each user in the model with a particular
	//    user and endpoint in Amazon Pinpoint. The data is correlated based on
	//    user IDs in Amazon Pinpoint. If you specify this value, an endpoint definition
	//    in Amazon Pinpoint has to specify both a user ID (UserId) and an endpoint
	//    ID. Otherwise, messages won’t be sent to the user's endpoint.
	RecommendationProviderIdType *string `type:"string"`

	// The Amazon Resource Name (ARN) of the AWS Identity and Access Management
	// (IAM) role that authorizes Amazon Pinpoint to retrieve recommendation data
	// from the recommender model.
	//
	// RecommendationProviderRoleArn is a required field
	RecommendationProviderRoleArn *string `type:"string" required:"true"`

	// The Amazon Resource Name (ARN) of the recommender model to retrieve recommendation
	// data from. This value must match the ARN of an Amazon Personalize campaign.
	//
	// RecommendationProviderUri is a required field
	RecommendationProviderUri *string `type:"string" required:"true"`

	// The name or Amazon Resource Name (ARN) of the AWS Lambda function to invoke
	// for additional processing of recommendation data that's retrieved from the
	// recommender model.
	RecommendationTransformerUri *string `type:"string"`

	// A custom display name for the standard endpoint or user attribute (RecommendationItems)
	// that temporarily stores recommended items for each endpoint or user, depending
	// on the value for the RecommendationProviderIdType property. This value is
	// required if the configuration doesn't invoke an AWS Lambda function (RecommendationTransformerUri)
	// to perform additional processing of recommendation data.
	//
	// This name appears in the Attribute finder of the template editor on the Amazon
	// Pinpoint console. The name can contain up to 25 characters. The characters
	// can be letters, numbers, spaces, underscores (_), or hyphens (-). These restrictions
	// don't apply to attribute values.
	RecommendationsDisplayName *string `type:"string"`

	// The number of recommended items to retrieve from the model for each endpoint
	// or user, depending on the value for the RecommendationProviderIdType property.
	// This number determines how many recommended items are available for use in
	// message variables. The minimum value is 1. The maximum value is 5. The default
	// value is 5.
	//
	// To use multiple recommended items and custom attributes with message variables,
	// you have to use an AWS Lambda function (RecommendationTransformerUri) to
	// perform additional processing of recommendation data.
	RecommendationsPerMessage *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Specifies Amazon Pinpoint configuration settings for retrieving and processing recommendation data from a recommender model.

func (UpdateRecommenderConfiguration) GoString added in v1.29.17 

func (s UpdateRecommenderConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateRecommenderConfiguration) SetAttributes added in v1.29.17 

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

SetAttributes sets the Attributes field's value.

func (*UpdateRecommenderConfiguration) SetDescription added in v1.29.17 

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

SetDescription sets the Description field's value.

func (*UpdateRecommenderConfiguration) SetName added in v1.29.17 

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

SetName sets the Name field's value.

func (*UpdateRecommenderConfiguration) SetRecommendationProviderIdType added in v1.29.17 

func (s *UpdateRecommenderConfiguration) SetRecommendationProviderIdType(v string) *UpdateRecommenderConfiguration

SetRecommendationProviderIdType sets the RecommendationProviderIdType field's value.

func (*UpdateRecommenderConfiguration) SetRecommendationProviderRoleArn added in v1.29.17 

func (s *UpdateRecommenderConfiguration) SetRecommendationProviderRoleArn(v string) *UpdateRecommenderConfiguration

SetRecommendationProviderRoleArn sets the RecommendationProviderRoleArn field's value.

func (*UpdateRecommenderConfiguration) SetRecommendationProviderUri added in v1.29.17 

func (s *UpdateRecommenderConfiguration) SetRecommendationProviderUri(v string) *UpdateRecommenderConfiguration

SetRecommendationProviderUri sets the RecommendationProviderUri field's value.

func (*UpdateRecommenderConfiguration) SetRecommendationTransformerUri added in v1.29.17 

func (s *UpdateRecommenderConfiguration) SetRecommendationTransformerUri(v string) *UpdateRecommenderConfiguration

SetRecommendationTransformerUri sets the RecommendationTransformerUri field's value.

func (*UpdateRecommenderConfiguration) SetRecommendationsDisplayName added in v1.29.17 

func (s *UpdateRecommenderConfiguration) SetRecommendationsDisplayName(v string) *UpdateRecommenderConfiguration

SetRecommendationsDisplayName sets the RecommendationsDisplayName field's value.

func (*UpdateRecommenderConfiguration) SetRecommendationsPerMessage added in v1.29.17 

func (s *UpdateRecommenderConfiguration) SetRecommendationsPerMessage(v int64) *UpdateRecommenderConfiguration

SetRecommendationsPerMessage sets the RecommendationsPerMessage field's value.

func (UpdateRecommenderConfiguration) String added in v1.29.17 

func (s UpdateRecommenderConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateRecommenderConfiguration) Validate added in v1.29.17 

func (s *UpdateRecommenderConfiguration) Validate() error

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

type UpdateRecommenderConfigurationInput added in v1.29.17 

type UpdateRecommenderConfigurationInput struct {

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

	// Specifies Amazon Pinpoint configuration settings for retrieving and processing
	// recommendation data from a recommender model.
	//
	// UpdateRecommenderConfiguration is a required field
	UpdateRecommenderConfiguration *UpdateRecommenderConfiguration `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateRecommenderConfigurationInput) GoString added in v1.29.17 

func (s UpdateRecommenderConfigurationInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateRecommenderConfigurationInput) SetRecommenderId added in v1.29.17 

func (s *UpdateRecommenderConfigurationInput) SetRecommenderId(v string) *UpdateRecommenderConfigurationInput

SetRecommenderId sets the RecommenderId field's value.

func (*UpdateRecommenderConfigurationInput) SetUpdateRecommenderConfiguration added in v1.29.17 

func (s *UpdateRecommenderConfigurationInput) SetUpdateRecommenderConfiguration(v *UpdateRecommenderConfiguration) *UpdateRecommenderConfigurationInput

SetUpdateRecommenderConfiguration sets the UpdateRecommenderConfiguration field's value.

func (UpdateRecommenderConfigurationInput) String added in v1.29.17 

func (s UpdateRecommenderConfigurationInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateRecommenderConfigurationInput) Validate added in v1.29.17 

func (s *UpdateRecommenderConfigurationInput) Validate() error

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

type UpdateRecommenderConfigurationOutput added in v1.29.17 

type UpdateRecommenderConfigurationOutput struct {

	// Provides information about Amazon Pinpoint configuration settings for retrieving
	// and processing data from a recommender model.
	//
	// RecommenderConfigurationResponse is a required field
	RecommenderConfigurationResponse *RecommenderConfigurationResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateRecommenderConfigurationOutput) GoString added in v1.29.17 

func (s UpdateRecommenderConfigurationOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateRecommenderConfigurationOutput) SetRecommenderConfigurationResponse added in v1.29.17 

func (s *UpdateRecommenderConfigurationOutput) SetRecommenderConfigurationResponse(v *RecommenderConfigurationResponse) *UpdateRecommenderConfigurationOutput

SetRecommenderConfigurationResponse sets the RecommenderConfigurationResponse field's value.

func (UpdateRecommenderConfigurationOutput) String added in v1.29.17 

func (s UpdateRecommenderConfigurationOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateSegmentInput 

type UpdateSegmentInput struct {

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

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

	// Specifies the configuration, dimension, and other settings for a segment.
	// A WriteSegmentRequest object can include a Dimensions object or a SegmentGroups
	// object, but not both.
	//
	// WriteSegmentRequest is a required field
	WriteSegmentRequest *WriteSegmentRequest `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateSegmentInput) GoString 

func (s UpdateSegmentInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateSegmentInput) Validate 

func (s *UpdateSegmentInput) Validate() error

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

type UpdateSegmentOutput 

type UpdateSegmentOutput struct {

	// Provides information about the configuration, dimension, and other settings
	// for a segment.
	//
	// SegmentResponse is a required field
	SegmentResponse *SegmentResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateSegmentOutput) GoString 

func (s UpdateSegmentOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type 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"`

	// Specifies the status and settings of the SMS channel for an application.
	//
	// SMSChannelRequest is a required field
	SMSChannelRequest *SMSChannelRequest `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateSmsChannelInput) GoString added in v1.8.38 

func (s UpdateSmsChannelInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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 {

	// Provides information about the status and settings of the SMS channel for
	// an application.
	//
	// SMSChannelResponse is a required field
	SMSChannelResponse *SMSChannelResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateSmsChannelOutput) GoString added in v1.8.38 

func (s UpdateSmsChannelOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateSmsChannelOutput) SetSMSChannelResponse added in v1.8.38 

func (s *UpdateSmsChannelOutput) SetSMSChannelResponse(v *SMSChannelResponse) *UpdateSmsChannelOutput

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateSmsTemplateInput added in v1.25.7 

type UpdateSmsTemplateInput struct {
	CreateNewVersion *bool `location:"querystring" locationName:"create-new-version" type:"boolean"`

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

	// TemplateName is a required field
	TemplateName *string `location:"uri" locationName:"template-name" type:"string" required:"true"`

	Version *string `location:"querystring" locationName:"version" type:"string"`
	// contains filtered or unexported fields
}

func (UpdateSmsTemplateInput) GoString added in v1.25.7 

func (s UpdateSmsTemplateInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateSmsTemplateInput) SetCreateNewVersion added in v1.26.7 

func (s *UpdateSmsTemplateInput) SetCreateNewVersion(v bool) *UpdateSmsTemplateInput

SetCreateNewVersion sets the CreateNewVersion field's value.

func (*UpdateSmsTemplateInput) SetSMSTemplateRequest added in v1.25.7 

func (s *UpdateSmsTemplateInput) SetSMSTemplateRequest(v *SMSTemplateRequest) *UpdateSmsTemplateInput

SetSMSTemplateRequest sets the SMSTemplateRequest field's value.

func (*UpdateSmsTemplateInput) SetTemplateName added in v1.25.7 

func (s *UpdateSmsTemplateInput) SetTemplateName(v string) *UpdateSmsTemplateInput

SetTemplateName sets the TemplateName field's value.

func (*UpdateSmsTemplateInput) SetVersion added in v1.26.7 

func (s *UpdateSmsTemplateInput) SetVersion(v string) *UpdateSmsTemplateInput

SetVersion sets the Version field's value.

func (UpdateSmsTemplateInput) String added in v1.25.7 

func (s UpdateSmsTemplateInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateSmsTemplateInput) Validate added in v1.25.7 

func (s *UpdateSmsTemplateInput) Validate() error

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

type UpdateSmsTemplateOutput added in v1.25.7 

type UpdateSmsTemplateOutput struct {

	// Provides information about an API request or response.
	//
	// MessageBody is a required field
	MessageBody *MessageBody `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateSmsTemplateOutput) GoString added in v1.25.7 

func (s UpdateSmsTemplateOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateSmsTemplateOutput) SetMessageBody added in v1.25.7 

func (s *UpdateSmsTemplateOutput) SetMessageBody(v *MessageBody) *UpdateSmsTemplateOutput

SetMessageBody sets the MessageBody field's value.

func (UpdateSmsTemplateOutput) String added in v1.25.7 

func (s UpdateSmsTemplateOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateTemplateActiveVersionInput added in v1.26.7 

type UpdateTemplateActiveVersionInput struct {

	// Specifies which version of a message template to use as the active version
	// of the template.
	//
	// TemplateActiveVersionRequest is a required field
	TemplateActiveVersionRequest *TemplateActiveVersionRequest `type:"structure" required:"true"`

	// TemplateName is a required field
	TemplateName *string `location:"uri" locationName:"template-name" type:"string" required:"true"`

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

func (UpdateTemplateActiveVersionInput) GoString added in v1.26.7 

func (s UpdateTemplateActiveVersionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateTemplateActiveVersionInput) SetTemplateActiveVersionRequest added in v1.26.7 

func (s *UpdateTemplateActiveVersionInput) SetTemplateActiveVersionRequest(v *TemplateActiveVersionRequest) *UpdateTemplateActiveVersionInput

SetTemplateActiveVersionRequest sets the TemplateActiveVersionRequest field's value.

func (*UpdateTemplateActiveVersionInput) SetTemplateName added in v1.26.7 

func (s *UpdateTemplateActiveVersionInput) SetTemplateName(v string) *UpdateTemplateActiveVersionInput

SetTemplateName sets the TemplateName field's value.

func (*UpdateTemplateActiveVersionInput) SetTemplateType added in v1.26.7 

func (s *UpdateTemplateActiveVersionInput) SetTemplateType(v string) *UpdateTemplateActiveVersionInput

SetTemplateType sets the TemplateType field's value.

func (UpdateTemplateActiveVersionInput) String added in v1.26.7 

func (s UpdateTemplateActiveVersionInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateTemplateActiveVersionInput) Validate added in v1.26.7 

func (s *UpdateTemplateActiveVersionInput) Validate() error

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

type UpdateTemplateActiveVersionOutput added in v1.26.7 

type UpdateTemplateActiveVersionOutput struct {

	// Provides information about an API request or response.
	//
	// MessageBody is a required field
	MessageBody *MessageBody `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateTemplateActiveVersionOutput) GoString added in v1.26.7 

func (s UpdateTemplateActiveVersionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateTemplateActiveVersionOutput) SetMessageBody added in v1.26.7 

func (s *UpdateTemplateActiveVersionOutput) SetMessageBody(v *MessageBody) *UpdateTemplateActiveVersionOutput

SetMessageBody sets the MessageBody field's value.

func (UpdateTemplateActiveVersionOutput) String added in v1.26.7 

func (s UpdateTemplateActiveVersionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateVoiceChannelInput added in v1.15.77 

type UpdateVoiceChannelInput struct {

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

	// Specifies the status and settings of the voice channel for an application.
	//
	// VoiceChannelRequest is a required field
	VoiceChannelRequest *VoiceChannelRequest `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateVoiceChannelInput) GoString added in v1.15.77 

func (s UpdateVoiceChannelInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateVoiceChannelInput) SetApplicationId added in v1.15.77 

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

SetApplicationId sets the ApplicationId field's value.

func (*UpdateVoiceChannelInput) SetVoiceChannelRequest added in v1.15.77 

func (s *UpdateVoiceChannelInput) SetVoiceChannelRequest(v *VoiceChannelRequest) *UpdateVoiceChannelInput

SetVoiceChannelRequest sets the VoiceChannelRequest field's value.

func (UpdateVoiceChannelInput) String added in v1.15.77 

func (s UpdateVoiceChannelInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateVoiceChannelInput) Validate added in v1.15.77 

func (s *UpdateVoiceChannelInput) Validate() error

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

type UpdateVoiceChannelOutput added in v1.15.77 

type UpdateVoiceChannelOutput struct {

	// Provides information about the status and settings of the voice channel for
	// an application.
	//
	// VoiceChannelResponse is a required field
	VoiceChannelResponse *VoiceChannelResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateVoiceChannelOutput) GoString added in v1.15.77 

func (s UpdateVoiceChannelOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateVoiceChannelOutput) SetVoiceChannelResponse added in v1.15.77 

func (s *UpdateVoiceChannelOutput) SetVoiceChannelResponse(v *VoiceChannelResponse) *UpdateVoiceChannelOutput

SetVoiceChannelResponse sets the VoiceChannelResponse field's value.

func (UpdateVoiceChannelOutput) String added in v1.15.77 

func (s UpdateVoiceChannelOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateVoiceTemplateInput added in v1.25.37 

type UpdateVoiceTemplateInput struct {
	CreateNewVersion *bool `location:"querystring" locationName:"create-new-version" type:"boolean"`

	// TemplateName is a required field
	TemplateName *string `location:"uri" locationName:"template-name" type:"string" required:"true"`

	Version *string `location:"querystring" locationName:"version" type:"string"`

	// Specifies the content and settings for a message template that can be used
	// in messages that are sent through the voice channel.
	//
	// VoiceTemplateRequest is a required field
	VoiceTemplateRequest *VoiceTemplateRequest `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateVoiceTemplateInput) GoString added in v1.25.37 

func (s UpdateVoiceTemplateInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateVoiceTemplateInput) SetCreateNewVersion added in v1.26.7 

func (s *UpdateVoiceTemplateInput) SetCreateNewVersion(v bool) *UpdateVoiceTemplateInput

SetCreateNewVersion sets the CreateNewVersion field's value.

func (*UpdateVoiceTemplateInput) SetTemplateName added in v1.25.37 

func (s *UpdateVoiceTemplateInput) SetTemplateName(v string) *UpdateVoiceTemplateInput

SetTemplateName sets the TemplateName field's value.

func (*UpdateVoiceTemplateInput) SetVersion added in v1.26.7 

func (s *UpdateVoiceTemplateInput) SetVersion(v string) *UpdateVoiceTemplateInput

SetVersion sets the Version field's value.

func (*UpdateVoiceTemplateInput) SetVoiceTemplateRequest added in v1.25.37 

func (s *UpdateVoiceTemplateInput) SetVoiceTemplateRequest(v *VoiceTemplateRequest) *UpdateVoiceTemplateInput

SetVoiceTemplateRequest sets the VoiceTemplateRequest field's value.

func (UpdateVoiceTemplateInput) String added in v1.25.37 

func (s UpdateVoiceTemplateInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateVoiceTemplateInput) Validate added in v1.25.37 

func (s *UpdateVoiceTemplateInput) Validate() error

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

type UpdateVoiceTemplateOutput added in v1.25.37 

type UpdateVoiceTemplateOutput struct {

	// Provides information about an API request or response.
	//
	// MessageBody is a required field
	MessageBody *MessageBody `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateVoiceTemplateOutput) GoString added in v1.25.37 

func (s UpdateVoiceTemplateOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateVoiceTemplateOutput) SetMessageBody added in v1.25.37 

func (s *UpdateVoiceTemplateOutput) SetMessageBody(v *MessageBody) *UpdateVoiceTemplateOutput

SetMessageBody sets the MessageBody field's value.

func (UpdateVoiceTemplateOutput) String added in v1.25.37 

func (s UpdateVoiceTemplateOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type VerificationResponse added in v1.42.34 

type VerificationResponse struct {

	// Specifies whether the OTP is valid or not.
	Valid *bool `type:"boolean"`
	// contains filtered or unexported fields
}

Verify OTP Message Response.

func (VerificationResponse) GoString added in v1.42.34 

func (s VerificationResponse) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*VerificationResponse) SetValid added in v1.42.34 

func (s *VerificationResponse) SetValid(v bool) *VerificationResponse

SetValid sets the Valid field's value.

func (VerificationResponse) String added in v1.42.34 

func (s VerificationResponse) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type VerifyOTPMessageInput added in v1.42.34 

type VerifyOTPMessageInput struct {

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

	// Verify OTP message request.
	//
	// VerifyOTPMessageRequestParameters is a required field
	VerifyOTPMessageRequestParameters *VerifyOTPMessageRequestParameters `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (VerifyOTPMessageInput) GoString added in v1.42.34 

func (s VerifyOTPMessageInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*VerifyOTPMessageInput) SetApplicationId added in v1.42.34 

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

SetApplicationId sets the ApplicationId field's value.

func (*VerifyOTPMessageInput) SetVerifyOTPMessageRequestParameters added in v1.42.34 

func (s *VerifyOTPMessageInput) SetVerifyOTPMessageRequestParameters(v *VerifyOTPMessageRequestParameters) *VerifyOTPMessageInput

SetVerifyOTPMessageRequestParameters sets the VerifyOTPMessageRequestParameters field's value.

func (VerifyOTPMessageInput) String added in v1.42.34 

func (s VerifyOTPMessageInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*VerifyOTPMessageInput) Validate added in v1.42.34 

func (s *VerifyOTPMessageInput) Validate() error

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

type VerifyOTPMessageOutput added in v1.42.34 

type VerifyOTPMessageOutput struct {

	// Verify OTP Message Response.
	//
	// VerificationResponse is a required field
	VerificationResponse *VerificationResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (VerifyOTPMessageOutput) GoString added in v1.42.34 

func (s VerifyOTPMessageOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*VerifyOTPMessageOutput) SetVerificationResponse added in v1.42.34 

func (s *VerifyOTPMessageOutput) SetVerificationResponse(v *VerificationResponse) *VerifyOTPMessageOutput

SetVerificationResponse sets the VerificationResponse field's value.

func (VerifyOTPMessageOutput) String added in v1.42.34 

func (s VerifyOTPMessageOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type VerifyOTPMessageRequestParameters added in v1.42.34 

type VerifyOTPMessageRequestParameters struct {

	// The destination identity to send OTP to.
	//
	// DestinationIdentity is a required field
	DestinationIdentity *string `type:"string" required:"true"`

	// The OTP the end user provided for verification.
	//
	// Otp is a required field
	Otp *string `type:"string" required:"true"`

	// The reference identifier provided when the OTP was previously sent.
	//
	// ReferenceId is a required field
	ReferenceId *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Verify OTP message request.

func (VerifyOTPMessageRequestParameters) GoString added in v1.42.34 

func (s VerifyOTPMessageRequestParameters) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*VerifyOTPMessageRequestParameters) SetDestinationIdentity added in v1.42.34 

func (s *VerifyOTPMessageRequestParameters) SetDestinationIdentity(v string) *VerifyOTPMessageRequestParameters

SetDestinationIdentity sets the DestinationIdentity field's value.

func (*VerifyOTPMessageRequestParameters) SetOtp added in v1.42.34 

func (s *VerifyOTPMessageRequestParameters) SetOtp(v string) *VerifyOTPMessageRequestParameters

SetOtp sets the Otp field's value.

func (*VerifyOTPMessageRequestParameters) SetReferenceId added in v1.42.34 

func (s *VerifyOTPMessageRequestParameters) SetReferenceId(v string) *VerifyOTPMessageRequestParameters

SetReferenceId sets the ReferenceId field's value.

func (VerifyOTPMessageRequestParameters) String added in v1.42.34 

func (s VerifyOTPMessageRequestParameters) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*VerifyOTPMessageRequestParameters) Validate added in v1.42.34 

func (s *VerifyOTPMessageRequestParameters) Validate() error

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

type VoiceChannelRequest added in v1.15.77 

type VoiceChannelRequest struct {

	// Specifies whether to enable the voice channel for the application.
	Enabled *bool `type:"boolean"`
	// contains filtered or unexported fields
}

Specifies the status and settings of the voice channel for an application.

func (VoiceChannelRequest) GoString added in v1.15.77 

func (s VoiceChannelRequest) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*VoiceChannelRequest) SetEnabled added in v1.15.77 

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

SetEnabled sets the Enabled field's value.

func (VoiceChannelRequest) String added in v1.15.77 

func (s VoiceChannelRequest) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type VoiceChannelResponse added in v1.15.77 

type VoiceChannelResponse struct {

	// The unique identifier for the application that the voice channel applies
	// to.
	ApplicationId *string `type:"string"`

	// The date and time, in ISO 8601 format, when the voice channel was enabled.
	CreationDate *string `type:"string"`

	// Specifies whether the voice channel is enabled for the application.
	Enabled *bool `type:"boolean"`

	// (Not used) This property is retained only for backward compatibility.
	HasCredential *bool `type:"boolean"`

	// (Deprecated) An identifier for the voice channel. This property is retained
	// only for backward compatibility.
	Id *string `type:"string"`

	// Specifies whether the voice channel is archived.
	IsArchived *bool `type:"boolean"`

	// The user who last modified the voice channel.
	LastModifiedBy *string `type:"string"`

	// The date and time, in ISO 8601 format, when the voice channel was last modified.
	LastModifiedDate *string `type:"string"`

	// The type of messaging or notification platform for the channel. For the voice
	// channel, this value is VOICE.
	//
	// Platform is a required field
	Platform *string `type:"string" required:"true"`

	// The current version of the voice channel.
	Version *int64 `type:"integer"`
	// contains filtered or unexported fields
}

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

func (VoiceChannelResponse) GoString added in v1.15.77 

func (s VoiceChannelResponse) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*VoiceChannelResponse) SetApplicationId added in v1.15.77 

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

SetApplicationId sets the ApplicationId field's value.

func (*VoiceChannelResponse) SetCreationDate added in v1.15.77 

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

SetCreationDate sets the CreationDate field's value.

func (*VoiceChannelResponse) SetEnabled added in v1.15.77 

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

SetEnabled sets the Enabled field's value.

func (*VoiceChannelResponse) SetHasCredential added in v1.15.77 

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

SetHasCredential sets the HasCredential field's value.

func (*VoiceChannelResponse) SetId added in v1.15.77 

func (s *VoiceChannelResponse) SetId(v string) *VoiceChannelResponse

SetId sets the Id field's value.

func (*VoiceChannelResponse) SetIsArchived added in v1.15.77 

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

SetIsArchived sets the IsArchived field's value.

func (*VoiceChannelResponse) SetLastModifiedBy added in v1.15.77 

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

SetLastModifiedBy sets the LastModifiedBy field's value.

func (*VoiceChannelResponse) SetLastModifiedDate added in v1.15.77 

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

SetLastModifiedDate sets the LastModifiedDate field's value.

func (*VoiceChannelResponse) SetPlatform added in v1.15.77 

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

SetPlatform sets the Platform field's value.

func (*VoiceChannelResponse) SetVersion added in v1.15.77 

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

SetVersion sets the Version field's value.

func (VoiceChannelResponse) String added in v1.15.77 

func (s VoiceChannelResponse) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type VoiceMessage added in v1.15.77 

type VoiceMessage struct {

	// The text of the script to use for the voice message.
	Body *string `type:"string"`

	// The code for the language to use when synthesizing the text of the message
	// script. For a list of supported languages and the code for each one, see
	// the Amazon Polly Developer Guide (https://docs.aws.amazon.com/polly/latest/dg/what-is.html).
	LanguageCode *string `type:"string"`

	// The long code to send the voice message from. This value should be one of
	// the dedicated long codes that's assigned to your AWS account. Although it
	// isn't required, we recommend that you specify the long code in E.164 format,
	// for example +12065550100, to ensure prompt and accurate delivery of the message.
	OriginationNumber *string `type:"string"`

	// The default message variables to use in the voice message. You can override
	// the default variables with individual address variables.
	Substitutions map[string][]*string `type:"map"`

	// The name of the voice to use when delivering the message. For a list of supported
	// voices, see the Amazon Polly Developer Guide (https://docs.aws.amazon.com/polly/latest/dg/what-is.html).
	VoiceId *string `type:"string"`
	// contains filtered or unexported fields
}

Specifies the settings for a one-time voice message that's sent directly to an endpoint through the voice channel.

func (VoiceMessage) GoString added in v1.15.77 

func (s VoiceMessage) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*VoiceMessage) SetBody added in v1.15.77 

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

SetBody sets the Body field's value.

func (*VoiceMessage) SetLanguageCode added in v1.15.77 

func (s *VoiceMessage) SetLanguageCode(v string) *VoiceMessage

SetLanguageCode sets the LanguageCode field's value.

func (*VoiceMessage) SetOriginationNumber added in v1.15.77 

func (s *VoiceMessage) SetOriginationNumber(v string) *VoiceMessage

SetOriginationNumber sets the OriginationNumber field's value.

func (*VoiceMessage) SetSubstitutions added in v1.15.77 

func (s *VoiceMessage) SetSubstitutions(v map[string][]*string) *VoiceMessage

SetSubstitutions sets the Substitutions field's value.

func (*VoiceMessage) SetVoiceId added in v1.15.77 

func (s *VoiceMessage) SetVoiceId(v string) *VoiceMessage

SetVoiceId sets the VoiceId field's value.

func (VoiceMessage) String added in v1.15.77 

func (s VoiceMessage) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type VoiceTemplateRequest added in v1.25.37 

type VoiceTemplateRequest struct {

	// The text of the script to use in messages that are based on the message template,
	// in plain text format.
	Body *string `type:"string"`

	// A JSON object that specifies the default values to use for message variables
	// in the message template. This object is a set of key-value pairs. Each key
	// defines a message variable in the template. The corresponding value defines
	// the default value for that variable. When you create a message that's based
	// on the template, you can override these defaults with message-specific and
	// address-specific variables and values.
	DefaultSubstitutions *string `type:"string"`

	// The code for the language to use when synthesizing the text of the script
	// in messages that are based on the message template. For a list of supported
	// languages and the code for each one, see the Amazon Polly Developer Guide
	// (https://docs.aws.amazon.com/polly/latest/dg/what-is.html).
	LanguageCode *string `type:"string"`

	// A string-to-string map of key-value pairs that defines the tags to associate
	// with the message template. Each tag consists of a required tag key and an
	// associated tag value.
	Tags map[string]*string `locationName:"tags" type:"map"`

	// A custom description of the message template.
	TemplateDescription *string `type:"string"`

	// The name of the voice to use when delivering messages that are based on the
	// message template. For a list of supported voices, see the Amazon Polly Developer
	// Guide (https://docs.aws.amazon.com/polly/latest/dg/what-is.html).
	VoiceId *string `type:"string"`
	// contains filtered or unexported fields
}

Specifies the content and settings for a message template that can be used in messages that are sent through the voice channel.

func (VoiceTemplateRequest) GoString added in v1.25.37 

func (s VoiceTemplateRequest) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*VoiceTemplateRequest) SetBody added in v1.25.37 

func (s *VoiceTemplateRequest) SetBody(v string) *VoiceTemplateRequest

SetBody sets the Body field's value.

func (*VoiceTemplateRequest) SetDefaultSubstitutions added in v1.25.37 

func (s *VoiceTemplateRequest) SetDefaultSubstitutions(v string) *VoiceTemplateRequest

SetDefaultSubstitutions sets the DefaultSubstitutions field's value.

func (*VoiceTemplateRequest) SetLanguageCode added in v1.25.37 

func (s *VoiceTemplateRequest) SetLanguageCode(v string) *VoiceTemplateRequest

SetLanguageCode sets the LanguageCode field's value.

func (*VoiceTemplateRequest) SetTags added in v1.25.37 

func (s *VoiceTemplateRequest) SetTags(v map[string]*string) *VoiceTemplateRequest

SetTags sets the Tags field's value.

func (*VoiceTemplateRequest) SetTemplateDescription added in v1.25.37 

func (s *VoiceTemplateRequest) SetTemplateDescription(v string) *VoiceTemplateRequest

SetTemplateDescription sets the TemplateDescription field's value.

func (*VoiceTemplateRequest) SetVoiceId added in v1.25.37 

func (s *VoiceTemplateRequest) SetVoiceId(v string) *VoiceTemplateRequest

SetVoiceId sets the VoiceId field's value.

func (VoiceTemplateRequest) String added in v1.25.37 

func (s VoiceTemplateRequest) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type VoiceTemplateResponse added in v1.25.37 

type VoiceTemplateResponse struct {

	// The Amazon Resource Name (ARN) of the message template.
	Arn *string `type:"string"`

	// The text of the script that's used in messages that are based on the message
	// template, in plain text format.
	Body *string `type:"string"`

	// The date, in ISO 8601 format, when the message template was created.
	//
	// CreationDate is a required field
	CreationDate *string `type:"string" required:"true"`

	// The JSON object that specifies the default values that are used for message
	// variables in the message template. This object is a set of key-value pairs.
	// Each key defines a message variable in the template. The corresponding value
	// defines the default value for that variable.
	DefaultSubstitutions *string `type:"string"`

	// The code for the language that's used when synthesizing the text of the script
	// in messages that are based on the message template. For a list of supported
	// languages and the code for each one, see the Amazon Polly Developer Guide
	// (https://docs.aws.amazon.com/polly/latest/dg/what-is.html).
	LanguageCode *string `type:"string"`

	// The date, in ISO 8601 format, when the message template was last modified.
	//
	// LastModifiedDate is a required field
	LastModifiedDate *string `type:"string" required:"true"`

	// A string-to-string map of key-value pairs that identifies the tags that are
	// associated with the message template. Each tag consists of a required tag
	// key and an associated tag value.
	Tags map[string]*string `locationName:"tags" type:"map"`

	// The custom description of the message template.
	TemplateDescription *string `type:"string"`

	// The name of the message template.
	//
	// TemplateName is a required field
	TemplateName *string `type:"string" required:"true"`

	// The type of channel that the message template is designed for. For a voice
	// template, this value is VOICE.
	//
	// TemplateType is a required field
	TemplateType *string `type:"string" required:"true" enum:"TemplateType"`

	// The unique identifier, as an integer, for the active version of the message
	// template, or the version of the template that you specified by using the
	// version parameter in your request.
	Version *string `type:"string"`

	// The name of the voice that's used when delivering messages that are based
	// on the message template. For a list of supported voices, see the Amazon Polly
	// Developer Guide (https://docs.aws.amazon.com/polly/latest/dg/what-is.html).
	VoiceId *string `type:"string"`
	// contains filtered or unexported fields
}

Provides information about the content and settings for a message template that can be used in messages that are sent through the voice channel.

func (VoiceTemplateResponse) GoString added in v1.25.37 

func (s VoiceTemplateResponse) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*VoiceTemplateResponse) SetArn added in v1.25.37 

func (s *VoiceTemplateResponse) SetArn(v string) *VoiceTemplateResponse

SetArn sets the Arn field's value.

func (*VoiceTemplateResponse) SetBody added in v1.25.37 

func (s *VoiceTemplateResponse) SetBody(v string) *VoiceTemplateResponse

SetBody sets the Body field's value.

func (*VoiceTemplateResponse) SetCreationDate added in v1.25.37 

func (s *VoiceTemplateResponse) SetCreationDate(v string) *VoiceTemplateResponse

SetCreationDate sets the CreationDate field's value.

func (*VoiceTemplateResponse) SetDefaultSubstitutions added in v1.25.37 

func (s *VoiceTemplateResponse) SetDefaultSubstitutions(v string) *VoiceTemplateResponse

SetDefaultSubstitutions sets the DefaultSubstitutions field's value.

func (*VoiceTemplateResponse) SetLanguageCode added in v1.25.37 

func (s *VoiceTemplateResponse) SetLanguageCode(v string) *VoiceTemplateResponse

SetLanguageCode sets the LanguageCode field's value.

func (*VoiceTemplateResponse) SetLastModifiedDate added in v1.25.37 

func (s *VoiceTemplateResponse) SetLastModifiedDate(v string) *VoiceTemplateResponse

SetLastModifiedDate sets the LastModifiedDate field's value.

func (*VoiceTemplateResponse) SetTags added in v1.25.37 

func (s *VoiceTemplateResponse) SetTags(v map[string]*string) *VoiceTemplateResponse

SetTags sets the Tags field's value.

func (*VoiceTemplateResponse) SetTemplateDescription added in v1.25.37 

func (s *VoiceTemplateResponse) SetTemplateDescription(v string) *VoiceTemplateResponse

SetTemplateDescription sets the TemplateDescription field's value.

func (*VoiceTemplateResponse) SetTemplateName added in v1.25.37 

func (s *VoiceTemplateResponse) SetTemplateName(v string) *VoiceTemplateResponse

SetTemplateName sets the TemplateName field's value.

func (*VoiceTemplateResponse) SetTemplateType added in v1.25.37 

func (s *VoiceTemplateResponse) SetTemplateType(v string) *VoiceTemplateResponse

SetTemplateType sets the TemplateType field's value.

func (*VoiceTemplateResponse) SetVersion added in v1.26.7 

func (s *VoiceTemplateResponse) SetVersion(v string) *VoiceTemplateResponse

SetVersion sets the Version field's value.

func (*VoiceTemplateResponse) SetVoiceId added in v1.25.37 

func (s *VoiceTemplateResponse) SetVoiceId(v string) *VoiceTemplateResponse

SetVoiceId sets the VoiceId field's value.

func (VoiceTemplateResponse) String added in v1.25.37 

func (s VoiceTemplateResponse) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type WaitActivity added in v1.25.25 

type WaitActivity struct {

	// The unique identifier for the next activity to perform, after performing
	// the wait activity.
	NextActivity *string `type:"string"`

	// The amount of time to wait or the date and time when the activity moves participants
	// to the next activity in the journey.
	WaitTime *WaitTime `type:"structure"`
	// contains filtered or unexported fields
}

Specifies the settings for a wait activity in a journey. This type of activity waits for a certain amount of time or until a specific date and time before moving participants to the next activity in a journey.

func (WaitActivity) GoString added in v1.25.25 

func (s WaitActivity) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*WaitActivity) SetNextActivity added in v1.25.25 

func (s *WaitActivity) SetNextActivity(v string) *WaitActivity

SetNextActivity sets the NextActivity field's value.

func (*WaitActivity) SetWaitTime added in v1.25.25 

func (s *WaitActivity) SetWaitTime(v *WaitTime) *WaitActivity

SetWaitTime sets the WaitTime field's value.

func (WaitActivity) String added in v1.25.25 

func (s WaitActivity) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type WaitTime added in v1.25.25 

type WaitTime struct {

	// The amount of time to wait, as a duration in ISO 8601 format, before determining
	// whether the activity's conditions have been met or moving participants to
	// the next activity in the journey.
	WaitFor *string `type:"string"`

	// The date and time, in ISO 8601 format, when Amazon Pinpoint determines whether
	// the activity's conditions have been met or the activity moves participants
	// to the next activity in the journey.
	WaitUntil *string `type:"string"`
	// contains filtered or unexported fields
}

Specifies a duration or a date and time that indicates when Amazon Pinpoint determines whether an activity's conditions have been met or an activity moves participants to the next activity in a journey.

func (WaitTime) GoString added in v1.25.25 

func (s WaitTime) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*WaitTime) SetWaitFor added in v1.25.25 

func (s *WaitTime) SetWaitFor(v string) *WaitTime

SetWaitFor sets the WaitFor field's value.

func (*WaitTime) SetWaitUntil added in v1.25.25 

func (s *WaitTime) SetWaitUntil(v string) *WaitTime

SetWaitUntil sets the WaitUntil field's value.

func (WaitTime) String added in v1.25.25 

func (s WaitTime) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type WriteApplicationSettingsRequest 

type WriteApplicationSettingsRequest struct {

	// The settings for the AWS Lambda function to invoke by default as a code hook
	// for campaigns in the application. You can use this hook to customize segments
	// that are used by campaigns in the application.
	//
	// To override these settings and define custom settings for a specific campaign,
	// use the CampaignHook object of the Campaign resource.
	CampaignHook *CampaignHook `type:"structure"`

	// Specifies whether to enable application-related alarms in Amazon CloudWatch.
	CloudWatchMetricsEnabled *bool `type:"boolean"`

	// The default sending limits for campaigns in the application. To override
	// these limits and define custom limits for a specific campaign or journey,
	// use the Campaign resource or the Journey resource, respectively.
	Limits *CampaignLimits `type:"structure"`

	// The default quiet time for campaigns in the application. Quiet time is a
	// specific time range when messages aren't sent to endpoints, if all the following
	// conditions are met:
	//
	//    * The EndpointDemographic.Timezone property of the endpoint is set to
	//    a valid value.
	//
	//    * The current time in the endpoint's time zone is later than or equal
	//    to the time specified by the QuietTime.Start property for the application
	//    (or a campaign or journey that has custom quiet time settings).
	//
	//    * The current time in the endpoint's time zone is earlier than or equal
	//    to the time specified by the QuietTime.End property for the application
	//    (or a campaign or journey that has custom quiet time settings).
	//
	// If any of the preceding conditions isn't met, the endpoint will receive messages
	// from a campaign or journey, even if quiet time is enabled.
	//
	// To override the default quiet time settings for a specific campaign or journey,
	// use the Campaign resource or the Journey resource to define a custom quiet
	// time for the campaign or journey.
	QuietTime *QuietTime `type:"structure"`
	// contains filtered or unexported fields
}

Specifies the default settings for an application.

func (WriteApplicationSettingsRequest) GoString 

func (s WriteApplicationSettingsRequest) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*WriteApplicationSettingsRequest) SetCampaignHook added in v1.13.11 

func (s *WriteApplicationSettingsRequest) SetCampaignHook(v *CampaignHook) *WriteApplicationSettingsRequest

SetCampaignHook sets the CampaignHook field's value.

func (*WriteApplicationSettingsRequest) SetCloudWatchMetricsEnabled added in v1.14.20 

func (s *WriteApplicationSettingsRequest) SetCloudWatchMetricsEnabled(v bool) *WriteApplicationSettingsRequest

SetCloudWatchMetricsEnabled sets the CloudWatchMetricsEnabled field's value.

func (*WriteApplicationSettingsRequest) SetLimits 

func (s *WriteApplicationSettingsRequest) SetLimits(v *CampaignLimits) *WriteApplicationSettingsRequest

SetLimits sets the Limits field's value.

func (*WriteApplicationSettingsRequest) SetQuietTime 

func (s *WriteApplicationSettingsRequest) SetQuietTime(v *QuietTime) *WriteApplicationSettingsRequest

SetQuietTime sets the QuietTime field's value.

func (WriteApplicationSettingsRequest) String 

func (s WriteApplicationSettingsRequest) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type WriteCampaignRequest 

type WriteCampaignRequest struct {

	// An array of requests that defines additional treatments for the campaign,
	// in addition to the default treatment for the campaign.
	AdditionalTreatments []*WriteTreatmentResource `type:"list"`

	// The delivery configuration settings for sending the campaign through a custom
	// channel. This object is required if the MessageConfiguration object for the
	// campaign specifies a CustomMessage object.
	CustomDeliveryConfiguration *CustomDeliveryConfiguration `type:"structure"`

	// A custom description of the campaign.
	Description *string `type:"string"`

	// The allocated percentage of users (segment members) who shouldn't receive
	// messages from the campaign.
	HoldoutPercent *int64 `type:"integer"`

	// The settings for the AWS Lambda function to invoke as a code hook for the
	// campaign. You can use this hook to customize the segment that's used by the
	// campaign.
	Hook *CampaignHook `type:"structure"`

	// Specifies whether to pause the campaign. A paused campaign doesn't run unless
	// you resume it by changing this value to false.
	IsPaused *bool `type:"boolean"`

	// The messaging limits for the campaign.
	Limits *CampaignLimits `type:"structure"`

	// The message configuration settings for the campaign.
	MessageConfiguration *MessageConfiguration `type:"structure"`

	// A custom name for the campaign.
	Name *string `type:"string"`

	// Defines the priority of the campaign, used to decide the order of messages
	// displayed to user if there are multiple messages scheduled to be displayed
	// at the same moment.
	Priority *int64 `type:"integer"`

	// The schedule settings for the campaign.
	Schedule *Schedule `type:"structure"`

	// The unique identifier for the segment to associate with the campaign.
	SegmentId *string `type:"string"`

	// The version of the segment to associate with the campaign.
	SegmentVersion *int64 `type:"integer"`

	// A string-to-string map of key-value pairs that defines the tags to associate
	// with the campaign. Each tag consists of a required tag key and an associated
	// tag value.
	Tags map[string]*string `locationName:"tags" type:"map"`

	// The message template to use for the campaign.
	TemplateConfiguration *TemplateConfiguration `type:"structure"`

	// A custom description of the default treatment for the campaign.
	TreatmentDescription *string `type:"string"`

	// A custom name of the default treatment for the campaign, if the campaign
	// has multiple treatments. A treatment is a variation of a campaign that's
	// used for A/B testing.
	TreatmentName *string `type:"string"`
	// contains filtered or unexported fields
}

Specifies the configuration and other settings for a campaign.

func (WriteCampaignRequest) GoString 

func (s WriteCampaignRequest) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*WriteCampaignRequest) SetAdditionalTreatments 

func (s *WriteCampaignRequest) SetAdditionalTreatments(v []*WriteTreatmentResource) *WriteCampaignRequest

SetAdditionalTreatments sets the AdditionalTreatments field's value.

func (*WriteCampaignRequest) SetCustomDeliveryConfiguration added in v1.30.13 

func (s *WriteCampaignRequest) SetCustomDeliveryConfiguration(v *CustomDeliveryConfiguration) *WriteCampaignRequest

SetCustomDeliveryConfiguration sets the CustomDeliveryConfiguration 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 

func (s *WriteCampaignRequest) SetHook(v *CampaignHook) *WriteCampaignRequest

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 

func (s *WriteCampaignRequest) SetLimits(v *CampaignLimits) *WriteCampaignRequest

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 

func (s *WriteCampaignRequest) SetName(v string) *WriteCampaignRequest

SetName sets the Name field's value.

func (*WriteCampaignRequest) SetPriority added in v1.40.44 

func (s *WriteCampaignRequest) SetPriority(v int64) *WriteCampaignRequest

SetPriority sets the Priority field's value.

func (*WriteCampaignRequest) SetSchedule 

func (s *WriteCampaignRequest) SetSchedule(v *Schedule) *WriteCampaignRequest

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) SetTags added in v1.17.6 

func (s *WriteCampaignRequest) SetTags(v map[string]*string) *WriteCampaignRequest

SetTags sets the Tags field's value.

func (*WriteCampaignRequest) SetTemplateConfiguration added in v1.25.7 

func (s *WriteCampaignRequest) SetTemplateConfiguration(v *TemplateConfiguration) *WriteCampaignRequest

SetTemplateConfiguration sets the TemplateConfiguration 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*WriteCampaignRequest) Validate added in v1.20.11 

func (s *WriteCampaignRequest) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type WriteEventStream added in v1.8.0 

type WriteEventStream struct {

	// The Amazon Resource Name (ARN) of the Amazon Kinesis data stream or Amazon
	// Kinesis Data Firehose delivery stream that you want to publish event data
	// to.
	//
	// For a Kinesis data stream, the ARN format is: arn:aws:kinesis:region:account-id:stream/stream_name
	//
	// For a Kinesis Data Firehose delivery stream, the ARN format is: arn:aws:firehose:region:account-id:deliverystream/stream_name
	//
	// DestinationStreamArn is a required field
	DestinationStreamArn *string `type:"string" required:"true"`

	// The AWS Identity and Access Management (IAM) role that authorizes Amazon
	// Pinpoint to publish event data to the stream in your AWS account.
	//
	// RoleArn is a required field
	RoleArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Specifies the Amazon Resource Name (ARN) of an event stream to publish events to and the AWS Identity and Access Management (IAM) role to use when publishing those events.

func (WriteEventStream) GoString added in v1.8.0 

func (s WriteEventStream) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*WriteEventStream) Validate added in v1.20.11 

func (s *WriteEventStream) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type WriteJourneyRequest added in v1.25.25 

type WriteJourneyRequest struct {

	// A map that contains a set of Activity objects, one object for each activity
	// in the journey. For each Activity object, the key is the unique identifier
	// (string) for an activity and the value is the settings for the activity.
	// An activity identifier can contain a maximum of 100 characters. The characters
	// must be alphanumeric characters.
	Activities map[string]*Activity `type:"map"`

	// The date, in ISO 8601 format, when the journey was created.
	CreationDate *string `type:"string"`

	// IAM role ARN to be assumed when invoking Connect campaign execution APIs
	// for dialing.
	JourneyChannelSettings *JourneyChannelSettings `type:"structure"`

	// The date, in ISO 8601 format, when the journey was last modified.
	LastModifiedDate *string `type:"string"`

	// The messaging and entry limits for the journey.
	Limits *JourneyLimits `type:"structure"`

	// Specifies whether the journey's scheduled start and end times use each participant's
	// local time. To base the schedule on each participant's local time, set this
	// value to true.
	LocalTime *bool `type:"boolean"`

	// The name of the journey. A journey name can contain a maximum of 150 characters.
	// The characters can be alphanumeric characters or symbols, such as underscores
	// (_) or hyphens (-). A journey name can't contain any spaces.
	//
	// Name is a required field
	Name *string `type:"string" required:"true"`

	// The quiet time settings for the journey. Quiet time is a specific time range
	// when a journey doesn't send messages to participants, if all the following
	// conditions are met:
	//
	//    * The EndpointDemographic.Timezone property of the endpoint for the participant
	//    is set to a valid value.
	//
	//    * The current time in the participant's time zone is later than or equal
	//    to the time specified by the QuietTime.Start property for the journey.
	//
	//    * The current time in the participant's time zone is earlier than or equal
	//    to the time specified by the QuietTime.End property for the journey.
	//
	// If any of the preceding conditions isn't met, the participant will receive
	// messages from the journey, even if quiet time is enabled.
	QuietTime *QuietTime `type:"structure"`

	// The frequency with which Amazon Pinpoint evaluates segment and event data
	// for the journey, as a duration in ISO 8601 format.
	RefreshFrequency *string `type:"string"`

	RefreshOnSegmentUpdate *bool `type:"boolean"`

	// The schedule settings for the journey.
	Schedule *JourneySchedule `type:"structure"`

	// The unique identifier for the first activity in the journey. The identifier
	// for this activity can contain a maximum of 128 characters. The characters
	// must be alphanumeric characters.
	StartActivity *string `type:"string"`

	// The segment that defines which users are participants in the journey.
	StartCondition *StartCondition `type:"structure"`

	// The status of the journey. Valid values are:
	//
	//    * DRAFT - Saves the journey and doesn't publish it.
	//
	//    * ACTIVE - Saves and publishes the journey. Depending on the journey's
	//    schedule, the journey starts running immediately or at the scheduled start
	//    time. If a journey's status is ACTIVE, you can't add, change, or remove
	//    activities from it.
	//
	// PAUSED, CANCELLED, COMPLETED, and CLOSED states are not supported in requests
	// to create or update a journey. To cancel, pause, or resume a journey, use
	// the Journey State resource.
	State *string `type:"string" enum:"State"`

	WaitForQuietTime *bool `type:"boolean"`
	// contains filtered or unexported fields
}

Specifies the configuration and other settings for a journey.

func (WriteJourneyRequest) GoString added in v1.25.25 

func (s WriteJourneyRequest) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*WriteJourneyRequest) SetActivities added in v1.25.25 

func (s *WriteJourneyRequest) SetActivities(v map[string]*Activity) *WriteJourneyRequest

SetActivities sets the Activities field's value.

func (*WriteJourneyRequest) SetCreationDate added in v1.25.25 

func (s *WriteJourneyRequest) SetCreationDate(v string) *WriteJourneyRequest

SetCreationDate sets the CreationDate field's value.

func (*WriteJourneyRequest) SetJourneyChannelSettings added in v1.40.50 

func (s *WriteJourneyRequest) SetJourneyChannelSettings(v *JourneyChannelSettings) *WriteJourneyRequest

SetJourneyChannelSettings sets the JourneyChannelSettings field's value.

func (*WriteJourneyRequest) SetLastModifiedDate added in v1.25.25 

func (s *WriteJourneyRequest) SetLastModifiedDate(v string) *WriteJourneyRequest

SetLastModifiedDate sets the LastModifiedDate field's value.

func (*WriteJourneyRequest) SetLimits added in v1.25.25 

func (s *WriteJourneyRequest) SetLimits(v *JourneyLimits) *WriteJourneyRequest

SetLimits sets the Limits field's value.

func (*WriteJourneyRequest) SetLocalTime added in v1.25.25 

func (s *WriteJourneyRequest) SetLocalTime(v bool) *WriteJourneyRequest

SetLocalTime sets the LocalTime field's value.

func (*WriteJourneyRequest) SetName added in v1.25.25 

func (s *WriteJourneyRequest) SetName(v string) *WriteJourneyRequest

SetName sets the Name field's value.

func (*WriteJourneyRequest) SetQuietTime added in v1.25.25 

func (s *WriteJourneyRequest) SetQuietTime(v *QuietTime) *WriteJourneyRequest

SetQuietTime sets the QuietTime field's value.

func (*WriteJourneyRequest) SetRefreshFrequency added in v1.25.25 

func (s *WriteJourneyRequest) SetRefreshFrequency(v string) *WriteJourneyRequest

SetRefreshFrequency sets the RefreshFrequency field's value.

func (*WriteJourneyRequest) SetRefreshOnSegmentUpdate added in v1.38.9 

func (s *WriteJourneyRequest) SetRefreshOnSegmentUpdate(v bool) *WriteJourneyRequest

SetRefreshOnSegmentUpdate sets the RefreshOnSegmentUpdate field's value.

func (*WriteJourneyRequest) SetSchedule added in v1.25.25 

func (s *WriteJourneyRequest) SetSchedule(v *JourneySchedule) *WriteJourneyRequest

SetSchedule sets the Schedule field's value.

func (*WriteJourneyRequest) SetStartActivity added in v1.25.25 

func (s *WriteJourneyRequest) SetStartActivity(v string) *WriteJourneyRequest

SetStartActivity sets the StartActivity field's value.

func (*WriteJourneyRequest) SetStartCondition added in v1.25.25 

func (s *WriteJourneyRequest) SetStartCondition(v *StartCondition) *WriteJourneyRequest

SetStartCondition sets the StartCondition field's value.

func (*WriteJourneyRequest) SetState added in v1.25.25 

func (s *WriteJourneyRequest) SetState(v string) *WriteJourneyRequest

SetState sets the State field's value.

func (*WriteJourneyRequest) SetWaitForQuietTime added in v1.38.9 

func (s *WriteJourneyRequest) SetWaitForQuietTime(v bool) *WriteJourneyRequest

SetWaitForQuietTime sets the WaitForQuietTime field's value.

func (WriteJourneyRequest) String added in v1.25.25 

func (s WriteJourneyRequest) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*WriteJourneyRequest) Validate added in v1.25.25 

func (s *WriteJourneyRequest) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type WriteSegmentRequest 

type WriteSegmentRequest struct {

	// The criteria that define the dimensions for the segment.
	Dimensions *SegmentDimensions `type:"structure"`

	// The name of the segment.
	Name *string `type:"string"`

	// The segment group to use and the dimensions to apply to the group's base
	// segments in order to build the segment. A segment group can consist of zero
	// or more base segments. Your request can include only one segment group.
	SegmentGroups *SegmentGroupList `type:"structure"`

	// A string-to-string map of key-value pairs that defines the tags to associate
	// with the segment. Each tag consists of a required tag key and an associated
	// tag value.
	Tags map[string]*string `locationName:"tags" type:"map"`
	// contains filtered or unexported fields
}

Specifies the configuration, dimension, and other settings for a segment. A WriteSegmentRequest object can include a Dimensions object or a SegmentGroups object, but not both.

func (WriteSegmentRequest) GoString 

func (s WriteSegmentRequest) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*WriteSegmentRequest) SetDimensions 

func (s *WriteSegmentRequest) SetDimensions(v *SegmentDimensions) *WriteSegmentRequest

SetDimensions sets the Dimensions field's value.

func (*WriteSegmentRequest) SetName 

func (s *WriteSegmentRequest) SetName(v string) *WriteSegmentRequest

SetName sets the Name field's value.

func (*WriteSegmentRequest) SetSegmentGroups added in v1.14.20 

func (s *WriteSegmentRequest) SetSegmentGroups(v *SegmentGroupList) *WriteSegmentRequest

SetSegmentGroups sets the SegmentGroups field's value.

func (*WriteSegmentRequest) SetTags added in v1.17.6 

func (s *WriteSegmentRequest) SetTags(v map[string]*string) *WriteSegmentRequest

SetTags sets the Tags field's value.

func (WriteSegmentRequest) String 

func (s WriteSegmentRequest) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*WriteSegmentRequest) Validate added in v1.20.11 

func (s *WriteSegmentRequest) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type WriteTreatmentResource 

type WriteTreatmentResource struct {

	// The delivery configuration settings for sending the treatment through a custom
	// channel. This object is required if the MessageConfiguration object for the
	// treatment specifies a CustomMessage object.
	CustomDeliveryConfiguration *CustomDeliveryConfiguration `type:"structure"`

	// The message configuration settings for the treatment.
	MessageConfiguration *MessageConfiguration `type:"structure"`

	// The schedule settings for the treatment.
	Schedule *Schedule `type:"structure"`

	// The allocated percentage of users (segment members) to send the treatment
	// to.
	//
	// SizePercent is a required field
	SizePercent *int64 `type:"integer" required:"true"`

	// The message template to use for the treatment.
	TemplateConfiguration *TemplateConfiguration `type:"structure"`

	// A custom description of the treatment.
	TreatmentDescription *string `type:"string"`

	// A custom name for the treatment.
	TreatmentName *string `type:"string"`
	// contains filtered or unexported fields
}

Specifies the settings for a campaign treatment. A treatment is a variation of a campaign that's used for A/B testing of a campaign.

func (WriteTreatmentResource) GoString 

func (s WriteTreatmentResource) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*WriteTreatmentResource) SetCustomDeliveryConfiguration added in v1.30.13 

func (s *WriteTreatmentResource) SetCustomDeliveryConfiguration(v *CustomDeliveryConfiguration) *WriteTreatmentResource

SetCustomDeliveryConfiguration sets the CustomDeliveryConfiguration field's value.

func (*WriteTreatmentResource) SetMessageConfiguration 

func (s *WriteTreatmentResource) SetMessageConfiguration(v *MessageConfiguration) *WriteTreatmentResource

SetMessageConfiguration sets the MessageConfiguration field's value.

func (*WriteTreatmentResource) SetSchedule 

func (s *WriteTreatmentResource) SetSchedule(v *Schedule) *WriteTreatmentResource

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) SetTemplateConfiguration added in v1.25.7 

func (s *WriteTreatmentResource) SetTemplateConfiguration(v *TemplateConfiguration) *WriteTreatmentResource

SetTemplateConfiguration sets the TemplateConfiguration 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*WriteTreatmentResource) Validate added in v1.20.11 

func (s *WriteTreatmentResource) Validate() error

Validate inspects the fields of the type to determine if they are valid.

Source Files

View all Source files

Directories

Path Synopsis
Package pinpointiface provides an interface to enable mocking the Amazon Pinpoint service client for testing your code.
 Package pinpointiface provides an interface to enable mocking the Amazon Pinpoint service client for testing your code.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.