pinpoint

package
v1.8.32 Latest Latest
Warning

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

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

Documentation

Overview

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

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

Using the Client

To use the client for Amazon Pinpoint you will first need to create a new instance of it.

When creating a client for an AWS service you'll first need to have a Session already created. The Session provides configuration that can be shared between multiple service clients. Additional configuration can be applied to the Session and service's client when they are constructed. The aws package's Config type contains several fields such as Region for the AWS Region the client should make API requests too. The optional Config value can be provided as the variadic argument for Sessions and client creation.

Once the service's client is created you can use it to make API requests the AWS service. These clients are safe to use concurrently. 

// Create a session to share configuration, and load external configuration.
sess := session.Must(session.NewSession())

// Create the service's client with the session.
svc := pinpoint.New(sess)

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

See aws package's Config type for more information on configuration options. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

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

Once the client is created you can make an API request to the service. Each API method takes a input parameter, and returns the service response and an error.

The API method will document which error codes the service can be returned by the operation if the service models the API operation's errors. These errors will also be available as const strings prefixed with "ErrCode". 

result, err := svc.CreateCampaign(params)
if err != nil {
    // Cast err to awserr.Error to handle specific error codes.
    aerr, ok := err.(awserr.Error)
    if ok && aerr.Code() == <error code to check for> {
        // Specific error code handling
    }
    return err
}

fmt.Println("CreateCampaign result:")
fmt.Println(result)

Using the Client with Context

The service's client also provides methods to make API requests with a Context value. This allows you to control the timeout, and cancellation of pending requests. These methods also take request Option as variadic parameter to apply additional configuration to the API request. 

ctx := context.Background()

result, err := svc.CreateCampaignWithContext(ctx, params)

See the request package documentation for more information on using Context pattern with the SDK. https://docs.aws.amazon.com/sdk-for-go/api/aws/request/

Index

Examples

Constants

View Source 
const (
	// ActionOpenApp is a Action enum value
	ActionOpenApp = "OPEN_APP"

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

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

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

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

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

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

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

	// ChannelTypeGcm is a ChannelType enum value
	ChannelTypeGcm = "GCM"
)
View Source 
const (
	// DimensionTypeInclusive is a DimensionType enum value
	DimensionTypeInclusive = "INCLUSIVE"

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

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

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

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

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

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

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

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

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

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

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

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

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

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

	// JobStatusFailed is a JobStatus enum value
	JobStatusFailed = "FAILED"
)
View Source 
const (
	// RecencyTypeActive is a RecencyType enum value
	RecencyTypeActive = "ACTIVE"

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

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

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

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

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

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

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

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

Service information constants

Variables

This section is empty.

Functions

This section is empty.

Types

type APNSChannelRequest 

type APNSChannelRequest struct {

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

	// The certificate private key.
	PrivateKey *string `type:"string"`
	// contains filtered or unexported fields
}

Apple Push Notification Service channel definition.

func (APNSChannelRequest) GoString 

func (s APNSChannelRequest) GoString() string

GoString returns the string representation

func (*APNSChannelRequest) SetCertificate 

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

SetCertificate sets the Certificate field's value.

func (*APNSChannelRequest) SetPrivateKey 

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

SetPrivateKey sets the PrivateKey field's value.

func (APNSChannelRequest) String 

func (s APNSChannelRequest) String() string

String returns the string representation

type APNSChannelResponse 

type APNSChannelResponse struct {

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

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

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

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

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

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

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

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

Apple Distribution Push Notification Service channel definition.

func (APNSChannelResponse) GoString 

func (s APNSChannelResponse) GoString() string

GoString returns the string representation

func (*APNSChannelResponse) SetApplicationId 

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

SetApplicationId sets the ApplicationId field's value.

func (*APNSChannelResponse) SetCreationDate 

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

SetCreationDate sets the CreationDate field's value.

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

type ActivitiesResponse 

type ActivitiesResponse struct {

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

Activities for campaign.

func (ActivitiesResponse) GoString 

func (s ActivitiesResponse) GoString() string

GoString returns the string representation

func (*ActivitiesResponse) SetItem 

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

SetItem sets the Item field's value.

func (ActivitiesResponse) String 

func (s ActivitiesResponse) String() string

String returns the string representation

type ActivityResponse 

type ActivityResponse struct {

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

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

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

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

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

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

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

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

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

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

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

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

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

Activity definition

func (ActivityResponse) GoString 

func (s ActivityResponse) GoString() string

GoString returns the string representation

func (*ActivityResponse) SetApplicationId 

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

SetApplicationId sets the ApplicationId field's value.

func (*ActivityResponse) SetCampaignId 

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

SetCampaignId sets the CampaignId field's value.

func (*ActivityResponse) SetEnd 

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

type ApplicationSettingsResource 

type ApplicationSettingsResource struct {

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

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

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

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

Application settings.

func (ApplicationSettingsResource) GoString 

func (s ApplicationSettingsResource) GoString() string

GoString returns the string representation

func (*ApplicationSettingsResource) SetApplicationId 

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

SetApplicationId sets the ApplicationId 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

type AttributeDimension 

type AttributeDimension struct {

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

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

Custom attibute dimension

func (AttributeDimension) GoString 

func (s AttributeDimension) GoString() string

GoString returns the string representation

func (*AttributeDimension) SetAttributeType 

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

SetAttributeType sets the AttributeType field's value.

func (*AttributeDimension) SetValues 

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

SetValues sets the Values field's value.

func (AttributeDimension) String 

func (s AttributeDimension) String() string

String returns the string representation

type CampaignLimits 

type CampaignLimits struct {

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

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

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

func (CampaignLimits) GoString 

func (s CampaignLimits) GoString() string

GoString returns the string representation

func (*CampaignLimits) SetDaily 

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

SetDaily sets the Daily field's value.

func (*CampaignLimits) SetTotal 

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

SetTotal sets the Total field's value.

func (CampaignLimits) String 

func (s CampaignLimits) String() string

String returns the string representation

type CampaignResponse 

type CampaignResponse struct {

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Campaign definition

func (CampaignResponse) GoString 

func (s CampaignResponse) GoString() string

GoString returns the string representation

func (*CampaignResponse) SetAdditionalTreatments 

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

SetAdditionalTreatments sets the AdditionalTreatments field's value.

func (*CampaignResponse) SetApplicationId 

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

SetApplicationId sets the ApplicationId field's value.

func (*CampaignResponse) SetCreationDate 

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

SetCreationDate sets the CreationDate field's value.

func (*CampaignResponse) SetDefaultState 

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

SetDefaultState sets the DefaultState field's value.

func (*CampaignResponse) SetDescription 

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

SetDescription sets the Description field's value.

func (*CampaignResponse) SetHoldoutPercent 

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

SetHoldoutPercent sets the HoldoutPercent field's value.

func (*CampaignResponse) 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) 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) SetTreatmentDescription 

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

SetTreatmentDescription sets the TreatmentDescription field's value.

func (*CampaignResponse) SetTreatmentName 

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

SetTreatmentName sets the TreatmentName field's value.

func (*CampaignResponse) SetVersion 

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

SetVersion sets the Version field's value.

func (CampaignResponse) String 

func (s CampaignResponse) String() string

String returns the string representation

type CampaignState 

type CampaignState struct {

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

State of the Campaign

func (CampaignState) GoString 

func (s CampaignState) GoString() string

GoString returns the string representation

func (*CampaignState) SetCampaignStatus 

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

SetCampaignStatus sets the CampaignStatus field's value.

func (CampaignState) String 

func (s CampaignState) String() string

String returns the string representation

type CampaignsResponse 

type CampaignsResponse struct {

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

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

List of available campaigns.

func (CampaignsResponse) GoString 

func (s CampaignsResponse) GoString() string

GoString returns the string representation

func (*CampaignsResponse) SetItem 

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

type CreateCampaignInput 

type CreateCampaignInput struct {

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

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

func (CreateCampaignInput) GoString 

func (s CreateCampaignInput) GoString() string

GoString returns the string representation

func (*CreateCampaignInput) SetApplicationId 

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

SetApplicationId sets the ApplicationId field's value.

func (*CreateCampaignInput) SetWriteCampaignRequest 

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

SetWriteCampaignRequest sets the WriteCampaignRequest field's value.

func (CreateCampaignInput) String 

func (s CreateCampaignInput) String() string

String returns the string representation

func (*CreateCampaignInput) Validate 

func (s *CreateCampaignInput) Validate() error

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

type CreateCampaignOutput 

type CreateCampaignOutput struct {

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

func (CreateCampaignOutput) GoString 

func (s CreateCampaignOutput) GoString() string

GoString returns the string representation

func (*CreateCampaignOutput) SetCampaignResponse 

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

SetCampaignResponse sets the CampaignResponse field's value.

func (CreateCampaignOutput) String 

func (s CreateCampaignOutput) String() string

String returns the string representation

type CreateImportJobInput 

type CreateImportJobInput struct {

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

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

func (CreateImportJobInput) GoString 

func (s CreateImportJobInput) GoString() string

GoString returns the string representation

func (*CreateImportJobInput) SetApplicationId 

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

SetApplicationId sets the ApplicationId field's value.

func (*CreateImportJobInput) SetImportJobRequest 

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

SetImportJobRequest sets the ImportJobRequest field's value.

func (CreateImportJobInput) String 

func (s CreateImportJobInput) String() string

String returns the string representation

func (*CreateImportJobInput) Validate 

func (s *CreateImportJobInput) Validate() error

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

type CreateImportJobOutput 

type CreateImportJobOutput struct {

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

func (CreateImportJobOutput) GoString 

func (s CreateImportJobOutput) GoString() string

GoString returns the string representation

func (*CreateImportJobOutput) SetImportJobResponse 

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

SetImportJobResponse sets the ImportJobResponse field's value.

func (CreateImportJobOutput) String 

func (s CreateImportJobOutput) String() string

String returns the string representation

type CreateSegmentInput 

type CreateSegmentInput struct {

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

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

func (CreateSegmentInput) GoString 

func (s CreateSegmentInput) GoString() string

GoString returns the string representation

func (*CreateSegmentInput) SetApplicationId 

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

SetApplicationId sets the ApplicationId field's value.

func (*CreateSegmentInput) SetWriteSegmentRequest 

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

SetWriteSegmentRequest sets the WriteSegmentRequest field's value.

func (CreateSegmentInput) String 

func (s CreateSegmentInput) String() string

String returns the string representation

func (*CreateSegmentInput) Validate 

func (s *CreateSegmentInput) Validate() error

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

type CreateSegmentOutput 

type CreateSegmentOutput struct {

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

func (CreateSegmentOutput) GoString 

func (s CreateSegmentOutput) GoString() string

GoString returns the string representation

func (*CreateSegmentOutput) SetSegmentResponse 

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

SetSegmentResponse sets the SegmentResponse field's value.

func (CreateSegmentOutput) String 

func (s CreateSegmentOutput) String() string

String returns the string representation

type DeleteApnsChannelInput 

type DeleteApnsChannelInput struct {

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

func (DeleteApnsChannelInput) GoString 

func (s DeleteApnsChannelInput) GoString() string

GoString returns the string representation

func (*DeleteApnsChannelInput) SetApplicationId 

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

SetApplicationId sets the ApplicationId field's value.

func (DeleteApnsChannelInput) String 

func (s DeleteApnsChannelInput) String() string

String returns the string representation

func (*DeleteApnsChannelInput) Validate 

func (s *DeleteApnsChannelInput) Validate() error

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

type DeleteApnsChannelOutput 

type DeleteApnsChannelOutput struct {

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

func (DeleteApnsChannelOutput) GoString 

func (s DeleteApnsChannelOutput) GoString() string

GoString returns the string representation

func (*DeleteApnsChannelOutput) SetAPNSChannelResponse 

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

type DeleteCampaignInput 

type DeleteCampaignInput struct {

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

	// CampaignId is a required field
	CampaignId *string `location:"uri" locationName:"campaign-id" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteCampaignInput) GoString 

func (s DeleteCampaignInput) GoString() string

GoString returns the string representation

func (*DeleteCampaignInput) SetApplicationId 

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

SetApplicationId sets the ApplicationId field's value.

func (*DeleteCampaignInput) SetCampaignId 

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

SetCampaignId sets the CampaignId field's value.

func (DeleteCampaignInput) String 

func (s DeleteCampaignInput) String() string

String returns the string representation

func (*DeleteCampaignInput) Validate 

func (s *DeleteCampaignInput) Validate() error

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

type DeleteCampaignOutput 

type DeleteCampaignOutput struct {

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

func (DeleteCampaignOutput) GoString 

func (s DeleteCampaignOutput) GoString() string

GoString returns the string representation

func (*DeleteCampaignOutput) SetCampaignResponse 

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

SetCampaignResponse sets the CampaignResponse field's value.

func (DeleteCampaignOutput) String 

func (s DeleteCampaignOutput) String() string

String returns the string representation

type DeleteEventStreamInput added in v1.8.0 

type DeleteEventStreamInput struct {

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

func (DeleteEventStreamInput) GoString added in v1.8.0 

func (s DeleteEventStreamInput) GoString() string

GoString returns the string representation

func (*DeleteEventStreamInput) SetApplicationId added in v1.8.0 

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

SetApplicationId sets the ApplicationId field's value.

func (DeleteEventStreamInput) String added in v1.8.0 

func (s DeleteEventStreamInput) String() string

String returns the string representation

func (*DeleteEventStreamInput) Validate added in v1.8.0 

func (s *DeleteEventStreamInput) Validate() error

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

type DeleteEventStreamOutput added in v1.8.0 

type DeleteEventStreamOutput struct {

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

func (DeleteEventStreamOutput) GoString added in v1.8.0 

func (s DeleteEventStreamOutput) GoString() string

GoString returns the string representation

func (*DeleteEventStreamOutput) SetEventStream added in v1.8.0 

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

type DeleteGcmChannelInput 

type DeleteGcmChannelInput struct {

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

func (DeleteGcmChannelInput) GoString 

func (s DeleteGcmChannelInput) GoString() string

GoString returns the string representation

func (*DeleteGcmChannelInput) SetApplicationId 

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

SetApplicationId sets the ApplicationId field's value.

func (DeleteGcmChannelInput) String 

func (s DeleteGcmChannelInput) String() string

String returns the string representation

func (*DeleteGcmChannelInput) Validate 

func (s *DeleteGcmChannelInput) Validate() error

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

type DeleteGcmChannelOutput 

type DeleteGcmChannelOutput struct {

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

func (DeleteGcmChannelOutput) GoString 

func (s DeleteGcmChannelOutput) GoString() string

GoString returns the string representation

func (*DeleteGcmChannelOutput) SetGCMChannelResponse 

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

type DeleteSegmentInput 

type DeleteSegmentInput struct {

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

	// SegmentId is a required field
	SegmentId *string `location:"uri" locationName:"segment-id" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteSegmentInput) GoString 

func (s DeleteSegmentInput) GoString() string

GoString returns the string representation

func (*DeleteSegmentInput) SetApplicationId 

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

SetApplicationId sets the ApplicationId field's value.

func (*DeleteSegmentInput) SetSegmentId 

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

SetSegmentId sets the SegmentId field's value.

func (DeleteSegmentInput) String 

func (s DeleteSegmentInput) String() string

String returns the string representation

func (*DeleteSegmentInput) Validate 

func (s *DeleteSegmentInput) Validate() error

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

type DeleteSegmentOutput 

type DeleteSegmentOutput struct {

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

func (DeleteSegmentOutput) GoString 

func (s DeleteSegmentOutput) GoString() string

GoString returns the string representation

func (*DeleteSegmentOutput) SetSegmentResponse 

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

SetSegmentResponse sets the SegmentResponse field's value.

func (DeleteSegmentOutput) String 

func (s DeleteSegmentOutput) String() string

String returns the string representation

type EndpointBatchItem 

type EndpointBatchItem struct {

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

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

	// The channel type.Valid values: APNS, GCM
	ChannelType *string `type:"string" enum:"ChannelType"`

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

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

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

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

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

	Metrics map[string]*float64 `type:"map"`

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

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

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

Endpoint update request

func (EndpointBatchItem) GoString 

func (s EndpointBatchItem) GoString() string

GoString returns the string representation

func (*EndpointBatchItem) SetAddress 

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

SetAddress sets the Address field's value.

func (*EndpointBatchItem) SetAttributes 

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

SetAttributes sets the Attributes field's value.

func (*EndpointBatchItem) SetChannelType 

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

SetChannelType sets the ChannelType field's value.

func (*EndpointBatchItem) SetDemographic 

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

type EndpointBatchRequest 

type EndpointBatchRequest struct {

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

Endpoint batch update request.

func (EndpointBatchRequest) GoString 

func (s EndpointBatchRequest) GoString() string

GoString returns the string representation

func (*EndpointBatchRequest) SetItem 

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

type EndpointDemographic 

type EndpointDemographic struct {

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

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

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

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

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

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

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

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

Endpoint demographic data

func (EndpointDemographic) GoString 

func (s EndpointDemographic) GoString() string

GoString returns the string representation

func (*EndpointDemographic) SetAppVersion 

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

SetAppVersion sets the AppVersion field's value.

func (*EndpointDemographic) SetLocale 

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

type EndpointLocation 

type EndpointLocation struct {

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

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

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

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

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

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

Endpoint location data

func (EndpointLocation) GoString 

func (s EndpointLocation) GoString() string

GoString returns the string representation

func (*EndpointLocation) SetCity 

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

SetCity sets the City field's value.

func (*EndpointLocation) SetCountry 

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

SetCountry sets the Country field's value.

func (*EndpointLocation) SetLatitude 

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

SetLatitude sets the Latitude field's value.

func (*EndpointLocation) SetLongitude 

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

SetLongitude sets the Longitude field's value.

func (*EndpointLocation) SetPostalCode 

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

SetPostalCode sets the PostalCode field's value.

func (*EndpointLocation) SetRegion 

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

SetRegion sets the Region field's value.

func (EndpointLocation) String 

func (s EndpointLocation) String() string

String returns the string representation

type EndpointRequest 

type EndpointRequest struct {

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

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

	// The channel type.Valid values: APNS, GCM
	ChannelType *string `type:"string" enum:"ChannelType"`

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

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

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

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

	Metrics map[string]*float64 `type:"map"`

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

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

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

Endpoint update request

func (EndpointRequest) GoString 

func (s EndpointRequest) GoString() string

GoString returns the string representation

func (*EndpointRequest) SetAddress 

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

SetAddress sets the Address field's value.

func (*EndpointRequest) SetAttributes 

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

SetAttributes sets the Attributes field's value.

func (*EndpointRequest) SetChannelType 

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

SetChannelType sets the ChannelType field's value.

func (*EndpointRequest) SetDemographic 

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

SetDemographic sets the Demographic field's value.

func (*EndpointRequest) SetEffectiveDate 

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

SetEffectiveDate sets the EffectiveDate field's value.

func (*EndpointRequest) SetEndpointStatus 

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

SetEndpointStatus sets the EndpointStatus field's value.

func (*EndpointRequest) SetLocation 

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

SetLocation sets the Location field's value.

func (*EndpointRequest) SetMetrics 

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

SetMetrics sets the Metrics field's value.

func (*EndpointRequest) SetOptOut 

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

SetOptOut sets the OptOut field's value.

func (*EndpointRequest) SetRequestId 

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

SetRequestId sets the RequestId field's value.

func (*EndpointRequest) SetUser 

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

type EndpointResponse 

type EndpointResponse struct {

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

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

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

	// The channel type.Valid values: APNS, GCM
	ChannelType *string `type:"string" enum:"ChannelType"`

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

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

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

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

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

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

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

	Metrics map[string]*float64 `type:"map"`

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

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

	// The ShardId of endpoint
	ShardId *string `type:"string"`

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

Endpoint response

func (EndpointResponse) GoString 

func (s EndpointResponse) GoString() string

GoString returns the string representation

func (*EndpointResponse) SetAddress 

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

SetAddress sets the Address field's value.

func (*EndpointResponse) SetApplicationId 

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

SetApplicationId sets the ApplicationId field's value.

func (*EndpointResponse) SetAttributes 

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

SetAttributes sets the Attributes field's value.

func (*EndpointResponse) SetChannelType 

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

SetChannelType sets the ChannelType field's value.

func (*EndpointResponse) SetCohortId 

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

SetCohortId sets the CohortId field's value.

func (*EndpointResponse) SetCreationDate 

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

SetCreationDate sets the CreationDate field's value.

func (*EndpointResponse) SetDemographic 

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

SetDemographic sets the Demographic field's value.

func (*EndpointResponse) SetEffectiveDate 

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

SetEffectiveDate sets the EffectiveDate field's value.

func (*EndpointResponse) SetEndpointStatus 

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

SetEndpointStatus sets the EndpointStatus field's value.

func (*EndpointResponse) SetId 

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

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

SetShardId sets the ShardId 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

type EndpointUser 

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

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

Endpoint user specific custom userAttributes

func (EndpointUser) GoString 

func (s EndpointUser) GoString() string

GoString returns the string representation

func (*EndpointUser) SetUserAttributes 

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

SetUserAttributes sets the UserAttributes field's value.

func (*EndpointUser) SetUserId 

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

SetUserId sets the UserId field's value.

func (EndpointUser) String 

func (s EndpointUser) String() string

String returns the string representation

type EventStream added in v1.8.0 

type EventStream struct {

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

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

	// The external ID assigned the IAM role that authorizes Amazon Pinpoint to
	// publish to the stream.
	ExternalId *string `type:"string"`

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

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

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

Model for an event publishing subscription export.

func (EventStream) GoString added in v1.8.0 

func (s EventStream) GoString() string

GoString returns the string representation

func (*EventStream) SetApplicationId added in v1.8.0 

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

SetApplicationId sets the ApplicationId field's value.

func (*EventStream) SetDestinationStreamArn added in v1.8.0 

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

SetDestinationStreamArn sets the DestinationStreamArn field's value.

func (*EventStream) SetExternalId added in v1.8.0 

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

SetExternalId sets the ExternalId field's value.

func (*EventStream) SetLastModifiedDate added in v1.8.0 

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

SetLastModifiedDate sets the LastModifiedDate field's value.

func (*EventStream) SetLastUpdatedBy added in v1.8.0 

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

SetLastUpdatedBy sets the LastUpdatedBy field's value.

func (*EventStream) SetRoleArn added in v1.8.0 

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

SetRoleArn sets the RoleArn field's value.

func (EventStream) String added in v1.8.0 

func (s EventStream) String() string

String returns the string representation

type GCMChannelRequest 

type GCMChannelRequest struct {

	// Platform credential API key from Google.
	ApiKey *string `type:"string"`
	// contains filtered or unexported fields
}

Google Cloud Messaging credentials

func (GCMChannelRequest) GoString 

func (s GCMChannelRequest) GoString() string

GoString returns the string representation

func (*GCMChannelRequest) SetApiKey 

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

SetApiKey sets the ApiKey field's value.

func (GCMChannelRequest) String 

func (s GCMChannelRequest) String() string

String returns the string representation

type GCMChannelResponse 

type GCMChannelResponse struct {

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

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

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

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

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

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

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

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

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

Google Cloud Messaging channel definition

func (GCMChannelResponse) GoString 

func (s GCMChannelResponse) GoString() string

GoString returns the string representation

func (*GCMChannelResponse) SetApplicationId 

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

SetApplicationId sets the ApplicationId field's value.

func (*GCMChannelResponse) SetCreationDate 

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

SetCreationDate sets the CreationDate field's value.

func (*GCMChannelResponse) SetCredential 

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

SetCredential sets the Credential field's value.

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

type GetApnsChannelInput 

type GetApnsChannelInput struct {

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

func (GetApnsChannelInput) GoString 

func (s GetApnsChannelInput) GoString() string

GoString returns the string representation

func (*GetApnsChannelInput) SetApplicationId 

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

SetApplicationId sets the ApplicationId field's value.

func (GetApnsChannelInput) String 

func (s GetApnsChannelInput) String() string

String returns the string representation

func (*GetApnsChannelInput) Validate 

func (s *GetApnsChannelInput) Validate() error

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

type GetApnsChannelOutput 

type GetApnsChannelOutput struct {

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

func (GetApnsChannelOutput) GoString 

func (s GetApnsChannelOutput) GoString() string

GoString returns the string representation

func (*GetApnsChannelOutput) SetAPNSChannelResponse 

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

SetAPNSChannelResponse sets the APNSChannelResponse field's value.

func (GetApnsChannelOutput) String 

func (s GetApnsChannelOutput) String() string

String returns the string representation

type GetApplicationSettingsInput 

type GetApplicationSettingsInput struct {

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

func (GetApplicationSettingsInput) GoString 

func (s GetApplicationSettingsInput) GoString() string

GoString returns the string representation

func (*GetApplicationSettingsInput) SetApplicationId 

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

func (*GetApplicationSettingsInput) Validate 

func (s *GetApplicationSettingsInput) Validate() error

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

type GetApplicationSettingsOutput 

type GetApplicationSettingsOutput struct {

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

func (GetApplicationSettingsOutput) GoString 

func (s GetApplicationSettingsOutput) GoString() string

GoString returns the string representation

func (*GetApplicationSettingsOutput) SetApplicationSettingsResource 

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

type GetCampaignActivitiesInput 

type GetCampaignActivitiesInput struct {

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

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

	PageSize *string `location:"querystring" locationName:"page-size" type:"string"`

	Token *string `location:"querystring" locationName:"token" type:"string"`
	// contains filtered or unexported fields
}

func (GetCampaignActivitiesInput) GoString 

func (s GetCampaignActivitiesInput) GoString() string

GoString returns the string representation

func (*GetCampaignActivitiesInput) SetApplicationId 

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

func (*GetCampaignActivitiesInput) Validate 

func (s *GetCampaignActivitiesInput) Validate() error

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

type GetCampaignActivitiesOutput 

type GetCampaignActivitiesOutput struct {

	// Activities for campaign.
	//
	// ActivitiesResponse is a required field
	ActivitiesResponse *ActivitiesResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (GetCampaignActivitiesOutput) GoString 

func (s GetCampaignActivitiesOutput) GoString() string

GoString returns the string representation

func (*GetCampaignActivitiesOutput) SetActivitiesResponse 

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

type GetCampaignInput 

type GetCampaignInput struct {

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

	// CampaignId is a required field
	CampaignId *string `location:"uri" locationName:"campaign-id" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetCampaignInput) GoString 

func (s GetCampaignInput) GoString() string

GoString returns the string representation

func (*GetCampaignInput) SetApplicationId 

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

SetApplicationId sets the ApplicationId field's value.

func (*GetCampaignInput) SetCampaignId 

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

SetCampaignId sets the CampaignId field's value.

func (GetCampaignInput) String 

func (s GetCampaignInput) String() string

String returns the string representation

func (*GetCampaignInput) Validate 

func (s *GetCampaignInput) Validate() error

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

type GetCampaignOutput 

type GetCampaignOutput struct {

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

func (GetCampaignOutput) GoString 

func (s GetCampaignOutput) GoString() string

GoString returns the string representation

func (*GetCampaignOutput) SetCampaignResponse 

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

SetCampaignResponse sets the CampaignResponse field's value.

func (GetCampaignOutput) String 

func (s GetCampaignOutput) String() string

String returns the string representation

type GetCampaignVersionInput 

type GetCampaignVersionInput struct {

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

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

	// Version is a required field
	Version *string `location:"uri" locationName:"version" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetCampaignVersionInput) GoString 

func (s GetCampaignVersionInput) GoString() string

GoString returns the string representation

func (*GetCampaignVersionInput) SetApplicationId 

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

SetApplicationId sets the ApplicationId field's value.

func (*GetCampaignVersionInput) SetCampaignId 

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

func (*GetCampaignVersionInput) Validate 

func (s *GetCampaignVersionInput) Validate() error

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

type GetCampaignVersionOutput 

type GetCampaignVersionOutput struct {

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

func (GetCampaignVersionOutput) GoString 

func (s GetCampaignVersionOutput) GoString() string

GoString returns the string representation

func (*GetCampaignVersionOutput) SetCampaignResponse 

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

type GetCampaignVersionsInput 

type GetCampaignVersionsInput struct {

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

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

	PageSize *string `location:"querystring" locationName:"page-size" type:"string"`

	Token *string `location:"querystring" locationName:"token" type:"string"`
	// contains filtered or unexported fields
}

func (GetCampaignVersionsInput) GoString 

func (s GetCampaignVersionsInput) GoString() string

GoString returns the string representation

func (*GetCampaignVersionsInput) SetApplicationId 

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

func (*GetCampaignVersionsInput) Validate 

func (s *GetCampaignVersionsInput) Validate() error

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

type GetCampaignVersionsOutput 

type GetCampaignVersionsOutput struct {

	// List of available campaigns.
	//
	// CampaignsResponse is a required field
	CampaignsResponse *CampaignsResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (GetCampaignVersionsOutput) GoString 

func (s GetCampaignVersionsOutput) GoString() string

GoString returns the string representation

func (*GetCampaignVersionsOutput) SetCampaignsResponse 

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

type GetCampaignsInput 

type GetCampaignsInput struct {

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

	PageSize *string `location:"querystring" locationName:"page-size" type:"string"`

	Token *string `location:"querystring" locationName:"token" type:"string"`
	// contains filtered or unexported fields
}

func (GetCampaignsInput) GoString 

func (s GetCampaignsInput) GoString() string

GoString returns the string representation

func (*GetCampaignsInput) SetApplicationId 

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

SetApplicationId sets the ApplicationId field's value.

func (*GetCampaignsInput) SetPageSize 

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

SetPageSize sets the PageSize field's value.

func (*GetCampaignsInput) SetToken 

func (s *GetCampaignsInput) SetToken(v string) *GetCampaignsInput

SetToken sets the Token field's value.

func (GetCampaignsInput) String 

func (s GetCampaignsInput) String() string

String returns the string representation

func (*GetCampaignsInput) Validate 

func (s *GetCampaignsInput) Validate() error

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

type GetCampaignsOutput 

type GetCampaignsOutput struct {

	// List of available campaigns.
	//
	// CampaignsResponse is a required field
	CampaignsResponse *CampaignsResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (GetCampaignsOutput) GoString 

func (s GetCampaignsOutput) GoString() string

GoString returns the string representation

func (*GetCampaignsOutput) SetCampaignsResponse 

func (s *GetCampaignsOutput) SetCampaignsResponse(v *CampaignsResponse) *GetCampaignsOutput

SetCampaignsResponse sets the CampaignsResponse field's value.

func (GetCampaignsOutput) String 

func (s GetCampaignsOutput) String() string

String returns the string representation

type GetEndpointInput 

type GetEndpointInput struct {

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

	// EndpointId is a required field
	EndpointId *string `location:"uri" locationName:"endpoint-id" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetEndpointInput) GoString 

func (s GetEndpointInput) GoString() string

GoString returns the string representation

func (*GetEndpointInput) SetApplicationId 

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

SetApplicationId sets the ApplicationId field's value.

func (*GetEndpointInput) SetEndpointId 

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

SetEndpointId sets the EndpointId field's value.

func (GetEndpointInput) String 

func (s GetEndpointInput) String() string

String returns the string representation

func (*GetEndpointInput) Validate 

func (s *GetEndpointInput) Validate() error

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

type GetEndpointOutput 

type GetEndpointOutput struct {

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

func (GetEndpointOutput) GoString 

func (s GetEndpointOutput) GoString() string

GoString returns the string representation

func (*GetEndpointOutput) SetEndpointResponse 

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

SetEndpointResponse sets the EndpointResponse field's value.

func (GetEndpointOutput) String 

func (s GetEndpointOutput) String() string

String returns the string representation

type GetEventStreamInput added in v1.8.0 

type GetEventStreamInput struct {

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

func (GetEventStreamInput) GoString added in v1.8.0 

func (s GetEventStreamInput) GoString() string

GoString returns the string representation

func (*GetEventStreamInput) SetApplicationId added in v1.8.0 

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

SetApplicationId sets the ApplicationId field's value.

func (GetEventStreamInput) String added in v1.8.0 

func (s GetEventStreamInput) String() string

String returns the string representation

func (*GetEventStreamInput) Validate added in v1.8.0 

func (s *GetEventStreamInput) Validate() error

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

type GetEventStreamOutput added in v1.8.0 

type GetEventStreamOutput struct {

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

func (GetEventStreamOutput) GoString added in v1.8.0 

func (s GetEventStreamOutput) GoString() string

GoString returns the string representation

func (*GetEventStreamOutput) SetEventStream added in v1.8.0 

func (s *GetEventStreamOutput) SetEventStream(v *EventStream) *GetEventStreamOutput

SetEventStream sets the EventStream field's value.

func (GetEventStreamOutput) String added in v1.8.0 

func (s GetEventStreamOutput) String() string

String returns the string representation

type GetGcmChannelInput 

type GetGcmChannelInput struct {

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

func (GetGcmChannelInput) GoString 

func (s GetGcmChannelInput) GoString() string

GoString returns the string representation

func (*GetGcmChannelInput) SetApplicationId 

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

SetApplicationId sets the ApplicationId field's value.

func (GetGcmChannelInput) String 

func (s GetGcmChannelInput) String() string

String returns the string representation

func (*GetGcmChannelInput) Validate 

func (s *GetGcmChannelInput) Validate() error

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

type GetGcmChannelOutput 

type GetGcmChannelOutput struct {

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

func (GetGcmChannelOutput) GoString 

func (s GetGcmChannelOutput) GoString() string

GoString returns the string representation

func (*GetGcmChannelOutput) SetGCMChannelResponse 

func (s *GetGcmChannelOutput) SetGCMChannelResponse(v *GCMChannelResponse) *GetGcmChannelOutput

SetGCMChannelResponse sets the GCMChannelResponse field's value.

func (GetGcmChannelOutput) String 

func (s GetGcmChannelOutput) String() string

String returns the string representation

type GetImportJobInput 

type GetImportJobInput struct {

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

	// JobId is a required field
	JobId *string `location:"uri" locationName:"job-id" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetImportJobInput) GoString 

func (s GetImportJobInput) GoString() string

GoString returns the string representation

func (*GetImportJobInput) SetApplicationId 

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

SetApplicationId sets the ApplicationId field's value.

func (*GetImportJobInput) SetJobId 

func (s *GetImportJobInput) SetJobId(v string) *GetImportJobInput

SetJobId sets the JobId field's value.

func (GetImportJobInput) String 

func (s GetImportJobInput) String() string

String returns the string representation

func (*GetImportJobInput) Validate 

func (s *GetImportJobInput) Validate() error

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

type GetImportJobOutput 

type GetImportJobOutput struct {

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

func (GetImportJobOutput) GoString 

func (s GetImportJobOutput) GoString() string

GoString returns the string representation

func (*GetImportJobOutput) SetImportJobResponse 

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

SetImportJobResponse sets the ImportJobResponse field's value.

func (GetImportJobOutput) String 

func (s GetImportJobOutput) String() string

String returns the string representation

type GetImportJobsInput 

type GetImportJobsInput struct {

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

	PageSize *string `location:"querystring" locationName:"page-size" type:"string"`

	Token *string `location:"querystring" locationName:"token" type:"string"`
	// contains filtered or unexported fields
}

func (GetImportJobsInput) GoString 

func (s GetImportJobsInput) GoString() string

GoString returns the string representation

func (*GetImportJobsInput) SetApplicationId 

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

SetApplicationId sets the ApplicationId field's value.

func (*GetImportJobsInput) SetPageSize 

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

SetPageSize sets the PageSize field's value.

func (*GetImportJobsInput) SetToken 

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

func (*GetImportJobsInput) Validate 

func (s *GetImportJobsInput) Validate() error

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

type GetImportJobsOutput 

type GetImportJobsOutput struct {

	// Import job list.
	//
	// ImportJobsResponse is a required field
	ImportJobsResponse *ImportJobsResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (GetImportJobsOutput) GoString 

func (s GetImportJobsOutput) GoString() string

GoString returns the string representation

func (*GetImportJobsOutput) SetImportJobsResponse 

func (s *GetImportJobsOutput) SetImportJobsResponse(v *ImportJobsResponse) *GetImportJobsOutput

SetImportJobsResponse sets the ImportJobsResponse field's value.

func (GetImportJobsOutput) String 

func (s GetImportJobsOutput) String() string

String returns the string representation

type GetSegmentImportJobsInput 

type GetSegmentImportJobsInput struct {

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

	PageSize *string `location:"querystring" locationName:"page-size" type:"string"`

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

	Token *string `location:"querystring" locationName:"token" type:"string"`
	// contains filtered or unexported fields
}

func (GetSegmentImportJobsInput) GoString 

func (s GetSegmentImportJobsInput) GoString() string

GoString returns the string representation

func (*GetSegmentImportJobsInput) SetApplicationId 

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

func (*GetSegmentImportJobsInput) Validate 

func (s *GetSegmentImportJobsInput) Validate() error

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

type GetSegmentImportJobsOutput 

type GetSegmentImportJobsOutput struct {

	// Import job list.
	//
	// ImportJobsResponse is a required field
	ImportJobsResponse *ImportJobsResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (GetSegmentImportJobsOutput) GoString 

func (s GetSegmentImportJobsOutput) GoString() string

GoString returns the string representation

func (*GetSegmentImportJobsOutput) SetImportJobsResponse 

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

type GetSegmentInput 

type GetSegmentInput struct {

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

	// SegmentId is a required field
	SegmentId *string `location:"uri" locationName:"segment-id" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetSegmentInput) GoString 

func (s GetSegmentInput) GoString() string

GoString returns the string representation

func (*GetSegmentInput) SetApplicationId 

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

SetApplicationId sets the ApplicationId field's value.

func (*GetSegmentInput) SetSegmentId 

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

SetSegmentId sets the SegmentId field's value.

func (GetSegmentInput) String 

func (s GetSegmentInput) String() string

String returns the string representation

func (*GetSegmentInput) Validate 

func (s *GetSegmentInput) Validate() error

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

type GetSegmentOutput 

type GetSegmentOutput struct {

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

func (GetSegmentOutput) GoString 

func (s GetSegmentOutput) GoString() string

GoString returns the string representation

func (*GetSegmentOutput) SetSegmentResponse 

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

SetSegmentResponse sets the SegmentResponse field's value.

func (GetSegmentOutput) String 

func (s GetSegmentOutput) String() string

String returns the string representation

type GetSegmentVersionInput 

type GetSegmentVersionInput struct {

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

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

	// Version is a required field
	Version *string `location:"uri" locationName:"version" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetSegmentVersionInput) GoString 

func (s GetSegmentVersionInput) GoString() string

GoString returns the string representation

func (*GetSegmentVersionInput) SetApplicationId 

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

SetApplicationId sets the ApplicationId field's value.

func (*GetSegmentVersionInput) SetSegmentId 

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

func (*GetSegmentVersionInput) Validate 

func (s *GetSegmentVersionInput) Validate() error

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

type GetSegmentVersionOutput 

type GetSegmentVersionOutput struct {

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

func (GetSegmentVersionOutput) GoString 

func (s GetSegmentVersionOutput) GoString() string

GoString returns the string representation

func (*GetSegmentVersionOutput) SetSegmentResponse 

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

type GetSegmentVersionsInput 

type GetSegmentVersionsInput struct {

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

	PageSize *string `location:"querystring" locationName:"page-size" type:"string"`

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

	Token *string `location:"querystring" locationName:"token" type:"string"`
	// contains filtered or unexported fields
}

func (GetSegmentVersionsInput) GoString 

func (s GetSegmentVersionsInput) GoString() string

GoString returns the string representation

func (*GetSegmentVersionsInput) SetApplicationId 

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

SetApplicationId sets the ApplicationId field's value.

func (*GetSegmentVersionsInput) SetPageSize 

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

func (*GetSegmentVersionsInput) Validate 

func (s *GetSegmentVersionsInput) Validate() error

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

type GetSegmentVersionsOutput 

type GetSegmentVersionsOutput struct {

	// Segments in your account.
	//
	// SegmentsResponse is a required field
	SegmentsResponse *SegmentsResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (GetSegmentVersionsOutput) GoString 

func (s GetSegmentVersionsOutput) GoString() string

GoString returns the string representation

func (*GetSegmentVersionsOutput) SetSegmentsResponse 

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

type GetSegmentsInput 

type GetSegmentsInput struct {

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

	PageSize *string `location:"querystring" locationName:"page-size" type:"string"`

	Token *string `location:"querystring" locationName:"token" type:"string"`
	// contains filtered or unexported fields
}

func (GetSegmentsInput) GoString 

func (s GetSegmentsInput) GoString() string

GoString returns the string representation

func (*GetSegmentsInput) SetApplicationId 

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

SetApplicationId sets the ApplicationId field's value.

func (*GetSegmentsInput) SetPageSize 

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

SetPageSize sets the PageSize field's value.

func (*GetSegmentsInput) SetToken 

func (s *GetSegmentsInput) SetToken(v string) *GetSegmentsInput

SetToken sets the Token field's value.

func (GetSegmentsInput) String 

func (s GetSegmentsInput) String() string

String returns the string representation

func (*GetSegmentsInput) Validate 

func (s *GetSegmentsInput) Validate() error

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

type GetSegmentsOutput 

type GetSegmentsOutput struct {

	// Segments in your account.
	//
	// SegmentsResponse is a required field
	SegmentsResponse *SegmentsResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (GetSegmentsOutput) GoString 

func (s GetSegmentsOutput) GoString() string

GoString returns the string representation

func (*GetSegmentsOutput) SetSegmentsResponse 

func (s *GetSegmentsOutput) SetSegmentsResponse(v *SegmentsResponse) *GetSegmentsOutput

SetSegmentsResponse sets the SegmentsResponse field's value.

func (GetSegmentsOutput) String 

func (s GetSegmentsOutput) String() string

String returns the string representation

type ImportJobRequest 

type ImportJobRequest struct {

	// Sets whether the endpoints create a segment when they are imported.
	DefineSegment *bool `type:"boolean"`

	// A unique, custom ID assigned to the IAM role that restricts who can assume
	// the role.
	ExternalId *string `type:"string"`

	// The format of the files that contain the endpoint definitions.Valid values:
	// CSV, JSON
	Format *string `type:"string" enum:"Format"`

	// Sets whether the endpoints are registered with Amazon Pinpoint when they
	// are imported.
	RegisterEndpoints *bool `type:"boolean"`

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

	// A URL that points to the location within an Amazon S3 bucket that contains
	// the endpoints to import. The location can be a folder or a single file.The
	// URL should follow this format: s3://bucket-name/folder-name/file-nameAmazon
	// Pinpoint will import endpoints from this location and any subfolders it contains.
	S3Url *string `type:"string"`

	// The ID of the segment to update if the import job is meant to update an existing
	// segment.
	SegmentId *string `type:"string"`

	// A custom name for the segment created by the import job. Use if DefineSegment
	// is true.
	SegmentName *string `type:"string"`
	// contains filtered or unexported fields
}

func (ImportJobRequest) GoString 

func (s ImportJobRequest) GoString() string

GoString returns the string representation

func (*ImportJobRequest) SetDefineSegment 

func (s *ImportJobRequest) SetDefineSegment(v bool) *ImportJobRequest

SetDefineSegment sets the DefineSegment field's value.

func (*ImportJobRequest) SetExternalId 

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

SetExternalId sets the ExternalId field's value.

func (*ImportJobRequest) SetFormat 

func (s *ImportJobRequest) SetFormat(v string) *ImportJobRequest

SetFormat sets the Format field's value.

func (*ImportJobRequest) SetRegisterEndpoints 

func (s *ImportJobRequest) SetRegisterEndpoints(v bool) *ImportJobRequest

SetRegisterEndpoints sets the RegisterEndpoints field's value.

func (*ImportJobRequest) SetRoleArn 

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

SetRoleArn sets the RoleArn field's value.

func (*ImportJobRequest) SetS3Url 

func (s *ImportJobRequest) SetS3Url(v string) *ImportJobRequest

SetS3Url sets the S3Url field's value.

func (*ImportJobRequest) SetSegmentId 

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

SetSegmentId sets the SegmentId field's value.

func (*ImportJobRequest) SetSegmentName 

func (s *ImportJobRequest) SetSegmentName(v string) *ImportJobRequest

SetSegmentName sets the SegmentName field's value.

func (ImportJobRequest) String 

func (s ImportJobRequest) String() string

String returns the string representation

type ImportJobResource 

type ImportJobResource struct {

	// Sets whether the endpoints create a segment when they are imported.
	DefineSegment *bool `type:"boolean"`

	// A unique, custom ID assigned to the IAM role that restricts who can assume
	// the role.
	ExternalId *string `type:"string"`

	// The format of the files that contain the endpoint definitions.Valid values:
	// CSV, JSON
	Format *string `type:"string" enum:"Format"`

	// Sets whether the endpoints are registered with Amazon Pinpoint when they
	// are imported.
	RegisterEndpoints *bool `type:"boolean"`

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

	// A URL that points to the location within an Amazon S3 bucket that contains
	// the endpoints to import. The location can be a folder or a single file.The
	// URL should follow this format: s3://bucket-name/folder-name/file-nameAmazon
	// Pinpoint will import endpoints from this location and any subfolders it contains.
	S3Url *string `type:"string"`

	// The ID of the segment to update if the import job is meant to update an existing
	// segment.
	SegmentId *string `type:"string"`

	// A custom name for the segment created by the import job. Use if DefineSegment
	// is true.
	SegmentName *string `type:"string"`
	// contains filtered or unexported fields
}

func (ImportJobResource) GoString 

func (s ImportJobResource) GoString() string

GoString returns the string representation

func (*ImportJobResource) SetDefineSegment 

func (s *ImportJobResource) SetDefineSegment(v bool) *ImportJobResource

SetDefineSegment sets the DefineSegment field's value.

func (*ImportJobResource) SetExternalId 

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

SetExternalId sets the ExternalId field's value.

func (*ImportJobResource) SetFormat 

func (s *ImportJobResource) SetFormat(v string) *ImportJobResource

SetFormat sets the Format field's value.

func (*ImportJobResource) SetRegisterEndpoints 

func (s *ImportJobResource) SetRegisterEndpoints(v bool) *ImportJobResource

SetRegisterEndpoints sets the RegisterEndpoints field's value.

func (*ImportJobResource) SetRoleArn 

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

SetRoleArn sets the RoleArn field's value.

func (*ImportJobResource) SetS3Url 

func (s *ImportJobResource) SetS3Url(v string) *ImportJobResource

SetS3Url sets the S3Url field's value.

func (*ImportJobResource) SetSegmentId 

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

SetSegmentId sets the SegmentId field's value.

func (*ImportJobResource) SetSegmentName 

func (s *ImportJobResource) SetSegmentName(v string) *ImportJobResource

SetSegmentName sets the SegmentName field's value.

func (ImportJobResource) String 

func (s ImportJobResource) String() string

String returns the string representation

type ImportJobResponse 

type ImportJobResponse struct {

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

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

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

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

	// The import job settings.
	Definition *ImportJobResource `type:"structure"`

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

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

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

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

	// The number of endpoints that failed to import; for example, because of syntax
	// errors.
	TotalFailures *int64 `type:"integer"`

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

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

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

func (ImportJobResponse) GoString 

func (s ImportJobResponse) GoString() string

GoString returns the string representation

func (*ImportJobResponse) SetApplicationId 

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

SetApplicationId sets the ApplicationId field's value.

func (*ImportJobResponse) SetCompletedPieces 

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

SetCompletedPieces sets the CompletedPieces field's value.

func (*ImportJobResponse) SetCompletionDate 

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

SetCompletionDate sets the CompletionDate field's value.

func (*ImportJobResponse) SetCreationDate 

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

SetCreationDate sets the CreationDate field's value.

func (*ImportJobResponse) SetDefinition 

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

type ImportJobsResponse 

type ImportJobsResponse struct {

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

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

Import job list.

func (ImportJobsResponse) GoString 

func (s ImportJobsResponse) GoString() string

GoString returns the string representation

func (*ImportJobsResponse) SetItem 

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

type Message 

type Message struct {

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

	// The message body. Can include up to 140 characters.
	Body *string `type:"string"`

	// The URL that points to the icon image for the push notification icon, for
	// example, the app icon.
	ImageIconUrl *string `type:"string"`

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

	// The JSON payload used for a silent push.
	JsonBody *string `type:"string"`

	// The URL that points to the media resource, for example a .mp4 or .gif file.
	MediaUrl *string `type:"string"`

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

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

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

func (Message) GoString 

func (s Message) GoString() string

GoString returns the string representation

func (*Message) SetAction 

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

SetAction sets the Action field's value.

func (*Message) SetBody 

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

SetBody sets the Body field's value.

func (*Message) SetImageIconUrl 

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

SetImageIconUrl sets the ImageIconUrl field's value.

func (*Message) 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) SetSilentPush 

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

SetSilentPush sets the SilentPush field's value.

func (*Message) SetTitle 

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

SetTitle sets the Title field's value.

func (*Message) SetUrl 

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

SetUrl sets the Url field's value.

func (Message) String 

func (s Message) String() string

String returns the string representation

type MessageBody 

type MessageBody struct {

	// The error message returned from the API.
	Message *string `type:"string"`

	// The unique message body ID.
	RequestID *string `type:"string"`
	// contains filtered or unexported fields
}

Simple message object.

func (MessageBody) GoString 

func (s MessageBody) GoString() string

GoString returns the string representation

func (*MessageBody) SetMessage 

func (s *MessageBody) SetMessage(v string) *MessageBody

SetMessage sets the Message field's value.

func (*MessageBody) SetRequestID 

func (s *MessageBody) SetRequestID(v string) *MessageBody

SetRequestID sets the RequestID field's value.

func (MessageBody) String 

func (s MessageBody) String() string

String returns the string representation

type MessageConfiguration 

type MessageConfiguration struct {

	// The message that the campaign delivers to APNS channels. Overrides the default
	// message.
	APNSMessage *Message `type:"structure"`

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

	// The message that the campaign delivers to GCM channels. Overrides the default
	// message.
	GCMMessage *Message `type:"structure"`
	// contains filtered or unexported fields
}

Message configuration for a campaign.

func (MessageConfiguration) GoString 

func (s MessageConfiguration) GoString() string

GoString returns the string representation

func (*MessageConfiguration) SetAPNSMessage 

func (s *MessageConfiguration) SetAPNSMessage(v *Message) *MessageConfiguration

SetAPNSMessage sets the APNSMessage field's value.

func (*MessageConfiguration) SetDefaultMessage 

func (s *MessageConfiguration) SetDefaultMessage(v *Message) *MessageConfiguration

SetDefaultMessage sets the DefaultMessage field's value.

func (*MessageConfiguration) SetGCMMessage 

func (s *MessageConfiguration) SetGCMMessage(v *Message) *MessageConfiguration

SetGCMMessage sets the GCMMessage field's value.

func (MessageConfiguration) String 

func (s MessageConfiguration) String() string

String returns the string representation

type Pinpoint 

type Pinpoint struct {
	*client.Client
}

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

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

func New 

func New(p client.ConfigProvider, cfgs ...*aws.Config) *Pinpoint

New creates a new instance of the Pinpoint client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example: 

// Create a Pinpoint client from just a session.
svc := pinpoint.New(mySession)

// Create a Pinpoint client with additional configuration
svc := pinpoint.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*Pinpoint) CreateCampaign 

func (c *Pinpoint) CreateCampaign(input *CreateCampaignInput) (*CreateCampaignOutput, error)

CreateCampaign API operation for Amazon Pinpoint.

Creates or updates a campaign.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint's API operation CreateCampaign for usage and error information.

Returned Error Codes:

  • ErrCodeBadRequestException "BadRequestException" 400 response

  • ErrCodeInternalServerErrorException "InternalServerErrorException" 500 response

  • ErrCodeForbiddenException "ForbiddenException" 403 response

  • ErrCodeNotFoundException "NotFoundException" 404 response

  • ErrCodeMethodNotAllowedException "MethodNotAllowedException" 405 response

  • ErrCodeTooManyRequestsException "TooManyRequestsException" 429 response

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/pinpoint"
)

func main() {
	sess := session.Must(session.NewSession())

	svc := pinpoint.New(sess)

	params := &pinpoint.CreateCampaignInput{
		ApplicationId: aws.String("__string"), // Required
		WriteCampaignRequest: &pinpoint.WriteCampaignRequest{ // Required
			AdditionalTreatments: []*pinpoint.WriteTreatmentResource{
				{ // Required
					MessageConfiguration: &pinpoint.MessageConfiguration{
						APNSMessage: &pinpoint.Message{
							Action:       aws.String("Action"),
							Body:         aws.String("__string"),
							ImageIconUrl: aws.String("__string"),
							ImageUrl:     aws.String("__string"),
							JsonBody:     aws.String("__string"),
							MediaUrl:     aws.String("__string"),
							SilentPush:   aws.Bool(true),
							Title:        aws.String("__string"),
							Url:          aws.String("__string"),
						},
						DefaultMessage: &pinpoint.Message{
							Action:       aws.String("Action"),
							Body:         aws.String("__string"),
							ImageIconUrl: aws.String("__string"),
							ImageUrl:     aws.String("__string"),
							JsonBody:     aws.String("__string"),
							MediaUrl:     aws.String("__string"),
							SilentPush:   aws.Bool(true),
							Title:        aws.String("__string"),
							Url:          aws.String("__string"),
						},
						GCMMessage: &pinpoint.Message{
							Action:       aws.String("Action"),
							Body:         aws.String("__string"),
							ImageIconUrl: aws.String("__string"),
							ImageUrl:     aws.String("__string"),
							JsonBody:     aws.String("__string"),
							MediaUrl:     aws.String("__string"),
							SilentPush:   aws.Bool(true),
							Title:        aws.String("__string"),
							Url:          aws.String("__string"),
						},
					},
					Schedule: &pinpoint.Schedule{
						EndTime:     aws.String("__string"),
						Frequency:   aws.String("Frequency"),
						IsLocalTime: aws.Bool(true),
						QuietTime: &pinpoint.QuietTime{
							End:   aws.String("__string"),
							Start: aws.String("__string"),
						},
						StartTime: aws.String("__string"),
						Timezone:  aws.String("__string"),
					},
					SizePercent:          aws.Int64(1),
					TreatmentDescription: aws.String("__string"),
					TreatmentName:        aws.String("__string"),
				},
				// More values...
			},
			Description:    aws.String("__string"),
			HoldoutPercent: aws.Int64(1),
			IsPaused:       aws.Bool(true),
			Limits: &pinpoint.CampaignLimits{
				Daily: aws.Int64(1),
				Total: aws.Int64(1),
			},
			MessageConfiguration: &pinpoint.MessageConfiguration{
				APNSMessage: &pinpoint.Message{
					Action:       aws.String("Action"),
					Body:         aws.String("__string"),
					ImageIconUrl: aws.String("__string"),
					ImageUrl:     aws.String("__string"),
					JsonBody:     aws.String("__string"),
					MediaUrl:     aws.String("__string"),
					SilentPush:   aws.Bool(true),
					Title:        aws.String("__string"),
					Url:          aws.String("__string"),
				},
				DefaultMessage: &pinpoint.Message{
					Action:       aws.String("Action"),
					Body:         aws.String("__string"),
					ImageIconUrl: aws.String("__string"),
					ImageUrl:     aws.String("__string"),
					JsonBody:     aws.String("__string"),
					MediaUrl:     aws.String("__string"),
					SilentPush:   aws.Bool(true),
					Title:        aws.String("__string"),
					Url:          aws.String("__string"),
				},
				GCMMessage: &pinpoint.Message{
					Action:       aws.String("Action"),
					Body:         aws.String("__string"),
					ImageIconUrl: aws.String("__string"),
					ImageUrl:     aws.String("__string"),
					JsonBody:     aws.String("__string"),
					MediaUrl:     aws.String("__string"),
					SilentPush:   aws.Bool(true),
					Title:        aws.String("__string"),
					Url:          aws.String("__string"),
				},
			},
			Name: aws.String("__string"),
			Schedule: &pinpoint.Schedule{
				EndTime:     aws.String("__string"),
				Frequency:   aws.String("Frequency"),
				IsLocalTime: aws.Bool(true),
				QuietTime: &pinpoint.QuietTime{
					End:   aws.String("__string"),
					Start: aws.String("__string"),
				},
				StartTime: aws.String("__string"),
				Timezone:  aws.String("__string"),
			},
			SegmentId:            aws.String("__string"),
			SegmentVersion:       aws.Int64(1),
			TreatmentDescription: aws.String("__string"),
			TreatmentName:        aws.String("__string"),
		},
	}
	resp, err := svc.CreateCampaign(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

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 can be used to capture response data after the request's "Send" method is called.

See CreateCampaign for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the CreateCampaign method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// 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)
}

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

func (c *Pinpoint) CreateImportJob(input *CreateImportJobInput) (*CreateImportJobOutput, error)

CreateImportJob API operation for Amazon Pinpoint.

Creates or updates an import job.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint's API operation CreateImportJob for usage and error information.

Returned Error Codes:

  • ErrCodeBadRequestException "BadRequestException" 400 response

  • ErrCodeInternalServerErrorException "InternalServerErrorException" 500 response

  • ErrCodeForbiddenException "ForbiddenException" 403 response

  • ErrCodeNotFoundException "NotFoundException" 404 response

  • ErrCodeMethodNotAllowedException "MethodNotAllowedException" 405 response

  • ErrCodeTooManyRequestsException "TooManyRequestsException" 429 response

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/pinpoint"
)

func main() {
	sess := session.Must(session.NewSession())

	svc := pinpoint.New(sess)

	params := &pinpoint.CreateImportJobInput{
		ApplicationId: aws.String("__string"), // Required
		ImportJobRequest: &pinpoint.ImportJobRequest{ // Required
			DefineSegment:     aws.Bool(true),
			ExternalId:        aws.String("__string"),
			Format:            aws.String("Format"),
			RegisterEndpoints: aws.Bool(true),
			RoleArn:           aws.String("__string"),
			S3Url:             aws.String("__string"),
			SegmentId:         aws.String("__string"),
			SegmentName:       aws.String("__string"),
		},
	}
	resp, err := svc.CreateImportJob(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

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 can be used to capture response data after the request's "Send" method is called.

See CreateImportJob for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the CreateImportJob method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// 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)
}

func (*Pinpoint) CreateImportJobWithContext added in v1.8.0 

func (c *Pinpoint) CreateImportJobWithContext(ctx aws.Context, input *CreateImportJobInput, opts ...request.Option) (*CreateImportJobOutput, error)

CreateImportJobWithContext is the same as CreateImportJob with the addition of the ability to pass a context and additional request options.

See CreateImportJob for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Pinpoint) CreateSegment 

func (c *Pinpoint) CreateSegment(input *CreateSegmentInput) (*CreateSegmentOutput, error)

CreateSegment API operation for Amazon Pinpoint.

Used to create or update a segment.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint's API operation CreateSegment for usage and error information.

Returned Error Codes:

  • ErrCodeBadRequestException "BadRequestException" 400 response

  • ErrCodeInternalServerErrorException "InternalServerErrorException" 500 response

  • ErrCodeForbiddenException "ForbiddenException" 403 response

  • ErrCodeNotFoundException "NotFoundException" 404 response

  • ErrCodeMethodNotAllowedException "MethodNotAllowedException" 405 response

  • ErrCodeTooManyRequestsException "TooManyRequestsException" 429 response

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/pinpoint"
)

func main() {
	sess := session.Must(session.NewSession())

	svc := pinpoint.New(sess)

	params := &pinpoint.CreateSegmentInput{
		ApplicationId: aws.String("__string"), // Required
		WriteSegmentRequest: &pinpoint.WriteSegmentRequest{ // Required
			Dimensions: &pinpoint.SegmentDimensions{
				Attributes: map[string]*pinpoint.AttributeDimension{
					"Key": { // Required
						AttributeType: aws.String("AttributeType"),
						Values: []*string{
							aws.String("__string"), // Required
							// More values...
						},
					},
					// More values...
				},
				Behavior: &pinpoint.SegmentBehaviors{
					Recency: &pinpoint.RecencyDimension{
						Duration:    aws.String("Duration"),
						RecencyType: aws.String("RecencyType"),
					},
				},
				Demographic: &pinpoint.SegmentDemographics{
					AppVersion: &pinpoint.SetDimension{
						DimensionType: aws.String("DimensionType"),
						Values: []*string{
							aws.String("__string"), // Required
							// More values...
						},
					},
					DeviceType: &pinpoint.SetDimension{
						DimensionType: aws.String("DimensionType"),
						Values: []*string{
							aws.String("__string"), // Required
							// More values...
						},
					},
					Make: &pinpoint.SetDimension{
						DimensionType: aws.String("DimensionType"),
						Values: []*string{
							aws.String("__string"), // Required
							// More values...
						},
					},
					Model: &pinpoint.SetDimension{
						DimensionType: aws.String("DimensionType"),
						Values: []*string{
							aws.String("__string"), // Required
							// More values...
						},
					},
					Platform: &pinpoint.SetDimension{
						DimensionType: aws.String("DimensionType"),
						Values: []*string{
							aws.String("__string"), // Required
							// More values...
						},
					},
				},
				Location: &pinpoint.SegmentLocation{
					Country: &pinpoint.SetDimension{
						DimensionType: aws.String("DimensionType"),
						Values: []*string{
							aws.String("__string"), // Required
							// More values...
						},
					},
				},
				UserAttributes: map[string]*pinpoint.AttributeDimension{
					"Key": { // Required
						AttributeType: aws.String("AttributeType"),
						Values: []*string{
							aws.String("__string"), // Required
							// More values...
						},
					},
					// More values...
				},
			},
			Name: aws.String("__string"),
		},
	}
	resp, err := svc.CreateSegment(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

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 can be used to capture response data after the request's "Send" method is called.

See CreateSegment for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the CreateSegment method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// 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)
}

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

func (c *Pinpoint) DeleteApnsChannel(input *DeleteApnsChannelInput) (*DeleteApnsChannelOutput, error)

DeleteApnsChannel API operation for Amazon Pinpoint.

Deletes the APNs channel for an app.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint's API operation DeleteApnsChannel for usage and error information.

Returned Error Codes:

  • ErrCodeBadRequestException "BadRequestException" 400 response

  • ErrCodeInternalServerErrorException "InternalServerErrorException" 500 response

  • ErrCodeForbiddenException "ForbiddenException" 403 response

  • ErrCodeNotFoundException "NotFoundException" 404 response

  • ErrCodeMethodNotAllowedException "MethodNotAllowedException" 405 response

  • ErrCodeTooManyRequestsException "TooManyRequestsException" 429 response

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/pinpoint"
)

func main() {
	sess := session.Must(session.NewSession())

	svc := pinpoint.New(sess)

	params := &pinpoint.DeleteApnsChannelInput{
		ApplicationId: aws.String("__string"), // Required
	}
	resp, err := svc.DeleteApnsChannel(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

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 can be used to capture response data after the request's "Send" method is called.

See DeleteApnsChannel for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeleteApnsChannel method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// 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)
}

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

func (c *Pinpoint) DeleteCampaign(input *DeleteCampaignInput) (*DeleteCampaignOutput, error)

DeleteCampaign API operation for Amazon Pinpoint.

Deletes a campaign.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint's API operation DeleteCampaign for usage and error information.

Returned Error Codes:

  • ErrCodeBadRequestException "BadRequestException" 400 response

  • ErrCodeInternalServerErrorException "InternalServerErrorException" 500 response

  • ErrCodeForbiddenException "ForbiddenException" 403 response

  • ErrCodeNotFoundException "NotFoundException" 404 response

  • ErrCodeMethodNotAllowedException "MethodNotAllowedException" 405 response

  • ErrCodeTooManyRequestsException "TooManyRequestsException" 429 response

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/pinpoint"
)

func main() {
	sess := session.Must(session.NewSession())

	svc := pinpoint.New(sess)

	params := &pinpoint.DeleteCampaignInput{
		ApplicationId: aws.String("__string"), // Required
		CampaignId:    aws.String("__string"), // Required
	}
	resp, err := svc.DeleteCampaign(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

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 can be used to capture response data after the request's "Send" method is called.

See DeleteCampaign for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeleteCampaign method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// 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)
}

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) DeleteEventStream added in v1.8.0 

func (c *Pinpoint) DeleteEventStream(input *DeleteEventStreamInput) (*DeleteEventStreamOutput, error)

DeleteEventStream API operation for Amazon Pinpoint.

Deletes the event stream for an app.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint's API operation DeleteEventStream for usage and error information.

Returned Error Codes:

  • ErrCodeBadRequestException "BadRequestException" 400 response

  • ErrCodeInternalServerErrorException "InternalServerErrorException" 500 response

  • ErrCodeForbiddenException "ForbiddenException" 403 response

  • ErrCodeNotFoundException "NotFoundException" 404 response

  • ErrCodeMethodNotAllowedException "MethodNotAllowedException" 405 response

  • ErrCodeTooManyRequestsException "TooManyRequestsException" 429 response

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/pinpoint"
)

func main() {
	sess := session.Must(session.NewSession())

	svc := pinpoint.New(sess)

	params := &pinpoint.DeleteEventStreamInput{
		ApplicationId: aws.String("__string"), // Required
	}
	resp, err := svc.DeleteEventStream(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

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 can be used to capture response data after the request's "Send" method is called.

See DeleteEventStream for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeleteEventStream method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// 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)
}

func (*Pinpoint) DeleteEventStreamWithContext added in v1.8.0 

func (c *Pinpoint) DeleteEventStreamWithContext(ctx aws.Context, input *DeleteEventStreamInput, opts ...request.Option) (*DeleteEventStreamOutput, error)

DeleteEventStreamWithContext is the same as DeleteEventStream with the addition of the ability to pass a context and additional request options.

See DeleteEventStream for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Pinpoint) DeleteGcmChannel 

func (c *Pinpoint) DeleteGcmChannel(input *DeleteGcmChannelInput) (*DeleteGcmChannelOutput, error)

DeleteGcmChannel API operation for Amazon Pinpoint.

Deletes the GCM channel for an app.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint's API operation DeleteGcmChannel for usage and error information.

Returned Error Codes:

  • ErrCodeBadRequestException "BadRequestException" 400 response

  • ErrCodeInternalServerErrorException "InternalServerErrorException" 500 response

  • ErrCodeForbiddenException "ForbiddenException" 403 response

  • ErrCodeNotFoundException "NotFoundException" 404 response

  • ErrCodeMethodNotAllowedException "MethodNotAllowedException" 405 response

  • ErrCodeTooManyRequestsException "TooManyRequestsException" 429 response

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/pinpoint"
)

func main() {
	sess := session.Must(session.NewSession())

	svc := pinpoint.New(sess)

	params := &pinpoint.DeleteGcmChannelInput{
		ApplicationId: aws.String("__string"), // Required
	}
	resp, err := svc.DeleteGcmChannel(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

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 can be used to capture response data after the request's "Send" method is called.

See DeleteGcmChannel for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeleteGcmChannel method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// 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)
}

func (*Pinpoint) DeleteGcmChannelWithContext added in v1.8.0 

func (c *Pinpoint) DeleteGcmChannelWithContext(ctx aws.Context, input *DeleteGcmChannelInput, opts ...request.Option) (*DeleteGcmChannelOutput, error)

DeleteGcmChannelWithContext is the same as DeleteGcmChannel with the addition of the ability to pass a context and additional request options.

See DeleteGcmChannel for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Pinpoint) DeleteSegment 

func (c *Pinpoint) DeleteSegment(input *DeleteSegmentInput) (*DeleteSegmentOutput, error)

DeleteSegment API operation for Amazon Pinpoint.

Deletes a segment.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint's API operation DeleteSegment for usage and error information.

Returned Error Codes:

  • ErrCodeBadRequestException "BadRequestException" 400 response

  • ErrCodeInternalServerErrorException "InternalServerErrorException" 500 response

  • ErrCodeForbiddenException "ForbiddenException" 403 response

  • ErrCodeNotFoundException "NotFoundException" 404 response

  • ErrCodeMethodNotAllowedException "MethodNotAllowedException" 405 response

  • ErrCodeTooManyRequestsException "TooManyRequestsException" 429 response

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/pinpoint"
)

func main() {
	sess := session.Must(session.NewSession())

	svc := pinpoint.New(sess)

	params := &pinpoint.DeleteSegmentInput{
		ApplicationId: aws.String("__string"), // Required
		SegmentId:     aws.String("__string"), // Required
	}
	resp, err := svc.DeleteSegment(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

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 can be used to capture response data after the request's "Send" method is called.

See DeleteSegment for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeleteSegment method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// 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)
}

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

func (c *Pinpoint) GetApnsChannel(input *GetApnsChannelInput) (*GetApnsChannelOutput, error)

GetApnsChannel API operation for Amazon Pinpoint.

Returns information about the APNs channel for an app.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint's API operation GetApnsChannel for usage and error information.

Returned Error Codes:

  • ErrCodeBadRequestException "BadRequestException" 400 response

  • ErrCodeInternalServerErrorException "InternalServerErrorException" 500 response

  • ErrCodeForbiddenException "ForbiddenException" 403 response

  • ErrCodeNotFoundException "NotFoundException" 404 response

  • ErrCodeMethodNotAllowedException "MethodNotAllowedException" 405 response

  • ErrCodeTooManyRequestsException "TooManyRequestsException" 429 response

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/pinpoint"
)

func main() {
	sess := session.Must(session.NewSession())

	svc := pinpoint.New(sess)

	params := &pinpoint.GetApnsChannelInput{
		ApplicationId: aws.String("__string"), // Required
	}
	resp, err := svc.GetApnsChannel(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

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 can be used to capture response data after the request's "Send" method is called.

See GetApnsChannel for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetApnsChannel method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// 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)
}

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

func (c *Pinpoint) GetApplicationSettings(input *GetApplicationSettingsInput) (*GetApplicationSettingsOutput, error)

GetApplicationSettings API operation for Amazon Pinpoint.

Used to request the settings for an app.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint's API operation GetApplicationSettings for usage and error information.

Returned Error Codes:

  • ErrCodeBadRequestException "BadRequestException" 400 response

  • ErrCodeInternalServerErrorException "InternalServerErrorException" 500 response

  • ErrCodeForbiddenException "ForbiddenException" 403 response

  • ErrCodeNotFoundException "NotFoundException" 404 response

  • ErrCodeMethodNotAllowedException "MethodNotAllowedException" 405 response

  • ErrCodeTooManyRequestsException "TooManyRequestsException" 429 response

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/pinpoint"
)

func main() {
	sess := session.Must(session.NewSession())

	svc := pinpoint.New(sess)

	params := &pinpoint.GetApplicationSettingsInput{
		ApplicationId: aws.String("__string"), // Required
	}
	resp, err := svc.GetApplicationSettings(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

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 can be used to capture response data after the request's "Send" method is called.

See GetApplicationSettings for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetApplicationSettings method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// 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)
}

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

func (c *Pinpoint) GetCampaign(input *GetCampaignInput) (*GetCampaignOutput, error)

GetCampaign API operation for Amazon Pinpoint.

Returns information about a campaign.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint's API operation GetCampaign for usage and error information.

Returned Error Codes:

  • ErrCodeBadRequestException "BadRequestException" 400 response

  • ErrCodeInternalServerErrorException "InternalServerErrorException" 500 response

  • ErrCodeForbiddenException "ForbiddenException" 403 response

  • ErrCodeNotFoundException "NotFoundException" 404 response

  • ErrCodeMethodNotAllowedException "MethodNotAllowedException" 405 response

  • ErrCodeTooManyRequestsException "TooManyRequestsException" 429 response

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/pinpoint"
)

func main() {
	sess := session.Must(session.NewSession())

	svc := pinpoint.New(sess)

	params := &pinpoint.GetCampaignInput{
		ApplicationId: aws.String("__string"), // Required
		CampaignId:    aws.String("__string"), // Required
	}
	resp, err := svc.GetCampaign(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*Pinpoint) GetCampaignActivities 

func (c *Pinpoint) GetCampaignActivities(input *GetCampaignActivitiesInput) (*GetCampaignActivitiesOutput, error)

GetCampaignActivities API operation for Amazon Pinpoint.

Returns information about the activity performed by a campaign.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint's API operation GetCampaignActivities for usage and error information.

Returned Error Codes:

  • ErrCodeBadRequestException "BadRequestException" 400 response

  • ErrCodeInternalServerErrorException "InternalServerErrorException" 500 response

  • ErrCodeForbiddenException "ForbiddenException" 403 response

  • ErrCodeNotFoundException "NotFoundException" 404 response

  • ErrCodeMethodNotAllowedException "MethodNotAllowedException" 405 response

  • ErrCodeTooManyRequestsException "TooManyRequestsException" 429 response

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/pinpoint"
)

func main() {
	sess := session.Must(session.NewSession())

	svc := pinpoint.New(sess)

	params := &pinpoint.GetCampaignActivitiesInput{
		ApplicationId: aws.String("__string"), // Required
		CampaignId:    aws.String("__string"), // Required
		PageSize:      aws.String("__string"),
		Token:         aws.String("__string"),
	}
	resp, err := svc.GetCampaignActivities(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

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 can be used to capture response data after the request's "Send" method is called.

See GetCampaignActivities for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetCampaignActivities method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// 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)
}

func (*Pinpoint) GetCampaignActivitiesWithContext added in v1.8.0 

func (c *Pinpoint) GetCampaignActivitiesWithContext(ctx aws.Context, input *GetCampaignActivitiesInput, opts ...request.Option) (*GetCampaignActivitiesOutput, error)

GetCampaignActivitiesWithContext is the same as GetCampaignActivities with the addition of the ability to pass a context and additional request options.

See GetCampaignActivities for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Pinpoint) GetCampaignRequest 

func (c *Pinpoint) GetCampaignRequest(input *GetCampaignInput) (req *request.Request, output *GetCampaignOutput)

GetCampaignRequest generates a "aws/request.Request" representing the client's request for the GetCampaign operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See GetCampaign for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetCampaign method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// 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)
}

func (*Pinpoint) GetCampaignVersion 

func (c *Pinpoint) GetCampaignVersion(input *GetCampaignVersionInput) (*GetCampaignVersionOutput, error)

GetCampaignVersion API operation for Amazon Pinpoint.

Returns information about a specific version of a campaign.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint's API operation GetCampaignVersion for usage and error information.

Returned Error Codes:

  • ErrCodeBadRequestException "BadRequestException" 400 response

  • ErrCodeInternalServerErrorException "InternalServerErrorException" 500 response

  • ErrCodeForbiddenException "ForbiddenException" 403 response

  • ErrCodeNotFoundException "NotFoundException" 404 response

  • ErrCodeMethodNotAllowedException "MethodNotAllowedException" 405 response

  • ErrCodeTooManyRequestsException "TooManyRequestsException" 429 response

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/pinpoint"
)

func main() {
	sess := session.Must(session.NewSession())

	svc := pinpoint.New(sess)

	params := &pinpoint.GetCampaignVersionInput{
		ApplicationId: aws.String("__string"), // Required
		CampaignId:    aws.String("__string"), // Required
		Version:       aws.String("__string"), // Required
	}
	resp, err := svc.GetCampaignVersion(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

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 can be used to capture response data after the request's "Send" method is called.

See GetCampaignVersion for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetCampaignVersion method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// 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)
}

func (*Pinpoint) GetCampaignVersionWithContext added in v1.8.0 

func (c *Pinpoint) GetCampaignVersionWithContext(ctx aws.Context, input *GetCampaignVersionInput, opts ...request.Option) (*GetCampaignVersionOutput, error)

GetCampaignVersionWithContext is the same as GetCampaignVersion with the addition of the ability to pass a context and additional request options.

See GetCampaignVersion for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Pinpoint) GetCampaignVersions 

func (c *Pinpoint) GetCampaignVersions(input *GetCampaignVersionsInput) (*GetCampaignVersionsOutput, error)

GetCampaignVersions API operation for Amazon Pinpoint.

Returns information about your campaign versions.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint's API operation GetCampaignVersions for usage and error information.

Returned Error Codes:

  • ErrCodeBadRequestException "BadRequestException" 400 response

  • ErrCodeInternalServerErrorException "InternalServerErrorException" 500 response

  • ErrCodeForbiddenException "ForbiddenException" 403 response

  • ErrCodeNotFoundException "NotFoundException" 404 response

  • ErrCodeMethodNotAllowedException "MethodNotAllowedException" 405 response

  • ErrCodeTooManyRequestsException "TooManyRequestsException" 429 response

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/pinpoint"
)

func main() {
	sess := session.Must(session.NewSession())

	svc := pinpoint.New(sess)

	params := &pinpoint.GetCampaignVersionsInput{
		ApplicationId: aws.String("__string"), // Required
		CampaignId:    aws.String("__string"), // Required
		PageSize:      aws.String("__string"),
		Token:         aws.String("__string"),
	}
	resp, err := svc.GetCampaignVersions(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

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 can be used to capture response data after the request's "Send" method is called.

See GetCampaignVersions for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetCampaignVersions method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// 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)
}

func (*Pinpoint) GetCampaignVersionsWithContext added in v1.8.0 

func (c *Pinpoint) GetCampaignVersionsWithContext(ctx aws.Context, input *GetCampaignVersionsInput, opts ...request.Option) (*GetCampaignVersionsOutput, error)

GetCampaignVersionsWithContext is the same as GetCampaignVersions with the addition of the ability to pass a context and additional request options.

See GetCampaignVersions for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Pinpoint) GetCampaignWithContext added in v1.8.0 

func (c *Pinpoint) GetCampaignWithContext(ctx aws.Context, input *GetCampaignInput, opts ...request.Option) (*GetCampaignOutput, error)

GetCampaignWithContext is the same as GetCampaign with the addition of the ability to pass a context and additional request options.

See GetCampaign for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Pinpoint) GetCampaigns 

func (c *Pinpoint) GetCampaigns(input *GetCampaignsInput) (*GetCampaignsOutput, error)

GetCampaigns API operation for Amazon Pinpoint.

Returns information about your campaigns.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint's API operation GetCampaigns for usage and error information.

Returned Error Codes:

  • ErrCodeBadRequestException "BadRequestException" 400 response

  • ErrCodeInternalServerErrorException "InternalServerErrorException" 500 response

  • ErrCodeForbiddenException "ForbiddenException" 403 response

  • ErrCodeNotFoundException "NotFoundException" 404 response

  • ErrCodeMethodNotAllowedException "MethodNotAllowedException" 405 response

  • ErrCodeTooManyRequestsException "TooManyRequestsException" 429 response

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/pinpoint"
)

func main() {
	sess := session.Must(session.NewSession())

	svc := pinpoint.New(sess)

	params := &pinpoint.GetCampaignsInput{
		ApplicationId: aws.String("__string"), // Required
		PageSize:      aws.String("__string"),
		Token:         aws.String("__string"),
	}
	resp, err := svc.GetCampaigns(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

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 can be used to capture response data after the request's "Send" method is called.

See GetCampaigns for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetCampaigns method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// 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)
}

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

func (c *Pinpoint) GetEndpoint(input *GetEndpointInput) (*GetEndpointOutput, error)

GetEndpoint API operation for Amazon Pinpoint.

Returns information about an endpoint.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint's API operation GetEndpoint for usage and error information.

Returned Error Codes:

  • ErrCodeBadRequestException "BadRequestException" 400 response

  • ErrCodeInternalServerErrorException "InternalServerErrorException" 500 response

  • ErrCodeForbiddenException "ForbiddenException" 403 response

  • ErrCodeNotFoundException "NotFoundException" 404 response

  • ErrCodeMethodNotAllowedException "MethodNotAllowedException" 405 response

  • ErrCodeTooManyRequestsException "TooManyRequestsException" 429 response

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/pinpoint"
)

func main() {
	sess := session.Must(session.NewSession())

	svc := pinpoint.New(sess)

	params := &pinpoint.GetEndpointInput{
		ApplicationId: aws.String("__string"), // Required
		EndpointId:    aws.String("__string"), // Required
	}
	resp, err := svc.GetEndpoint(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

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 can be used to capture response data after the request's "Send" method is called.

See GetEndpoint for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetEndpoint method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// 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)
}

func (*Pinpoint) GetEndpointWithContext added in v1.8.0 

func (c *Pinpoint) GetEndpointWithContext(ctx aws.Context, input *GetEndpointInput, opts ...request.Option) (*GetEndpointOutput, error)

GetEndpointWithContext is the same as GetEndpoint with the addition of the ability to pass a context and additional request options.

See GetEndpoint for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Pinpoint) GetEventStream added in v1.8.0 

func (c *Pinpoint) GetEventStream(input *GetEventStreamInput) (*GetEventStreamOutput, error)

GetEventStream API operation for Amazon Pinpoint.

Returns the event stream for an app.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint's API operation GetEventStream for usage and error information.

Returned Error Codes:

  • ErrCodeBadRequestException "BadRequestException" 400 response

  • ErrCodeInternalServerErrorException "InternalServerErrorException" 500 response

  • ErrCodeForbiddenException "ForbiddenException" 403 response

  • ErrCodeNotFoundException "NotFoundException" 404 response

  • ErrCodeMethodNotAllowedException "MethodNotAllowedException" 405 response

  • ErrCodeTooManyRequestsException "TooManyRequestsException" 429 response

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/pinpoint"
)

func main() {
	sess := session.Must(session.NewSession())

	svc := pinpoint.New(sess)

	params := &pinpoint.GetEventStreamInput{
		ApplicationId: aws.String("__string"), // Required
	}
	resp, err := svc.GetEventStream(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

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 can be used to capture response data after the request's "Send" method is called.

See GetEventStream for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetEventStream method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// 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)
}

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

func (c *Pinpoint) GetGcmChannel(input *GetGcmChannelInput) (*GetGcmChannelOutput, error)

GetGcmChannel API operation for Amazon Pinpoint.

Returns information about the GCM channel for an app.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint's API operation GetGcmChannel for usage and error information.

Returned Error Codes:

  • ErrCodeBadRequestException "BadRequestException" 400 response

  • ErrCodeInternalServerErrorException "InternalServerErrorException" 500 response

  • ErrCodeForbiddenException "ForbiddenException" 403 response

  • ErrCodeNotFoundException "NotFoundException" 404 response

  • ErrCodeMethodNotAllowedException "MethodNotAllowedException" 405 response

  • ErrCodeTooManyRequestsException "TooManyRequestsException" 429 response

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/pinpoint"
)

func main() {
	sess := session.Must(session.NewSession())

	svc := pinpoint.New(sess)

	params := &pinpoint.GetGcmChannelInput{
		ApplicationId: aws.String("__string"), // Required
	}
	resp, err := svc.GetGcmChannel(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

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 can be used to capture response data after the request's "Send" method is called.

See GetGcmChannel for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetGcmChannel method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// 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)
}

func (*Pinpoint) GetGcmChannelWithContext added in v1.8.0 

func (c *Pinpoint) GetGcmChannelWithContext(ctx aws.Context, input *GetGcmChannelInput, opts ...request.Option) (*GetGcmChannelOutput, error)

GetGcmChannelWithContext is the same as GetGcmChannel with the addition of the ability to pass a context and additional request options.

See GetGcmChannel for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Pinpoint) GetImportJob 

func (c *Pinpoint) GetImportJob(input *GetImportJobInput) (*GetImportJobOutput, error)

GetImportJob API operation for Amazon Pinpoint.

Returns information about an import job.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint's API operation GetImportJob for usage and error information.

Returned Error Codes:

  • ErrCodeBadRequestException "BadRequestException" 400 response

  • ErrCodeInternalServerErrorException "InternalServerErrorException" 500 response

  • ErrCodeForbiddenException "ForbiddenException" 403 response

  • ErrCodeNotFoundException "NotFoundException" 404 response

  • ErrCodeMethodNotAllowedException "MethodNotAllowedException" 405 response

  • ErrCodeTooManyRequestsException "TooManyRequestsException" 429 response

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/pinpoint"
)

func main() {
	sess := session.Must(session.NewSession())

	svc := pinpoint.New(sess)

	params := &pinpoint.GetImportJobInput{
		ApplicationId: aws.String("__string"), // Required
		JobId:         aws.String("__string"), // Required
	}
	resp, err := svc.GetImportJob(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

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 can be used to capture response data after the request's "Send" method is called.

See GetImportJob for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetImportJob method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// 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)
}

func (*Pinpoint) GetImportJobWithContext added in v1.8.0 

func (c *Pinpoint) GetImportJobWithContext(ctx aws.Context, input *GetImportJobInput, opts ...request.Option) (*GetImportJobOutput, error)

GetImportJobWithContext is the same as GetImportJob with the addition of the ability to pass a context and additional request options.

See GetImportJob for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Pinpoint) GetImportJobs 

func (c *Pinpoint) GetImportJobs(input *GetImportJobsInput) (*GetImportJobsOutput, error)

GetImportJobs API operation for Amazon Pinpoint.

Returns information about your import jobs.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint's API operation GetImportJobs for usage and error information.

Returned Error Codes:

  • ErrCodeBadRequestException "BadRequestException" 400 response

  • ErrCodeInternalServerErrorException "InternalServerErrorException" 500 response

  • ErrCodeForbiddenException "ForbiddenException" 403 response

  • ErrCodeNotFoundException "NotFoundException" 404 response

  • ErrCodeMethodNotAllowedException "MethodNotAllowedException" 405 response

  • ErrCodeTooManyRequestsException "TooManyRequestsException" 429 response

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/pinpoint"
)

func main() {
	sess := session.Must(session.NewSession())

	svc := pinpoint.New(sess)

	params := &pinpoint.GetImportJobsInput{
		ApplicationId: aws.String("__string"), // Required
		PageSize:      aws.String("__string"),
		Token:         aws.String("__string"),
	}
	resp, err := svc.GetImportJobs(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

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 can be used to capture response data after the request's "Send" method is called.

See GetImportJobs for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetImportJobs method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// 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)
}

func (*Pinpoint) GetImportJobsWithContext added in v1.8.0 

func (c *Pinpoint) GetImportJobsWithContext(ctx aws.Context, input *GetImportJobsInput, opts ...request.Option) (*GetImportJobsOutput, error)

GetImportJobsWithContext is the same as GetImportJobs with the addition of the ability to pass a context and additional request options.

See GetImportJobs for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Pinpoint) GetSegment 

func (c *Pinpoint) GetSegment(input *GetSegmentInput) (*GetSegmentOutput, error)

GetSegment API operation for Amazon Pinpoint.

Returns information about a segment.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint's API operation GetSegment for usage and error information.

Returned Error Codes:

  • ErrCodeBadRequestException "BadRequestException" 400 response

  • ErrCodeInternalServerErrorException "InternalServerErrorException" 500 response

  • ErrCodeForbiddenException "ForbiddenException" 403 response

  • ErrCodeNotFoundException "NotFoundException" 404 response

  • ErrCodeMethodNotAllowedException "MethodNotAllowedException" 405 response

  • ErrCodeTooManyRequestsException "TooManyRequestsException" 429 response

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/pinpoint"
)

func main() {
	sess := session.Must(session.NewSession())

	svc := pinpoint.New(sess)

	params := &pinpoint.GetSegmentInput{
		ApplicationId: aws.String("__string"), // Required
		SegmentId:     aws.String("__string"), // Required
	}
	resp, err := svc.GetSegment(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*Pinpoint) GetSegmentImportJobs 

func (c *Pinpoint) GetSegmentImportJobs(input *GetSegmentImportJobsInput) (*GetSegmentImportJobsOutput, error)

GetSegmentImportJobs API operation for Amazon Pinpoint.

Returns a list of import jobs for a specific segment.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint's API operation GetSegmentImportJobs for usage and error information.

Returned Error Codes:

  • ErrCodeBadRequestException "BadRequestException" 400 response

  • ErrCodeInternalServerErrorException "InternalServerErrorException" 500 response

  • ErrCodeForbiddenException "ForbiddenException" 403 response

  • ErrCodeNotFoundException "NotFoundException" 404 response

  • ErrCodeMethodNotAllowedException "MethodNotAllowedException" 405 response

  • ErrCodeTooManyRequestsException "TooManyRequestsException" 429 response

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/pinpoint"
)

func main() {
	sess := session.Must(session.NewSession())

	svc := pinpoint.New(sess)

	params := &pinpoint.GetSegmentImportJobsInput{
		ApplicationId: aws.String("__string"), // Required
		SegmentId:     aws.String("__string"), // Required
		PageSize:      aws.String("__string"),
		Token:         aws.String("__string"),
	}
	resp, err := svc.GetSegmentImportJobs(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

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 can be used to capture response data after the request's "Send" method is called.

See GetSegmentImportJobs for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetSegmentImportJobs method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// 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)
}

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 can be used to capture response data after the request's "Send" method is called.

See GetSegment for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetSegment method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// 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)
}

func (*Pinpoint) GetSegmentVersion 

func (c *Pinpoint) GetSegmentVersion(input *GetSegmentVersionInput) (*GetSegmentVersionOutput, error)

GetSegmentVersion API operation for Amazon Pinpoint.

Returns information about a segment version.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint's API operation GetSegmentVersion for usage and error information.

Returned Error Codes:

  • ErrCodeBadRequestException "BadRequestException" 400 response

  • ErrCodeInternalServerErrorException "InternalServerErrorException" 500 response

  • ErrCodeForbiddenException "ForbiddenException" 403 response

  • ErrCodeNotFoundException "NotFoundException" 404 response

  • ErrCodeMethodNotAllowedException "MethodNotAllowedException" 405 response

  • ErrCodeTooManyRequestsException "TooManyRequestsException" 429 response

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/pinpoint"
)

func main() {
	sess := session.Must(session.NewSession())

	svc := pinpoint.New(sess)

	params := &pinpoint.GetSegmentVersionInput{
		ApplicationId: aws.String("__string"), // Required
		SegmentId:     aws.String("__string"), // Required
		Version:       aws.String("__string"), // Required
	}
	resp, err := svc.GetSegmentVersion(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

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 can be used to capture response data after the request's "Send" method is called.

See GetSegmentVersion for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetSegmentVersion method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// 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)
}

func (*Pinpoint) GetSegmentVersionWithContext added in v1.8.0 

func (c *Pinpoint) GetSegmentVersionWithContext(ctx aws.Context, input *GetSegmentVersionInput, opts ...request.Option) (*GetSegmentVersionOutput, error)

GetSegmentVersionWithContext is the same as GetSegmentVersion with the addition of the ability to pass a context and additional request options.

See GetSegmentVersion for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Pinpoint) GetSegmentVersions 

func (c *Pinpoint) GetSegmentVersions(input *GetSegmentVersionsInput) (*GetSegmentVersionsOutput, error)

GetSegmentVersions API operation for Amazon Pinpoint.

Returns information about your segment versions.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint's API operation GetSegmentVersions for usage and error information.

Returned Error Codes:

  • ErrCodeBadRequestException "BadRequestException" 400 response

  • ErrCodeInternalServerErrorException "InternalServerErrorException" 500 response

  • ErrCodeForbiddenException "ForbiddenException" 403 response

  • ErrCodeNotFoundException "NotFoundException" 404 response

  • ErrCodeMethodNotAllowedException "MethodNotAllowedException" 405 response

  • ErrCodeTooManyRequestsException "TooManyRequestsException" 429 response

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/pinpoint"
)

func main() {
	sess := session.Must(session.NewSession())

	svc := pinpoint.New(sess)

	params := &pinpoint.GetSegmentVersionsInput{
		ApplicationId: aws.String("__string"), // Required
		SegmentId:     aws.String("__string"), // Required
		PageSize:      aws.String("__string"),
		Token:         aws.String("__string"),
	}
	resp, err := svc.GetSegmentVersions(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

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 can be used to capture response data after the request's "Send" method is called.

See GetSegmentVersions for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetSegmentVersions method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// 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)
}

func (*Pinpoint) GetSegmentVersionsWithContext added in v1.8.0 

func (c *Pinpoint) GetSegmentVersionsWithContext(ctx aws.Context, input *GetSegmentVersionsInput, opts ...request.Option) (*GetSegmentVersionsOutput, error)

GetSegmentVersionsWithContext is the same as GetSegmentVersions with the addition of the ability to pass a context and additional request options.

See GetSegmentVersions for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Pinpoint) GetSegmentWithContext added in v1.8.0 

func (c *Pinpoint) GetSegmentWithContext(ctx aws.Context, input *GetSegmentInput, opts ...request.Option) (*GetSegmentOutput, error)

GetSegmentWithContext is the same as GetSegment with the addition of the ability to pass a context and additional request options.

See GetSegment for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Pinpoint) GetSegments 

func (c *Pinpoint) GetSegments(input *GetSegmentsInput) (*GetSegmentsOutput, error)

GetSegments API operation for Amazon Pinpoint.

Used to get information about your segments.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint's API operation GetSegments for usage and error information.

Returned Error Codes:

  • ErrCodeBadRequestException "BadRequestException" 400 response

  • ErrCodeInternalServerErrorException "InternalServerErrorException" 500 response

  • ErrCodeForbiddenException "ForbiddenException" 403 response

  • ErrCodeNotFoundException "NotFoundException" 404 response

  • ErrCodeMethodNotAllowedException "MethodNotAllowedException" 405 response

  • ErrCodeTooManyRequestsException "TooManyRequestsException" 429 response

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/pinpoint"
)

func main() {
	sess := session.Must(session.NewSession())

	svc := pinpoint.New(sess)

	params := &pinpoint.GetSegmentsInput{
		ApplicationId: aws.String("__string"), // Required
		PageSize:      aws.String("__string"),
		Token:         aws.String("__string"),
	}
	resp, err := svc.GetSegments(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

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 can be used to capture response data after the request's "Send" method is called.

See GetSegments for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetSegments method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// 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)
}

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) PutEventStream added in v1.8.0 

func (c *Pinpoint) PutEventStream(input *PutEventStreamInput) (*PutEventStreamOutput, error)

PutEventStream API operation for Amazon Pinpoint.

Use to create or update the event stream for an app.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint's API operation PutEventStream for usage and error information.

Returned Error Codes:

  • ErrCodeBadRequestException "BadRequestException" 400 response

  • ErrCodeInternalServerErrorException "InternalServerErrorException" 500 response

  • ErrCodeForbiddenException "ForbiddenException" 403 response

  • ErrCodeNotFoundException "NotFoundException" 404 response

  • ErrCodeMethodNotAllowedException "MethodNotAllowedException" 405 response

  • ErrCodeTooManyRequestsException "TooManyRequestsException" 429 response

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/pinpoint"
)

func main() {
	sess := session.Must(session.NewSession())

	svc := pinpoint.New(sess)

	params := &pinpoint.PutEventStreamInput{
		ApplicationId: aws.String("__string"), // Required
		WriteEventStream: &pinpoint.WriteEventStream{ // Required
			DestinationStreamArn: aws.String("__string"),
			ExternalId:           aws.String("__string"),
			RoleArn:              aws.String("__string"),
		},
	}
	resp, err := svc.PutEventStream(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

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 can be used to capture response data after the request's "Send" method is called.

See PutEventStream for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the PutEventStream method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// 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)
}

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

func (c *Pinpoint) UpdateApnsChannel(input *UpdateApnsChannelInput) (*UpdateApnsChannelOutput, error)

UpdateApnsChannel API operation for Amazon Pinpoint.

Use to update the APNs channel for an app.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint's API operation UpdateApnsChannel for usage and error information.

Returned Error Codes:

  • ErrCodeBadRequestException "BadRequestException" 400 response

  • ErrCodeInternalServerErrorException "InternalServerErrorException" 500 response

  • ErrCodeForbiddenException "ForbiddenException" 403 response

  • ErrCodeNotFoundException "NotFoundException" 404 response

  • ErrCodeMethodNotAllowedException "MethodNotAllowedException" 405 response

  • ErrCodeTooManyRequestsException "TooManyRequestsException" 429 response

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/pinpoint"
)

func main() {
	sess := session.Must(session.NewSession())

	svc := pinpoint.New(sess)

	params := &pinpoint.UpdateApnsChannelInput{
		APNSChannelRequest: &pinpoint.APNSChannelRequest{ // Required
			Certificate: aws.String("__string"),
			PrivateKey:  aws.String("__string"),
		},
		ApplicationId: aws.String("__string"), // Required
	}
	resp, err := svc.UpdateApnsChannel(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

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 can be used to capture response data after the request's "Send" method is called.

See UpdateApnsChannel for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the UpdateApnsChannel method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// 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)
}

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

func (c *Pinpoint) UpdateApplicationSettings(input *UpdateApplicationSettingsInput) (*UpdateApplicationSettingsOutput, error)

UpdateApplicationSettings API operation for Amazon Pinpoint.

Used to update the settings for an app.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint's API operation UpdateApplicationSettings for usage and error information.

Returned Error Codes:

  • ErrCodeBadRequestException "BadRequestException" 400 response

  • ErrCodeInternalServerErrorException "InternalServerErrorException" 500 response

  • ErrCodeForbiddenException "ForbiddenException" 403 response

  • ErrCodeNotFoundException "NotFoundException" 404 response

  • ErrCodeMethodNotAllowedException "MethodNotAllowedException" 405 response

  • ErrCodeTooManyRequestsException "TooManyRequestsException" 429 response

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/pinpoint"
)

func main() {
	sess := session.Must(session.NewSession())

	svc := pinpoint.New(sess)

	params := &pinpoint.UpdateApplicationSettingsInput{
		ApplicationId: aws.String("__string"), // Required
		WriteApplicationSettingsRequest: &pinpoint.WriteApplicationSettingsRequest{ // Required
			Limits: &pinpoint.CampaignLimits{
				Daily: aws.Int64(1),
				Total: aws.Int64(1),
			},
			QuietTime: &pinpoint.QuietTime{
				End:   aws.String("__string"),
				Start: aws.String("__string"),
			},
		},
	}
	resp, err := svc.UpdateApplicationSettings(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

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 can be used to capture response data after the request's "Send" method is called.

See UpdateApplicationSettings for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the UpdateApplicationSettings method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// 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)
}

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

func (c *Pinpoint) UpdateCampaign(input *UpdateCampaignInput) (*UpdateCampaignOutput, error)

UpdateCampaign API operation for Amazon Pinpoint.

Use to update a campaign.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint's API operation UpdateCampaign for usage and error information.

Returned Error Codes:

  • ErrCodeBadRequestException "BadRequestException" 400 response

  • ErrCodeInternalServerErrorException "InternalServerErrorException" 500 response

  • ErrCodeForbiddenException "ForbiddenException" 403 response

  • ErrCodeNotFoundException "NotFoundException" 404 response

  • ErrCodeMethodNotAllowedException "MethodNotAllowedException" 405 response

  • ErrCodeTooManyRequestsException "TooManyRequestsException" 429 response

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/pinpoint"
)

func main() {
	sess := session.Must(session.NewSession())

	svc := pinpoint.New(sess)

	params := &pinpoint.UpdateCampaignInput{
		ApplicationId: aws.String("__string"), // Required
		CampaignId:    aws.String("__string"), // Required
		WriteCampaignRequest: &pinpoint.WriteCampaignRequest{ // Required
			AdditionalTreatments: []*pinpoint.WriteTreatmentResource{
				{ // Required
					MessageConfiguration: &pinpoint.MessageConfiguration{
						APNSMessage: &pinpoint.Message{
							Action:       aws.String("Action"),
							Body:         aws.String("__string"),
							ImageIconUrl: aws.String("__string"),
							ImageUrl:     aws.String("__string"),
							JsonBody:     aws.String("__string"),
							MediaUrl:     aws.String("__string"),
							SilentPush:   aws.Bool(true),
							Title:        aws.String("__string"),
							Url:          aws.String("__string"),
						},
						DefaultMessage: &pinpoint.Message{
							Action:       aws.String("Action"),
							Body:         aws.String("__string"),
							ImageIconUrl: aws.String("__string"),
							ImageUrl:     aws.String("__string"),
							JsonBody:     aws.String("__string"),
							MediaUrl:     aws.String("__string"),
							SilentPush:   aws.Bool(true),
							Title:        aws.String("__string"),
							Url:          aws.String("__string"),
						},
						GCMMessage: &pinpoint.Message{
							Action:       aws.String("Action"),
							Body:         aws.String("__string"),
							ImageIconUrl: aws.String("__string"),
							ImageUrl:     aws.String("__string"),
							JsonBody:     aws.String("__string"),
							MediaUrl:     aws.String("__string"),
							SilentPush:   aws.Bool(true),
							Title:        aws.String("__string"),
							Url:          aws.String("__string"),
						},
					},
					Schedule: &pinpoint.Schedule{
						EndTime:     aws.String("__string"),
						Frequency:   aws.String("Frequency"),
						IsLocalTime: aws.Bool(true),
						QuietTime: &pinpoint.QuietTime{
							End:   aws.String("__string"),
							Start: aws.String("__string"),
						},
						StartTime: aws.String("__string"),
						Timezone:  aws.String("__string"),
					},
					SizePercent:          aws.Int64(1),
					TreatmentDescription: aws.String("__string"),
					TreatmentName:        aws.String("__string"),
				},
				// More values...
			},
			Description:    aws.String("__string"),
			HoldoutPercent: aws.Int64(1),
			IsPaused:       aws.Bool(true),
			Limits: &pinpoint.CampaignLimits{
				Daily: aws.Int64(1),
				Total: aws.Int64(1),
			},
			MessageConfiguration: &pinpoint.MessageConfiguration{
				APNSMessage: &pinpoint.Message{
					Action:       aws.String("Action"),
					Body:         aws.String("__string"),
					ImageIconUrl: aws.String("__string"),
					ImageUrl:     aws.String("__string"),
					JsonBody:     aws.String("__string"),
					MediaUrl:     aws.String("__string"),
					SilentPush:   aws.Bool(true),
					Title:        aws.String("__string"),
					Url:          aws.String("__string"),
				},
				DefaultMessage: &pinpoint.Message{
					Action:       aws.String("Action"),
					Body:         aws.String("__string"),
					ImageIconUrl: aws.String("__string"),
					ImageUrl:     aws.String("__string"),
					JsonBody:     aws.String("__string"),
					MediaUrl:     aws.String("__string"),
					SilentPush:   aws.Bool(true),
					Title:        aws.String("__string"),
					Url:          aws.String("__string"),
				},
				GCMMessage: &pinpoint.Message{
					Action:       aws.String("Action"),
					Body:         aws.String("__string"),
					ImageIconUrl: aws.String("__string"),
					ImageUrl:     aws.String("__string"),
					JsonBody:     aws.String("__string"),
					MediaUrl:     aws.String("__string"),
					SilentPush:   aws.Bool(true),
					Title:        aws.String("__string"),
					Url:          aws.String("__string"),
				},
			},
			Name: aws.String("__string"),
			Schedule: &pinpoint.Schedule{
				EndTime:     aws.String("__string"),
				Frequency:   aws.String("Frequency"),
				IsLocalTime: aws.Bool(true),
				QuietTime: &pinpoint.QuietTime{
					End:   aws.String("__string"),
					Start: aws.String("__string"),
				},
				StartTime: aws.String("__string"),
				Timezone:  aws.String("__string"),
			},
			SegmentId:            aws.String("__string"),
			SegmentVersion:       aws.Int64(1),
			TreatmentDescription: aws.String("__string"),
			TreatmentName:        aws.String("__string"),
		},
	}
	resp, err := svc.UpdateCampaign(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

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 can be used to capture response data after the request's "Send" method is called.

See UpdateCampaign for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the UpdateCampaign method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// 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)
}

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

func (c *Pinpoint) UpdateEndpoint(input *UpdateEndpointInput) (*UpdateEndpointOutput, error)

UpdateEndpoint API operation for Amazon Pinpoint.

Use to update an endpoint.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint's API operation UpdateEndpoint for usage and error information.

Returned Error Codes:

  • ErrCodeBadRequestException "BadRequestException" 400 response

  • ErrCodeInternalServerErrorException "InternalServerErrorException" 500 response

  • ErrCodeForbiddenException "ForbiddenException" 403 response

  • ErrCodeNotFoundException "NotFoundException" 404 response

  • ErrCodeMethodNotAllowedException "MethodNotAllowedException" 405 response

  • ErrCodeTooManyRequestsException "TooManyRequestsException" 429 response

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/pinpoint"
)

func main() {
	sess := session.Must(session.NewSession())

	svc := pinpoint.New(sess)

	params := &pinpoint.UpdateEndpointInput{
		ApplicationId: aws.String("__string"), // Required
		EndpointId:    aws.String("__string"), // Required
		EndpointRequest: &pinpoint.EndpointRequest{ // Required
			Address: aws.String("__string"),
			Attributes: map[string][]*string{
				"Key": { // Required
					aws.String("__string"), // Required
					// More values...
				},
				// More values...
			},
			ChannelType: aws.String("ChannelType"),
			Demographic: &pinpoint.EndpointDemographic{
				AppVersion:      aws.String("__string"),
				Locale:          aws.String("__string"),
				Make:            aws.String("__string"),
				Model:           aws.String("__string"),
				ModelVersion:    aws.String("__string"),
				Platform:        aws.String("__string"),
				PlatformVersion: aws.String("__string"),
				Timezone:        aws.String("__string"),
			},
			EffectiveDate:  aws.String("__string"),
			EndpointStatus: aws.String("__string"),
			Location: &pinpoint.EndpointLocation{
				City:       aws.String("__string"),
				Country:    aws.String("__string"),
				Latitude:   aws.Float64(1.0),
				Longitude:  aws.Float64(1.0),
				PostalCode: aws.String("__string"),
				Region:     aws.String("__string"),
			},
			Metrics: map[string]*float64{
				"Key": aws.Float64(1.0), // Required
				// More values...
			},
			OptOut:    aws.String("__string"),
			RequestId: aws.String("__string"),
			User: &pinpoint.EndpointUser{
				UserAttributes: map[string][]*string{
					"Key": { // Required
						aws.String("__string"), // Required
						// More values...
					},
					// More values...
				},
				UserId: aws.String("__string"),
			},
		},
	}
	resp, err := svc.UpdateEndpoint(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

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 can be used to capture response data after the request's "Send" method is called.

See UpdateEndpoint for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the UpdateEndpoint method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// 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)
}

func (*Pinpoint) UpdateEndpointWithContext added in v1.8.0 

func (c *Pinpoint) UpdateEndpointWithContext(ctx aws.Context, input *UpdateEndpointInput, opts ...request.Option) (*UpdateEndpointOutput, error)

UpdateEndpointWithContext is the same as UpdateEndpoint with the addition of the ability to pass a context and additional request options.

See UpdateEndpoint for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Pinpoint) UpdateEndpointsBatch 

func (c *Pinpoint) UpdateEndpointsBatch(input *UpdateEndpointsBatchInput) (*UpdateEndpointsBatchOutput, error)

UpdateEndpointsBatch API operation for Amazon Pinpoint.

Use to update a batch of endpoints.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint's API operation UpdateEndpointsBatch for usage and error information.

Returned Error Codes:

  • ErrCodeBadRequestException "BadRequestException" 400 response

  • ErrCodeInternalServerErrorException "InternalServerErrorException" 500 response

  • ErrCodeForbiddenException "ForbiddenException" 403 response

  • ErrCodeNotFoundException "NotFoundException" 404 response

  • ErrCodeMethodNotAllowedException "MethodNotAllowedException" 405 response

  • ErrCodeTooManyRequestsException "TooManyRequestsException" 429 response

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/pinpoint"
)

func main() {
	sess := session.Must(session.NewSession())

	svc := pinpoint.New(sess)

	params := &pinpoint.UpdateEndpointsBatchInput{
		ApplicationId: aws.String("__string"), // Required
		EndpointBatchRequest: &pinpoint.EndpointBatchRequest{ // Required
			Item: []*pinpoint.EndpointBatchItem{
				{ // Required
					Address: aws.String("__string"),
					Attributes: map[string][]*string{
						"Key": { // Required
							aws.String("__string"), // Required
							// More values...
						},
						// More values...
					},
					ChannelType: aws.String("ChannelType"),
					Demographic: &pinpoint.EndpointDemographic{
						AppVersion:      aws.String("__string"),
						Locale:          aws.String("__string"),
						Make:            aws.String("__string"),
						Model:           aws.String("__string"),
						ModelVersion:    aws.String("__string"),
						Platform:        aws.String("__string"),
						PlatformVersion: aws.String("__string"),
						Timezone:        aws.String("__string"),
					},
					EffectiveDate:  aws.String("__string"),
					EndpointStatus: aws.String("__string"),
					Id:             aws.String("__string"),
					Location: &pinpoint.EndpointLocation{
						City:       aws.String("__string"),
						Country:    aws.String("__string"),
						Latitude:   aws.Float64(1.0),
						Longitude:  aws.Float64(1.0),
						PostalCode: aws.String("__string"),
						Region:     aws.String("__string"),
					},
					Metrics: map[string]*float64{
						"Key": aws.Float64(1.0), // Required
						// More values...
					},
					OptOut:    aws.String("__string"),
					RequestId: aws.String("__string"),
					User: &pinpoint.EndpointUser{
						UserAttributes: map[string][]*string{
							"Key": { // Required
								aws.String("__string"), // Required
								// More values...
							},
							// More values...
						},
						UserId: aws.String("__string"),
					},
				},
				// More values...
			},
		},
	}
	resp, err := svc.UpdateEndpointsBatch(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

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 can be used to capture response data after the request's "Send" method is called.

See UpdateEndpointsBatch for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the UpdateEndpointsBatch method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// 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)
}

func (*Pinpoint) UpdateEndpointsBatchWithContext added in v1.8.0 

func (c *Pinpoint) UpdateEndpointsBatchWithContext(ctx aws.Context, input *UpdateEndpointsBatchInput, opts ...request.Option) (*UpdateEndpointsBatchOutput, error)

UpdateEndpointsBatchWithContext is the same as UpdateEndpointsBatch with the addition of the ability to pass a context and additional request options.

See UpdateEndpointsBatch for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Pinpoint) UpdateGcmChannel 

func (c *Pinpoint) UpdateGcmChannel(input *UpdateGcmChannelInput) (*UpdateGcmChannelOutput, error)

UpdateGcmChannel API operation for Amazon Pinpoint.

Use to update the GCM channel for an app.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint's API operation UpdateGcmChannel for usage and error information.

Returned Error Codes:

  • ErrCodeBadRequestException "BadRequestException" 400 response

  • ErrCodeInternalServerErrorException "InternalServerErrorException" 500 response

  • ErrCodeForbiddenException "ForbiddenException" 403 response

  • ErrCodeNotFoundException "NotFoundException" 404 response

  • ErrCodeMethodNotAllowedException "MethodNotAllowedException" 405 response

  • ErrCodeTooManyRequestsException "TooManyRequestsException" 429 response

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/pinpoint"
)

func main() {
	sess := session.Must(session.NewSession())

	svc := pinpoint.New(sess)

	params := &pinpoint.UpdateGcmChannelInput{
		ApplicationId: aws.String("__string"), // Required
		GCMChannelRequest: &pinpoint.GCMChannelRequest{ // Required
			ApiKey: aws.String("__string"),
		},
	}
	resp, err := svc.UpdateGcmChannel(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

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 can be used to capture response data after the request's "Send" method is called.

See UpdateGcmChannel for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the UpdateGcmChannel method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// 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)
}

func (*Pinpoint) UpdateGcmChannelWithContext added in v1.8.0 

func (c *Pinpoint) UpdateGcmChannelWithContext(ctx aws.Context, input *UpdateGcmChannelInput, opts ...request.Option) (*UpdateGcmChannelOutput, error)

UpdateGcmChannelWithContext is the same as UpdateGcmChannel with the addition of the ability to pass a context and additional request options.

See UpdateGcmChannel for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Pinpoint) UpdateSegment 

func (c *Pinpoint) UpdateSegment(input *UpdateSegmentInput) (*UpdateSegmentOutput, error)

UpdateSegment API operation for Amazon Pinpoint.

Use to update a segment.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Pinpoint's API operation UpdateSegment for usage and error information.

Returned Error Codes:

  • ErrCodeBadRequestException "BadRequestException" 400 response

  • ErrCodeInternalServerErrorException "InternalServerErrorException" 500 response

  • ErrCodeForbiddenException "ForbiddenException" 403 response

  • ErrCodeNotFoundException "NotFoundException" 404 response

  • ErrCodeMethodNotAllowedException "MethodNotAllowedException" 405 response

  • ErrCodeTooManyRequestsException "TooManyRequestsException" 429 response

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/pinpoint"
)

func main() {
	sess := session.Must(session.NewSession())

	svc := pinpoint.New(sess)

	params := &pinpoint.UpdateSegmentInput{
		ApplicationId: aws.String("__string"), // Required
		SegmentId:     aws.String("__string"), // Required
		WriteSegmentRequest: &pinpoint.WriteSegmentRequest{ // Required
			Dimensions: &pinpoint.SegmentDimensions{
				Attributes: map[string]*pinpoint.AttributeDimension{
					"Key": { // Required
						AttributeType: aws.String("AttributeType"),
						Values: []*string{
							aws.String("__string"), // Required
							// More values...
						},
					},
					// More values...
				},
				Behavior: &pinpoint.SegmentBehaviors{
					Recency: &pinpoint.RecencyDimension{
						Duration:    aws.String("Duration"),
						RecencyType: aws.String("RecencyType"),
					},
				},
				Demographic: &pinpoint.SegmentDemographics{
					AppVersion: &pinpoint.SetDimension{
						DimensionType: aws.String("DimensionType"),
						Values: []*string{
							aws.String("__string"), // Required
							// More values...
						},
					},
					DeviceType: &pinpoint.SetDimension{
						DimensionType: aws.String("DimensionType"),
						Values: []*string{
							aws.String("__string"), // Required
							// More values...
						},
					},
					Make: &pinpoint.SetDimension{
						DimensionType: aws.String("DimensionType"),
						Values: []*string{
							aws.String("__string"), // Required
							// More values...
						},
					},
					Model: &pinpoint.SetDimension{
						DimensionType: aws.String("DimensionType"),
						Values: []*string{
							aws.String("__string"), // Required
							// More values...
						},
					},
					Platform: &pinpoint.SetDimension{
						DimensionType: aws.String("DimensionType"),
						Values: []*string{
							aws.String("__string"), // Required
							// More values...
						},
					},
				},
				Location: &pinpoint.SegmentLocation{
					Country: &pinpoint.SetDimension{
						DimensionType: aws.String("DimensionType"),
						Values: []*string{
							aws.String("__string"), // Required
							// More values...
						},
					},
				},
				UserAttributes: map[string]*pinpoint.AttributeDimension{
					"Key": { // Required
						AttributeType: aws.String("AttributeType"),
						Values: []*string{
							aws.String("__string"), // Required
							// More values...
						},
					},
					// More values...
				},
			},
			Name: aws.String("__string"),
		},
	}
	resp, err := svc.UpdateSegment(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

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 can be used to capture response data after the request's "Send" method is called.

See UpdateSegment for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the UpdateSegment method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// 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)
}

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.

type PutEventStreamInput added in v1.8.0 

type PutEventStreamInput struct {

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

	// Write event stream wrapper.
	//
	// WriteEventStream is a required field
	WriteEventStream *WriteEventStream `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (PutEventStreamInput) GoString added in v1.8.0 

func (s PutEventStreamInput) GoString() string

GoString returns the string representation

func (*PutEventStreamInput) SetApplicationId added in v1.8.0 

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

SetApplicationId sets the ApplicationId field's value.

func (*PutEventStreamInput) SetWriteEventStream added in v1.8.0 

func (s *PutEventStreamInput) SetWriteEventStream(v *WriteEventStream) *PutEventStreamInput

SetWriteEventStream sets the WriteEventStream field's value.

func (PutEventStreamInput) String added in v1.8.0 

func (s PutEventStreamInput) String() string

String returns the string representation

func (*PutEventStreamInput) Validate added in v1.8.0 

func (s *PutEventStreamInput) Validate() error

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

type PutEventStreamOutput added in v1.8.0 

type PutEventStreamOutput struct {

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

func (PutEventStreamOutput) GoString added in v1.8.0 

func (s PutEventStreamOutput) GoString() string

GoString returns the string representation

func (*PutEventStreamOutput) SetEventStream added in v1.8.0 

func (s *PutEventStreamOutput) SetEventStream(v *EventStream) *PutEventStreamOutput

SetEventStream sets the EventStream field's value.

func (PutEventStreamOutput) String added in v1.8.0 

func (s PutEventStreamOutput) String() string

String returns the string representation

type QuietTime 

type QuietTime struct {

	// The default end time for quiet time in ISO 8601 format.
	End *string `type:"string"`

	// The default start time for quiet time in ISO 8601 format.
	Start *string `type:"string"`
	// contains filtered or unexported fields
}

Quiet Time

func (QuietTime) GoString 

func (s QuietTime) GoString() string

GoString returns the string representation

func (*QuietTime) SetEnd 

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

SetEnd sets the End field's value.

func (*QuietTime) SetStart 

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

SetStart sets the Start field's value.

func (QuietTime) String 

func (s QuietTime) String() string

String returns the string representation

type RecencyDimension 

type RecencyDimension struct {

	// The length of time during which users have been active or inactive with your
	// app.Valid values: HR_24, DAY_7, DAY_14, DAY_30
	Duration *string `type:"string" enum:"Duration"`

	// The recency dimension type:ACTIVE – Users who have used your app within the
	// specified duration are included in the segment.INACTIVE – Users who have
	// not used your app within the specified duration are included in the segment.
	RecencyType *string `type:"string" enum:"RecencyType"`
	// contains filtered or unexported fields
}

Define how a segment based on recency of use.

func (RecencyDimension) GoString 

func (s RecencyDimension) GoString() string

GoString returns the string representation

func (*RecencyDimension) SetDuration 

func (s *RecencyDimension) SetDuration(v string) *RecencyDimension

SetDuration sets the Duration field's value.

func (*RecencyDimension) SetRecencyType 

func (s *RecencyDimension) SetRecencyType(v string) *RecencyDimension

SetRecencyType sets the RecencyType field's value.

func (RecencyDimension) String 

func (s RecencyDimension) String() string

String returns the string representation

type Schedule 

type Schedule struct {

	// The scheduled time that the campaign ends in ISO 8601 format.
	EndTime *string `type:"string"`

	// How often the campaign delivers messages.Valid values: ONCE, HOURLY, DAILY,
	// WEEKLY, MONTHLY
	Frequency *string `type:"string" enum:"Frequency"`

	// Indicates whether the campaign schedule takes effect according to each user's
	// local time.
	IsLocalTime *bool `type:"boolean"`

	// The time during which the campaign sends no messages.
	QuietTime *QuietTime `type:"structure"`

	// The scheduled time that the campaign begins in ISO 8601 format.
	StartTime *string `type:"string"`

	// The starting UTC offset for the schedule if the value for isLocalTime is
	// trueValid values: UTCUTC+01UTC+02UTC+03UTC+03:30UTC+04UTC+04:30UTC+05UTC+05:30UTC+05:45UTC+06UTC+06:30UTC+07UTC+08UTC+09UTC+09:30UTC+10UTC+10:30UTC+11UTC+12UTC+13UTC-02UTC-03UTC-04UTC-05UTC-06UTC-07UTC-08UTC-09UTC-10UTC-11
	Timezone *string `type:"string"`
	// contains filtered or unexported fields
}

Shcedule that defines when a campaign is run.

func (Schedule) GoString 

func (s Schedule) GoString() string

GoString returns the string representation

func (*Schedule) SetEndTime 

func (s *Schedule) SetEndTime(v string) *Schedule

SetEndTime sets the EndTime field's value.

func (*Schedule) SetFrequency 

func (s *Schedule) SetFrequency(v string) *Schedule

SetFrequency sets the Frequency field's value.

func (*Schedule) SetIsLocalTime 

func (s *Schedule) SetIsLocalTime(v bool) *Schedule

SetIsLocalTime sets the IsLocalTime field's value.

func (*Schedule) SetQuietTime 

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

SetQuietTime sets the QuietTime field's value.

func (*Schedule) SetStartTime 

func (s *Schedule) SetStartTime(v string) *Schedule

SetStartTime sets the StartTime field's value.

func (*Schedule) SetTimezone 

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

SetTimezone sets the Timezone field's value.

func (Schedule) String 

func (s Schedule) String() string

String returns the string representation

type SegmentBehaviors 

type SegmentBehaviors struct {

	// The recency of use.
	Recency *RecencyDimension `type:"structure"`
	// contains filtered or unexported fields
}

Segment behavior dimensions

func (SegmentBehaviors) GoString 

func (s SegmentBehaviors) GoString() string

GoString returns the string representation

func (*SegmentBehaviors) SetRecency 

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

type SegmentDemographics 

type SegmentDemographics struct {

	// The app version criteria for the segment.
	AppVersion *SetDimension `type:"structure"`

	// The device type criteria for the segment.
	DeviceType *SetDimension `type:"structure"`

	// The device make criteria for the segment.
	Make *SetDimension `type:"structure"`

	// The device model criteria for the segment.
	Model *SetDimension `type:"structure"`

	// The device platform criteria for the segment.
	Platform *SetDimension `type:"structure"`
	// contains filtered or unexported fields
}

Segment demographic dimensions

func (SegmentDemographics) GoString 

func (s SegmentDemographics) GoString() string

GoString returns the string representation

func (*SegmentDemographics) SetAppVersion 

func (s *SegmentDemographics) SetAppVersion(v *SetDimension) *SegmentDemographics

SetAppVersion sets the AppVersion 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

type SegmentDimensions 

type SegmentDimensions struct {

	// Custom segment attributes.
	Attributes map[string]*AttributeDimension `type:"map"`

	// The segment behaviors attributes.
	Behavior *SegmentBehaviors `type:"structure"`

	// The segment demographics attributes.
	Demographic *SegmentDemographics `type:"structure"`

	// The segment location attributes.
	Location *SegmentLocation `type:"structure"`

	// Custom segment user attributes.
	UserAttributes map[string]*AttributeDimension `type:"map"`
	// contains filtered or unexported fields
}

Segment dimensions

func (SegmentDimensions) GoString 

func (s SegmentDimensions) GoString() string

GoString returns the string representation

func (*SegmentDimensions) SetAttributes 

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) SetUserAttributes added in v1.8.0 

func (s *SegmentDimensions) SetUserAttributes(v map[string]*AttributeDimension) *SegmentDimensions

SetUserAttributes sets the UserAttributes field's value.

func (SegmentDimensions) String 

func (s SegmentDimensions) String() string

String returns the string representation

type SegmentImportResource 

type SegmentImportResource struct {

	// A unique, custom ID assigned to the IAM role that restricts who can assume
	// the role.
	ExternalId *string `type:"string"`

	// The format of the endpoint files that were imported to create this segment.Valid
	// values: CSV, JSON
	Format *string `type:"string" enum:"Format"`

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

	// A URL that points to the Amazon S3 location from which the endpoints for
	// this segment were imported.
	S3Url *string `type:"string"`

	// The number of endpoints that were successfully imported to create this segment.
	Size *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Segment import definition.

func (SegmentImportResource) GoString 

func (s SegmentImportResource) GoString() string

GoString returns the string representation

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

type SegmentLocation 

type SegmentLocation struct {

	// The country filter according to ISO 3166-1 Alpha-2 codes.
	Country *SetDimension `type:"structure"`
	// contains filtered or unexported fields
}

Segment location dimensions

func (SegmentLocation) GoString 

func (s SegmentLocation) GoString() string

GoString returns the string representation

func (*SegmentLocation) SetCountry 

func (s *SegmentLocation) SetCountry(v *SetDimension) *SegmentLocation

SetCountry sets the Country field's value.

func (SegmentLocation) String 

func (s SegmentLocation) String() string

String returns the string representation

type SegmentResponse 

type SegmentResponse struct {

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

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

	// The segment dimensions attributes.
	Dimensions *SegmentDimensions `type:"structure"`

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

	// The import job settings.
	ImportDefinition *SegmentImportResource `type:"structure"`

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

	// The name of segment
	Name *string `type:"string"`

	// The segment type:DIMENSIONAL – A dynamic segment built from selection criteria
	// based on endpoint data reported by your app. You create this type of segment
	// by using the segment builder in the Amazon Pinpoint console or by making
	// a POST request to the segments resource.IMPORT – A static segment built from
	// an imported set of endpoint definitions. You create this type of segment
	// by importing a segment in the Amazon Pinpoint console or by making a POST
	// request to the jobs/import resource.
	SegmentType *string `type:"string" enum:"SegmentType"`

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

Segment definition.

func (SegmentResponse) GoString 

func (s SegmentResponse) GoString() string

GoString returns the string representation

func (*SegmentResponse) SetApplicationId 

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

SetApplicationId sets the ApplicationId field's value.

func (*SegmentResponse) SetCreationDate 

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

SetCreationDate sets the CreationDate field's value.

func (*SegmentResponse) SetDimensions 

func (s *SegmentResponse) SetDimensions(v *SegmentDimensions) *SegmentResponse

SetDimensions sets the Dimensions field's value.

func (*SegmentResponse) SetId 

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

SetId sets the Id field's value.

func (*SegmentResponse) SetImportDefinition 

func (s *SegmentResponse) SetImportDefinition(v *SegmentImportResource) *SegmentResponse

SetImportDefinition sets the ImportDefinition field's value.

func (*SegmentResponse) SetLastModifiedDate 

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

SetLastModifiedDate sets the LastModifiedDate field's value.

func (*SegmentResponse) SetName 

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

SetName sets the Name field's value.

func (*SegmentResponse) SetSegmentType 

func (s *SegmentResponse) SetSegmentType(v string) *SegmentResponse

SetSegmentType sets the SegmentType field's value.

func (*SegmentResponse) SetVersion 

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

SetVersion sets the Version field's value.

func (SegmentResponse) String 

func (s SegmentResponse) String() string

String returns the string representation

type SegmentsResponse 

type SegmentsResponse struct {

	// The list of segments.
	Item []*SegmentResponse `type:"list"`

	// An identifier used to retrieve the next page of results. The token is null
	// if no additional pages exist.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

Segments in your account.

func (SegmentsResponse) GoString 

func (s SegmentsResponse) GoString() string

GoString returns the string representation

func (*SegmentsResponse) SetItem 

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

type SetDimension 

type SetDimension struct {

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

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

Dimension specification of a segment.

func (SetDimension) GoString 

func (s SetDimension) GoString() string

GoString returns the string representation

func (*SetDimension) SetDimensionType 

func (s *SetDimension) SetDimensionType(v string) *SetDimension

SetDimensionType sets the DimensionType field's value.

func (*SetDimension) SetValues 

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

SetValues sets the Values field's value.

func (SetDimension) String 

func (s SetDimension) String() string

String returns the string representation

type TreatmentResource 

type TreatmentResource struct {

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

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

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

	// The allocated percentage of users for this treatment.
	SizePercent *int64 `type:"integer"`

	// The treatment status.
	State *CampaignState `type:"structure"`

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

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

Treatment resource

func (TreatmentResource) GoString 

func (s TreatmentResource) GoString() string

GoString returns the string representation

func (*TreatmentResource) SetId 

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

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

SetTreatmentDescription sets the TreatmentDescription field's value.

func (*TreatmentResource) SetTreatmentName 

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

SetTreatmentName sets the TreatmentName field's value.

func (TreatmentResource) String 

func (s TreatmentResource) String() string

String returns the string representation

type UpdateApnsChannelInput 

type UpdateApnsChannelInput struct {

	// Apple Push Notification Service channel definition.
	//
	// APNSChannelRequest is a required field
	APNSChannelRequest *APNSChannelRequest `type:"structure" required:"true"`

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

func (UpdateApnsChannelInput) GoString 

func (s UpdateApnsChannelInput) GoString() string

GoString returns the string representation

func (*UpdateApnsChannelInput) SetAPNSChannelRequest 

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

func (*UpdateApnsChannelInput) Validate 

func (s *UpdateApnsChannelInput) Validate() error

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

type UpdateApnsChannelOutput 

type UpdateApnsChannelOutput struct {

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

func (UpdateApnsChannelOutput) GoString 

func (s UpdateApnsChannelOutput) GoString() string

GoString returns the string representation

func (*UpdateApnsChannelOutput) SetAPNSChannelResponse 

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

type UpdateApplicationSettingsInput 

type UpdateApplicationSettingsInput struct {

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

	// Creating application setting request
	//
	// WriteApplicationSettingsRequest is a required field
	WriteApplicationSettingsRequest *WriteApplicationSettingsRequest `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateApplicationSettingsInput) GoString 

func (s UpdateApplicationSettingsInput) GoString() string

GoString returns the string representation

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

func (*UpdateApplicationSettingsInput) Validate 

func (s *UpdateApplicationSettingsInput) Validate() error

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

type UpdateApplicationSettingsOutput 

type UpdateApplicationSettingsOutput struct {

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

func (UpdateApplicationSettingsOutput) GoString 

func (s UpdateApplicationSettingsOutput) GoString() string

GoString returns the string representation

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

type UpdateCampaignInput 

type UpdateCampaignInput struct {

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

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

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

func (UpdateCampaignInput) GoString 

func (s UpdateCampaignInput) GoString() string

GoString returns the string representation

func (*UpdateCampaignInput) SetApplicationId 

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

SetApplicationId sets the ApplicationId field's value.

func (*UpdateCampaignInput) SetCampaignId 

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

SetCampaignId sets the CampaignId field's value.

func (*UpdateCampaignInput) SetWriteCampaignRequest 

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

SetWriteCampaignRequest sets the WriteCampaignRequest field's value.

func (UpdateCampaignInput) String 

func (s UpdateCampaignInput) String() string

String returns the string representation

func (*UpdateCampaignInput) Validate 

func (s *UpdateCampaignInput) Validate() error

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

type UpdateCampaignOutput 

type UpdateCampaignOutput struct {

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

func (UpdateCampaignOutput) GoString 

func (s UpdateCampaignOutput) GoString() string

GoString returns the string representation

func (*UpdateCampaignOutput) SetCampaignResponse 

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

SetCampaignResponse sets the CampaignResponse field's value.

func (UpdateCampaignOutput) String 

func (s UpdateCampaignOutput) String() string

String returns the string representation

type UpdateEndpointInput 

type UpdateEndpointInput struct {

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

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

	// Endpoint update request
	//
	// EndpointRequest is a required field
	EndpointRequest *EndpointRequest `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateEndpointInput) GoString 

func (s UpdateEndpointInput) GoString() string

GoString returns the string representation

func (*UpdateEndpointInput) SetApplicationId 

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

SetApplicationId sets the ApplicationId field's value.

func (*UpdateEndpointInput) SetEndpointId 

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

SetEndpointId sets the EndpointId field's value.

func (*UpdateEndpointInput) SetEndpointRequest 

func (s *UpdateEndpointInput) SetEndpointRequest(v *EndpointRequest) *UpdateEndpointInput

SetEndpointRequest sets the EndpointRequest field's value.

func (UpdateEndpointInput) String 

func (s UpdateEndpointInput) String() string

String returns the string representation

func (*UpdateEndpointInput) Validate 

func (s *UpdateEndpointInput) Validate() error

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

type UpdateEndpointOutput 

type UpdateEndpointOutput struct {

	// Simple message object.
	//
	// MessageBody is a required field
	MessageBody *MessageBody `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateEndpointOutput) GoString 

func (s UpdateEndpointOutput) GoString() string

GoString returns the string representation

func (*UpdateEndpointOutput) SetMessageBody 

func (s *UpdateEndpointOutput) SetMessageBody(v *MessageBody) *UpdateEndpointOutput

SetMessageBody sets the MessageBody field's value.

func (UpdateEndpointOutput) String 

func (s UpdateEndpointOutput) String() string

String returns the string representation

type UpdateEndpointsBatchInput 

type UpdateEndpointsBatchInput struct {

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

	// Endpoint batch update request.
	//
	// EndpointBatchRequest is a required field
	EndpointBatchRequest *EndpointBatchRequest `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateEndpointsBatchInput) GoString 

func (s UpdateEndpointsBatchInput) GoString() string

GoString returns the string representation

func (*UpdateEndpointsBatchInput) SetApplicationId 

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

func (*UpdateEndpointsBatchInput) Validate 

func (s *UpdateEndpointsBatchInput) Validate() error

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

type UpdateEndpointsBatchOutput 

type UpdateEndpointsBatchOutput struct {

	// Simple message object.
	//
	// MessageBody is a required field
	MessageBody *MessageBody `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateEndpointsBatchOutput) GoString 

func (s UpdateEndpointsBatchOutput) GoString() string

GoString returns the string representation

func (*UpdateEndpointsBatchOutput) SetMessageBody 

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

type UpdateGcmChannelInput 

type UpdateGcmChannelInput struct {

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

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

func (UpdateGcmChannelInput) GoString 

func (s UpdateGcmChannelInput) GoString() string

GoString returns the string representation

func (*UpdateGcmChannelInput) SetApplicationId 

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

SetApplicationId sets the ApplicationId field's value.

func (*UpdateGcmChannelInput) SetGCMChannelRequest 

func (s *UpdateGcmChannelInput) SetGCMChannelRequest(v *GCMChannelRequest) *UpdateGcmChannelInput

SetGCMChannelRequest sets the GCMChannelRequest field's value.

func (UpdateGcmChannelInput) String 

func (s UpdateGcmChannelInput) String() string

String returns the string representation

func (*UpdateGcmChannelInput) Validate 

func (s *UpdateGcmChannelInput) Validate() error

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

type UpdateGcmChannelOutput 

type UpdateGcmChannelOutput struct {

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

func (UpdateGcmChannelOutput) GoString 

func (s UpdateGcmChannelOutput) GoString() string

GoString returns the string representation

func (*UpdateGcmChannelOutput) SetGCMChannelResponse 

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

type UpdateSegmentInput 

type UpdateSegmentInput struct {

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

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

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

func (UpdateSegmentInput) GoString 

func (s UpdateSegmentInput) GoString() string

GoString returns the string representation

func (*UpdateSegmentInput) SetApplicationId 

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

SetApplicationId sets the ApplicationId field's value.

func (*UpdateSegmentInput) SetSegmentId 

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

SetSegmentId sets the SegmentId field's value.

func (*UpdateSegmentInput) SetWriteSegmentRequest 

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

SetWriteSegmentRequest sets the WriteSegmentRequest field's value.

func (UpdateSegmentInput) String 

func (s UpdateSegmentInput) String() string

String returns the string representation

func (*UpdateSegmentInput) Validate 

func (s *UpdateSegmentInput) Validate() error

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

type UpdateSegmentOutput 

type UpdateSegmentOutput struct {

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

func (UpdateSegmentOutput) GoString 

func (s UpdateSegmentOutput) GoString() string

GoString returns the string representation

func (*UpdateSegmentOutput) SetSegmentResponse 

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

SetSegmentResponse sets the SegmentResponse field's value.

func (UpdateSegmentOutput) String 

func (s UpdateSegmentOutput) String() string

String returns the string representation

type WriteApplicationSettingsRequest 

type WriteApplicationSettingsRequest struct {

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

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

Creating application setting request

func (WriteApplicationSettingsRequest) GoString 

func (s WriteApplicationSettingsRequest) GoString() string

GoString returns the string representation

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

type WriteCampaignRequest 

type WriteCampaignRequest struct {

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

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

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

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

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

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

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

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

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

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

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

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

Used to create a campaign.

func (WriteCampaignRequest) GoString 

func (s WriteCampaignRequest) GoString() string

GoString returns the string representation

func (*WriteCampaignRequest) SetAdditionalTreatments 

func (s *WriteCampaignRequest) SetAdditionalTreatments(v []*WriteTreatmentResource) *WriteCampaignRequest

SetAdditionalTreatments sets the AdditionalTreatments field's value.

func (*WriteCampaignRequest) SetDescription 

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

SetDescription sets the Description field's value.

func (*WriteCampaignRequest) SetHoldoutPercent 

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

SetHoldoutPercent sets the HoldoutPercent field's value.

func (*WriteCampaignRequest) 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) 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) SetTreatmentDescription 

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

SetTreatmentDescription sets the TreatmentDescription field's value.

func (*WriteCampaignRequest) SetTreatmentName 

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

SetTreatmentName sets the TreatmentName field's value.

func (WriteCampaignRequest) String 

func (s WriteCampaignRequest) String() string

String returns the string representation

type WriteEventStream added in v1.8.0 

type WriteEventStream struct {

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

	// The external ID assigned the IAM role that authorizes Amazon Pinpoint to
	// publish to the stream.
	ExternalId *string `type:"string"`

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

Request to save an EventStream.

func (WriteEventStream) GoString added in v1.8.0 

func (s WriteEventStream) GoString() string

GoString returns the string representation

func (*WriteEventStream) SetDestinationStreamArn added in v1.8.0 

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

SetDestinationStreamArn sets the DestinationStreamArn field's value.

func (*WriteEventStream) SetExternalId added in v1.8.0 

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

SetExternalId sets the ExternalId field's value.

func (*WriteEventStream) SetRoleArn added in v1.8.0 

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

SetRoleArn sets the RoleArn field's value.

func (WriteEventStream) String added in v1.8.0 

func (s WriteEventStream) String() string

String returns the string representation

type WriteSegmentRequest 

type WriteSegmentRequest struct {

	// The segment dimensions attributes.
	Dimensions *SegmentDimensions `type:"structure"`

	// The name of segment
	Name *string `type:"string"`
	// contains filtered or unexported fields
}

Segment definition.

func (WriteSegmentRequest) GoString 

func (s WriteSegmentRequest) GoString() string

GoString returns the string representation

func (*WriteSegmentRequest) SetDimensions 

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

func (s WriteSegmentRequest) String() string

String returns the string representation

type WriteTreatmentResource 

type WriteTreatmentResource struct {

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

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

	// The allocated percentage of users for this treatment.
	SizePercent *int64 `type:"integer"`

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

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

Used to create a campaign treatment.

func (WriteTreatmentResource) GoString 

func (s WriteTreatmentResource) GoString() string

GoString returns the string representation

func (*WriteTreatmentResource) SetMessageConfiguration 

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

SetMessageConfiguration sets the MessageConfiguration field's value.

func (*WriteTreatmentResource) SetSchedule 

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

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.