aws-sdk-go: github.com/aws/aws-sdk-go/service/pinpoint Index | Files | Directories

package pinpoint

import "github.com/aws/aws-sdk-go/service/pinpoint"

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

Doc Engage API - Amazon Pinpoint API

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

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

Using the Client

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

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

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

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

Index

Package Files

api.go doc.go errors.go service.go

Constants

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"
)
const (
    // AttributeTypeInclusive is a AttributeType enum value
    AttributeTypeInclusive = "INCLUSIVE"

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

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

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

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

    // CampaignStatusPaused is a CampaignStatus enum value
    CampaignStatusPaused = "PAUSED"

    // CampaignStatusDeleted is a CampaignStatus enum value
    CampaignStatusDeleted = "DELETED"
)
const (
    // ChannelTypeGcm is a ChannelType enum value
    ChannelTypeGcm = "GCM"

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    // DimensionTypeExclusive is a DimensionType enum value
    DimensionTypeExclusive = "EXCLUSIVE"
)
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"
)
const (
    // FilterTypeSystem is a FilterType enum value
    FilterTypeSystem = "SYSTEM"

    // FilterTypeEndpoint is a FilterType enum value
    FilterTypeEndpoint = "ENDPOINT"
)
const (
    // FormatCsv is a Format enum value
    FormatCsv = "CSV"

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

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

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

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

    // FrequencyMonthly is a Frequency enum value
    FrequencyMonthly = "MONTHLY"

    // FrequencyEvent is a Frequency enum value
    FrequencyEvent = "EVENT"
)
const (
    // IncludeAll is a Include enum value
    IncludeAll = "ALL"

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

    // IncludeNone is a Include enum value
    IncludeNone = "NONE"
)
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"
)
const (
    // MessageTypeTransactional is a MessageType enum value
    MessageTypeTransactional = "TRANSACTIONAL"

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

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

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

    // SegmentTypeImport is a SegmentType enum value
    SegmentTypeImport = "IMPORT"
)
const (
    // SourceTypeAll is a SourceType enum value
    SourceTypeAll = "ALL"

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

    // SourceTypeNone is a SourceType enum value
    SourceTypeNone = "NONE"
)
const (
    // TypeAll is a Type enum value
    TypeAll = "ALL"

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

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

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

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

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

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

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

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

Service information constants

type ADMChannelRequest Uses

type ADMChannelRequest struct {

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

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

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

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

func (ADMChannelRequest) GoString Uses

func (s ADMChannelRequest) GoString() string

GoString returns the string representation

func (*ADMChannelRequest) SetClientId Uses

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

SetClientId sets the ClientId field's value.

func (*ADMChannelRequest) SetClientSecret Uses

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

SetClientSecret sets the ClientSecret field's value.

func (*ADMChannelRequest) SetEnabled Uses

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

SetEnabled sets the Enabled field's value.

func (ADMChannelRequest) String Uses

func (s ADMChannelRequest) String() string

String returns the string representation

func (*ADMChannelRequest) Validate Uses

func (s *ADMChannelRequest) Validate() error

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

type ADMChannelResponse Uses

type ADMChannelResponse struct {

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

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

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

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

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

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

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

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

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

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

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

func (ADMChannelResponse) GoString Uses

func (s ADMChannelResponse) GoString() string

GoString returns the string representation

func (*ADMChannelResponse) SetApplicationId Uses

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

SetApplicationId sets the ApplicationId field's value.

func (*ADMChannelResponse) SetCreationDate Uses

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

SetCreationDate sets the CreationDate field's value.

func (*ADMChannelResponse) SetEnabled Uses

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

SetEnabled sets the Enabled field's value.

func (*ADMChannelResponse) SetHasCredential Uses

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

SetHasCredential sets the HasCredential field's value.

func (*ADMChannelResponse) SetId Uses

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

SetId sets the Id field's value.

func (*ADMChannelResponse) SetIsArchived Uses

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

SetIsArchived sets the IsArchived field's value.

func (*ADMChannelResponse) SetLastModifiedBy Uses

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

SetLastModifiedBy sets the LastModifiedBy field's value.

func (*ADMChannelResponse) SetLastModifiedDate Uses

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

SetLastModifiedDate sets the LastModifiedDate field's value.

func (*ADMChannelResponse) SetPlatform Uses

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

SetPlatform sets the Platform field's value.

func (*ADMChannelResponse) SetVersion Uses

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

SetVersion sets the Version field's value.

func (ADMChannelResponse) String Uses

func (s ADMChannelResponse) String() string

String returns the string representation

type ADMMessage Uses

type ADMMessage struct {

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

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

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

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

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

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

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

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

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

    // The raw, JSON-formatted string to use as the payload for the notification
    // message. This value overrides the message.
    RawContent *string `type:"string"`

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

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

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

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

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

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

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

func (ADMMessage) GoString Uses

func (s ADMMessage) GoString() string

GoString returns the string representation

func (*ADMMessage) SetAction Uses

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

SetAction sets the Action field's value.

func (*ADMMessage) SetBody Uses

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

SetBody sets the Body field's value.

func (*ADMMessage) SetConsolidationKey Uses

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

SetConsolidationKey sets the ConsolidationKey field's value.

func (*ADMMessage) SetData Uses

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

SetData sets the Data field's value.

func (*ADMMessage) SetExpiresAfter Uses

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

SetExpiresAfter sets the ExpiresAfter field's value.

func (*ADMMessage) SetIconReference Uses

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

SetIconReference sets the IconReference field's value.

func (*ADMMessage) SetImageIconUrl Uses

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

SetImageIconUrl sets the ImageIconUrl field's value.

func (*ADMMessage) SetImageUrl Uses

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

SetImageUrl sets the ImageUrl field's value.

func (*ADMMessage) SetMD5 Uses

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

SetMD5 sets the MD5 field's value.

func (*ADMMessage) SetRawContent Uses

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

SetRawContent sets the RawContent field's value.

func (*ADMMessage) SetSilentPush Uses

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

SetSilentPush sets the SilentPush field's value.

func (*ADMMessage) SetSmallImageIconUrl Uses

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

SetSmallImageIconUrl sets the SmallImageIconUrl field's value.

func (*ADMMessage) SetSound Uses

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

SetSound sets the Sound field's value.

func (*ADMMessage) SetSubstitutions Uses

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

SetSubstitutions sets the Substitutions field's value.

func (*ADMMessage) SetTitle Uses

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

SetTitle sets the Title field's value.

func (*ADMMessage) SetUrl Uses

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

SetUrl sets the Url field's value.

func (ADMMessage) String Uses

func (s ADMMessage) String() string

String returns the string representation

type APNSChannelRequest Uses

type APNSChannelRequest struct {

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

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

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

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

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

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

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

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

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

func (APNSChannelRequest) GoString Uses

func (s APNSChannelRequest) GoString() string

GoString returns the string representation

func (*APNSChannelRequest) SetBundleId Uses

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

SetBundleId sets the BundleId field's value.

func (*APNSChannelRequest) SetCertificate Uses

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

SetCertificate sets the Certificate field's value.

func (*APNSChannelRequest) SetDefaultAuthenticationMethod Uses

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

SetDefaultAuthenticationMethod sets the DefaultAuthenticationMethod field's value.

func (*APNSChannelRequest) SetEnabled Uses

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

SetEnabled sets the Enabled field's value.

func (*APNSChannelRequest) SetPrivateKey Uses

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

SetPrivateKey sets the PrivateKey field's value.

func (*APNSChannelRequest) SetTeamId Uses

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

SetTeamId sets the TeamId field's value.

func (*APNSChannelRequest) SetTokenKey Uses

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

SetTokenKey sets the TokenKey field's value.

func (*APNSChannelRequest) SetTokenKeyId Uses

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

SetTokenKeyId sets the TokenKeyId field's value.

func (APNSChannelRequest) String Uses

func (s APNSChannelRequest) String() string

String returns the string representation

type APNSChannelResponse Uses

type APNSChannelResponse struct {

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

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

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

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

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

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

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

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

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

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

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

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

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

func (APNSChannelResponse) GoString Uses

func (s APNSChannelResponse) GoString() string

GoString returns the string representation

func (*APNSChannelResponse) SetApplicationId Uses

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

SetApplicationId sets the ApplicationId field's value.

func (*APNSChannelResponse) SetCreationDate Uses

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

SetCreationDate sets the CreationDate field's value.

func (*APNSChannelResponse) SetDefaultAuthenticationMethod Uses

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

SetDefaultAuthenticationMethod sets the DefaultAuthenticationMethod field's value.

func (*APNSChannelResponse) SetEnabled Uses

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

SetEnabled sets the Enabled field's value.

func (*APNSChannelResponse) SetHasCredential Uses

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

SetHasCredential sets the HasCredential field's value.

func (*APNSChannelResponse) SetHasTokenKey Uses

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

SetHasTokenKey sets the HasTokenKey field's value.

func (*APNSChannelResponse) SetId Uses

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

SetId sets the Id field's value.

func (*APNSChannelResponse) SetIsArchived Uses

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

SetIsArchived sets the IsArchived field's value.

func (*APNSChannelResponse) SetLastModifiedBy Uses

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

SetLastModifiedBy sets the LastModifiedBy field's value.

func (*APNSChannelResponse) SetLastModifiedDate Uses

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

SetLastModifiedDate sets the LastModifiedDate field's value.

func (*APNSChannelResponse) SetPlatform Uses

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

SetPlatform sets the Platform field's value.

func (*APNSChannelResponse) SetVersion Uses

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

SetVersion sets the Version field's value.

func (APNSChannelResponse) String Uses

func (s APNSChannelResponse) String() string

String returns the string representation

type APNSMessage Uses

type APNSMessage struct {

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

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

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

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

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

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

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

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

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

    // The raw, JSON-formatted string to use as the payload for the notification
    // message. This value overrides the message.
    RawContent *string `type:"string"`

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

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

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

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

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

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

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

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

func (APNSMessage) GoString Uses

func (s APNSMessage) GoString() string

GoString returns the string representation

func (*APNSMessage) SetAction Uses

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

SetAction sets the Action field's value.

func (*APNSMessage) SetBadge Uses

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

SetBadge sets the Badge field's value.

func (*APNSMessage) SetBody Uses

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

SetBody sets the Body field's value.

func (*APNSMessage) SetCategory Uses

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

SetCategory sets the Category field's value.

func (*APNSMessage) SetCollapseId Uses

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

SetCollapseId sets the CollapseId field's value.

func (*APNSMessage) SetData Uses

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

SetData sets the Data field's value.

func (*APNSMessage) SetMediaUrl Uses

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

SetMediaUrl sets the MediaUrl field's value.

func (*APNSMessage) SetPreferredAuthenticationMethod Uses

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

SetPreferredAuthenticationMethod sets the PreferredAuthenticationMethod field's value.

func (*APNSMessage) SetPriority Uses

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

SetPriority sets the Priority field's value.

func (*APNSMessage) SetRawContent Uses

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

SetRawContent sets the RawContent field's value.

func (*APNSMessage) SetSilentPush Uses

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

SetSilentPush sets the SilentPush field's value.

func (*APNSMessage) SetSound Uses

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

SetSound sets the Sound field's value.

func (*APNSMessage) SetSubstitutions Uses

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

SetSubstitutions sets the Substitutions field's value.

func (*APNSMessage) SetThreadId Uses

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

SetThreadId sets the ThreadId field's value.

func (*APNSMessage) SetTimeToLive Uses

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

SetTimeToLive sets the TimeToLive field's value.

func (*APNSMessage) SetTitle Uses

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

SetTitle sets the Title field's value.

func (*APNSMessage) SetUrl Uses

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

SetUrl sets the Url field's value.

func (APNSMessage) String Uses

func (s APNSMessage) String() string

String returns the string representation

type APNSSandboxChannelRequest Uses

type APNSSandboxChannelRequest struct {

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

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

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

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

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

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

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

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

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

func (APNSSandboxChannelRequest) GoString Uses

func (s APNSSandboxChannelRequest) GoString() string

GoString returns the string representation

func (*APNSSandboxChannelRequest) SetBundleId Uses

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

SetBundleId sets the BundleId field's value.

func (*APNSSandboxChannelRequest) SetCertificate Uses

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

SetCertificate sets the Certificate field's value.

func (*APNSSandboxChannelRequest) SetDefaultAuthenticationMethod Uses

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

SetDefaultAuthenticationMethod sets the DefaultAuthenticationMethod field's value.

func (*APNSSandboxChannelRequest) SetEnabled Uses

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

SetEnabled sets the Enabled field's value.

func (*APNSSandboxChannelRequest) SetPrivateKey Uses

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

SetPrivateKey sets the PrivateKey field's value.

func (*APNSSandboxChannelRequest) SetTeamId Uses

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

SetTeamId sets the TeamId field's value.

func (*APNSSandboxChannelRequest) SetTokenKey Uses

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

SetTokenKey sets the TokenKey field's value.

func (*APNSSandboxChannelRequest) SetTokenKeyId Uses

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

SetTokenKeyId sets the TokenKeyId field's value.

func (APNSSandboxChannelRequest) String Uses

func (s APNSSandboxChannelRequest) String() string

String returns the string representation

type APNSSandboxChannelResponse Uses

type APNSSandboxChannelResponse struct {

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

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

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

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

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

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

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

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

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

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

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

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

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

func (APNSSandboxChannelResponse) GoString Uses

func (s APNSSandboxChannelResponse) GoString() string

GoString returns the string representation

func (*APNSSandboxChannelResponse) SetApplicationId Uses

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

SetApplicationId sets the ApplicationId field's value.

func (*APNSSandboxChannelResponse) SetCreationDate Uses

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

SetCreationDate sets the CreationDate field's value.

func (*APNSSandboxChannelResponse) SetDefaultAuthenticationMethod Uses

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

SetDefaultAuthenticationMethod sets the DefaultAuthenticationMethod field's value.

func (*APNSSandboxChannelResponse) SetEnabled Uses

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

SetEnabled sets the Enabled field's value.

func (*APNSSandboxChannelResponse) SetHasCredential Uses

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

SetHasCredential sets the HasCredential field's value.

func (*APNSSandboxChannelResponse) SetHasTokenKey Uses

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

SetHasTokenKey sets the HasTokenKey field's value.

func (*APNSSandboxChannelResponse) SetId Uses

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

SetId sets the Id field's value.

func (*APNSSandboxChannelResponse) SetIsArchived Uses

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

SetIsArchived sets the IsArchived field's value.

func (*APNSSandboxChannelResponse) SetLastModifiedBy Uses

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

SetLastModifiedBy sets the LastModifiedBy field's value.

func (*APNSSandboxChannelResponse) SetLastModifiedDate Uses

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

SetLastModifiedDate sets the LastModifiedDate field's value.

func (*APNSSandboxChannelResponse) SetPlatform Uses

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

SetPlatform sets the Platform field's value.

func (*APNSSandboxChannelResponse) SetVersion Uses

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

SetVersion sets the Version field's value.

func (APNSSandboxChannelResponse) String Uses

func (s APNSSandboxChannelResponse) String() string

String returns the string representation

type APNSVoipChannelRequest Uses

type APNSVoipChannelRequest struct {

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

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

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

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

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

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

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

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

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

func (APNSVoipChannelRequest) GoString Uses

func (s APNSVoipChannelRequest) GoString() string

GoString returns the string representation

func (*APNSVoipChannelRequest) SetBundleId Uses

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

SetBundleId sets the BundleId field's value.

func (*APNSVoipChannelRequest) SetCertificate Uses

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

SetCertificate sets the Certificate field's value.

func (*APNSVoipChannelRequest) SetDefaultAuthenticationMethod Uses

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

SetDefaultAuthenticationMethod sets the DefaultAuthenticationMethod field's value.

func (*APNSVoipChannelRequest) SetEnabled Uses

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

SetEnabled sets the Enabled field's value.

func (*APNSVoipChannelRequest) SetPrivateKey Uses

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

SetPrivateKey sets the PrivateKey field's value.

func (*APNSVoipChannelRequest) SetTeamId Uses

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

SetTeamId sets the TeamId field's value.

func (*APNSVoipChannelRequest) SetTokenKey Uses

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

SetTokenKey sets the TokenKey field's value.

func (*APNSVoipChannelRequest) SetTokenKeyId Uses

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

SetTokenKeyId sets the TokenKeyId field's value.

func (APNSVoipChannelRequest) String Uses

func (s APNSVoipChannelRequest) String() string

String returns the string representation

type APNSVoipChannelResponse Uses

type APNSVoipChannelResponse struct {

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

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

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

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

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

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

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

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

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

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

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

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

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

func (APNSVoipChannelResponse) GoString Uses

func (s APNSVoipChannelResponse) GoString() string

GoString returns the string representation

func (*APNSVoipChannelResponse) SetApplicationId Uses

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

SetApplicationId sets the ApplicationId field's value.

func (*APNSVoipChannelResponse) SetCreationDate Uses

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

SetCreationDate sets the CreationDate field's value.

func (*APNSVoipChannelResponse) SetDefaultAuthenticationMethod Uses

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

SetDefaultAuthenticationMethod sets the DefaultAuthenticationMethod field's value.

func (*APNSVoipChannelResponse) SetEnabled Uses

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

SetEnabled sets the Enabled field's value.

func (*APNSVoipChannelResponse) SetHasCredential Uses

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

SetHasCredential sets the HasCredential field's value.

func (*APNSVoipChannelResponse) SetHasTokenKey Uses

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

SetHasTokenKey sets the HasTokenKey field's value.

func (*APNSVoipChannelResponse) SetId Uses

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

SetId sets the Id field's value.

func (*APNSVoipChannelResponse) SetIsArchived Uses

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

SetIsArchived sets the IsArchived field's value.

func (*APNSVoipChannelResponse) SetLastModifiedBy Uses

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

SetLastModifiedBy sets the LastModifiedBy field's value.

func (*APNSVoipChannelResponse) SetLastModifiedDate Uses

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

SetLastModifiedDate sets the LastModifiedDate field's value.

func (*APNSVoipChannelResponse) SetPlatform Uses

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

SetPlatform sets the Platform field's value.

func (*APNSVoipChannelResponse) SetVersion Uses

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

SetVersion sets the Version field's value.

func (APNSVoipChannelResponse) String Uses

func (s APNSVoipChannelResponse) String() string

String returns the string representation

type APNSVoipSandboxChannelRequest Uses

type APNSVoipSandboxChannelRequest struct {

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

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

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

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

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

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

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

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

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

func (APNSVoipSandboxChannelRequest) GoString Uses

func (s APNSVoipSandboxChannelRequest) GoString() string

GoString returns the string representation

func (*APNSVoipSandboxChannelRequest) SetBundleId Uses

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

SetBundleId sets the BundleId field's value.

func (*APNSVoipSandboxChannelRequest) SetCertificate Uses

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

SetCertificate sets the Certificate field's value.

func (*APNSVoipSandboxChannelRequest) SetDefaultAuthenticationMethod Uses

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

SetDefaultAuthenticationMethod sets the DefaultAuthenticationMethod field's value.

func (*APNSVoipSandboxChannelRequest) SetEnabled Uses

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

SetEnabled sets the Enabled field's value.

func (*APNSVoipSandboxChannelRequest) SetPrivateKey Uses

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

SetPrivateKey sets the PrivateKey field's value.

func (*APNSVoipSandboxChannelRequest) SetTeamId Uses

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

SetTeamId sets the TeamId field's value.

func (*APNSVoipSandboxChannelRequest) SetTokenKey Uses

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

SetTokenKey sets the TokenKey field's value.

func (*APNSVoipSandboxChannelRequest) SetTokenKeyId Uses

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

SetTokenKeyId sets the TokenKeyId field's value.

func (APNSVoipSandboxChannelRequest) String Uses

func (s APNSVoipSandboxChannelRequest) String() string

String returns the string representation

type APNSVoipSandboxChannelResponse Uses

type APNSVoipSandboxChannelResponse struct {

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

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

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

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

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

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

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

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

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

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

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

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

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

func (APNSVoipSandboxChannelResponse) GoString Uses

func (s APNSVoipSandboxChannelResponse) GoString() string

GoString returns the string representation

func (*APNSVoipSandboxChannelResponse) SetApplicationId Uses

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

SetApplicationId sets the ApplicationId field's value.

func (*APNSVoipSandboxChannelResponse) SetCreationDate Uses

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

SetCreationDate sets the CreationDate field's value.

func (*APNSVoipSandboxChannelResponse) SetDefaultAuthenticationMethod Uses

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

SetDefaultAuthenticationMethod sets the DefaultAuthenticationMethod field's value.

func (*APNSVoipSandboxChannelResponse) SetEnabled Uses

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

SetEnabled sets the Enabled field's value.

func (*APNSVoipSandboxChannelResponse) SetHasCredential Uses

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

SetHasCredential sets the HasCredential field's value.

func (*APNSVoipSandboxChannelResponse) SetHasTokenKey Uses

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

SetHasTokenKey sets the HasTokenKey field's value.

func (*APNSVoipSandboxChannelResponse) SetId Uses

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

SetId sets the Id field's value.

func (*APNSVoipSandboxChannelResponse) SetIsArchived Uses

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

SetIsArchived sets the IsArchived field's value.

func (*APNSVoipSandboxChannelResponse) SetLastModifiedBy Uses

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

SetLastModifiedBy sets the LastModifiedBy field's value.

func (*APNSVoipSandboxChannelResponse) SetLastModifiedDate Uses

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

SetLastModifiedDate sets the LastModifiedDate field's value.

func (*APNSVoipSandboxChannelResponse) SetPlatform Uses

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

SetPlatform sets the Platform field's value.

func (*APNSVoipSandboxChannelResponse) SetVersion Uses

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

SetVersion sets the Version field's value.

func (APNSVoipSandboxChannelResponse) String Uses

func (s APNSVoipSandboxChannelResponse) String() string

String returns the string representation

type ActivitiesResponse Uses

type ActivitiesResponse struct {

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

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

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

func (ActivitiesResponse) GoString Uses

func (s ActivitiesResponse) GoString() string

GoString returns the string representation

func (*ActivitiesResponse) SetItem Uses

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

SetItem sets the Item field's value.

func (*ActivitiesResponse) SetNextToken Uses

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

SetNextToken sets the NextToken field's value.

func (ActivitiesResponse) String Uses

func (s ActivitiesResponse) String() string

String returns the string representation

type ActivityResponse Uses

type ActivityResponse struct {

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

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

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

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

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

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

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

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

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

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

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

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

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

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

func (ActivityResponse) GoString Uses

func (s ActivityResponse) GoString() string

GoString returns the string representation

func (*ActivityResponse) SetApplicationId Uses

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

SetApplicationId sets the ApplicationId field's value.

func (*ActivityResponse) SetCampaignId Uses

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

SetCampaignId sets the CampaignId field's value.

func (*ActivityResponse) SetEnd Uses

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

SetEnd sets the End field's value.

func (*ActivityResponse) SetId Uses

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

SetId sets the Id field's value.

func (*ActivityResponse) SetResult Uses

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

SetResult sets the Result field's value.

func (*ActivityResponse) SetScheduledStart Uses

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

SetScheduledStart sets the ScheduledStart field's value.

func (*ActivityResponse) SetStart Uses

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

SetStart sets the Start field's value.

func (*ActivityResponse) SetState Uses

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

SetState sets the State field's value.

func (*ActivityResponse) SetSuccessfulEndpointCount Uses

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

SetSuccessfulEndpointCount sets the SuccessfulEndpointCount field's value.

func (*ActivityResponse) SetTimezonesCompletedCount Uses

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

SetTimezonesCompletedCount sets the TimezonesCompletedCount field's value.

func (*ActivityResponse) SetTimezonesTotalCount Uses

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

SetTimezonesTotalCount sets the TimezonesTotalCount field's value.

func (*ActivityResponse) SetTotalEndpointCount Uses

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

SetTotalEndpointCount sets the TotalEndpointCount field's value.

func (*ActivityResponse) SetTreatmentId Uses

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

SetTreatmentId sets the TreatmentId field's value.

func (ActivityResponse) String Uses

func (s ActivityResponse) String() string

String returns the string representation

type AddressConfiguration Uses

type AddressConfiguration struct {

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

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

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

    // The raw, JSON-formatted string to use as the payload for the notification
    // message. This value overrides the message.
    RawContent *string `type:"string"`

    // An object that maps variable values for the message. Amazon Pinpoint merges
    // these values with the variable values specified by properties of the DefaultMessage
    // object. The substitutions in this map take precedence over all other substitutions.
    Substitutions map[string][]*string `type:"map"`

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

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

func (AddressConfiguration) GoString Uses

func (s AddressConfiguration) GoString() string

GoString returns the string representation

func (*AddressConfiguration) SetBodyOverride Uses

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

SetBodyOverride sets the BodyOverride field's value.

func (*AddressConfiguration) SetChannelType Uses

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

SetChannelType sets the ChannelType field's value.

func (*AddressConfiguration) SetContext Uses

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

SetContext sets the Context field's value.

func (*AddressConfiguration) SetRawContent Uses

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

SetRawContent sets the RawContent field's value.

func (*AddressConfiguration) SetSubstitutions Uses

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

SetSubstitutions sets the Substitutions field's value.

func (*AddressConfiguration) SetTitleOverride Uses

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

SetTitleOverride sets the TitleOverride field's value.

func (AddressConfiguration) String Uses

func (s AddressConfiguration) String() string

String returns the string representation

type ApplicationDateRangeKpiResponse Uses

type ApplicationDateRangeKpiResponse struct {

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

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

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

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

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

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

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

func (ApplicationDateRangeKpiResponse) GoString Uses

func (s ApplicationDateRangeKpiResponse) GoString() string

GoString returns the string representation

func (*ApplicationDateRangeKpiResponse) SetApplicationId Uses

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

SetApplicationId sets the ApplicationId field's value.

func (*ApplicationDateRangeKpiResponse) SetEndTime Uses

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

SetEndTime sets the EndTime field's value.

func (*ApplicationDateRangeKpiResponse) SetKpiName Uses

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

SetKpiName sets the KpiName field's value.

func (*ApplicationDateRangeKpiResponse) SetKpiResult Uses

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

SetKpiResult sets the KpiResult field's value.

func (*ApplicationDateRangeKpiResponse) SetNextToken Uses

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

SetNextToken sets the NextToken field's value.

func (*ApplicationDateRangeKpiResponse) SetStartTime Uses

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

SetStartTime sets the StartTime field's value.

func (ApplicationDateRangeKpiResponse) String Uses

func (s ApplicationDateRangeKpiResponse) String() string

String returns the string representation

type ApplicationResponse Uses

type ApplicationResponse struct {

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

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

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

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

Provides information about an application.

func (ApplicationResponse) GoString Uses

func (s ApplicationResponse) GoString() string

GoString returns the string representation

func (*ApplicationResponse) SetArn Uses

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

SetArn sets the Arn field's value.

func (*ApplicationResponse) SetId Uses

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

SetId sets the Id field's value.

func (*ApplicationResponse) SetName Uses

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

SetName sets the Name field's value.

func (*ApplicationResponse) SetTags Uses

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

SetTags sets the Tags field's value.

func (ApplicationResponse) String Uses

func (s ApplicationResponse) String() string

String returns the string representation

type ApplicationSettingsResource Uses

type ApplicationSettingsResource struct {

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

    // The settings for the AWS Lambda function to use by default as a code hook
    // for campaigns in the application.
    CampaignHook *CampaignHook `type:"structure"`

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

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

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

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

func (ApplicationSettingsResource) GoString Uses

func (s ApplicationSettingsResource) GoString() string

GoString returns the string representation

func (*ApplicationSettingsResource) SetApplicationId Uses

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

SetApplicationId sets the ApplicationId field's value.

func (*ApplicationSettingsResource) SetCampaignHook Uses

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

SetCampaignHook sets the CampaignHook field's value.

func (*ApplicationSettingsResource) SetLastModifiedDate Uses

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

SetLastModifiedDate sets the LastModifiedDate field's value.

func (*ApplicationSettingsResource) SetLimits Uses

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

SetLimits sets the Limits field's value.

func (*ApplicationSettingsResource) SetQuietTime Uses

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

SetQuietTime sets the QuietTime field's value.

func (ApplicationSettingsResource) String Uses

func (s ApplicationSettingsResource) String() string

String returns the string representation

type ApplicationsResponse Uses

type ApplicationsResponse struct {

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

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

Provides information about all of your applications.

func (ApplicationsResponse) GoString Uses

func (s ApplicationsResponse) GoString() string

GoString returns the string representation

func (*ApplicationsResponse) SetItem Uses

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

SetItem sets the Item field's value.

func (*ApplicationsResponse) SetNextToken Uses

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

SetNextToken sets the NextToken field's value.

func (ApplicationsResponse) String Uses

func (s ApplicationsResponse) String() string

String returns the string representation

type AttributeDimension Uses

type AttributeDimension struct {

    // The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints
    // that match the criteria are included in the segment; and, EXCLUSIVE, endpoints
    // that match the criteria are excluded from the segment.
    AttributeType *string `type:"string" enum:"AttributeType"`

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

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

func (AttributeDimension) GoString Uses

func (s AttributeDimension) GoString() string

GoString returns the string representation

func (*AttributeDimension) SetAttributeType Uses

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

SetAttributeType sets the AttributeType field's value.

func (*AttributeDimension) SetValues Uses

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

SetValues sets the Values field's value.

func (AttributeDimension) String Uses

func (s AttributeDimension) String() string

String returns the string representation

func (*AttributeDimension) Validate Uses

func (s *AttributeDimension) Validate() error

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

type AttributesResource Uses

type AttributesResource struct {

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

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

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

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

func (AttributesResource) GoString Uses

func (s AttributesResource) GoString() string

GoString returns the string representation

func (*AttributesResource) SetApplicationId Uses

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

SetApplicationId sets the ApplicationId field's value.

func (*AttributesResource) SetAttributeType Uses

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

SetAttributeType sets the AttributeType field's value.

func (*AttributesResource) SetAttributes Uses

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

SetAttributes sets the Attributes field's value.

func (AttributesResource) String Uses

func (s AttributesResource) String() string

String returns the string representation

type BaiduChannelRequest Uses

type BaiduChannelRequest struct {

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

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

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

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

func (BaiduChannelRequest) GoString Uses

func (s BaiduChannelRequest) GoString() string

GoString returns the string representation

func (*BaiduChannelRequest) SetApiKey Uses

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

SetApiKey sets the ApiKey field's value.

func (*BaiduChannelRequest) SetEnabled Uses

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

SetEnabled sets the Enabled field's value.

func (*BaiduChannelRequest) SetSecretKey Uses

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

SetSecretKey sets the SecretKey field's value.

func (BaiduChannelRequest) String Uses

func (s BaiduChannelRequest) String() string

String returns the string representation

func (*BaiduChannelRequest) Validate Uses

func (s *BaiduChannelRequest) Validate() error

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

type BaiduChannelResponse Uses

type BaiduChannelResponse struct {

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

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

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

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

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

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

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

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

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

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

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

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

func (BaiduChannelResponse) GoString Uses

func (s BaiduChannelResponse) GoString() string

GoString returns the string representation

func (*BaiduChannelResponse) SetApplicationId Uses

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

SetApplicationId sets the ApplicationId field's value.

func (*BaiduChannelResponse) SetCreationDate Uses

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

SetCreationDate sets the CreationDate field's value.

func (*BaiduChannelResponse) SetCredential Uses

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

SetCredential sets the Credential field's value.

func (*BaiduChannelResponse) SetEnabled Uses

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

SetEnabled sets the Enabled field's value.

func (*BaiduChannelResponse) SetHasCredential Uses

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

SetHasCredential sets the HasCredential field's value.

func (*BaiduChannelResponse) SetId Uses

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

SetId sets the Id field's value.

func (*BaiduChannelResponse) SetIsArchived Uses

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

SetIsArchived sets the IsArchived field's value.

func (*BaiduChannelResponse) SetLastModifiedBy Uses

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

SetLastModifiedBy sets the LastModifiedBy field's value.

func (*BaiduChannelResponse) SetLastModifiedDate Uses

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

SetLastModifiedDate sets the LastModifiedDate field's value.

func (*BaiduChannelResponse) SetPlatform Uses

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

SetPlatform sets the Platform field's value.

func (*BaiduChannelResponse) SetVersion Uses

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

SetVersion sets the Version field's value.

func (BaiduChannelResponse) String Uses

func (s BaiduChannelResponse) String() string

String returns the string representation

type BaiduMessage Uses

type BaiduMessage struct {

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

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

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

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

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

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

    // The raw, JSON-formatted string to use as the payload for the notification
    // message. This value overrides the message.
    RawContent *string `type:"string"`

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

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

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

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

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

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

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

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

func (BaiduMessage) GoString Uses

func (s BaiduMessage) GoString() string

GoString returns the string representation

func (*BaiduMessage) SetAction Uses

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

SetAction sets the Action field's value.

func (*BaiduMessage) SetBody Uses

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

SetBody sets the Body field's value.

func (*BaiduMessage) SetData Uses

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

SetData sets the Data field's value.

func (*BaiduMessage) SetIconReference Uses

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

SetIconReference sets the IconReference field's value.

func (*BaiduMessage) SetImageIconUrl Uses

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

SetImageIconUrl sets the ImageIconUrl field's value.

func (*BaiduMessage) SetImageUrl Uses

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

SetImageUrl sets the ImageUrl field's value.

func (*BaiduMessage) SetRawContent Uses

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

SetRawContent sets the RawContent field's value.

func (*BaiduMessage) SetSilentPush Uses

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

SetSilentPush sets the SilentPush field's value.

func (*BaiduMessage) SetSmallImageIconUrl Uses

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

SetSmallImageIconUrl sets the SmallImageIconUrl field's value.

func (*BaiduMessage) SetSound Uses

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

SetSound sets the Sound field's value.

func (*BaiduMessage) SetSubstitutions Uses

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

SetSubstitutions sets the Substitutions field's value.

func (*BaiduMessage) SetTimeToLive Uses

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

SetTimeToLive sets the TimeToLive field's value.

func (*BaiduMessage) SetTitle Uses

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

SetTitle sets the Title field's value.

func (*BaiduMessage) SetUrl Uses

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

SetUrl sets the Url field's value.

func (BaiduMessage) String Uses

func (s BaiduMessage) String() string

String returns the string representation

type BaseKpiResult Uses

type BaseKpiResult struct {

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

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

func (BaseKpiResult) GoString Uses

func (s BaseKpiResult) GoString() string

GoString returns the string representation

func (*BaseKpiResult) SetRows Uses

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

SetRows sets the Rows field's value.

func (BaseKpiResult) String Uses

func (s BaseKpiResult) String() string

String returns the string representation

type CampaignDateRangeKpiResponse Uses

type CampaignDateRangeKpiResponse struct {

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

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

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

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

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

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

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

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

func (CampaignDateRangeKpiResponse) GoString Uses

func (s CampaignDateRangeKpiResponse) GoString() string

GoString returns the string representation

func (*CampaignDateRangeKpiResponse) SetApplicationId Uses

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

SetApplicationId sets the ApplicationId field's value.

func (*CampaignDateRangeKpiResponse) SetCampaignId Uses

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

SetCampaignId sets the CampaignId field's value.

func (*CampaignDateRangeKpiResponse) SetEndTime Uses

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

SetEndTime sets the EndTime field's value.

func (*CampaignDateRangeKpiResponse) SetKpiName Uses

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

SetKpiName sets the KpiName field's value.

func (*CampaignDateRangeKpiResponse) SetKpiResult Uses

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

SetKpiResult sets the KpiResult field's value.

func (*CampaignDateRangeKpiResponse) SetNextToken Uses

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

SetNextToken sets the NextToken field's value.

func (*CampaignDateRangeKpiResponse) SetStartTime Uses

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

SetStartTime sets the StartTime field's value.

func (CampaignDateRangeKpiResponse) String Uses

func (s CampaignDateRangeKpiResponse) String() string

String returns the string representation

type CampaignEmailMessage Uses

type CampaignEmailMessage struct {

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

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

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

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

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

func (CampaignEmailMessage) GoString Uses

func (s CampaignEmailMessage) GoString() string

GoString returns the string representation

func (*CampaignEmailMessage) SetBody Uses

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

SetBody sets the Body field's value.

func (*CampaignEmailMessage) SetFromAddress Uses

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

SetFromAddress sets the FromAddress field's value.

func (*CampaignEmailMessage) SetHtmlBody Uses

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

SetHtmlBody sets the HtmlBody field's value.

func (*CampaignEmailMessage) SetTitle Uses

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

SetTitle sets the Title field's value.

func (CampaignEmailMessage) String Uses

func (s CampaignEmailMessage) String() string

String returns the string representation

func (*CampaignEmailMessage) Validate Uses

func (s *CampaignEmailMessage) Validate() error

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

type CampaignEventFilter Uses

type CampaignEventFilter struct {

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

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

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

func (CampaignEventFilter) GoString Uses

func (s CampaignEventFilter) GoString() string

GoString returns the string representation

func (*CampaignEventFilter) SetDimensions Uses

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

SetDimensions sets the Dimensions field's value.

func (*CampaignEventFilter) SetFilterType Uses

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

SetFilterType sets the FilterType field's value.

func (CampaignEventFilter) String Uses

func (s CampaignEventFilter) String() string

String returns the string representation

func (*CampaignEventFilter) Validate Uses

func (s *CampaignEventFilter) Validate() error

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

type CampaignHook Uses

type CampaignHook struct {

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

    // Specifies which Lambda mode to use when invoking the AWS Lambda function.
    Mode *string `type:"string" enum:"Mode"`

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

Specifies the AWS Lambda function to use as a code hook for a campaign.

func (CampaignHook) GoString Uses

func (s CampaignHook) GoString() string

GoString returns the string representation

func (*CampaignHook) SetLambdaFunctionName Uses

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

SetLambdaFunctionName sets the LambdaFunctionName field's value.

func (*CampaignHook) SetMode Uses

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

SetMode sets the Mode field's value.

func (*CampaignHook) SetWebUrl Uses

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

SetWebUrl sets the WebUrl field's value.

func (CampaignHook) String Uses

func (s CampaignHook) String() string

String returns the string representation

type CampaignLimits Uses

type CampaignLimits struct {

    // The maximum number of messages that a campaign can send to a single endpoint
    // during a 24-hour period. The maximum value is 100.
    Daily *int64 `type:"integer"`

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

    // The maximum number of messages that a campaign can send each second. The
    // minimum value is 50. The maximum value is 20,000.
    MessagesPerSecond *int64 `type:"integer"`

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

Specifies limits on the messages that a campaign can send.

func (CampaignLimits) GoString Uses

func (s CampaignLimits) GoString() string

GoString returns the string representation

func (*CampaignLimits) SetDaily Uses

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

SetDaily sets the Daily field's value.

func (*CampaignLimits) SetMaximumDuration Uses

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

SetMaximumDuration sets the MaximumDuration field's value.

func (*CampaignLimits) SetMessagesPerSecond Uses

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

SetMessagesPerSecond sets the MessagesPerSecond field's value.

func (*CampaignLimits) SetTotal Uses

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

SetTotal sets the Total field's value.

func (CampaignLimits) String Uses

func (s CampaignLimits) String() string

String returns the string representation

type CampaignResponse Uses

type CampaignResponse struct {

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

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

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

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

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

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

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

    // The settings for the AWS Lambda function to use as a code hook for the campaign.
    Hook *CampaignHook `type:"structure"`

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

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

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

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

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

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

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

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

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

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

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

    // The custom description of a variation of the campaign that's used for A/B
    // testing.
    TreatmentDescription *string `type:"string"`

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

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

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

func (CampaignResponse) GoString Uses

func (s CampaignResponse) GoString() string

GoString returns the string representation

func (*CampaignResponse) SetAdditionalTreatments Uses

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

SetAdditionalTreatments sets the AdditionalTreatments field's value.

func (*CampaignResponse) SetApplicationId Uses

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

SetApplicationId sets the ApplicationId field's value.

func (*CampaignResponse) SetArn Uses

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

SetArn sets the Arn field's value.

func (*CampaignResponse) SetCreationDate Uses

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

SetCreationDate sets the CreationDate field's value.

func (*CampaignResponse) SetDefaultState Uses

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

SetDefaultState sets the DefaultState field's value.

func (*CampaignResponse) SetDescription Uses

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

SetDescription sets the Description field's value.

func (*CampaignResponse) SetHoldoutPercent Uses

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

SetHoldoutPercent sets the HoldoutPercent field's value.

func (*CampaignResponse) SetHook Uses

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

SetHook sets the Hook field's value.

func (*CampaignResponse) SetId Uses

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

SetId sets the Id field's value.

func (*CampaignResponse) SetIsPaused Uses

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

SetIsPaused sets the IsPaused field's value.

func (*CampaignResponse) SetLastModifiedDate Uses

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

SetLastModifiedDate sets the LastModifiedDate field's value.

func (*CampaignResponse) SetLimits Uses

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

SetLimits sets the Limits field's value.

func (*CampaignResponse) SetMessageConfiguration Uses

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

SetMessageConfiguration sets the MessageConfiguration field's value.

func (*CampaignResponse) SetName Uses

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

SetName sets the Name field's value.

func (*CampaignResponse) SetSchedule Uses

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

SetSchedule sets the Schedule field's value.

func (*CampaignResponse) SetSegmentId Uses

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

SetSegmentId sets the SegmentId field's value.

func (*CampaignResponse) SetSegmentVersion Uses

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

SetSegmentVersion sets the SegmentVersion field's value.

func (*CampaignResponse) SetState Uses

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

SetState sets the State field's value.

func (*CampaignResponse) SetTags Uses

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

SetTags sets the Tags field's value.

func (*CampaignResponse) SetTreatmentDescription Uses

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

SetTreatmentDescription sets the TreatmentDescription field's value.

func (*CampaignResponse) SetTreatmentName Uses

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

SetTreatmentName sets the TreatmentName field's value.

func (*CampaignResponse) SetVersion Uses

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

SetVersion sets the Version field's value.

func (CampaignResponse) String Uses

func (s CampaignResponse) String() string

String returns the string representation

type CampaignSmsMessage Uses

type CampaignSmsMessage struct {

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

    // The type of SMS message. Valid values are: TRANSACTIONAL, the message is
    // critical or time-sensitive, such as a one-time password that supports a customer
    // transaction; and, PROMOTIONAL, the message isn't critical or time-sensitive,
    // such as a marketing message.
    MessageType *string `type:"string" enum:"MessageType"`

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

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

func (CampaignSmsMessage) GoString Uses

func (s CampaignSmsMessage) GoString() string

GoString returns the string representation

func (*CampaignSmsMessage) SetBody Uses

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

SetBody sets the Body field's value.

func (*CampaignSmsMessage) SetMessageType Uses

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

SetMessageType sets the MessageType field's value.

func (*CampaignSmsMessage) SetSenderId Uses

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

SetSenderId sets the SenderId field's value.

func (CampaignSmsMessage) String Uses

func (s CampaignSmsMessage) String() string

String returns the string representation

type CampaignState Uses

type CampaignState struct {

    // The status of the campaign, or the status of a treatment that belongs to
    // an A/B test campaign. If a campaign uses A/B testing, the campaign has a
    // status of COMPLETED only when all campaign treatments have a status of COMPLETED.
    CampaignStatus *string `type:"string" enum:"CampaignStatus"`
    // contains filtered or unexported fields
}

Provides information about the status of a campaign.

func (CampaignState) GoString Uses

func (s CampaignState) GoString() string

GoString returns the string representation

func (*CampaignState) SetCampaignStatus Uses

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

SetCampaignStatus sets the CampaignStatus field's value.

func (CampaignState) String Uses

func (s CampaignState) String() string

String returns the string representation

type CampaignsResponse Uses

type CampaignsResponse struct {

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

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

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

func (CampaignsResponse) GoString Uses

func (s CampaignsResponse) GoString() string

GoString returns the string representation

func (*CampaignsResponse) SetItem Uses

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

SetItem sets the Item field's value.

func (*CampaignsResponse) SetNextToken Uses

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

SetNextToken sets the NextToken field's value.

func (CampaignsResponse) String Uses

func (s CampaignsResponse) String() string

String returns the string representation

type ChannelResponse Uses

type ChannelResponse struct {

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

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

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

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

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

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

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

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

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

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

func (ChannelResponse) GoString Uses

func (s ChannelResponse) GoString() string

GoString returns the string representation

func (*ChannelResponse) SetApplicationId Uses

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

SetApplicationId sets the ApplicationId field's value.

func (*ChannelResponse) SetCreationDate Uses

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

SetCreationDate sets the CreationDate field's value.

func (*ChannelResponse) SetEnabled Uses

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

SetEnabled sets the Enabled field's value.

func (*ChannelResponse) SetHasCredential Uses

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

SetHasCredential sets the HasCredential field's value.

func (*ChannelResponse) SetId Uses

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

SetId sets the Id field's value.

func (*ChannelResponse) SetIsArchived Uses

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

SetIsArchived sets the IsArchived field's value.

func (*ChannelResponse) SetLastModifiedBy Uses

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

SetLastModifiedBy sets the LastModifiedBy field's value.

func (*ChannelResponse) SetLastModifiedDate Uses

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

SetLastModifiedDate sets the LastModifiedDate field's value.

func (*ChannelResponse) SetVersion Uses

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

SetVersion sets the Version field's value.

func (ChannelResponse) String Uses

func (s ChannelResponse) String() string

String returns the string representation

type ChannelsResponse Uses

type ChannelsResponse struct {

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

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

func (ChannelsResponse) GoString Uses

func (s ChannelsResponse) GoString() string

GoString returns the string representation

func (*ChannelsResponse) SetChannels Uses

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

SetChannels sets the Channels field's value.

func (ChannelsResponse) String Uses

func (s ChannelsResponse) String() string

String returns the string representation

type CreateAppInput Uses

type CreateAppInput struct {

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

func (CreateAppInput) GoString Uses

func (s CreateAppInput) GoString() string

GoString returns the string representation

func (*CreateAppInput) SetCreateApplicationRequest Uses

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

SetCreateApplicationRequest sets the CreateApplicationRequest field's value.

func (CreateAppInput) String Uses

func (s CreateAppInput) String() string

String returns the string representation

func (*CreateAppInput) Validate Uses

func (s *CreateAppInput) Validate() error

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

type CreateAppOutput Uses

type CreateAppOutput struct {

    // Provides information about an application.
    //
    // ApplicationResponse is a required field
    ApplicationResponse *ApplicationResponse `type:"structure" required:"true"`
    // contains filtered or unexported fields
}

func (CreateAppOutput) GoString Uses

func (s CreateAppOutput) GoString() string

GoString returns the string representation

func (*CreateAppOutput) SetApplicationResponse Uses

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

SetApplicationResponse sets the ApplicationResponse field's value.

func (CreateAppOutput) String Uses

func (s CreateAppOutput) String() string

String returns the string representation

type CreateApplicationRequest Uses

type CreateApplicationRequest struct {

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

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

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

func (CreateApplicationRequest) GoString Uses

func (s CreateApplicationRequest) GoString() string

GoString returns the string representation

func (*CreateApplicationRequest) SetName Uses

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

SetName sets the Name field's value.

func (*CreateApplicationRequest) SetTags Uses

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

SetTags sets the Tags field's value.

func (CreateApplicationRequest) String Uses

func (s CreateApplicationRequest) String() string

String returns the string representation

func (*CreateApplicationRequest) Validate Uses

func (s *CreateApplicationRequest) Validate() error

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

type CreateCampaignInput Uses

type CreateCampaignInput struct {

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

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

func (CreateCampaignInput) GoString Uses

func (s CreateCampaignInput) GoString() string

GoString returns the string representation

func (*CreateCampaignInput) SetApplicationId Uses

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

SetApplicationId sets the ApplicationId field's value.

func (*CreateCampaignInput) SetWriteCampaignRequest Uses

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

SetWriteCampaignRequest sets the WriteCampaignRequest field's value.

func (CreateCampaignInput) String Uses

func (s CreateCampaignInput) String() string

String returns the string representation

func (*CreateCampaignInput) Validate Uses

func (s *CreateCampaignInput) Validate() error

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

type CreateCampaignOutput Uses

type CreateCampaignOutput struct {

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

func (CreateCampaignOutput) GoString Uses

func (s CreateCampaignOutput) GoString() string

GoString returns the string representation

func (*CreateCampaignOutput) SetCampaignResponse Uses

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

SetCampaignResponse sets the CampaignResponse field's value.

func (CreateCampaignOutput) String Uses

func (s CreateCampaignOutput) String() string

String returns the string representation

type CreateExportJobInput Uses

type CreateExportJobInput struct {

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

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

func (CreateExportJobInput) GoString Uses

func (s CreateExportJobInput) GoString() string

GoString returns the string representation

func (*CreateExportJobInput) SetApplicationId Uses

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

SetApplicationId sets the ApplicationId field's value.

func (*CreateExportJobInput) SetExportJobRequest Uses

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

SetExportJobRequest sets the ExportJobRequest field's value.

func (CreateExportJobInput) String Uses

func (s CreateExportJobInput) String() string

String returns the string representation

func (*CreateExportJobInput) Validate Uses

func (s *CreateExportJobInput) Validate() error

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

type CreateExportJobOutput Uses

type CreateExportJobOutput struct {

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

func (CreateExportJobOutput) GoString Uses

func (s CreateExportJobOutput) GoString() string

GoString returns the string representation

func (*CreateExportJobOutput) SetExportJobResponse Uses

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

SetExportJobResponse sets the ExportJobResponse field's value.

func (CreateExportJobOutput) String Uses

func (s CreateExportJobOutput) String() string

String returns the string representation

type CreateImportJobInput Uses

type CreateImportJobInput struct {

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

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

func (CreateImportJobInput) GoString Uses

func (s CreateImportJobInput) GoString() string

GoString returns the string representation

func (*CreateImportJobInput) SetApplicationId Uses

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

SetApplicationId sets the ApplicationId field's value.

func (*CreateImportJobInput) SetImportJobRequest Uses

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

SetImportJobRequest sets the ImportJobRequest field's value.

func (CreateImportJobInput) String Uses

func (s CreateImportJobInput) String() string

String returns the string representation

func (*CreateImportJobInput) Validate Uses

func (s *CreateImportJobInput) Validate() error

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

type CreateImportJobOutput Uses

type CreateImportJobOutput struct {

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

func (CreateImportJobOutput) GoString Uses

func (s CreateImportJobOutput) GoString() string

GoString returns the string representation

func (*CreateImportJobOutput) SetImportJobResponse Uses

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

SetImportJobResponse sets the ImportJobResponse field's value.

func (CreateImportJobOutput) String Uses

func (s CreateImportJobOutput) String() string

String returns the string representation

type CreateSegmentInput Uses

type CreateSegmentInput struct {

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

    // Specifies the configuration, dimension, and other settings for a segment.
    // A WriteSegmentRequest object can include a Dimensions object or a SegmentGroups
    // object, but not both.
    //
    // WriteSegmentRequest is a required field
    WriteSegmentRequest *WriteSegmentRequest `type:"structure" required:"true"`
    // contains filtered or unexported fields
}

func (CreateSegmentInput) GoString Uses

func (s CreateSegmentInput) GoString() string

GoString returns the string representation

func (*CreateSegmentInput) SetApplicationId Uses

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

SetApplicationId sets the ApplicationId field's value.

func (*CreateSegmentInput) SetWriteSegmentRequest Uses

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

SetWriteSegmentRequest sets the WriteSegmentRequest field's value.

func (CreateSegmentInput) String Uses

func (s CreateSegmentInput) String() string

String returns the string representation

func (*CreateSegmentInput) Validate Uses

func (s *CreateSegmentInput) Validate() error

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

type CreateSegmentOutput Uses

type CreateSegmentOutput struct {

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

func (CreateSegmentOutput) GoString Uses

func (s CreateSegmentOutput) GoString() string

GoString returns the string representation

func (*CreateSegmentOutput) SetSegmentResponse Uses

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

SetSegmentResponse sets the SegmentResponse field's value.

func (CreateSegmentOutput) String Uses

func (s CreateSegmentOutput) String() string

String returns the string representation

type DefaultMessage Uses

type DefaultMessage struct {

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

    // The default message variables to use in the push notification, email, or
    // SMS message. You can override these default variables with individual address
    // variables.
    Substitutions map[string][]*string `type:"map"`
    // contains filtered or unexported fields
}

Specifies the default message to use for all channels.

func (DefaultMessage) GoString Uses

func (s DefaultMessage) GoString() string

GoString returns the string representation

func (*DefaultMessage) SetBody Uses

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

SetBody sets the Body field's value.

func (*DefaultMessage) SetSubstitutions Uses

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

SetSubstitutions sets the Substitutions field's value.

func (DefaultMessage) String Uses

func (s DefaultMessage) String() string

String returns the string representation

type DefaultPushNotificationMessage Uses

type DefaultPushNotificationMessage struct {

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

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

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

    // Specifies whether the default notification is a silent push notification,
    // which is a push notification that doesn't display on a recipient's device.
    // Silent push notifications can be used for cases such as updating an app's
    // configuration or delivering messages to an in-app notification center.
    SilentPush *bool `type:"boolean"`

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

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

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

Specifies the default settings and content for a push notification that's sent directly to an endpoint.

func (DefaultPushNotificationMessage) GoString Uses

func (s DefaultPushNotificationMessage) GoString() string

GoString returns the string representation

func (*DefaultPushNotificationMessage) SetAction Uses

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

SetAction sets the Action field's value.

func (*DefaultPushNotificationMessage) SetBody Uses

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

SetBody sets the Body field's value.

func (*DefaultPushNotificationMessage) SetData Uses

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

SetData sets the Data field's value.

func (*DefaultPushNotificationMessage) SetSilentPush Uses

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

SetSilentPush sets the SilentPush field's value.

func (*DefaultPushNotificationMessage) SetSubstitutions Uses

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

SetSubstitutions sets the Substitutions field's value.

func (*DefaultPushNotificationMessage) SetTitle Uses

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

SetTitle sets the Title field's value.

func (*DefaultPushNotificationMessage) SetUrl Uses

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

SetUrl sets the Url field's value.

func (DefaultPushNotificationMessage) String Uses

func (s DefaultPushNotificationMessage) String() string

String returns the string representation

type DeleteAdmChannelInput Uses

type DeleteAdmChannelInput struct {

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

func (DeleteAdmChannelInput) GoString Uses

func (s DeleteAdmChannelInput) GoString() string

GoString returns the string representation

func (*DeleteAdmChannelInput) SetApplicationId Uses

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

SetApplicationId sets the ApplicationId field's value.

func (DeleteAdmChannelInput) String Uses

func (s DeleteAdmChannelInput) String() string

String returns the string representation

func (*DeleteAdmChannelInput) Validate Uses

func (s *DeleteAdmChannelInput) Validate() error

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

type DeleteAdmChannelOutput Uses

type DeleteAdmChannelOutput struct {

    // Provides information about the status and settings of the ADM (Amazon Device
    // Messaging) channel for an application.
    //
    // ADMChannelResponse is a required field
    ADMChannelResponse *ADMChannelResponse `type:"structure" required:"true"`
    // contains filtered or unexported fields
}

func (DeleteAdmChannelOutput) GoString Uses

func (s DeleteAdmChannelOutput) GoString() string

GoString returns the string representation

func (*DeleteAdmChannelOutput) SetADMChannelResponse Uses

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

SetADMChannelResponse sets the ADMChannelResponse field's value.

func (DeleteAdmChannelOutput) String Uses

func (s DeleteAdmChannelOutput) String() string

String returns the string representation

type DeleteApnsChannelInput Uses

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 Uses

func (s DeleteApnsChannelInput) GoString() string

GoString returns the string representation

func (*DeleteApnsChannelInput) SetApplicationId Uses

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

SetApplicationId sets the ApplicationId field's value.

func (DeleteApnsChannelInput) String Uses

func (s DeleteApnsChannelInput) String() string

String returns the string representation

func (*DeleteApnsChannelInput) Validate Uses

func (s *DeleteApnsChannelInput) Validate() error

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

type DeleteApnsChannelOutput Uses

type DeleteApnsChannelOutput struct {

    // Provides information about the status and settings of the APNs (Apple Push
    // Notification service) channel for an application.
    //
    // APNSChannelResponse is a required field
    APNSChannelResponse *APNSChannelResponse `type:"structure" required:"true"`
    // contains filtered or unexported fields
}

func (DeleteApnsChannelOutput) GoString Uses

func (s DeleteApnsChannelOutput) GoString() string

GoString returns the string representation

func (*DeleteApnsChannelOutput) SetAPNSChannelResponse Uses

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

SetAPNSChannelResponse sets the APNSChannelResponse field's value.

func (DeleteApnsChannelOutput) String Uses

func (s DeleteApnsChannelOutput) String() string

String returns the string representation

type DeleteApnsSandboxChannelInput Uses

type DeleteApnsSandboxChannelInput struct {

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

func (DeleteApnsSandboxChannelInput) GoString Uses

func (s DeleteApnsSandboxChannelInput) GoString() string

GoString returns the string representation

func (*DeleteApnsSandboxChannelInput) SetApplicationId Uses

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

SetApplicationId sets the ApplicationId field's value.

func (DeleteApnsSandboxChannelInput) String Uses

func (s DeleteApnsSandboxChannelInput) String() string

String returns the string representation

func (*DeleteApnsSandboxChannelInput) Validate Uses

func (s *DeleteApnsSandboxChannelInput) Validate() error

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

type DeleteApnsSandboxChannelOutput Uses

type DeleteApnsSandboxChannelOutput struct {

    // Provides information about the status and settings of the APNs (Apple Push
    // Notification service) sandbox channel for an application.
    //
    // APNSSandboxChannelResponse is a required field
    APNSSandboxChannelResponse *APNSSandboxChannelResponse `type:"structure" required:"true"`
    // contains filtered or unexported fields
}

func (DeleteApnsSandboxChannelOutput) GoString Uses

func (s DeleteApnsSandboxChannelOutput) GoString() string

GoString returns the string representation

func (*DeleteApnsSandboxChannelOutput) SetAPNSSandboxChannelResponse Uses

func (s *DeleteApnsSandboxChannelOutput) SetAPNSSandboxChannelResponse(v *APNSSandboxChannelResponse) *DeleteApnsSandboxChannelOutput

SetAPNSSandboxChannelResponse sets the APNSSandboxChannelResponse field's value.

func (DeleteApnsSandboxChannelOutput) String Uses

func (s DeleteApnsSandboxChannelOutput) String() string

String returns the string representation

type DeleteApnsVoipChannelInput Uses

type DeleteApnsVoipChannelInput struct {

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

func (DeleteApnsVoipChannelInput) GoString Uses

func (s DeleteApnsVoipChannelInput) GoString() string

GoString returns the string representation

func (*DeleteApnsVoipChannelInput) SetApplicationId Uses

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

SetApplicationId sets the ApplicationId field's value.

func (DeleteApnsVoipChannelInput) String Uses

func (s DeleteApnsVoipChannelInput) String() string

String returns the string representation

func (*DeleteApnsVoipChannelInput) Validate Uses

func (s *DeleteApnsVoipChannelInput) Validate() error

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

type DeleteApnsVoipChannelOutput Uses

type DeleteApnsVoipChannelOutput struct {

    // Provides information about the status and settings of the APNs (Apple Push
    // Notification service) VoIP channel for an application.
    //
    // APNSVoipChannelResponse is a required field
    APNSVoipChannelResponse *APNSVoipChannelResponse `type:"structure" required:"true"`
    // contains filtered or unexported fields
}

func (DeleteApnsVoipChannelOutput) GoString Uses

func (s DeleteApnsVoipChannelOutput) GoString() string

GoString returns the string representation

func (*DeleteApnsVoipChannelOutput) SetAPNSVoipChannelResponse Uses

func (s *DeleteApnsVoipChannelOutput) SetAPNSVoipChannelResponse(v *APNSVoipChannelResponse) *DeleteApnsVoipChannelOutput

SetAPNSVoipChannelResponse sets the APNSVoipChannelResponse field's value.

func (DeleteApnsVoipChannelOutput) String Uses

func (s DeleteApnsVoipChannelOutput) String() string

String returns the string representation

type DeleteApnsVoipSandboxChannelInput Uses

type DeleteApnsVoipSandboxChannelInput struct {

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

func (DeleteApnsVoipSandboxChannelInput) GoString Uses

func (s DeleteApnsVoipSandboxChannelInput) GoString() string

GoString returns the string representation

func (*DeleteApnsVoipSandboxChannelInput) SetApplicationId Uses

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

SetApplicationId sets the ApplicationId field's value.

func (DeleteApnsVoipSandboxChannelInput) String Uses

func (s DeleteApnsVoipSandboxChannelInput) String() string

String returns the string representation

func (*DeleteApnsVoipSandboxChannelInput) Validate Uses

func (s *DeleteApnsVoipSandboxChannelInput) Validate() error

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

type DeleteApnsVoipSandboxChannelOutput Uses

type DeleteApnsVoipSandboxChannelOutput struct {

    // Provides information about the status and settings of the APNs (Apple Push
    // Notification service) VoIP sandbox channel for an application.
    //
    // APNSVoipSandboxChannelResponse is a required field
    APNSVoipSandboxChannelResponse *APNSVoipSandboxChannelResponse `type:"structure" required:"true"`
    // contains filtered or unexported fields
}

func (DeleteApnsVoipSandboxChannelOutput) GoString Uses

func (s DeleteApnsVoipSandboxChannelOutput) GoString() string

GoString returns the string representation

func (*DeleteApnsVoipSandboxChannelOutput) SetAPNSVoipSandboxChannelResponse Uses

func (s *DeleteApnsVoipSandboxChannelOutput) SetAPNSVoipSandboxChannelResponse(v *APNSVoipSandboxChannelResponse) *DeleteApnsVoipSandboxChannelOutput

SetAPNSVoipSandboxChannelResponse sets the APNSVoipSandboxChannelResponse field's value.

func (DeleteApnsVoipSandboxChannelOutput) String Uses

func (s DeleteApnsVoipSandboxChannelOutput) String() string

String returns the string representation

type DeleteAppInput Uses

type DeleteAppInput struct {

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

func (DeleteAppInput) GoString Uses

func (s DeleteAppInput) GoString() string

GoString returns the string representation

func (*DeleteAppInput) SetApplicationId Uses

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

SetApplicationId sets the ApplicationId field's value.

func (DeleteAppInput) String Uses

func (s DeleteAppInput) String() string

String returns the string representation

func (*DeleteAppInput) Validate Uses

func (s *DeleteAppInput) Validate() error

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

type DeleteAppOutput Uses

type DeleteAppOutput struct {

    // Provides information about an application.
    //
    // ApplicationResponse is a required field
    ApplicationResponse *ApplicationResponse `type:"structure" required:"true"`
    // contains filtered or unexported fields
}

func (DeleteAppOutput) GoString Uses

func (s DeleteAppOutput) GoString() string

GoString returns the string representation

func (*DeleteAppOutput) SetApplicationResponse Uses

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

SetApplicationResponse sets the ApplicationResponse field's value.

func (DeleteAppOutput) String Uses

func (s DeleteAppOutput) String() string

String returns the string representation

type DeleteBaiduChannelInput Uses

type DeleteBaiduChannelInput struct {

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

func (DeleteBaiduChannelInput) GoString Uses

func (s DeleteBaiduChannelInput) GoString() string

GoString returns the string representation

func (*DeleteBaiduChannelInput) SetApplicationId Uses

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

SetApplicationId sets the ApplicationId field's value.

func (DeleteBaiduChannelInput) String Uses

func (s DeleteBaiduChannelInput) String() string

String returns the string representation

func (*DeleteBaiduChannelInput) Validate Uses

func (s *DeleteBaiduChannelInput) Validate() error

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

type DeleteBaiduChannelOutput Uses

type DeleteBaiduChannelOutput struct {

    // Provides information about the status and settings of the Baidu (Baidu Cloud
    // Push) channel for an application.
    //
    // BaiduChannelResponse is a required field
    BaiduChannelResponse *BaiduChannelResponse `type:"structure" required:"true"`
    // contains filtered or unexported fields
}

func (DeleteBaiduChannelOutput) GoString Uses

func (s DeleteBaiduChannelOutput) GoString() string

GoString returns the string representation

func (*DeleteBaiduChannelOutput) SetBaiduChannelResponse Uses

func (s *DeleteBaiduChannelOutput) SetBaiduChannelResponse(v *BaiduChannelResponse) *DeleteBaiduChannelOutput

SetBaiduChannelResponse sets the BaiduChannelResponse field's value.

func (DeleteBaiduChannelOutput) String Uses

func (s DeleteBaiduChannelOutput) String() string

String returns the string representation

type DeleteCampaignInput Uses

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 Uses

func (s DeleteCampaignInput) GoString() string

GoString returns the string representation

func (*DeleteCampaignInput) SetApplicationId Uses

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

SetApplicationId sets the ApplicationId field's value.

func (*DeleteCampaignInput) SetCampaignId Uses

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

SetCampaignId sets the CampaignId field's value.

func (DeleteCampaignInput) String Uses

func (s DeleteCampaignInput) String() string

String returns the string representation

func (*DeleteCampaignInput) Validate Uses

func (s *DeleteCampaignInput) Validate() error

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

type DeleteCampaignOutput Uses

type DeleteCampaignOutput struct {

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

func (DeleteCampaignOutput) GoString Uses

func (s DeleteCampaignOutput) GoString() string

GoString returns the string representation

func (*DeleteCampaignOutput) SetCampaignResponse Uses

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

SetCampaignResponse sets the CampaignResponse field's value.

func (DeleteCampaignOutput) String Uses

func (s DeleteCampaignOutput) String() string

String returns the string representation

type DeleteEmailChannelInput Uses

type DeleteEmailChannelInput struct {

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

func (DeleteEmailChannelInput) GoString Uses

func (s DeleteEmailChannelInput) GoString() string

GoString returns the string representation

func (*DeleteEmailChannelInput) SetApplicationId Uses

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

SetApplicationId sets the ApplicationId field's value.

func (DeleteEmailChannelInput) String Uses

func (s DeleteEmailChannelInput) String() string

String returns the string representation

func (*DeleteEmailChannelInput) Validate Uses

func (s *DeleteEmailChannelInput) Validate() error

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

type DeleteEmailChannelOutput Uses

type DeleteEmailChannelOutput struct {

    // Provides information about the status and settings of the email channel for
    // an application.
    //
    // EmailChannelResponse is a required field
    EmailChannelResponse *EmailChannelResponse `type:"structure" required:"true"`
    // contains filtered or unexported fields
}

func (DeleteEmailChannelOutput) GoString Uses

func (s DeleteEmailChannelOutput) GoString() string

GoString returns the string representation

func (*DeleteEmailChannelOutput) SetEmailChannelResponse Uses

func (s *DeleteEmailChannelOutput) SetEmailChannelResponse(v *EmailChannelResponse) *DeleteEmailChannelOutput

SetEmailChannelResponse sets the EmailChannelResponse field's value.

func (DeleteEmailChannelOutput) String Uses

func (s DeleteEmailChannelOutput) String() string

String returns the string representation

type DeleteEndpointInput Uses

type DeleteEndpointInput struct {

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

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

func (DeleteEndpointInput) GoString Uses

func (s DeleteEndpointInput) GoString() string

GoString returns the string representation

func (*DeleteEndpointInput) SetApplicationId Uses

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

SetApplicationId sets the ApplicationId field's value.

func (*DeleteEndpointInput) SetEndpointId Uses

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

SetEndpointId sets the EndpointId field's value.

func (DeleteEndpointInput) String Uses

func (s DeleteEndpointInput) String() string

String returns the string representation

func (*DeleteEndpointInput) Validate Uses

func (s *DeleteEndpointInput) Validate() error

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

type DeleteEndpointOutput Uses

type DeleteEndpointOutput struct {

    // Provides information about the channel type and other settings for an endpoint.
    //
    // EndpointResponse is a required field
    EndpointResponse *EndpointResponse `type:"structure" required:"true"`
    // contains filtered or unexported fields
}

func (DeleteEndpointOutput) GoString Uses

func (s DeleteEndpointOutput) GoString() string

GoString returns the string representation

func (*DeleteEndpointOutput) SetEndpointResponse Uses

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

SetEndpointResponse sets the EndpointResponse field's value.

func (DeleteEndpointOutput) String Uses

func (s DeleteEndpointOutput) String() string

String returns the string representation

type DeleteEventStreamInput Uses

type DeleteEventStreamInput struct {

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

func (DeleteEventStreamInput) GoString Uses

func (s DeleteEventStreamInput) GoString() string

GoString returns the string representation

func (*DeleteEventStreamInput) SetApplicationId Uses

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

SetApplicationId sets the ApplicationId field's value.

func (DeleteEventStreamInput) String Uses

func (s DeleteEventStreamInput) String() string

String returns the string representation

func (*DeleteEventStreamInput) Validate Uses

func (s *DeleteEventStreamInput) Validate() error

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

type DeleteEventStreamOutput Uses

type DeleteEventStreamOutput struct {

    // Specifies settings for publishing event data to an Amazon Kinesis data stream
    // or an Amazon Kinesis Data Firehose delivery stream.
    //
    // EventStream is a required field
    EventStream *EventStream `type:"structure" required:"true"`
    // contains filtered or unexported fields
}

func (DeleteEventStreamOutput) GoString Uses

func (s DeleteEventStreamOutput) GoString() string

GoString returns the string representation

func (*DeleteEventStreamOutput) SetEventStream Uses

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

SetEventStream sets the EventStream field's value.

func (DeleteEventStreamOutput) String Uses

func (s DeleteEventStreamOutput) String() string

String returns the string representation

type DeleteGcmChannelInput Uses

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 Uses

func (s DeleteGcmChannelInput) GoString() string

GoString returns the string representation

func (*DeleteGcmChannelInput) SetApplicationId Uses

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

SetApplicationId sets the ApplicationId field's value.

func (DeleteGcmChannelInput) String Uses

func (s DeleteGcmChannelInput) String() string

String returns the string representation

func (*DeleteGcmChannelInput) Validate Uses

func (s *DeleteGcmChannelInput) Validate() error

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

type DeleteGcmChannelOutput Uses

type DeleteGcmChannelOutput struct {

    // Provides information about the status and settings of the GCM channel for
    // an application. The GCM channel enables Amazon Pinpoint to send push notifications
    // through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging
    // (GCM), service.
    //
    // GCMChannelResponse is a required field
    GCMChannelResponse *GCMChannelResponse `type:"structure" required:"true"`
    // contains filtered or unexported fields
}

func (DeleteGcmChannelOutput) GoString Uses

func (s DeleteGcmChannelOutput) GoString() string

GoString returns the string representation

func (*DeleteGcmChannelOutput) SetGCMChannelResponse Uses

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

SetGCMChannelResponse sets the GCMChannelResponse field's value.

func (DeleteGcmChannelOutput) String Uses

func (s DeleteGcmChannelOutput) String() string

String returns the string representation

type DeleteSegmentInput Uses

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 Uses

func (s DeleteSegmentInput) GoString() string

GoString returns the string representation

func (*DeleteSegmentInput) SetApplicationId Uses

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

SetApplicationId sets the ApplicationId field's value.

func (*DeleteSegmentInput) SetSegmentId Uses

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

SetSegmentId sets the SegmentId field's value.

func (DeleteSegmentInput) String Uses

func (s DeleteSegmentInput) String() string

String returns the string representation

func (*DeleteSegmentInput) Validate Uses

func (s *DeleteSegmentInput) Validate() error

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

type DeleteSegmentOutput Uses

type DeleteSegmentOutput struct {

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

func (DeleteSegmentOutput) GoString Uses

func (s DeleteSegmentOutput) GoString() string

GoString returns the string representation

func (*DeleteSegmentOutput) SetSegmentResponse Uses

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

SetSegmentResponse sets the SegmentResponse field's value.

func (DeleteSegmentOutput) String Uses

func (s DeleteSegmentOutput) String() string

String returns the string representation

type DeleteSmsChannelInput Uses

type DeleteSmsChannelInput struct {

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

func (DeleteSmsChannelInput) GoString Uses

func (s DeleteSmsChannelInput) GoString() string

GoString returns the string representation

func (*DeleteSmsChannelInput) SetApplicationId Uses

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

SetApplicationId sets the ApplicationId field's value.

func (DeleteSmsChannelInput) String Uses

func (s DeleteSmsChannelInput) String() string

String returns the string representation

func (*DeleteSmsChannelInput) Validate Uses

func (s *DeleteSmsChannelInput) Validate() error

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

type DeleteSmsChannelOutput Uses

type DeleteSmsChannelOutput struct {

    // Provides information about the status and settings of the SMS channel for
    // an application.
    //
    // SMSChannelResponse is a required field
    SMSChannelResponse *SMSChannelResponse `type:"structure" required:"true"`
    // contains filtered or unexported fields
}

func (DeleteSmsChannelOutput) GoString Uses

func (s DeleteSmsChannelOutput) GoString() string

GoString returns the string representation

func (*DeleteSmsChannelOutput) SetSMSChannelResponse Uses

func (s *DeleteSmsChannelOutput) SetSMSChannelResponse(v *SMSChannelResponse) *DeleteSmsChannelOutput

SetSMSChannelResponse sets the SMSChannelResponse field's value.

func (DeleteSmsChannelOutput) String Uses

func (s DeleteSmsChannelOutput) String() string

String returns the string representation

type DeleteUserEndpointsInput Uses

type DeleteUserEndpointsInput struct {

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

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

func (DeleteUserEndpointsInput) GoString Uses

func (s DeleteUserEndpointsInput) GoString() string

GoString returns the string representation

func (*DeleteUserEndpointsInput) SetApplicationId Uses

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

SetApplicationId sets the ApplicationId field's value.

func (*DeleteUserEndpointsInput) SetUserId Uses

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

SetUserId sets the UserId field's value.

func (DeleteUserEndpointsInput) String Uses

func (s DeleteUserEndpointsInput) String() string

String returns the string representation

func (*DeleteUserEndpointsInput) Validate Uses

func (s *DeleteUserEndpointsInput) Validate() error

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

type DeleteUserEndpointsOutput Uses

type DeleteUserEndpointsOutput struct {

    // Provides information about all the endpoints that are associated with a user
    // ID.
    //
    // EndpointsResponse is a required field
    EndpointsResponse *EndpointsResponse `type:"structure" required:"true"`
    // contains filtered or unexported fields
}

func (DeleteUserEndpointsOutput) GoString Uses

func (s DeleteUserEndpointsOutput) GoString() string

GoString returns the string representation

func (*DeleteUserEndpointsOutput) SetEndpointsResponse Uses

func (s *DeleteUserEndpointsOutput) SetEndpointsResponse(v *EndpointsResponse) *DeleteUserEndpointsOutput

SetEndpointsResponse sets the EndpointsResponse field's value.

func (DeleteUserEndpointsOutput) String Uses

func (s DeleteUserEndpointsOutput) String() string

String returns the string representation

type DeleteVoiceChannelInput Uses

type DeleteVoiceChannelInput struct {

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

func (DeleteVoiceChannelInput) GoString Uses

func (s DeleteVoiceChannelInput) GoString() string

GoString returns the string representation

func (*DeleteVoiceChannelInput) SetApplicationId Uses

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

SetApplicationId sets the ApplicationId field's value.

func (DeleteVoiceChannelInput) String Uses

func (s DeleteVoiceChannelInput) String() string

String returns the string representation

func (*DeleteVoiceChannelInput) Validate Uses

func (s *DeleteVoiceChannelInput) Validate() error

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

type DeleteVoiceChannelOutput Uses

type DeleteVoiceChannelOutput struct {

    // Provides information about the status and settings of the voice channel for
    // an application.
    //
    // VoiceChannelResponse is a required field
    VoiceChannelResponse *VoiceChannelResponse `type:"structure" required:"true"`
    // contains filtered or unexported fields
}

func (DeleteVoiceChannelOutput) GoString Uses

func (s DeleteVoiceChannelOutput) GoString() string

GoString returns the string representation

func (*DeleteVoiceChannelOutput) SetVoiceChannelResponse Uses

func (s *DeleteVoiceChannelOutput) SetVoiceChannelResponse(v *VoiceChannelResponse) *DeleteVoiceChannelOutput

SetVoiceChannelResponse sets the VoiceChannelResponse field's value.

func (DeleteVoiceChannelOutput) String Uses

func (s DeleteVoiceChannelOutput) String() string

String returns the string representation

type DirectMessageConfiguration Uses

type DirectMessageConfiguration struct {

    // The default push notification message for the ADM (Amazon Device Messaging)
    // channel. This message overrides the default push notification message (DefaultPushNotificationMessage).
    ADMMessage *ADMMessage `type:"structure"`

    // The default push notification message for the APNs (Apple Push Notification
    // service) channel. This message overrides the default push notification message
    // (DefaultPushNotificationMessage).
    APNSMessage *APNSMessage `type:"structure"`

    // The default push notification message for the Baidu (Baidu Cloud Push) channel.
    // This message overrides the default push notification message (DefaultPushNotificationMessage).
    BaiduMessage *BaiduMessage `type:"structure"`

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

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

    // The default message for the email channel. This message overrides the default
    // message (DefaultMessage).
    EmailMessage *EmailMessage `type:"structure"`

    // The default push notification message for the GCM channel, which is used
    // to send notifications through the Firebase Cloud Messaging (FCM), formerly
    // Google Cloud Messaging (GCM), service. This message overrides the default
    // push notification message (DefaultPushNotificationMessage).
    GCMMessage *GCMMessage `type:"structure"`

    // The default message for the SMS channel. This message overrides the default
    // message (DefaultMessage).
    SMSMessage *SMSMessage `type:"structure"`

    // The default message for the voice channel. This message overrides the default
    // message (DefaultMessage).
    VoiceMessage *VoiceMessage `type:"structure"`
    // contains filtered or unexported fields
}

Specifies the settings and content for the default message and any default messages that you tailored for specific channels.

func (DirectMessageConfiguration) GoString Uses

func (s DirectMessageConfiguration) GoString() string

GoString returns the string representation

func (*DirectMessageConfiguration) SetADMMessage Uses

func (s *DirectMessageConfiguration) SetADMMessage(v *ADMMessage) *DirectMessageConfiguration

SetADMMessage sets the ADMMessage field's value.

func (*DirectMessageConfiguration) SetAPNSMessage Uses

func (s *DirectMessageConfiguration) SetAPNSMessage(v *APNSMessage) *DirectMessageConfiguration

SetAPNSMessage sets the APNSMessage field's value.

func (*DirectMessageConfiguration) SetBaiduMessage Uses

func (s *DirectMessageConfiguration) SetBaiduMessage(v *BaiduMessage) *DirectMessageConfiguration

SetBaiduMessage sets the BaiduMessage field's value.

func (*DirectMessageConfiguration) SetDefaultMessage Uses

func (s *DirectMessageConfiguration) SetDefaultMessage(v *DefaultMessage) *DirectMessageConfiguration

SetDefaultMessage sets the DefaultMessage field's value.

func (*DirectMessageConfiguration) SetDefaultPushNotificationMessage Uses

func (s *DirectMessageConfiguration) SetDefaultPushNotificationMessage(v *DefaultPushNotificationMessage) *DirectMessageConfiguration

SetDefaultPushNotificationMessage sets the DefaultPushNotificationMessage field's value.

func (*DirectMessageConfiguration) SetEmailMessage Uses

func (s *DirectMessageConfiguration) SetEmailMessage(v *EmailMessage) *DirectMessageConfiguration

SetEmailMessage sets the EmailMessage field's value.

func (*DirectMessageConfiguration) SetGCMMessage Uses

func (s *DirectMessageConfiguration) SetGCMMessage(v *GCMMessage) *DirectMessageConfiguration

SetGCMMessage sets the GCMMessage field's value.

func (*DirectMessageConfiguration) SetSMSMessage Uses

func (s *DirectMessageConfiguration) SetSMSMessage(v *SMSMessage) *DirectMessageConfiguration

SetSMSMessage sets the SMSMessage field's value.

func (*DirectMessageConfiguration) SetVoiceMessage Uses

func (s *DirectMessageConfiguration) SetVoiceMessage(v *VoiceMessage) *DirectMessageConfiguration

SetVoiceMessage sets the VoiceMessage field's value.

func (DirectMessageConfiguration) String Uses

func (s DirectMessageConfiguration) String() string

String returns the string representation

type EmailChannelRequest Uses

type EmailChannelRequest struct {

    // The configuration set that you want to apply to email that you send through
    // the channel by using the Amazon Pinpoint Email API (emailAPIreference.html).
    ConfigurationSet *string `type:"string"`

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

    // The verified email address that you want to send email from when you send
    // email through the channel.
    //
    // FromAddress is a required field
    FromAddress *string `type:"string" required:"true"`

    // The Amazon Resource Name (ARN) of the identity, verified with Amazon Simple
    // Email Service (Amazon SES), that you want to use when you send email through
    // the channel.
    //
    // Identity is a required field
    Identity *string `type:"string" required:"true"`

    // The ARN of the AWS Identity and Access Management (IAM) role that you want
    // Amazon Pinpoint to use when it submits email-related event data for the channel.
    RoleArn *string `type:"string"`
    // contains filtered or unexported fields
}

Specifies the status and settings of the email channel for an application.

func (EmailChannelRequest) GoString Uses

func (s EmailChannelRequest) GoString() string

GoString returns the string representation

func (*EmailChannelRequest) SetConfigurationSet Uses

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

SetConfigurationSet sets the ConfigurationSet field's value.

func (*EmailChannelRequest) SetEnabled Uses

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

SetEnabled sets the Enabled field's value.

func (*EmailChannelRequest) SetFromAddress Uses

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

SetFromAddress sets the FromAddress field's value.

func (*EmailChannelRequest) SetIdentity Uses

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

SetIdentity sets the Identity field's value.

func (*EmailChannelRequest) SetRoleArn Uses

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

SetRoleArn sets the RoleArn field's value.

func (EmailChannelRequest) String Uses

func (s EmailChannelRequest) String() string

String returns the string representation

func (*EmailChannelRequest) Validate Uses

func (s *EmailChannelRequest) Validate() error

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

type EmailChannelResponse Uses

type EmailChannelResponse struct {

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

    // The configuration set that's applied to email that's sent through the channel
    // by using the Amazon Pinpoint Email API (emailAPIreference.html).
    ConfigurationSet *string `type:"string"`

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

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

    // The verified email address that you send email from when you send email through
    // the channel.
    FromAddress *string `type:"string"`

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

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

    // The Amazon Resource Name (ARN) of the identity, verified with Amazon Simple
    // Email Service (Amazon SES), that you use when you send email through the
    // channel.
    Identity *string `type:"string"`

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

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

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

    // The maximum number of emails that you can send through the channel each second.
    MessagesPerSecond *int64 `type:"integer"`

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

    // The ARN of the AWS Identity and Access Management (IAM) role that Amazon
    // Pinpoint uses to submit email-related event data for the channel.
    RoleArn *string `type:"string"`

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

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

func (EmailChannelResponse) GoString Uses

func (s EmailChannelResponse) GoString() string

GoString returns the string representation

func (*EmailChannelResponse) SetApplicationId Uses

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

SetApplicationId sets the ApplicationId field's value.

func (*EmailChannelResponse) SetConfigurationSet Uses

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

SetConfigurationSet sets the ConfigurationSet field's value.

func (*EmailChannelResponse) SetCreationDate Uses

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

SetCreationDate sets the CreationDate field's value.

func (*EmailChannelResponse) SetEnabled Uses

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

SetEnabled sets the Enabled field's value.

func (*EmailChannelResponse) SetFromAddress Uses

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

SetFromAddress sets the FromAddress field's value.

func (*EmailChannelResponse) SetHasCredential Uses

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

SetHasCredential sets the HasCredential field's value.

func (*EmailChannelResponse) SetId Uses

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

SetId sets the Id field's value.

func (*EmailChannelResponse) SetIdentity Uses

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

SetIdentity sets the Identity field's value.

func (*EmailChannelResponse) SetIsArchived Uses

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

SetIsArchived sets the IsArchived field's value.

func (*EmailChannelResponse) SetLastModifiedBy Uses

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

SetLastModifiedBy sets the LastModifiedBy field's value.

func (*EmailChannelResponse) SetLastModifiedDate Uses

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

SetLastModifiedDate sets the LastModifiedDate field's value.

func (*EmailChannelResponse) SetMessagesPerSecond Uses

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

SetMessagesPerSecond sets the MessagesPerSecond field's value.

func (*EmailChannelResponse) SetPlatform Uses

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

SetPlatform sets the Platform field's value.

func (*EmailChannelResponse) SetRoleArn Uses

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

SetRoleArn sets the RoleArn field's value.

func (*EmailChannelResponse) SetVersion Uses

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

SetVersion sets the Version field's value.

func (EmailChannelResponse) String Uses

func (s EmailChannelResponse) String() string

String returns the string representation

type EmailMessage Uses

type EmailMessage struct {

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

    // The email address to forward bounces and complaints to, if feedback forwarding
    // is enabled.
    FeedbackForwardingAddress *string `type:"string"`

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

    // The email message, represented as a raw MIME message.
    RawEmail *RawEmail `type:"structure"`

    // The reply-to email address(es) for the email message. If a recipient replies
    // to the email, each reply-to address receives the reply.
    ReplyToAddresses []*string `type:"list"`

    // The email message, composed of a subject, a text part, and an HTML part.
    SimpleEmail *SimpleEmail `type:"structure"`

    // The default message variables to use in the email message. You can override
    // the default variables with individual address variables.
    Substitutions map[string][]*string `type:"map"`
    // contains filtered or unexported fields
}

Specifies the default settings and content for a one-time email message that's sent directly to an endpoint.

func (EmailMessage) GoString Uses

func (s EmailMessage) GoString() string

GoString returns the string representation

func (*EmailMessage) SetBody Uses

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

SetBody sets the Body field's value.

func (*EmailMessage) SetFeedbackForwardingAddress Uses

func (s *EmailMessage) SetFeedbackForwardingAddress(v string) *EmailMessage

SetFeedbackForwardingAddress sets the FeedbackForwardingAddress field's value.

func (*EmailMessage) SetFromAddress Uses

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

SetFromAddress sets the FromAddress field's value.

func (*EmailMessage) SetRawEmail Uses

func (s *EmailMessage) SetRawEmail(v *RawEmail) *EmailMessage

SetRawEmail sets the RawEmail field's value.

func (*EmailMessage) SetReplyToAddresses Uses

func (s *EmailMessage) SetReplyToAddresses(v []*string) *EmailMessage

SetReplyToAddresses sets the ReplyToAddresses field's value.

func (*EmailMessage) SetSimpleEmail Uses

func (s *EmailMessage) SetSimpleEmail(v *SimpleEmail) *EmailMessage

SetSimpleEmail sets the SimpleEmail field's value.

func (*EmailMessage) SetSubstitutions Uses

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

SetSubstitutions sets the Substitutions field's value.

func (EmailMessage) String Uses

func (s EmailMessage) String() string

String returns the string representation

type EndpointBatchItem Uses

type EndpointBatchItem struct {

    // The destination address for messages or push notifications that you send
    // to the endpoint. The address varies by channel. For a push-notification channel,
    // use the token provided by the push notification service, such as an Apple
    // Push Notification service (APNs) device token or a Firebase Cloud Messaging
    // (FCM) registration token. For the SMS channel, use a phone number in E.164
    // format, such as +12065550100. For the email channel, use an email address.
    Address *string `type:"string"`

    // One or more custom attributes that describe the endpoint by associating a
    // name with an array of values. For example, the value of a custom attribute
    // named Interests might be: ["science", "music", "travel"]. You can use these
    // attributes as filter criteria when you create segments.
    //
    // When you define the name of a custom attribute, avoid using the following
    // characters: number sign (#), colon (:), question mark (?), backslash (\),
    // and slash (/). The Amazon Pinpoint console can't display attribute names
    // that contain these characters. This limitation doesn't apply to attribute
    // values.
    Attributes map[string][]*string `type:"map"`

    // The channel to use when sending messages or push notifications to the endpoint.
    ChannelType *string `type:"string" enum:"ChannelType"`

    // The demographic information for the endpoint, such as the time zone and platform.
    Demographic *EndpointDemographic `type:"structure"`

    // The date and time, in ISO 8601 format, when the endpoint was created or updated.
    EffectiveDate *string `type:"string"`

    // Not used.
    EndpointStatus *string `type:"string"`

    // The unique identifier for the endpoint in the context of the batch.
    Id  *string `type:"string"`

    // The geographic information for the endpoint.
    Location *EndpointLocation `type:"structure"`

    // One or more custom metrics that your app reports to Amazon Pinpoint for the
    // endpoint.
    Metrics map[string]*float64 `type:"map"`

    // Specifies whether the user who's associated with the endpoint has opted out
    // of receiving messages and push notifications from you. Possible values are:
    // ALL, the user has opted out and doesn't want to receive any messages or push
    // notifications; and, NONE, the user hasn't opted out and wants to receive
    // all messages and push notifications.
    OptOut *string `type:"string"`

    // The unique identifier for the request to create or update the endpoint.
    RequestId *string `type:"string"`

    // One or more custom user attributes that your app reports to Amazon Pinpoint
    // for the user who's associated with the endpoint.
    User *EndpointUser `type:"structure"`
    // contains filtered or unexported fields
}

Specifies an endpoint to create or update and the settings and attributes to set or change for the endpoint.

func (EndpointBatchItem) GoString Uses

func (s EndpointBatchItem) GoString() string

GoString returns the string representation

func (*EndpointBatchItem) SetAddress Uses

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

SetAddress sets the Address field's value.

func (*EndpointBatchItem) SetAttributes Uses

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

SetAttributes sets the Attributes field's value.

func (*EndpointBatchItem) SetChannelType Uses

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

SetChannelType sets the ChannelType field's value.

func (*EndpointBatchItem) SetDemographic Uses

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

SetDemographic sets the Demographic field's value.

func (*EndpointBatchItem) SetEffectiveDate Uses

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

SetEffectiveDate sets the EffectiveDate field's value.

func (*EndpointBatchItem) SetEndpointStatus Uses

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

SetEndpointStatus sets the EndpointStatus field's value.

func (*EndpointBatchItem) SetId Uses

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

SetId sets the Id field's value.

func (*EndpointBatchItem) SetLocation Uses

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

SetLocation sets the Location field's value.

func (*EndpointBatchItem) SetMetrics Uses

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

SetMetrics sets the Metrics field's value.

func (*EndpointBatchItem) SetOptOut Uses

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

SetOptOut sets the OptOut field's value.

func (*EndpointBatchItem) SetRequestId Uses

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

SetRequestId sets the RequestId field's value.

func (*EndpointBatchItem) SetUser Uses

func (s *EndpointBatchItem) SetUser(v *EndpointUser) *EndpointBatchItem

SetUser sets the User field's value.

func (EndpointBatchItem) String Uses

func (s EndpointBatchItem) String() string

String returns the string representation

type EndpointBatchRequest Uses

type EndpointBatchRequest struct {

    // An array that defines the endpoints to create or update and, for each endpoint,
    // the property values to set or change. An array can contain a maximum of 100
    // items.
    //
    // Item is a required field
    Item []*EndpointBatchItem `type:"list" required:"true"`
    // contains filtered or unexported fields
}

Specifies a batch of endpoints to create or update and the settings and attributes to set or change for each endpoint.

func (EndpointBatchRequest) GoString Uses

func (s EndpointBatchRequest) GoString() string

GoString returns the string representation

func (*EndpointBatchRequest) SetItem Uses

func (s *EndpointBatchRequest) SetItem(v []*EndpointBatchItem) *EndpointBatchRequest

SetItem sets the Item field's value.

func (EndpointBatchRequest) String Uses

func (s EndpointBatchRequest) String() string

String returns the string representation

func (*EndpointBatchRequest) Validate Uses

func (s *EndpointBatchRequest) Validate() error

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

type EndpointDemographic Uses

type EndpointDemographic struct {

    // The version of the app that's associated with the endpoint.
    AppVersion *string `type:"string"`

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

    // The manufacturer of the endpoint device, such as Apple or Samsung.
    Make *string `type:"string"`

    // The model name or number of the endpoint device, such as iPhone.
    Model *string `type:"string"`

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

    // The platform of the endpoint device, such as iOS or Android.
    Platform *string `type:"string"`

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

    // The time zone of the endpoint, specified as a tz database name value, such
    // as America/Los_Angeles.
    Timezone *string `type:"string"`
    // contains filtered or unexported fields
}

Specifies demographic information about an endpoint, such as the applicable time zone and platform.

func (EndpointDemographic) GoString Uses

func (s EndpointDemographic) GoString() string

GoString returns the string representation

func (*EndpointDemographic) SetAppVersion Uses

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

SetAppVersion sets the AppVersion field's value.

func (*EndpointDemographic) SetLocale Uses

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

SetLocale sets the Locale field's value.

func (*EndpointDemographic) SetMake Uses

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

SetMake sets the Make field's value.

func (*EndpointDemographic) SetModel Uses

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

SetModel sets the Model field's value.

func (*EndpointDemographic) SetModelVersion Uses

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

SetModelVersion sets the ModelVersion field's value.

func (*EndpointDemographic) SetPlatform Uses

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

SetPlatform sets the Platform field's value.

func (*EndpointDemographic) SetPlatformVersion Uses

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

SetPlatformVersion sets the PlatformVersion field's value.

func (*EndpointDemographic) SetTimezone Uses

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

SetTimezone sets the Timezone field's value.

func (EndpointDemographic) String Uses

func (s EndpointDemographic) String() string

String returns the string representation

type EndpointItemResponse Uses

type EndpointItemResponse struct {

    // The custom message that's returned in the response as a result of processing
    // the endpoint data.
    Message *string `type:"string"`

    // The status code that's returned in the response as a result of processing
    // the endpoint data.
    StatusCode *int64 `type:"integer"`
    // contains filtered or unexported fields
}

Provides the status code and message that result from processing data for an endpoint.

func (EndpointItemResponse) GoString Uses

func (s EndpointItemResponse) GoString() string

GoString returns the string representation

func (*EndpointItemResponse) SetMessage Uses