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

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

    // AlignmentRight is a Alignment enum value
    AlignmentRight = "RIGHT"
)

const (
    // AttributeTypeInclusive is a AttributeType enum value
    AttributeTypeInclusive = "INCLUSIVE"

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

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

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

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

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

    // AttributeTypeOn is a AttributeType enum value
    AttributeTypeOn = "ON"
)

const (
    // ButtonActionLink is a ButtonAction enum value
    ButtonActionLink = "LINK"

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

    // ButtonActionClose is a ButtonAction enum value
    ButtonActionClose = "CLOSE"
)

const (
    // CampaignStatusScheduled is a CampaignStatus enum value
    CampaignStatusScheduled = "SCHEDULED"

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

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

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

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

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

    // CampaignStatusInvalid is a CampaignStatus enum value
    CampaignStatusInvalid = "INVALID"
)

const (
    // ChannelTypePush is a ChannelType enum value
    ChannelTypePush = "PUSH"

    // ChannelTypeGcm is a ChannelType enum value
    ChannelTypeGcm = "GCM"

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

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

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

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

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

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

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

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

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

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

    // ChannelTypeInApp is a ChannelType enum value
    ChannelTypeInApp = "IN_APP"
)

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

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

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

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

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

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

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

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

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

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

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

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

    // EndpointTypesElementInApp is a EndpointTypesElement enum value
    EndpointTypesElementInApp = "IN_APP"
)

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"

    // FrequencyInAppEvent is a Frequency enum value
    FrequencyInAppEvent = "IN_APP_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"

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

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

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

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

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

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

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

    // JobStatusFailed is a JobStatus enum value
    JobStatusFailed = "FAILED"
)

const (
    // LayoutBottomBanner is a Layout enum value
    LayoutBottomBanner = "BOTTOM_BANNER"

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

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

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

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

    // LayoutCarousel is a Layout enum value
    LayoutCarousel = "CAROUSEL"
)

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

    // OperatorAny is a Operator enum value
    OperatorAny = "ANY"
)

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 (
    // StateDraft is a State enum value
    StateDraft = "DRAFT"

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

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

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

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

    // StatePaused is a State enum value
    StatePaused = "PAUSED"
)

const (
    // TemplateTypeEmail is a TemplateType enum value
    TemplateTypeEmail = "EMAIL"

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

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

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

    // TemplateTypeInapp is a TemplateType enum value
    TemplateTypeInapp = "INAPP"
)

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"

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

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

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

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

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

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

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

const (
    ServiceName = "pinpoint"  // Name of service.
    EndpointsID = ServiceName // ID to lookup a service endpoint with.
    ServiceID   = "Pinpoint"  // ServiceID is a unique identifier of a specific service.
)

func Action_Values ¶

func Action_Values() []string

Action_Values returns all elements of the Action enum

func Alignment_Values ¶

func Alignment_Values() []string

Alignment_Values returns all elements of the Alignment enum

func AttributeType_Values ¶

func AttributeType_Values() []string

AttributeType_Values returns all elements of the AttributeType enum

func ButtonAction_Values ¶

func ButtonAction_Values() []string

ButtonAction_Values returns all elements of the ButtonAction enum

func CampaignStatus_Values ¶

func CampaignStatus_Values() []string

CampaignStatus_Values returns all elements of the CampaignStatus enum

func ChannelType_Values ¶

func ChannelType_Values() []string

ChannelType_Values returns all elements of the ChannelType enum

func DeliveryStatus_Values ¶

func DeliveryStatus_Values() []string

DeliveryStatus_Values returns all elements of the DeliveryStatus enum

func DimensionType_Values ¶

func DimensionType_Values() []string

DimensionType_Values returns all elements of the DimensionType enum

func Duration_Values ¶

func Duration_Values() []string

Duration_Values returns all elements of the Duration enum

func EndpointTypesElement_Values ¶

func EndpointTypesElement_Values() []string

EndpointTypesElement_Values returns all elements of the EndpointTypesElement enum

func FilterType_Values ¶

func FilterType_Values() []string

FilterType_Values returns all elements of the FilterType enum

func Format_Values ¶

func Format_Values() []string

Format_Values returns all elements of the Format enum

func Frequency_Values ¶

func Frequency_Values() []string

Frequency_Values returns all elements of the Frequency enum

func Include_Values ¶

func Include_Values() []string

Include_Values returns all elements of the Include enum

func JobStatus_Values ¶

func JobStatus_Values() []string

JobStatus_Values returns all elements of the JobStatus enum

func Layout_Values ¶

func Layout_Values() []string

Layout_Values returns all elements of the Layout enum

func MessageType_Values ¶

func MessageType_Values() []string

MessageType_Values returns all elements of the MessageType enum

func Mode_Values ¶

func Mode_Values() []string

Mode_Values returns all elements of the Mode enum

func Operator_Values ¶

func Operator_Values() []string

Operator_Values returns all elements of the Operator enum

func RecencyType_Values ¶

func RecencyType_Values() []string

RecencyType_Values returns all elements of the RecencyType enum

func SegmentType_Values ¶

func SegmentType_Values() []string

SegmentType_Values returns all elements of the SegmentType enum

func SourceType_Values ¶

func SourceType_Values() []string

SourceType_Values returns all elements of the SourceType enum

func State_Values ¶

func State_Values() []string

State_Values returns all elements of the State enum

func TemplateType_Values ¶

func TemplateType_Values() []string

TemplateType_Values returns all elements of the TemplateType enum

func Type_Values ¶

func Type_Values() []string

Type_Values returns all elements of the Type enum

type ADMChannelRequest ¶

type ADMChannelRequest struct {

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

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

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

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

func (ADMChannelRequest) GoString ¶

func (s ADMChannelRequest) GoString() string

GoString returns the string representation.

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

func (*ADMChannelRequest) SetClientId ¶

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

SetClientId sets the ClientId field's value.

func (*ADMChannelRequest) SetClientSecret ¶

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

SetClientSecret sets the ClientSecret field's value.

func (*ADMChannelRequest) SetEnabled ¶

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

SetEnabled sets the Enabled field's value.

func (ADMChannelRequest) String ¶

func (s ADMChannelRequest) String() string

String returns the string representation.

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

func (*ADMChannelRequest) Validate ¶

func (s *ADMChannelRequest) Validate() error

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

type ADMChannelResponse ¶

type ADMChannelResponse struct {

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

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

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

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

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

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

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

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

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

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

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

func (ADMChannelResponse) GoString ¶

func (s ADMChannelResponse) GoString() string

GoString returns the string representation.

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

func (*ADMChannelResponse) SetApplicationId ¶

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

SetApplicationId sets the ApplicationId field's value.

func (*ADMChannelResponse) SetCreationDate ¶

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

SetCreationDate sets the CreationDate field's value.

func (*ADMChannelResponse) SetEnabled ¶

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

SetEnabled sets the Enabled field's value.

func (*ADMChannelResponse) SetHasCredential ¶

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

SetHasCredential sets the HasCredential field's value.

func (*ADMChannelResponse) SetId ¶

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

SetId sets the Id field's value.

func (*ADMChannelResponse) SetIsArchived ¶

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

SetIsArchived sets the IsArchived field's value.

func (*ADMChannelResponse) SetLastModifiedBy ¶

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

SetLastModifiedBy sets the LastModifiedBy field's value.

func (*ADMChannelResponse) SetLastModifiedDate ¶

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

SetLastModifiedDate sets the LastModifiedDate field's value.

func (*ADMChannelResponse) SetPlatform ¶

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

SetPlatform sets the Platform field's value.

func (*ADMChannelResponse) SetVersion ¶

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

SetVersion sets the Version field's value.

func (ADMChannelResponse) String ¶

func (s ADMChannelResponse) String() string

String returns the string representation.

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

type ADMMessage ¶

type ADMMessage struct {

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

func (ADMMessage) GoString ¶

func (s ADMMessage) GoString() string

GoString returns the string representation.

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

func (*ADMMessage) SetAction ¶

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

SetAction sets the Action field's value.

func (*ADMMessage) SetBody ¶

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

SetBody sets the Body field's value.

func (*ADMMessage) SetConsolidationKey ¶

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

SetConsolidationKey sets the ConsolidationKey field's value.

func (*ADMMessage) SetData ¶

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

SetData sets the Data field's value.

func (*ADMMessage) SetExpiresAfter ¶

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

SetExpiresAfter sets the ExpiresAfter field's value.

func (*ADMMessage) SetIconReference ¶

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

SetIconReference sets the IconReference field's value.

func (*ADMMessage) SetImageIconUrl ¶

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

SetImageIconUrl sets the ImageIconUrl field's value.

func (*ADMMessage) SetImageUrl ¶

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

SetImageUrl sets the ImageUrl field's value.

func (*ADMMessage) SetMD5 ¶

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

SetMD5 sets the MD5 field's value.

func (*ADMMessage) SetRawContent ¶

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

SetRawContent sets the RawContent field's value.

func (*ADMMessage) SetSilentPush ¶

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

SetSilentPush sets the SilentPush field's value.

func (*ADMMessage) SetSmallImageIconUrl ¶

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

SetSmallImageIconUrl sets the SmallImageIconUrl field's value.

func (*ADMMessage) SetSound ¶

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

SetSound sets the Sound field's value.

func (*ADMMessage) SetSubstitutions ¶

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

SetSubstitutions sets the Substitutions field's value.

func (*ADMMessage) SetTitle ¶

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

SetTitle sets the Title field's value.

func (*ADMMessage) SetUrl ¶

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

SetUrl sets the Url field's value.

func (ADMMessage) String ¶

func (s ADMMessage) String() string

String returns the string representation.

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

type APNSChannelRequest ¶

type APNSChannelRequest struct {

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

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

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

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

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

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

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

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

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

func (APNSChannelRequest) GoString ¶

func (s APNSChannelRequest) GoString() string

GoString returns the string representation.

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

func (*APNSChannelRequest) SetBundleId ¶

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

SetBundleId sets the BundleId field's value.

func (*APNSChannelRequest) SetCertificate ¶

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

SetCertificate sets the Certificate field's value.

func (*APNSChannelRequest) SetDefaultAuthenticationMethod ¶

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

SetDefaultAuthenticationMethod sets the DefaultAuthenticationMethod field's value.

func (*APNSChannelRequest) SetEnabled ¶

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

SetEnabled sets the Enabled field's value.

func (*APNSChannelRequest) SetPrivateKey ¶

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

SetPrivateKey sets the PrivateKey field's value.

func (*APNSChannelRequest) SetTeamId ¶

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

SetTeamId sets the TeamId field's value.

func (*APNSChannelRequest) SetTokenKey ¶

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

SetTokenKey sets the TokenKey field's value.

func (*APNSChannelRequest) SetTokenKeyId ¶

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

SetTokenKeyId sets the TokenKeyId field's value.

func (APNSChannelRequest) String ¶

func (s APNSChannelRequest) String() string

String returns the string representation.

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

type APNSChannelResponse ¶

type APNSChannelResponse struct {

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

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

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

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

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

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

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

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

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

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

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

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

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

func (APNSChannelResponse) GoString ¶

func (s APNSChannelResponse) GoString() string

GoString returns the string representation.

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

func (*APNSChannelResponse) SetApplicationId ¶

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

SetApplicationId sets the ApplicationId field's value.

func (*APNSChannelResponse) SetCreationDate ¶

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

SetCreationDate sets the CreationDate field's value.

func (*APNSChannelResponse) SetDefaultAuthenticationMethod ¶

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

SetDefaultAuthenticationMethod sets the DefaultAuthenticationMethod field's value.

func (*APNSChannelResponse) SetEnabled ¶

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

SetEnabled sets the Enabled field's value.

func (*APNSChannelResponse) SetHasCredential ¶

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

SetHasCredential sets the HasCredential field's value.

func (*APNSChannelResponse) SetHasTokenKey ¶

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

SetHasTokenKey sets the HasTokenKey field's value.

func (*APNSChannelResponse) SetId ¶

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

SetId sets the Id field's value.

func (*APNSChannelResponse) SetIsArchived ¶

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

SetIsArchived sets the IsArchived field's value.

func (*APNSChannelResponse) SetLastModifiedBy ¶

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

SetLastModifiedBy sets the LastModifiedBy field's value.

func (*APNSChannelResponse) SetLastModifiedDate ¶

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

SetLastModifiedDate sets the LastModifiedDate field's value.

func (*APNSChannelResponse) SetPlatform ¶

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

SetPlatform sets the Platform field's value.

func (*APNSChannelResponse) SetVersion ¶

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

SetVersion sets the Version field's value.

func (APNSChannelResponse) String ¶

func (s APNSChannelResponse) String() string

String returns the string representation.

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

type APNSMessage ¶

type APNSMessage struct {

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

func (APNSMessage) GoString ¶

func (s APNSMessage) GoString() string

GoString returns the string representation.

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

func (*APNSMessage) SetAPNSPushType ¶

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

SetAPNSPushType sets the APNSPushType field's value.

func (*APNSMessage) SetAction ¶

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

SetAction sets the Action field's value.

func (*APNSMessage) SetBadge ¶

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

SetBadge sets the Badge field's value.

func (*APNSMessage) SetBody ¶

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

SetBody sets the Body field's value.

func (*APNSMessage) SetCategory ¶

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

SetCategory sets the Category field's value.

func (*APNSMessage) SetCollapseId ¶

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

SetCollapseId sets the CollapseId field's value.

func (*APNSMessage) SetData ¶

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

SetData sets the Data field's value.

func (*APNSMessage) SetMediaUrl ¶

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

SetMediaUrl sets the MediaUrl field's value.

func (*APNSMessage) SetPreferredAuthenticationMethod ¶

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

SetPreferredAuthenticationMethod sets the PreferredAuthenticationMethod field's value.

func (*APNSMessage) SetPriority ¶

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

SetPriority sets the Priority field's value.

func (*APNSMessage) SetRawContent ¶

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

SetRawContent sets the RawContent field's value.

func (*APNSMessage) SetSilentPush ¶

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

SetSilentPush sets the SilentPush field's value.

func (*APNSMessage) SetSound ¶

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

SetSound sets the Sound field's value.

func (*APNSMessage) SetSubstitutions ¶

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

SetSubstitutions sets the Substitutions field's value.

func (*APNSMessage) SetThreadId ¶

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

SetThreadId sets the ThreadId field's value.

func (*APNSMessage) SetTimeToLive ¶

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

SetTimeToLive sets the TimeToLive field's value.

func (*APNSMessage) SetTitle ¶

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

SetTitle sets the Title field's value.

func (*APNSMessage) SetUrl ¶

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

SetUrl sets the Url field's value.

func (APNSMessage) String ¶

func (s APNSMessage) String() string

String returns the string representation.

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

type APNSPushNotificationTemplate ¶

type APNSPushNotificationTemplate struct {

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

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

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

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

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

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

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

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

func (APNSPushNotificationTemplate) GoString ¶

func (s APNSPushNotificationTemplate) GoString() string

GoString returns the string representation.

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

func (*APNSPushNotificationTemplate) SetAction ¶

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

SetAction sets the Action field's value.

func (*APNSPushNotificationTemplate) SetBody ¶

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

SetBody sets the Body field's value.

func (*APNSPushNotificationTemplate) SetMediaUrl ¶

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

SetMediaUrl sets the MediaUrl field's value.

func (*APNSPushNotificationTemplate) SetRawContent ¶

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

SetRawContent sets the RawContent field's value.

func (*APNSPushNotificationTemplate) SetSound ¶

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

SetSound sets the Sound field's value.

func (*APNSPushNotificationTemplate) SetTitle ¶

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

SetTitle sets the Title field's value.

func (*APNSPushNotificationTemplate) SetUrl ¶

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

SetUrl sets the Url field's value.

func (APNSPushNotificationTemplate) String ¶

func (s APNSPushNotificationTemplate) String() string

String returns the string representation.

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

type APNSSandboxChannelRequest ¶

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 ¶

func (s APNSSandboxChannelRequest) GoString() string

GoString returns the string representation.

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

func (*APNSSandboxChannelRequest) SetBundleId ¶

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

SetBundleId sets the BundleId field's value.

func (*APNSSandboxChannelRequest) SetCertificate ¶

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

SetCertificate sets the Certificate field's value.

func (*APNSSandboxChannelRequest) SetDefaultAuthenticationMethod ¶

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

SetDefaultAuthenticationMethod sets the DefaultAuthenticationMethod field's value.

func (*APNSSandboxChannelRequest) SetEnabled ¶

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

SetEnabled sets the Enabled field's value.

func (*APNSSandboxChannelRequest) SetPrivateKey ¶

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

SetPrivateKey sets the PrivateKey field's value.

func (*APNSSandboxChannelRequest) SetTeamId ¶

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

SetTeamId sets the TeamId field's value.

func (*APNSSandboxChannelRequest) SetTokenKey ¶

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

SetTokenKey sets the TokenKey field's value.

func (*APNSSandboxChannelRequest) SetTokenKeyId ¶

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

SetTokenKeyId sets the TokenKeyId field's value.

func (APNSSandboxChannelRequest) String ¶

func (s APNSSandboxChannelRequest) String() string

String returns the string representation.

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

type APNSSandboxChannelResponse ¶

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 ¶

func (s APNSSandboxChannelResponse) GoString() string

GoString returns the string representation.

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

func (*APNSSandboxChannelResponse) SetApplicationId ¶

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

SetApplicationId sets the ApplicationId field's value.

func (*APNSSandboxChannelResponse) SetCreationDate ¶

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

SetCreationDate sets the CreationDate field's value.

func (*APNSSandboxChannelResponse) SetDefaultAuthenticationMethod ¶

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

SetDefaultAuthenticationMethod sets the DefaultAuthenticationMethod field's value.

func (*APNSSandboxChannelResponse) SetEnabled ¶

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

SetEnabled sets the Enabled field's value.

func (*APNSSandboxChannelResponse) SetHasCredential ¶

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

SetHasCredential sets the HasCredential field's value.

func (*APNSSandboxChannelResponse) SetHasTokenKey ¶

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

SetHasTokenKey sets the HasTokenKey field's value.

func (*APNSSandboxChannelResponse) SetId ¶

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

SetId sets the Id field's value.

func (*APNSSandboxChannelResponse) SetIsArchived ¶

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

SetIsArchived sets the IsArchived field's value.

func (*APNSSandboxChannelResponse) SetLastModifiedBy ¶

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

SetLastModifiedBy sets the LastModifiedBy field's value.

func (*APNSSandboxChannelResponse) SetLastModifiedDate ¶

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

SetLastModifiedDate sets the LastModifiedDate field's value.

func (*APNSSandboxChannelResponse) SetPlatform ¶

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

SetPlatform sets the Platform field's value.

func (*APNSSandboxChannelResponse) SetVersion ¶

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

SetVersion sets the Version field's value.

func (APNSSandboxChannelResponse) String ¶

func (s APNSSandboxChannelResponse) String() string

String returns the string representation.

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

type APNSVoipChannelRequest ¶

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 ¶

func (s APNSVoipChannelRequest) GoString() string

GoString returns the string representation.

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

func (*APNSVoipChannelRequest) SetBundleId ¶

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

SetBundleId sets the BundleId field's value.

func (*APNSVoipChannelRequest) SetCertificate ¶

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

SetCertificate sets the Certificate field's value.

func (*APNSVoipChannelRequest) SetDefaultAuthenticationMethod ¶

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

SetDefaultAuthenticationMethod sets the DefaultAuthenticationMethod field's value.

func (*APNSVoipChannelRequest) SetEnabled ¶

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

SetEnabled sets the Enabled field's value.

func (*APNSVoipChannelRequest) SetPrivateKey ¶

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

SetPrivateKey sets the PrivateKey field's value.

func (*APNSVoipChannelRequest) SetTeamId ¶

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

SetTeamId sets the TeamId field's value.

func (*APNSVoipChannelRequest) SetTokenKey ¶

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

SetTokenKey sets the TokenKey field's value.

func (*APNSVoipChannelRequest) SetTokenKeyId ¶

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

SetTokenKeyId sets the TokenKeyId field's value.

func (APNSVoipChannelRequest) String ¶

func (s APNSVoipChannelRequest) String() string

String returns the string representation.

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

type APNSVoipChannelResponse ¶

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 ¶

func (s APNSVoipChannelResponse) GoString() string

GoString returns the string representation.

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

func (*APNSVoipChannelResponse) SetApplicationId ¶

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

SetApplicationId sets the ApplicationId field's value.

func (*APNSVoipChannelResponse) SetCreationDate ¶

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

SetCreationDate sets the CreationDate field's value.

func (*APNSVoipChannelResponse) SetDefaultAuthenticationMethod ¶

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

SetDefaultAuthenticationMethod sets the DefaultAuthenticationMethod field's value.

func (*APNSVoipChannelResponse) SetEnabled ¶

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

SetEnabled sets the Enabled field's value.

func (*APNSVoipChannelResponse) SetHasCredential ¶

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

SetHasCredential sets the HasCredential field's value.

func (*APNSVoipChannelResponse) SetHasTokenKey ¶

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

SetHasTokenKey sets the HasTokenKey field's value.

func (*APNSVoipChannelResponse) SetId ¶

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

SetId sets the Id field's value.

func (*APNSVoipChannelResponse) SetIsArchived ¶

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

SetIsArchived sets the IsArchived field's value.

func (*APNSVoipChannelResponse) SetLastModifiedBy ¶

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

SetLastModifiedBy sets the LastModifiedBy field's value.

func (*APNSVoipChannelResponse) SetLastModifiedDate ¶

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

SetLastModifiedDate sets the LastModifiedDate field's value.

func (*APNSVoipChannelResponse) SetPlatform ¶

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

SetPlatform sets the Platform field's value.

func (*APNSVoipChannelResponse) SetVersion ¶

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

SetVersion sets the Version field's value.

func (APNSVoipChannelResponse) String ¶

func (s APNSVoipChannelResponse) String() string

String returns the string representation.

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

type APNSVoipSandboxChannelRequest ¶

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 ¶

func (s APNSVoipSandboxChannelRequest) GoString() string

GoString returns the string representation.

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

func (*APNSVoipSandboxChannelRequest) SetBundleId ¶

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

SetBundleId sets the BundleId field's value.

func (*APNSVoipSandboxChannelRequest) SetCertificate ¶

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

SetCertificate sets the Certificate field's value.

func (*APNSVoipSandboxChannelRequest) SetDefaultAuthenticationMethod ¶

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

SetDefaultAuthenticationMethod sets the DefaultAuthenticationMethod field's value.

func (*APNSVoipSandboxChannelRequest) SetEnabled ¶

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

SetEnabled sets the Enabled field's value.

func (*APNSVoipSandboxChannelRequest) SetPrivateKey ¶

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

SetPrivateKey sets the PrivateKey field's value.

func (*APNSVoipSandboxChannelRequest) SetTeamId ¶

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

SetTeamId sets the TeamId field's value.

func (*APNSVoipSandboxChannelRequest) SetTokenKey ¶

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

SetTokenKey sets the TokenKey field's value.

func (*APNSVoipSandboxChannelRequest) SetTokenKeyId ¶

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

SetTokenKeyId sets the TokenKeyId field's value.

func (APNSVoipSandboxChannelRequest) String ¶

func (s APNSVoipSandboxChannelRequest) String() string

String returns the string representation.

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

type APNSVoipSandboxChannelResponse ¶

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 ¶

func (s APNSVoipSandboxChannelResponse) GoString() string

GoString returns the string representation.

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

func (*APNSVoipSandboxChannelResponse) SetApplicationId ¶

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

SetApplicationId sets the ApplicationId field's value.

func (*APNSVoipSandboxChannelResponse) SetCreationDate ¶

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

SetCreationDate sets the CreationDate field's value.

func (*APNSVoipSandboxChannelResponse) SetDefaultAuthenticationMethod ¶

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

SetDefaultAuthenticationMethod sets the DefaultAuthenticationMethod field's value.

func (*APNSVoipSandboxChannelResponse) SetEnabled ¶

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

SetEnabled sets the Enabled field's value.

func (*APNSVoipSandboxChannelResponse) SetHasCredential ¶

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

SetHasCredential sets the HasCredential field's value.

func (*APNSVoipSandboxChannelResponse) SetHasTokenKey ¶

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

SetHasTokenKey sets the HasTokenKey field's value.

func (*APNSVoipSandboxChannelResponse) SetId ¶

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

SetId sets the Id field's value.

func (*APNSVoipSandboxChannelResponse) SetIsArchived ¶

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

SetIsArchived sets the IsArchived field's value.

func (*APNSVoipSandboxChannelResponse) SetLastModifiedBy ¶

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

SetLastModifiedBy sets the LastModifiedBy field's value.

func (*APNSVoipSandboxChannelResponse) SetLastModifiedDate ¶

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

SetLastModifiedDate sets the LastModifiedDate field's value.

func (*APNSVoipSandboxChannelResponse) SetPlatform ¶

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

SetPlatform sets the Platform field's value.

func (*APNSVoipSandboxChannelResponse) SetVersion ¶

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

SetVersion sets the Version field's value.

func (APNSVoipSandboxChannelResponse) String ¶

func (s APNSVoipSandboxChannelResponse) String() string

String returns the string representation.

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

type ActivitiesResponse ¶

type ActivitiesResponse struct {

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

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

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

func (ActivitiesResponse) GoString ¶

func (s ActivitiesResponse) GoString() string

GoString returns the string representation.

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

func (*ActivitiesResponse) SetItem ¶

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

SetItem sets the Item field's value.

func (*ActivitiesResponse) SetNextToken ¶

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

SetNextToken sets the NextToken field's value.

func (ActivitiesResponse) String ¶

func (s ActivitiesResponse) String() string

String returns the string representation.

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

type Activity ¶

type Activity struct {

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

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

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

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

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

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

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

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

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

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

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

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

func (Activity) GoString ¶

func (s Activity) GoString() string

GoString returns the string representation.

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

func (*Activity) SetCUSTOM ¶

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

SetCUSTOM sets the CUSTOM field's value.

func (*Activity) SetConditionalSplit ¶

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

SetConditionalSplit sets the ConditionalSplit field's value.

func (*Activity) SetContactCenter ¶

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

SetContactCenter sets the ContactCenter field's value.

func (*Activity) SetDescription ¶

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

SetDescription sets the Description field's value.

func (*Activity) SetEMAIL ¶

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

SetEMAIL sets the EMAIL field's value.

func (*Activity) SetHoldout ¶

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

SetHoldout sets the Holdout field's value.

func (*Activity) SetMultiCondition ¶

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

SetMultiCondition sets the MultiCondition field's value.

func (*Activity) SetPUSH ¶

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

SetPUSH sets the PUSH field's value.

func (*Activity) SetRandomSplit ¶

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

SetRandomSplit sets the RandomSplit field's value.

func (*Activity) SetSMS ¶

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

SetSMS sets the SMS field's value.

func (*Activity) SetWait ¶

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

SetWait sets the Wait field's value.

func (Activity) String ¶

func (s Activity) String() string

String returns the string representation.

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

func (*Activity) Validate ¶

func (s *Activity) Validate() error

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

type ActivityResponse ¶

type ActivityResponse struct {

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

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

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

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

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

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

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

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

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

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

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

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

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

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

func (ActivityResponse) GoString ¶

func (s ActivityResponse) GoString() string

GoString returns the string representation.

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

func (*ActivityResponse) SetApplicationId ¶

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

SetApplicationId sets the ApplicationId field's value.

func (*ActivityResponse) SetCampaignId ¶

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

SetCampaignId sets the CampaignId field's value.

func (*ActivityResponse) SetEnd ¶

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

SetEnd sets the End field's value.

func (*ActivityResponse) SetId ¶

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

SetId sets the Id field's value.

func (*ActivityResponse) SetResult ¶

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

SetResult sets the Result field's value.

func (*ActivityResponse) SetScheduledStart ¶

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

SetScheduledStart sets the ScheduledStart field's value.

func (*ActivityResponse) SetStart ¶

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

SetStart sets the Start field's value.

func (*ActivityResponse) SetState ¶

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

SetState sets the State field's value.

func (*ActivityResponse) SetSuccessfulEndpointCount ¶

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

SetSuccessfulEndpointCount sets the SuccessfulEndpointCount field's value.

func (*ActivityResponse) SetTimezonesCompletedCount ¶

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

SetTimezonesCompletedCount sets the TimezonesCompletedCount field's value.

func (*ActivityResponse) SetTimezonesTotalCount ¶

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

SetTimezonesTotalCount sets the TimezonesTotalCount field's value.

func (*ActivityResponse) SetTotalEndpointCount ¶

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

SetTotalEndpointCount sets the TotalEndpointCount field's value.

func (*ActivityResponse) SetTreatmentId ¶

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

SetTreatmentId sets the TreatmentId field's value.

func (ActivityResponse) String ¶

func (s ActivityResponse) String() string

String returns the string representation.

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

type AddressConfiguration ¶

type AddressConfiguration struct {

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

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

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

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

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

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

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

func (AddressConfiguration) GoString ¶

func (s AddressConfiguration) GoString() string

GoString returns the string representation.

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

func (*AddressConfiguration) SetBodyOverride ¶

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

SetBodyOverride sets the BodyOverride field's value.

func (*AddressConfiguration) SetChannelType ¶

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

SetChannelType sets the ChannelType field's value.

func (*AddressConfiguration) SetContext ¶

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

SetContext sets the Context field's value.

func (*AddressConfiguration) SetRawContent ¶

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

SetRawContent sets the RawContent field's value.

func (*AddressConfiguration) SetSubstitutions ¶

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

SetSubstitutions sets the Substitutions field's value.

func (*AddressConfiguration) SetTitleOverride ¶

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

SetTitleOverride sets the TitleOverride field's value.

func (AddressConfiguration) String ¶

func (s AddressConfiguration) String() string

String returns the string representation.

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

type AndroidPushNotificationTemplate ¶

type AndroidPushNotificationTemplate struct {

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

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

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

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

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

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

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

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

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

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

func (AndroidPushNotificationTemplate) GoString ¶

func (s AndroidPushNotificationTemplate) GoString() string

GoString returns the string representation.

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

func (*AndroidPushNotificationTemplate) SetAction ¶

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

SetAction sets the Action field's value.

func (*AndroidPushNotificationTemplate) SetBody ¶

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

SetBody sets the Body field's value.

func (*AndroidPushNotificationTemplate) SetImageIconUrl ¶

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

SetImageIconUrl sets the ImageIconUrl field's value.

func (*AndroidPushNotificationTemplate) SetImageUrl ¶

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

SetImageUrl sets the ImageUrl field's value.

func (*AndroidPushNotificationTemplate) SetRawContent ¶

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

SetRawContent sets the RawContent field's value.

func (*AndroidPushNotificationTemplate) SetSmallImageIconUrl ¶

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

SetSmallImageIconUrl sets the SmallImageIconUrl field's value.

func (*AndroidPushNotificationTemplate) SetSound ¶

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

SetSound sets the Sound field's value.

func (*AndroidPushNotificationTemplate) SetTitle ¶

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

SetTitle sets the Title field's value.

func (*AndroidPushNotificationTemplate) SetUrl ¶

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

SetUrl sets the Url field's value.

func (AndroidPushNotificationTemplate) String ¶

func (s AndroidPushNotificationTemplate) String() string

String returns the string representation.

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

type ApplicationDateRangeKpiResponse ¶

type ApplicationDateRangeKpiResponse struct {

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

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

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

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

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

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

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

func (ApplicationDateRangeKpiResponse) GoString ¶

func (s ApplicationDateRangeKpiResponse) GoString() string

GoString returns the string representation.

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

func (*ApplicationDateRangeKpiResponse) SetApplicationId ¶

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

SetApplicationId sets the ApplicationId field's value.

func (*ApplicationDateRangeKpiResponse) SetEndTime ¶

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

SetEndTime sets the EndTime field's value.

func (*ApplicationDateRangeKpiResponse) SetKpiName ¶

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

SetKpiName sets the KpiName field's value.

func (*ApplicationDateRangeKpiResponse) SetKpiResult ¶

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

SetKpiResult sets the KpiResult field's value.

func (*ApplicationDateRangeKpiResponse) SetNextToken ¶

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

SetNextToken sets the NextToken field's value.

func (*ApplicationDateRangeKpiResponse) SetStartTime ¶

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

SetStartTime sets the StartTime field's value.

func (ApplicationDateRangeKpiResponse) String ¶

func (s ApplicationDateRangeKpiResponse) String() string

String returns the string representation.

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

type ApplicationResponse ¶

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 ¶

func (s ApplicationResponse) GoString() string

GoString returns the string representation.

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

func (*ApplicationResponse) SetArn ¶

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

SetArn sets the Arn field's value.

func (*ApplicationResponse) SetId ¶

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

SetId sets the Id field's value.

func (*ApplicationResponse) SetName ¶

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

SetName sets the Name field's value.

func (*ApplicationResponse) SetTags ¶

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

SetTags sets the Tags field's value.

func (ApplicationResponse) String ¶

func (s ApplicationResponse) String() string

String returns the string representation.

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

type ApplicationSettingsResource ¶

type ApplicationSettingsResource struct {

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

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

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

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

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

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

func (ApplicationSettingsResource) GoString ¶

func (s ApplicationSettingsResource) GoString() string

GoString returns the string representation.

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

func (*ApplicationSettingsResource) SetApplicationId ¶

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

SetApplicationId sets the ApplicationId field's value.

func (*ApplicationSettingsResource) SetCampaignHook ¶

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

SetCampaignHook sets the CampaignHook field's value.

func (*ApplicationSettingsResource) SetLastModifiedDate ¶

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

SetLastModifiedDate sets the LastModifiedDate field's value.

func (*ApplicationSettingsResource) SetLimits ¶

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

SetLimits sets the Limits field's value.

func (*ApplicationSettingsResource) SetQuietTime ¶

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

SetQuietTime sets the QuietTime field's value.

func (ApplicationSettingsResource) String ¶

func (s ApplicationSettingsResource) String() string

String returns the string representation.

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

type ApplicationsResponse ¶

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 ¶

func (s ApplicationsResponse) GoString() string

GoString returns the string representation.

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

func (*ApplicationsResponse) SetItem ¶

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

SetItem sets the Item field's value.

func (*ApplicationsResponse) SetNextToken ¶

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

SetNextToken sets the NextToken field's value.

func (ApplicationsResponse) String ¶

func (s ApplicationsResponse) String() string

String returns the string representation.

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

type AttributeDimension ¶

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

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

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

func (AttributeDimension) GoString ¶

func (s AttributeDimension) GoString() string

GoString returns the string representation.

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

func (*AttributeDimension) SetAttributeType ¶

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

SetAttributeType sets the AttributeType field's value.

func (*AttributeDimension) SetValues ¶

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

SetValues sets the Values field's value.

func (AttributeDimension) String ¶

func (s AttributeDimension) String() string

String returns the string representation.

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

func (*AttributeDimension) Validate ¶

func (s *AttributeDimension) Validate() error

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

type AttributesResource ¶

type AttributesResource struct {

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

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

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

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

func (AttributesResource) GoString ¶

func (s AttributesResource) GoString() string

GoString returns the string representation.

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

func (*AttributesResource) SetApplicationId ¶

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

SetApplicationId sets the ApplicationId field's value.

func (*AttributesResource) SetAttributeType ¶

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

SetAttributeType sets the AttributeType field's value.

func (*AttributesResource) SetAttributes ¶

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

SetAttributes sets the Attributes field's value.

func (AttributesResource) String ¶

func (s AttributesResource) String() string

String returns the string representation.

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

type BadRequestException ¶

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

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

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

Provides information about an API request or response.

func (*BadRequestException) Code ¶

func (s *BadRequestException) Code() string

Code returns the exception type name.

func (*BadRequestException) Error ¶

func (s *BadRequestException) Error() string

func (BadRequestException) GoString ¶

func (s BadRequestException) GoString() string

GoString returns the string representation.

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

func (*BadRequestException) Message ¶

func (s *BadRequestException) Message() string

Message returns the exception's message.

func (*BadRequestException) OrigErr ¶

func (s *BadRequestException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*BadRequestException) RequestID ¶

func (s *BadRequestException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*BadRequestException) StatusCode ¶

func (s *BadRequestException) StatusCode() int

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

func (BadRequestException) String ¶

func (s BadRequestException) String() string

String returns the string representation.

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

type BaiduChannelRequest ¶

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 ¶

func (s BaiduChannelRequest) GoString() string

GoString returns the string representation.

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

func (*BaiduChannelRequest) SetApiKey ¶

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

SetApiKey sets the ApiKey field's value.

func (*BaiduChannelRequest) SetEnabled ¶

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

SetEnabled sets the Enabled field's value.

func (*BaiduChannelRequest) SetSecretKey ¶

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

SetSecretKey sets the SecretKey field's value.

func (BaiduChannelRequest) String ¶

func (s BaiduChannelRequest) String() string

String returns the string representation.

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

func (*BaiduChannelRequest) Validate ¶

func (s *BaiduChannelRequest) Validate() error

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

type BaiduChannelResponse ¶

type BaiduChannelResponse struct {

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

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

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

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

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

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

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

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

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

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

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

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

func (BaiduChannelResponse) GoString ¶

func (s BaiduChannelResponse) GoString() string

GoString returns the string representation.

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

func (*BaiduChannelResponse) SetApplicationId ¶

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

SetApplicationId sets the ApplicationId field's value.

func (*BaiduChannelResponse) SetCreationDate ¶

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

SetCreationDate sets the CreationDate field's value.

func (*BaiduChannelResponse) SetCredential ¶

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

SetCredential sets the Credential field's value.

func (*BaiduChannelResponse) SetEnabled ¶

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

SetEnabled sets the Enabled field's value.

func (*BaiduChannelResponse) SetHasCredential ¶

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

SetHasCredential sets the HasCredential field's value.

func (*BaiduChannelResponse) SetId ¶

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

SetId sets the Id field's value.

func (*BaiduChannelResponse) SetIsArchived ¶

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

SetIsArchived sets the IsArchived field's value.

func (*BaiduChannelResponse) SetLastModifiedBy ¶

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

SetLastModifiedBy sets the LastModifiedBy field's value.

func (*BaiduChannelResponse) SetLastModifiedDate ¶

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

SetLastModifiedDate sets the LastModifiedDate field's value.

func (*BaiduChannelResponse) SetPlatform ¶

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

SetPlatform sets the Platform field's value.

func (*BaiduChannelResponse) SetVersion ¶

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

SetVersion sets the Version field's value.

func (BaiduChannelResponse) String ¶

func (s BaiduChannelResponse) String() string

String returns the string representation.

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

type BaiduMessage ¶

type BaiduMessage struct {

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

func (BaiduMessage) GoString ¶

func (s BaiduMessage) GoString() string

GoString returns the string representation.

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

func (*BaiduMessage) SetAction ¶

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

SetAction sets the Action field's value.

func (*BaiduMessage) SetBody ¶

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

SetBody sets the Body field's value.

func (*BaiduMessage) SetData ¶

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

SetData sets the Data field's value.

func (*BaiduMessage) SetIconReference ¶

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

SetIconReference sets the IconReference field's value.

func (*BaiduMessage) SetImageIconUrl ¶

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

SetImageIconUrl sets the ImageIconUrl field's value.

func (*BaiduMessage) SetImageUrl ¶

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

SetImageUrl sets the ImageUrl field's value.

func (*BaiduMessage) SetRawContent ¶

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

SetRawContent sets the RawContent field's value.

func (*BaiduMessage) SetSilentPush ¶

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

SetSilentPush sets the SilentPush field's value.

func (*BaiduMessage) SetSmallImageIconUrl ¶

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

SetSmallImageIconUrl sets the SmallImageIconUrl field's value.

func (*BaiduMessage) SetSound ¶

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

SetSound sets the Sound field's value.

func (*BaiduMessage) SetSubstitutions ¶

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

SetSubstitutions sets the Substitutions field's value.

func (*BaiduMessage) SetTimeToLive ¶

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

SetTimeToLive sets the TimeToLive field's value.

func (*BaiduMessage) SetTitle ¶

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

SetTitle sets the Title field's value.

func (*BaiduMessage) SetUrl ¶

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

SetUrl sets the Url field's value.

func (BaiduMessage) String ¶

func (s BaiduMessage) String() string

String returns the string representation.

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

type BaseKpiResult ¶

type BaseKpiResult struct {

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

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

func (BaseKpiResult) GoString ¶

func (s BaseKpiResult) GoString() string

GoString returns the string representation.

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

func (*BaseKpiResult) SetRows ¶

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

SetRows sets the Rows field's value.

func (BaseKpiResult) String ¶

func (s BaseKpiResult) String() string

String returns the string representation.

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

type CampaignCustomMessage ¶

type CampaignCustomMessage struct {

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

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

func (CampaignCustomMessage) GoString ¶

func (s CampaignCustomMessage) GoString() string

GoString returns the string representation.

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

func (*CampaignCustomMessage) SetData ¶

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

SetData sets the Data field's value.

func (CampaignCustomMessage) String ¶

func (s CampaignCustomMessage) String() string

String returns the string representation.

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

type CampaignDateRangeKpiResponse ¶

type CampaignDateRangeKpiResponse struct {

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

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

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

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

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

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

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

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

func (CampaignDateRangeKpiResponse) GoString ¶

func (s CampaignDateRangeKpiResponse) GoString() string

GoString returns the string representation.

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

func (*CampaignDateRangeKpiResponse) SetApplicationId ¶

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

SetApplicationId sets the ApplicationId field's value.

func (*CampaignDateRangeKpiResponse) SetCampaignId ¶

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

SetCampaignId sets the CampaignId field's value.

func (*CampaignDateRangeKpiResponse) SetEndTime ¶

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

SetEndTime sets the EndTime field's value.

func (*CampaignDateRangeKpiResponse) SetKpiName ¶

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

SetKpiName sets the KpiName field's value.

func (*CampaignDateRangeKpiResponse) SetKpiResult ¶

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

SetKpiResult sets the KpiResult field's value.

func (*CampaignDateRangeKpiResponse) SetNextToken ¶

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

SetNextToken sets the NextToken field's value.

func (*CampaignDateRangeKpiResponse) SetStartTime ¶

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

SetStartTime sets the StartTime field's value.

func (CampaignDateRangeKpiResponse) String ¶

func (s CampaignDateRangeKpiResponse) String() string

String returns the string representation.

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

type CampaignEmailMessage ¶

type CampaignEmailMessage struct {

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

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

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

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

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

func (CampaignEmailMessage) GoString ¶

func (s CampaignEmailMessage) GoString() string

GoString returns the string representation.

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

func (*CampaignEmailMessage) SetBody ¶

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

SetBody sets the Body field's value.

func (*CampaignEmailMessage) SetFromAddress ¶

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

SetFromAddress sets the FromAddress field's value.

func (*CampaignEmailMessage) SetHtmlBody ¶

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

SetHtmlBody sets the HtmlBody field's value.

func (*CampaignEmailMessage) SetTitle ¶

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

SetTitle sets the Title field's value.

func (CampaignEmailMessage) String ¶

func (s CampaignEmailMessage) String() string

String returns the string representation.

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

type CampaignEventFilter ¶

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 ¶

func (s CampaignEventFilter) GoString() string

GoString returns the string representation.

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

func (*CampaignEventFilter) SetDimensions ¶

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

SetDimensions sets the Dimensions field's value.

func (*CampaignEventFilter) SetFilterType ¶

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

SetFilterType sets the FilterType field's value.

func (CampaignEventFilter) String ¶

func (s CampaignEventFilter) String() string

String returns the string representation.

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

func (*CampaignEventFilter) Validate ¶

func (s *CampaignEventFilter) Validate() error

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

type CampaignHook ¶

type CampaignHook struct {

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

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

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

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

func (CampaignHook) GoString ¶

func (s CampaignHook) GoString() string

GoString returns the string representation.

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

func (*CampaignHook) SetLambdaFunctionName ¶

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

SetLambdaFunctionName sets the LambdaFunctionName field's value.

func (*CampaignHook) SetMode ¶

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

SetMode sets the Mode field's value.

func (*CampaignHook) SetWebUrl ¶

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

SetWebUrl sets the WebUrl field's value.

func (CampaignHook) String ¶

func (s CampaignHook) String() string

String returns the string representation.

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

type CampaignInAppMessage ¶

type CampaignInAppMessage struct {

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

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

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

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

In-app message configuration.

func (CampaignInAppMessage) GoString ¶

func (s CampaignInAppMessage) GoString() string

GoString returns the string representation.

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

func (*CampaignInAppMessage) SetBody ¶

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

SetBody sets the Body field's value.

func (*CampaignInAppMessage) SetContent ¶

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

SetContent sets the Content field's value.

func (*CampaignInAppMessage) SetCustomConfig ¶

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

SetCustomConfig sets the CustomConfig field's value.

func (*CampaignInAppMessage) SetLayout ¶

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

SetLayout sets the Layout field's value.

func (CampaignInAppMessage) String ¶

func (s CampaignInAppMessage) String() string

String returns the string representation.

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

func (*CampaignInAppMessage) Validate ¶

func (s *CampaignInAppMessage) Validate() error

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

type CampaignLimits ¶

type CampaignLimits struct {

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

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

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

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

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

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

func (CampaignLimits) GoString ¶

func (s CampaignLimits) GoString() string

GoString returns the string representation.

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

func (*CampaignLimits) SetDaily ¶

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

SetDaily sets the Daily field's value.

func (*CampaignLimits) SetMaximumDuration ¶

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

SetMaximumDuration sets the MaximumDuration field's value.

func (*CampaignLimits) SetMessagesPerSecond ¶

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

SetMessagesPerSecond sets the MessagesPerSecond field's value.

func (*CampaignLimits) SetSession ¶

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

SetSession sets the Session field's value.

func (*CampaignLimits) SetTotal ¶

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

SetTotal sets the Total field's value.

func (CampaignLimits) String ¶

func (s CampaignLimits) String() string

String returns the string representation.

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

type CampaignResponse ¶

type CampaignResponse struct {

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

func (CampaignResponse) GoString ¶

func (s CampaignResponse) GoString() string

GoString returns the string representation.

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

func (*CampaignResponse) SetAdditionalTreatments ¶

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

SetAdditionalTreatments sets the AdditionalTreatments field's value.

func (*CampaignResponse) SetApplicationId ¶

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

SetApplicationId sets the ApplicationId field's value.

func (*CampaignResponse) SetArn ¶

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

SetArn sets the Arn field's value.

func (*CampaignResponse) SetCreationDate ¶

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

SetCreationDate sets the CreationDate field's value.

func (*CampaignResponse) SetCustomDeliveryConfiguration ¶

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

SetCustomDeliveryConfiguration sets the CustomDeliveryConfiguration field's value.

func (*CampaignResponse) SetDefaultState ¶

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

SetDefaultState sets the DefaultState field's value.

func (*CampaignResponse) SetDescription ¶

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

SetDescription sets the Description field's value.

func (*CampaignResponse) SetHoldoutPercent ¶

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

SetHoldoutPercent sets the HoldoutPercent field's value.

func (*CampaignResponse) SetHook ¶

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

SetHook sets the Hook field's value.

func (*CampaignResponse) SetId ¶

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

SetId sets the Id field's value.

func (*CampaignResponse) SetIsPaused ¶

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

SetIsPaused sets the IsPaused field's value.

func (*CampaignResponse) SetLastModifiedDate ¶

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

SetLastModifiedDate sets the LastModifiedDate field's value.

func (*CampaignResponse) SetLimits ¶

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

SetLimits sets the Limits field's value.

func (*CampaignResponse) SetMessageConfiguration ¶

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

SetMessageConfiguration sets the MessageConfiguration field's value.

func (*CampaignResponse) SetName ¶

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

SetName sets the Name field's value.

func (*CampaignResponse) SetPriority ¶

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

SetPriority sets the Priority field's value.

func (*CampaignResponse) SetSchedule ¶

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

SetSchedule sets the Schedule field's value.

func (*CampaignResponse) SetSegmentId ¶

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

SetSegmentId sets the SegmentId field's value.

func (*CampaignResponse) SetSegmentVersion ¶

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

SetSegmentVersion sets the SegmentVersion field's value.

func (*CampaignResponse) SetState ¶

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

SetState sets the State field's value.

func (*CampaignResponse) SetTags ¶

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

SetTags sets the Tags field's value.

func (*CampaignResponse) SetTemplateConfiguration ¶

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

SetTemplateConfiguration sets the TemplateConfiguration field's value.

func (*CampaignResponse) SetTreatmentDescription ¶

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

SetTreatmentDescription sets the TreatmentDescription field's value.

func (*CampaignResponse) SetTreatmentName ¶

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

SetTreatmentName sets the TreatmentName field's value.

func (*CampaignResponse) SetVersion ¶

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

SetVersion sets the Version field's value.

func (CampaignResponse) String ¶

func (s CampaignResponse) String() string

String returns the string representation.

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

type CampaignSmsMessage ¶

type CampaignSmsMessage struct {

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

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

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

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

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

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

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

func (CampaignSmsMessage) GoString ¶

func (s CampaignSmsMessage) GoString() string

GoString returns the string representation.

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

func (*CampaignSmsMessage) SetBody ¶

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

SetBody sets the Body field's value.

func (*CampaignSmsMessage) SetEntityId ¶

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

SetEntityId sets the EntityId field's value.

func (*CampaignSmsMessage) SetMessageType ¶

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

SetMessageType sets the MessageType field's value.

func (*CampaignSmsMessage) SetOriginationNumber ¶

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

SetOriginationNumber sets the OriginationNumber field's value.

func (*CampaignSmsMessage) SetSenderId ¶

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

SetSenderId sets the SenderId field's value.

func (*CampaignSmsMessage) SetTemplateId ¶

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

SetTemplateId sets the TemplateId field's value.

func (CampaignSmsMessage) String ¶

func (s CampaignSmsMessage) String() string

String returns the string representation.

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

type CampaignState ¶

type CampaignState struct {

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

Provides information about the status of a campaign.

func (CampaignState) GoString ¶

func (s CampaignState) GoString() string

GoString returns the string representation.

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

func (*CampaignState) SetCampaignStatus ¶

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

SetCampaignStatus sets the CampaignStatus field's value.

func (CampaignState) String ¶

func (s CampaignState) String() string

String returns the string representation.

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

type CampaignsResponse ¶

type CampaignsResponse struct {

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

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

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

func (CampaignsResponse) GoString ¶

func (s CampaignsResponse) GoString() string

GoString returns the string representation.

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

func (*CampaignsResponse) SetItem ¶

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

SetItem sets the Item field's value.

func (*CampaignsResponse) SetNextToken ¶

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

SetNextToken sets the NextToken field's value.

func (CampaignsResponse) String ¶

func (s CampaignsResponse) String() string

String returns the string representation.

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

type ChannelResponse ¶

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 ¶

func (s ChannelResponse) GoString() string

GoString returns the string representation.

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

func (*ChannelResponse) SetApplicationId ¶

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

SetApplicationId sets the ApplicationId field's value.

func (*ChannelResponse) SetCreationDate ¶

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

SetCreationDate sets the CreationDate field's value.

func (*ChannelResponse) SetEnabled ¶

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

SetEnabled sets the Enabled field's value.

func (*ChannelResponse) SetHasCredential ¶

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

SetHasCredential sets the HasCredential field's value.

func (*ChannelResponse) SetId ¶

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

SetId sets the Id field's value.

func (*ChannelResponse) SetIsArchived ¶

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

SetIsArchived sets the IsArchived field's value.

func (*ChannelResponse) SetLastModifiedBy ¶

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

SetLastModifiedBy sets the LastModifiedBy field's value.

func (*ChannelResponse) SetLastModifiedDate ¶

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

SetLastModifiedDate sets the LastModifiedDate field's value.

func (*ChannelResponse) SetVersion ¶

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

SetVersion sets the Version field's value.

func (ChannelResponse) String ¶

func (s ChannelResponse) String() string

String returns the string representation.

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

type ChannelsResponse ¶

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 ¶

func (s ChannelsResponse) GoString() string

GoString returns the string representation.

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

func (*ChannelsResponse) SetChannels ¶

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

SetChannels sets the Channels field's value.

func (ChannelsResponse) String ¶

func (s ChannelsResponse) String() string

String returns the string representation.

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

type Condition ¶

type Condition struct {

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

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

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

func (Condition) GoString ¶

func (s Condition) GoString() string

GoString returns the string representation.

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

func (*Condition) SetConditions ¶

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

SetConditions sets the Conditions field's value.

func (*Condition) SetOperator ¶

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

SetOperator sets the Operator field's value.

func (Condition) String ¶

func (s Condition) String() string

String returns the string representation.

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

func (*Condition) Validate ¶

func (s *Condition) Validate() error

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

type ConditionalSplitActivity ¶

type ConditionalSplitActivity struct {

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

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

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

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

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

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

func (ConditionalSplitActivity) GoString ¶

func (s ConditionalSplitActivity) GoString() string

GoString returns the string representation.

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

func (*ConditionalSplitActivity) SetCondition ¶

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

SetCondition sets the Condition field's value.

func (*ConditionalSplitActivity) SetEvaluationWaitTime ¶

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

SetEvaluationWaitTime sets the EvaluationWaitTime field's value.

func (*ConditionalSplitActivity) SetFalseActivity ¶

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

SetFalseActivity sets the FalseActivity field's value.

func (*ConditionalSplitActivity) SetTrueActivity ¶

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

SetTrueActivity sets the TrueActivity field's value.

func (ConditionalSplitActivity) String ¶

func (s ConditionalSplitActivity) String() string

String returns the string representation.

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

func (*ConditionalSplitActivity) Validate ¶

func (s *ConditionalSplitActivity) Validate() error

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

type ConflictException ¶

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

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

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

Provides information about an API request or response.

func (*ConflictException) Code ¶

func (s *ConflictException) Code() string

Code returns the exception type name.

func (*ConflictException) Error ¶

func (s *ConflictException) Error() string

func (ConflictException) GoString ¶

func (s ConflictException) GoString() string

GoString returns the string representation.

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

func (*ConflictException) Message ¶

func (s *ConflictException) Message() string

Message returns the exception's message.

func (*ConflictException) OrigErr ¶

func (s *ConflictException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ConflictException) RequestID ¶

func (s *ConflictException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ConflictException) StatusCode ¶

func (s *ConflictException) StatusCode() int

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

func (ConflictException) String ¶

func (s ConflictException) String() string

String returns the string representation.

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

type ContactCenterActivity ¶

type ContactCenterActivity struct {

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

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

func (ContactCenterActivity) GoString ¶

func (s ContactCenterActivity) GoString() string

GoString returns the string representation.

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

func (*ContactCenterActivity) SetNextActivity ¶

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

SetNextActivity sets the NextActivity field's value.

func (ContactCenterActivity) String ¶

func (s ContactCenterActivity) String() string

String returns the string representation.

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

type CreateAppInput ¶

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 ¶

func (s CreateAppInput) GoString() string

GoString returns the string representation.

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

func (*CreateAppInput) SetCreateApplicationRequest ¶

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

SetCreateApplicationRequest sets the CreateApplicationRequest field's value.

func (CreateAppInput) String ¶

func (s CreateAppInput) String() string

String returns the string representation.

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

func (*CreateAppInput) Validate ¶

func (s *CreateAppInput) Validate() error

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

type CreateAppOutput ¶

type CreateAppOutput struct {

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

func (CreateAppOutput) GoString ¶

func (s CreateAppOutput) GoString() string

GoString returns the string representation.

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

func (*CreateAppOutput) SetApplicationResponse ¶

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

SetApplicationResponse sets the ApplicationResponse field's value.

func (CreateAppOutput) String ¶

func (s CreateAppOutput) String() string

String returns the string representation.

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

type CreateApplicationRequest ¶

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 ¶

func (s CreateApplicationRequest) GoString() string

GoString returns the string representation.

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

func (*CreateApplicationRequest) SetName ¶

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

SetName sets the Name field's value.

func (*CreateApplicationRequest) SetTags ¶

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

SetTags sets the Tags field's value.

func (CreateApplicationRequest) String ¶

func (s CreateApplicationRequest) String() string

String returns the string representation.

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

func (*CreateApplicationRequest) Validate ¶

func (s *CreateApplicationRequest) Validate() error

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

type CreateCampaignInput ¶

type CreateCampaignInput struct {

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

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

func (CreateCampaignInput) GoString ¶

func (s CreateCampaignInput) GoString() string

GoString returns the string representation.

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

func (*CreateCampaignInput) SetApplicationId ¶

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

SetApplicationId sets the ApplicationId field's value.

func (*CreateCampaignInput) SetWriteCampaignRequest ¶

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

SetWriteCampaignRequest sets the WriteCampaignRequest field's value.

func (CreateCampaignInput) String ¶

func (s CreateCampaignInput) String() string

String returns the string representation.

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

func (*CreateCampaignInput) Validate ¶

func (s *CreateCampaignInput) Validate() error

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

type CreateCampaignOutput ¶

type CreateCampaignOutput struct {

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

func (CreateCampaignOutput) GoString ¶

func (s CreateCampaignOutput) GoString() string

GoString returns the string representation.

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

func (*CreateCampaignOutput) SetCampaignResponse ¶

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

SetCampaignResponse sets the CampaignResponse field's value.

func (CreateCampaignOutput) String ¶

func (s CreateCampaignOutput) String() string

String returns the string representation.

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

type CreateEmailTemplateInput ¶

type CreateEmailTemplateInput struct {

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

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

func (CreateEmailTemplateInput) GoString ¶

func (s CreateEmailTemplateInput) GoString() string

GoString returns the string representation.

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

func (*CreateEmailTemplateInput) SetEmailTemplateRequest ¶

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

SetEmailTemplateRequest sets the EmailTemplateRequest field's value.

func (*CreateEmailTemplateInput) SetTemplateName ¶

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

SetTemplateName sets the TemplateName field's value.

func (CreateEmailTemplateInput) String ¶

func (s CreateEmailTemplateInput) String() string

String returns the string representation.

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

func (*CreateEmailTemplateInput) Validate ¶

func (s *CreateEmailTemplateInput) Validate() error

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

type CreateEmailTemplateOutput ¶

type CreateEmailTemplateOutput struct {

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

func (CreateEmailTemplateOutput) GoString ¶

func (s CreateEmailTemplateOutput) GoString() string

GoString returns the string representation.

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

func (*CreateEmailTemplateOutput) SetCreateTemplateMessageBody ¶

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

SetCreateTemplateMessageBody sets the CreateTemplateMessageBody field's value.

func (CreateEmailTemplateOutput) String ¶

func (s CreateEmailTemplateOutput) String() string

String returns the string representation.

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

type CreateExportJobInput ¶

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 ¶

func (s CreateExportJobInput) GoString() string

GoString returns the string representation.

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

func (*CreateExportJobInput) SetApplicationId ¶

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

SetApplicationId sets the ApplicationId field's value.

func (*CreateExportJobInput) SetExportJobRequest ¶

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

SetExportJobRequest sets the ExportJobRequest field's value.

func (CreateExportJobInput) String ¶

func (s CreateExportJobInput) String() string

String returns the string representation.

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

func (*CreateExportJobInput) Validate ¶

func (s *CreateExportJobInput) Validate() error

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

type CreateExportJobOutput ¶

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 ¶

func (s CreateExportJobOutput) GoString() string

GoString returns the string representation.

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

func (*CreateExportJobOutput) SetExportJobResponse ¶

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

SetExportJobResponse sets the ExportJobResponse field's value.

func (CreateExportJobOutput) String ¶

func (s CreateExportJobOutput) String() string

String returns the string representation.

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

type CreateImportJobInput ¶

type CreateImportJobInput struct {

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

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

func (CreateImportJobInput) GoString ¶

func (s CreateImportJobInput) GoString() string

GoString returns the string representation.

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

func (*CreateImportJobInput) SetApplicationId ¶

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

SetApplicationId sets the ApplicationId field's value.

func (*CreateImportJobInput) SetImportJobRequest ¶

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

SetImportJobRequest sets the ImportJobRequest field's value.

func (CreateImportJobInput) String ¶

func (s CreateImportJobInput) String() string

String returns the string representation.

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

func (*CreateImportJobInput) Validate ¶

func (s *CreateImportJobInput) Validate() error

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

type CreateImportJobOutput ¶

type CreateImportJobOutput struct {

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

func (CreateImportJobOutput) GoString ¶

func (s CreateImportJobOutput) GoString() string

GoString returns the string representation.

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

func (*CreateImportJobOutput) SetImportJobResponse ¶

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

SetImportJobResponse sets the ImportJobResponse field's value.

func (CreateImportJobOutput) String ¶

func (s CreateImportJobOutput) String() string

String returns the string representation.

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

type CreateInAppTemplateInput ¶

type CreateInAppTemplateInput struct {

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

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

func (CreateInAppTemplateInput) GoString ¶

func (s CreateInAppTemplateInput) GoString() string

GoString returns the string representation.

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

func (*CreateInAppTemplateInput) SetInAppTemplateRequest ¶

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

SetInAppTemplateRequest sets the InAppTemplateRequest field's value.

func (*CreateInAppTemplateInput) SetTemplateName ¶

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

SetTemplateName sets the TemplateName field's value.

func (CreateInAppTemplateInput) String ¶

func (s CreateInAppTemplateInput) String() string

String returns the string representation.

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

func (*CreateInAppTemplateInput) Validate ¶

func (s *CreateInAppTemplateInput) Validate() error

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

type CreateInAppTemplateOutput ¶

type CreateInAppTemplateOutput struct {

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

func (CreateInAppTemplateOutput) GoString ¶

func (s CreateInAppTemplateOutput) GoString() string

GoString returns the string representation.

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

func (*CreateInAppTemplateOutput) SetTemplateCreateMessageBody ¶

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

SetTemplateCreateMessageBody sets the TemplateCreateMessageBody field's value.

func (CreateInAppTemplateOutput) String ¶

func (s CreateInAppTemplateOutput) String() string

String returns the string representation.

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

type CreateJourneyInput ¶

type CreateJourneyInput struct {

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

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

func (CreateJourneyInput) GoString ¶

func (s CreateJourneyInput) GoString() string

GoString returns the string representation.

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

func (*CreateJourneyInput) SetApplicationId ¶

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

SetApplicationId sets the ApplicationId field's value.

func (*CreateJourneyInput) SetWriteJourneyRequest ¶

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

SetWriteJourneyRequest sets the WriteJourneyRequest field's value.

func (CreateJourneyInput) String ¶

func (s CreateJourneyInput) String() string

String returns the string representation.

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

func (*CreateJourneyInput) Validate ¶

func (s *CreateJourneyInput) Validate() error

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

type CreateJourneyOutput ¶

type CreateJourneyOutput struct {

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

func (CreateJourneyOutput) GoString ¶

func (s CreateJourneyOutput) GoString() string

GoString returns the string representation.

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

func (*CreateJourneyOutput) SetJourneyResponse ¶

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

SetJourneyResponse sets the JourneyResponse field's value.

func (CreateJourneyOutput) String ¶

func (s CreateJourneyOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreatePushTemplateInput ¶

type CreatePushTemplateInput struct {

    // Specifies the content and settings for a message template that can be used
    // in messages that are sent through a push notification channel.
    //
    // PushNotificationTemplateRequest is a required field
    PushNotificationTemplateRequest *PushNotificationTemplateRequest `type:"structure" required:"true"`

    // TemplateName is a required field
    TemplateName *string `location:"uri" locationName:"template-name" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (CreatePushTemplateInput) GoString ¶

func (s CreatePushTemplateInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreatePushTemplateInput) SetPushNotificationTemplateRequest ¶

func (s *CreatePushTemplateInput) SetPushNotificationTemplateRequest(v *PushNotificationTemplateRequest) *CreatePushTemplateInput

SetPushNotificationTemplateRequest sets the PushNotificationTemplateRequest field's value.

func (*CreatePushTemplateInput) SetTemplateName ¶

func (s *CreatePushTemplateInput) SetTemplateName(v string) *CreatePushTemplateInput

SetTemplateName sets the TemplateName field's value.

func (CreatePushTemplateInput) String ¶

func (s CreatePushTemplateInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreatePushTemplateInput) Validate ¶

func (s *CreatePushTemplateInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreatePushTemplateOutput ¶

type CreatePushTemplateOutput struct {

    // Provides information about a request to create a message template.
    //
    // CreateTemplateMessageBody is a required field
    CreateTemplateMessageBody *CreateTemplateMessageBody `type:"structure" required:"true"`
    // contains filtered or unexported fields
}

func (CreatePushTemplateOutput) GoString ¶

func (s CreatePushTemplateOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreatePushTemplateOutput) SetCreateTemplateMessageBody ¶

func (s *CreatePushTemplateOutput) SetCreateTemplateMessageBody(v *CreateTemplateMessageBody) *CreatePushTemplateOutput

SetCreateTemplateMessageBody sets the CreateTemplateMessageBody field's value.

func (CreatePushTemplateOutput) String ¶

func (s CreatePushTemplateOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateRecommenderConfiguration ¶

type CreateRecommenderConfiguration struct {

    // A map of key-value pairs that defines 1-10 custom endpoint or user attributes,
    // depending on the value for the RecommendationProviderIdType property. Each
    // of these attributes temporarily stores a recommended item that's retrieved
    // from the recommender model and sent to an AWS Lambda function for additional
    // processing. Each attribute can be used as a message variable in a message
    // template.
    //
    // In the map, the key is the name of a custom attribute and the value is a
    // custom display name for that attribute. The display name appears in the Attribute
    // finder of the template editor on the Amazon Pinpoint console. The following
    // restrictions apply to these names:
    //
    //    * An attribute name must start with a letter or number and it can contain
    //    up to 50 characters. The characters can be letters, numbers, underscores
    //    (_), or hyphens (-). Attribute names are case sensitive and must be unique.
    //
    //    * An attribute display name must start with a letter or number and it
    //    can contain up to 25 characters. The characters can be letters, numbers,
    //    spaces, underscores (_), or hyphens (-).
    //
    // This object is required if the configuration invokes an AWS Lambda function
    // (RecommendationTransformerUri) to process recommendation data. Otherwise,
    // don't include this object in your request.
    Attributes map[string]*string `type:"map"`

    // A custom description of the configuration for the recommender model. The
    // description can contain up to 128 characters. The characters can be letters,
    // numbers, spaces, or the following symbols: _ ; () , ‐.
    Description *string `type:"string"`

    // A custom name of the configuration for the recommender model. The name must
    // start with a letter or number and it can contain up to 128 characters. The
    // characters can be letters, numbers, spaces, underscores (_), or hyphens (-).
    Name *string `type:"string"`

    // The type of Amazon Pinpoint ID to associate with unique user IDs in the recommender
    // model. This value enables the model to use attribute and event data that’s
    // specific to a particular endpoint or user in an Amazon Pinpoint application.
    // Valid values are:
    //
    //    * PINPOINT_ENDPOINT_ID - Associate each user in the model with a particular
    //    endpoint in Amazon Pinpoint. The data is correlated based on endpoint
    //    IDs in Amazon Pinpoint. This is the default value.
    //
    //    * PINPOINT_USER_ID - Associate each user in the model with a particular
    //    user and endpoint in Amazon Pinpoint. The data is correlated based on
    //    user IDs in Amazon Pinpoint. If you specify this value, an endpoint definition
    //    in Amazon Pinpoint has to specify both a user ID (UserId) and an endpoint
    //    ID. Otherwise, messages won’t be sent to the user's endpoint.
    RecommendationProviderIdType *string `type:"string"`

    // The Amazon Resource Name (ARN) of the AWS Identity and Access Management
    // (IAM) role that authorizes Amazon Pinpoint to retrieve recommendation data
    // from the recommender model.
    //
    // RecommendationProviderRoleArn is a required field
    RecommendationProviderRoleArn *string `type:"string" required:"true"`

    // The Amazon Resource Name (ARN) of the recommender model to retrieve recommendation
    // data from. This value must match the ARN of an Amazon Personalize campaign.
    //
    // RecommendationProviderUri is a required field
    RecommendationProviderUri *string `type:"string" required:"true"`

    // The name or Amazon Resource Name (ARN) of the AWS Lambda function to invoke
    // for additional processing of recommendation data that's retrieved from the
    // recommender model.
    RecommendationTransformerUri *string `type:"string"`

    // A custom display name for the standard endpoint or user attribute (RecommendationItems)
    // that temporarily stores recommended items for each endpoint or user, depending
    // on the value for the RecommendationProviderIdType property. This value is
    // required if the configuration doesn't invoke an AWS Lambda function (RecommendationTransformerUri)
    // to perform additional processing of recommendation data.
    //
    // This name appears in the Attribute finder of the template editor on the Amazon
    // Pinpoint console. The name can contain up to 25 characters. The characters
    // can be letters, numbers, spaces, underscores (_), or hyphens (-). These restrictions
    // don't apply to attribute values.
    RecommendationsDisplayName *string `type:"string"`

    // The number of recommended items to retrieve from the model for each endpoint
    // or user, depending on the value for the RecommendationProviderIdType property.
    // This number determines how many recommended items are available for use in
    // message variables. The minimum value is 1. The maximum value is 5. The default
    // value is 5.
    //
    // To use multiple recommended items and custom attributes with message variables,
    // you have to use an AWS Lambda function (RecommendationTransformerUri) to
    // perform additional processing of recommendation data.
    RecommendationsPerMessage *int64 `type:"integer"`
    // contains filtered or unexported fields
}

Specifies Amazon Pinpoint configuration settings for retrieving and processing recommendation data from a recommender model.

func (CreateRecommenderConfiguration) GoString ¶

func (s CreateRecommenderConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateRecommenderConfiguration) SetAttributes ¶

func (s *CreateRecommenderConfiguration) SetAttributes(v map[string]*string) *CreateRecommenderConfiguration

SetAttributes sets the Attributes field's value.

func (*CreateRecommenderConfiguration) SetDescription ¶

func (s *CreateRecommenderConfiguration) SetDescription(v string) *CreateRecommenderConfiguration

SetDescription sets the Description field's value.

func (*CreateRecommenderConfiguration) SetName ¶

func (s *CreateRecommenderConfiguration) SetName(v string) *CreateRecommenderConfiguration

SetName sets the Name field's value.

func (*CreateRecommenderConfiguration) SetRecommendationProviderIdType ¶

func (s *CreateRecommenderConfiguration) SetRecommendationProviderIdType(v string) *CreateRecommenderConfiguration

SetRecommendationProviderIdType sets the RecommendationProviderIdType field's value.

func (*CreateRecommenderConfiguration) SetRecommendationProviderRoleArn ¶

func (s *CreateRecommenderConfiguration) SetRecommendationProviderRoleArn(v string) *CreateRecommenderConfiguration

SetRecommendationProviderRoleArn sets the RecommendationProviderRoleArn field's value.

func (*CreateRecommenderConfiguration) SetRecommendationProviderUri ¶

func (s *CreateRecommenderConfiguration) SetRecommendationProviderUri(v string) *CreateRecommenderConfiguration

SetRecommendationProviderUri sets the RecommendationProviderUri field's value.

func (*CreateRecommenderConfiguration) SetRecommendationTransformerUri ¶

func (s *CreateRecommenderConfiguration) SetRecommendationTransformerUri(v string) *CreateRecommenderConfiguration

SetRecommendationTransformerUri sets the RecommendationTransformerUri field's value.

func (*CreateRecommenderConfiguration) SetRecommendationsDisplayName ¶

func (s *CreateRecommenderConfiguration) SetRecommendationsDisplayName(v string) *CreateRecommenderConfiguration

SetRecommendationsDisplayName sets the RecommendationsDisplayName field's value.

func (*CreateRecommenderConfiguration) SetRecommendationsPerMessage ¶

func (s *CreateRecommenderConfiguration) SetRecommendationsPerMessage(v int64) *CreateRecommenderConfiguration

SetRecommendationsPerMessage sets the RecommendationsPerMessage field's value.

func (CreateRecommenderConfiguration) String ¶

func (s CreateRecommenderConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateRecommenderConfiguration) Validate ¶

func (s *CreateRecommenderConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateRecommenderConfigurationInput ¶

type CreateRecommenderConfigurationInput struct {

    // Specifies Amazon Pinpoint configuration settings for retrieving and processing
    // recommendation data from a recommender model.
    //
    // CreateRecommenderConfiguration is a required field
    CreateRecommenderConfiguration *CreateRecommenderConfiguration `type:"structure" required:"true"`
    // contains filtered or unexported fields
}

func (CreateRecommenderConfigurationInput) GoString ¶

func (s CreateRecommenderConfigurationInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateRecommenderConfigurationInput) SetCreateRecommenderConfiguration ¶

func (s *CreateRecommenderConfigurationInput) SetCreateRecommenderConfiguration(v *CreateRecommenderConfiguration) *CreateRecommenderConfigurationInput

SetCreateRecommenderConfiguration sets the CreateRecommenderConfiguration field's value.

func (CreateRecommenderConfigurationInput) String ¶

func (s CreateRecommenderConfigurationInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateRecommenderConfigurationInput) Validate ¶

func (s *CreateRecommenderConfigurationInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateRecommenderConfigurationOutput ¶

type CreateRecommenderConfigurationOutput struct {

    // Provides information about Amazon Pinpoint configuration settings for retrieving
    // and processing data from a recommender model.
    //
    // RecommenderConfigurationResponse is a required field
    RecommenderConfigurationResponse *RecommenderConfigurationResponse `type:"structure" required:"true"`
    // contains filtered or unexported fields
}

func (CreateRecommenderConfigurationOutput) GoString ¶

func (s CreateRecommenderConfigurationOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateRecommenderConfigurationOutput) SetRecommenderConfigurationResponse ¶

func (s *CreateRecommenderConfigurationOutput) SetRecommenderConfigurationResponse(v *RecommenderConfigurationResponse) *CreateRecommenderConfigurationOutput

SetRecommenderConfigurationResponse sets the RecommenderConfigurationResponse field's value.

func (CreateRecommenderConfigurationOutput) String ¶

func (s CreateRecommenderConfigurationOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateSegmentInput ¶

type CreateSegmentInput struct {

    // ApplicationId is a required field
    ApplicationId *string `location:"uri" locationName:"application-id" type:"string" required:"true"`

    // Specifies the configuration, dimension, and other settings for a segment.
    // A WriteSegmentRequest object can include a Dimensions object or a SegmentGroups
    // object, but not both.
    //
    // WriteSegmentRequest is a required field
    WriteSegmentRequest *WriteSegmentRequest `type:"structure" required:"true"`
    // contains filtered or unexported fields
}

func (CreateSegmentInput) GoString ¶

func (s CreateSegmentInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateSegmentInput) SetApplicationId ¶

func (s *CreateSegmentInput) SetApplicationId(v string) *CreateSegmentInput

SetApplicationId sets the ApplicationId field's value.

func (*CreateSegmentInput) SetWriteSegmentRequest ¶

func (s *CreateSegmentInput) SetWriteSegmentRequest(v *WriteSegmentRequest) *CreateSegmentInput

SetWriteSegmentRequest sets the WriteSegmentRequest field's value.

func (CreateSegmentInput) String ¶

func (s CreateSegmentInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateSegmentInput) Validate ¶

func (s *CreateSegmentInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateSegmentOutput ¶

type CreateSegmentOutput struct {

    // Provides information about the configuration, dimension, and other settings
    // for a segment.
    //
    // SegmentResponse is a required field
    SegmentResponse *SegmentResponse `type:"structure" required:"true"`
    // contains filtered or unexported fields
}

func (CreateSegmentOutput) GoString ¶

func (s CreateSegmentOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateSegmentOutput) SetSegmentResponse ¶

func (s *CreateSegmentOutput) SetSegmentResponse(v *SegmentResponse) *CreateSegmentOutput

SetSegmentResponse sets the SegmentResponse field's value.

func (CreateSegmentOutput) String ¶

func (s CreateSegmentOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateSmsTemplateInput ¶

type CreateSmsTemplateInput struct {

    // Specifies the content and settings for a message template that can be used
    // in text messages that are sent through the SMS channel.
    //
    // SMSTemplateRequest is a required field
    SMSTemplateRequest *SMSTemplateRequest `type:"structure" required:"true"`

    // TemplateName is a required field
    TemplateName *string `location:"uri" locationName:"template-name" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (CreateSmsTemplateInput) GoString ¶

func (s CreateSmsTemplateInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateSmsTemplateInput) SetSMSTemplateRequest ¶

func (s *CreateSmsTemplateInput) SetSMSTemplateRequest(v *SMSTemplateRequest) *CreateSmsTemplateInput

SetSMSTemplateRequest sets the SMSTemplateRequest field's value.

func (*CreateSmsTemplateInput) SetTemplateName ¶

func (s *CreateSmsTemplateInput) SetTemplateName(v string) *CreateSmsTemplateInput

SetTemplateName sets the TemplateName field's value.

func (CreateSmsTemplateInput) String ¶

func (s CreateSmsTemplateInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateSmsTemplateInput) Validate ¶

func (s *CreateSmsTemplateInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateSmsTemplateOutput ¶

type CreateSmsTemplateOutput struct {

    // Provides information about a request to create a message template.
    //
    // CreateTemplateMessageBody is a required field
    CreateTemplateMessageBody *CreateTemplateMessageBody `type:"structure" required:"true"`
    // contains filtered or unexported fields
}

func (CreateSmsTemplateOutput) GoString ¶

func (s CreateSmsTemplateOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateSmsTemplateOutput) SetCreateTemplateMessageBody ¶

func (s *CreateSmsTemplateOutput) SetCreateTemplateMessageBody(v *CreateTemplateMessageBody) *CreateSmsTemplateOutput

SetCreateTemplateMessageBody sets the CreateTemplateMessageBody field's value.

func (CreateSmsTemplateOutput) String ¶

func (s CreateSmsTemplateOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateTemplateMessageBody ¶

type CreateTemplateMessageBody struct {

    // The Amazon Resource Name (ARN) of the message template that was created.
    Arn *string `type:"string"`

    // The message that's returned from the API for the request to create the message
    // template.
    Message *string `type:"string"`

    // The unique identifier for the request to create the message template.
    RequestID *string `type:"string"`
    // contains filtered or unexported fields
}

Provides information about a request to create a message template.

func (CreateTemplateMessageBody) GoString ¶

func (s CreateTemplateMessageBody) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateTemplateMessageBody) SetArn ¶

func (s *CreateTemplateMessageBody) SetArn(v string) *CreateTemplateMessageBody

SetArn sets the Arn field's value.

func (*CreateTemplateMessageBody) SetMessage ¶

func (s *CreateTemplateMessageBody) SetMessage(v string) *CreateTemplateMessageBody

SetMessage sets the Message field's value.

func (*CreateTemplateMessageBody) SetRequestID ¶

func (s *CreateTemplateMessageBody) SetRequestID(v string) *CreateTemplateMessageBody

SetRequestID sets the RequestID field's value.

func (CreateTemplateMessageBody) String ¶

func (s CreateTemplateMessageBody) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateVoiceTemplateInput ¶

type CreateVoiceTemplateInput struct {

    // TemplateName is a required field
    TemplateName *string `location:"uri" locationName:"template-name" type:"string" required:"true"`

    // Specifies the content and settings for a message template that can be used
    // in messages that are sent through the voice channel.
    //
    // VoiceTemplateRequest is a required field
    VoiceTemplateRequest *VoiceTemplateRequest `type:"structure" required:"true"`
    // contains filtered or unexported fields
}

func (CreateVoiceTemplateInput) GoString ¶

func (s CreateVoiceTemplateInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateVoiceTemplateInput) SetTemplateName ¶

func (s *CreateVoiceTemplateInput) SetTemplateName(v string) *CreateVoiceTemplateInput

SetTemplateName sets the TemplateName field's value.

func (*CreateVoiceTemplateInput) SetVoiceTemplateRequest ¶

func (s *CreateVoiceTemplateInput) SetVoiceTemplateRequest(v *VoiceTemplateRequest) *CreateVoiceTemplateInput

SetVoiceTemplateRequest sets the VoiceTemplateRequest field's value.

func (CreateVoiceTemplateInput) String ¶

func (s CreateVoiceTemplateInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateVoiceTemplateInput) Validate ¶

func (s *CreateVoiceTemplateInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateVoiceTemplateOutput ¶

type CreateVoiceTemplateOutput struct {

    // Provides information about a request to create a message template.
    //
    // CreateTemplateMessageBody is a required field
    CreateTemplateMessageBody *CreateTemplateMessageBody `type:"structure" required:"true"`
    // contains filtered or unexported fields
}

func (CreateVoiceTemplateOutput) GoString ¶

func (s CreateVoiceTemplateOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateVoiceTemplateOutput) SetCreateTemplateMessageBody ¶

func (s *CreateVoiceTemplateOutput) SetCreateTemplateMessageBody(v *CreateTemplateMessageBody) *CreateVoiceTemplateOutput

SetCreateTemplateMessageBody sets the CreateTemplateMessageBody field's value.

func (CreateVoiceTemplateOutput) String ¶

func (s CreateVoiceTemplateOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CustomDeliveryConfiguration ¶

type CustomDeliveryConfiguration struct {

    // The destination to send the campaign or treatment to. This value can be one
    // of the following:
    //
    //    * The name or Amazon Resource Name (ARN) of an AWS Lambda function to
    //    invoke to handle delivery of the campaign or treatment.
    //
    //    * The URL for a web application or service that supports HTTPS and can
    //    receive the message. The URL has to be a full URL, including the HTTPS
    //    protocol.
    //
    // DeliveryUri is a required field
    DeliveryUri *string `type:"string" required:"true"`

    // The types of endpoints to send the campaign or treatment to. Each valid value
    // maps to a type of channel that you can associate with an endpoint by using
    // the ChannelType property of an endpoint.
    EndpointTypes []*string `type:"list"`
    // contains filtered or unexported fields
}

Specifies the delivery configuration settings for sending a campaign or campaign treatment through a custom channel. This object is required if you use the CampaignCustomMessage object to define the message to send for the campaign or campaign treatment.

func (CustomDeliveryConfiguration) GoString ¶

func (s CustomDeliveryConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CustomDeliveryConfiguration) SetDeliveryUri ¶

func (s *CustomDeliveryConfiguration) SetDeliveryUri(v string) *CustomDeliveryConfiguration

SetDeliveryUri sets the DeliveryUri field's value.

func (*CustomDeliveryConfiguration) SetEndpointTypes ¶

func (s *CustomDeliveryConfiguration) SetEndpointTypes(v []*string) *CustomDeliveryConfiguration

SetEndpointTypes sets the EndpointTypes field's value.

func (CustomDeliveryConfiguration) String ¶

func (s CustomDeliveryConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CustomDeliveryConfiguration) Validate ¶

func (s *CustomDeliveryConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CustomMessageActivity ¶

type CustomMessageActivity struct {

    // The destination to send the campaign or treatment to. This value can be one
    // of the following:
    //
    //    * The name or Amazon Resource Name (ARN) of an AWS Lambda function to
    //    invoke to handle delivery of the campaign or treatment.
    //
    //    * The URL for a web application or service that supports HTTPS and can
    //    receive the message. The URL has to be a full URL, including the HTTPS
    //    protocol.
    DeliveryUri *string `type:"string"`

    // The types of endpoints to send the custom message to. Each valid value maps
    // to a type of channel that you can associate with an endpoint by using the
    // ChannelType property of an endpoint.
    EndpointTypes []*string `type:"list"`

    // Specifies the message data included in a custom channel message that's sent
    // to participants in a journey.
    MessageConfig *JourneyCustomMessage `type:"structure"`

    // The unique identifier for the next activity to perform, after Amazon Pinpoint
    // calls the AWS Lambda function or web hook.
    NextActivity *string `type:"string"`

    // The name of the custom message template to use for the message. If specified,
    // this value must match the name of an existing message template.
    TemplateName *string `type:"string"`

    // The unique identifier for the version of the message template to use for
    // the message. If specified, this value must match the identifier for an existing
    // template version. To retrieve a list of versions and version identifiers
    // for a template, use the Template Versions resource.
    //
    // If you don't specify a value for this property, Amazon Pinpoint uses the
    // active version of the template. The active version is typically the version
    // of a template that's been most recently reviewed and approved for use, depending
    // on your workflow. It isn't necessarily the latest version of a template.
    TemplateVersion *string `type:"string"`
    // contains filtered or unexported fields
}

The settings for a custom message activity. This type of activity calls an AWS Lambda function or web hook that sends messages to participants.

func (CustomMessageActivity) GoString ¶

func (s CustomMessageActivity) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CustomMessageActivity) SetDeliveryUri ¶

func (s *CustomMessageActivity) SetDeliveryUri(v string) *CustomMessageActivity

SetDeliveryUri sets the DeliveryUri field's value.

func (*CustomMessageActivity) SetEndpointTypes ¶

func (s *CustomMessageActivity) SetEndpointTypes(v []*string) *CustomMessageActivity

SetEndpointTypes sets the EndpointTypes field's value.

func (*CustomMessageActivity) SetMessageConfig ¶

func (s *CustomMessageActivity) SetMessageConfig(v *JourneyCustomMessage) *CustomMessageActivity

SetMessageConfig sets the MessageConfig field's value.

func (*CustomMessageActivity) SetNextActivity ¶

func (s *CustomMessageActivity) SetNextActivity(v string) *CustomMessageActivity

SetNextActivity sets the NextActivity field's value.

func (*CustomMessageActivity) SetTemplateName ¶

func (s *CustomMessageActivity) SetTemplateName(v string) *CustomMessageActivity

SetTemplateName sets the TemplateName field's value.

func (*CustomMessageActivity) SetTemplateVersion ¶

func (s *CustomMessageActivity) SetTemplateVersion(v string) *CustomMessageActivity

SetTemplateVersion sets the TemplateVersion field's value.

func (CustomMessageActivity) String ¶

func (s CustomMessageActivity) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DefaultButtonConfiguration ¶

type DefaultButtonConfiguration struct {

    // The background color of the button.
    BackgroundColor *string `type:"string"`

    // The border radius of the button.
    BorderRadius *int64 `type:"integer"`

    // Action triggered by the button.
    //
    // ButtonAction is a required field
    ButtonAction *string `type:"string" required:"true" enum:"ButtonAction"`

    // Button destination.
    Link *string `type:"string"`

    // Button text.
    //
    // Text is a required field
    Text *string `type:"string" required:"true"`

    // The text color of the button.
    TextColor *string `type:"string"`
    // contains filtered or unexported fields
}

Default button configuration.

func (DefaultButtonConfiguration) GoString ¶

func (s DefaultButtonConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DefaultButtonConfiguration) SetBackgroundColor ¶

func (s *DefaultButtonConfiguration) SetBackgroundColor(v string) *DefaultButtonConfiguration

SetBackgroundColor sets the BackgroundColor field's value.

func (*DefaultButtonConfiguration) SetBorderRadius ¶

func (s *DefaultButtonConfiguration) SetBorderRadius(v int64) *DefaultButtonConfiguration

SetBorderRadius sets the BorderRadius field's value.

func (*DefaultButtonConfiguration) SetButtonAction ¶

func (s *DefaultButtonConfiguration) SetButtonAction(v string) *DefaultButtonConfiguration

SetButtonAction sets the ButtonAction field's value.

func (*DefaultButtonConfiguration) SetLink ¶

func (s *DefaultButtonConfiguration) SetLink(v string) *DefaultButtonConfiguration

SetLink sets the Link field's value.

func (*DefaultButtonConfiguration) SetText ¶

func (s *DefaultButtonConfiguration) SetText(v string) *DefaultButtonConfiguration

SetText sets the Text field's value.

func (*DefaultButtonConfiguration) SetTextColor ¶

func (s *DefaultButtonConfiguration) SetTextColor(v string) *DefaultButtonConfiguration

SetTextColor sets the TextColor field's value.

func (DefaultButtonConfiguration) String ¶

func (s DefaultButtonConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DefaultButtonConfiguration) Validate ¶

func (s *DefaultButtonConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DefaultMessage ¶

type DefaultMessage struct {

    // The default body of the message.
    Body *string `type:"string"`

    // The default message variables to use in the message. You can override these
    // default variables with individual address variables.
    Substitutions map[string][]*string `type:"map"`
    // contains filtered or unexported fields
}

Specifies the default message for all channels.

func (DefaultMessage) GoString ¶

func (s DefaultMessage) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DefaultMessage) SetBody ¶

func (s *DefaultMessage) SetBody(v string) *DefaultMessage

SetBody sets the Body field's value.

func (*DefaultMessage) SetSubstitutions ¶

func (s *DefaultMessage) SetSubstitutions(v map[string][]*string) *DefaultMessage

SetSubstitutions sets the Substitutions field's value.

func (DefaultMessage) String ¶

func (s DefaultMessage) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DefaultPushNotificationMessage ¶

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 ¶

func (s DefaultPushNotificationMessage) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DefaultPushNotificationMessage) SetAction ¶

func (s *DefaultPushNotificationMessage) SetAction(v string) *DefaultPushNotificationMessage

SetAction sets the Action field's value.

func (*DefaultPushNotificationMessage) SetBody ¶

func (s *DefaultPushNotificationMessage) SetBody(v string) *DefaultPushNotificationMessage

SetBody sets the Body field's value.

func (*DefaultPushNotificationMessage) SetData ¶

func (s *DefaultPushNotificationMessage) SetData(v map[string]*string) *DefaultPushNotificationMessage

SetData sets the Data field's value.

func (*DefaultPushNotificationMessage) SetSilentPush ¶

func (s *DefaultPushNotificationMessage) SetSilentPush(v bool) *DefaultPushNotificationMessage

SetSilentPush sets the SilentPush field's value.

func (*DefaultPushNotificationMessage) SetSubstitutions ¶

func (s *DefaultPushNotificationMessage) SetSubstitutions(v map[string][]*string) *DefaultPushNotificationMessage

SetSubstitutions sets the Substitutions field's value.

func (*DefaultPushNotificationMessage) SetTitle ¶

func (s *DefaultPushNotificationMessage) SetTitle(v string) *DefaultPushNotificationMessage

SetTitle sets the Title field's value.

func (*DefaultPushNotificationMessage) SetUrl ¶

func (s *DefaultPushNotificationMessage) SetUrl(v string) *DefaultPushNotificationMessage

SetUrl sets the Url field's value.

func (DefaultPushNotificationMessage) String ¶

func (s DefaultPushNotificationMessage) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DefaultPushNotificationTemplate ¶

type DefaultPushNotificationTemplate struct {

    // The action to occur if a recipient taps a push notification that's based
    // on the message template. Valid values are:
    //
    //    * OPEN_APP - Your app opens or it becomes the foreground app if it was
    //    sent to the background. This is the default action.
    //
    //    * DEEP_LINK - Your app opens and displays a designated user interface
    //    in the app. This setting uses the deep-linking features of the iOS and
    //    Android platforms.
    //
    //    * URL - The default mobile browser on the recipient's device opens and
    //    loads the web page at a URL that you specify.
    Action *string `type:"string" enum:"Action"`

    // The message body to use in push notifications that are based on the message
    // template.
    Body *string `type:"string"`

    // The sound to play when a recipient receives a push notification that's based
    // on the message template. You can use the default stream or specify the file
    // name of a sound resource that's bundled in your app. On an Android platform,
    // the sound file must reside in /res/raw/.
    //
    // For an iOS platform, this value is the key for the name of a sound file in
    // your app's main bundle or the Library/Sounds folder in your app's data container.
    // If the sound file can't be found or you specify default for the value, the
    // system plays the default alert sound.
    Sound *string `type:"string"`

    // The title to use in push notifications that are based on the message template.
    // This title appears above the notification message on a recipient's device.
    Title *string `type:"string"`

    // The URL to open in a recipient's default mobile browser, if a recipient taps
    // a push notification that's based on the message template and the value of
    // the Action property is URL.
    Url *string `type:"string"`
    // contains filtered or unexported fields
}

Specifies the default settings and content for a message template that can be used in messages that are sent through a push notification channel.

func (DefaultPushNotificationTemplate) GoString ¶

func (s DefaultPushNotificationTemplate) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DefaultPushNotificationTemplate) SetAction ¶

func (s *DefaultPushNotificationTemplate) SetAction(v string) *DefaultPushNotificationTemplate

SetAction sets the Action field's value.

func (*DefaultPushNotificationTemplate) SetBody ¶

func (s *DefaultPushNotificationTemplate) SetBody(v string) *DefaultPushNotificationTemplate

SetBody sets the Body field's value.

func (*DefaultPushNotificationTemplate) SetSound ¶

func (s *DefaultPushNotificationTemplate) SetSound(v string) *DefaultPushNotificationTemplate

SetSound sets the Sound field's value.

func (*DefaultPushNotificationTemplate) SetTitle ¶

func (s *DefaultPushNotificationTemplate) SetTitle(v string) *DefaultPushNotificationTemplate

SetTitle sets the Title field's value.

func (*DefaultPushNotificationTemplate) SetUrl ¶

func (s *DefaultPushNotificationTemplate) SetUrl(v string) *DefaultPushNotificationTemplate

SetUrl sets the Url field's value.

func (DefaultPushNotificationTemplate) String ¶

func (s DefaultPushNotificationTemplate) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteAdmChannelInput ¶

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 ¶

func (s DeleteAdmChannelInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteAdmChannelInput) SetApplicationId ¶

func (s *DeleteAdmChannelInput) SetApplicationId(v string) *DeleteAdmChannelInput

SetApplicationId sets the ApplicationId field's value.

func (DeleteAdmChannelInput) String ¶

func (s DeleteAdmChannelInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteAdmChannelInput) Validate ¶

func (s *DeleteAdmChannelInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteAdmChannelOutput ¶

type DeleteAdmChannelOutput struct {

    // Provides information about the status and settings of the ADM (Amazon Device
    // Messaging) channel for an application.
    //
    // ADMChannelResponse is a required field
    ADMChannelResponse *ADMChannelResponse `type:"structure" required:"true"`
    // contains filtered or unexported fields
}

func (DeleteAdmChannelOutput) GoString ¶

func (s DeleteAdmChannelOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteAdmChannelOutput) SetADMChannelResponse ¶

func (s *DeleteAdmChannelOutput) SetADMChannelResponse(v *ADMChannelResponse) *DeleteAdmChannelOutput

SetADMChannelResponse sets the ADMChannelResponse field's value.

func (DeleteAdmChannelOutput) String ¶

func (s DeleteAdmChannelOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteApnsChannelInput ¶

type DeleteApnsChannelInput struct {

    // ApplicationId is a required field
    ApplicationId *string `location:"uri" locationName:"application-id" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (DeleteApnsChannelInput) GoString ¶

func (s DeleteApnsChannelInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteApnsChannelInput) SetApplicationId ¶

func (s *DeleteApnsChannelInput) SetApplicationId(v string) *DeleteApnsChannelInput

SetApplicationId sets the ApplicationId field's value.

func (DeleteApnsChannelInput) String ¶

func (s DeleteApnsChannelInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteApnsChannelInput) Validate ¶

func (s *DeleteApnsChannelInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteApnsChannelOutput ¶

type DeleteApnsChannelOutput struct {

    // Provides information about the status and settings of the APNs (Apple Push
    // Notification service) channel for an application.
    //
    // APNSChannelResponse is a required field
    APNSChannelResponse *APNSChannelResponse `type:"structure" required:"true"`
    // contains filtered or unexported fields
}