@datafire/amazonaws_pinpoint v5.0.0

@datafire/amazonaws_pinpoint

Client library for Amazon Pinpoint

Installation and Usage

npm install --save @datafire/amazonaws_pinpoint

let amazonaws_pinpoint = require('@datafire/amazonaws_pinpoint').create({
  accessKeyId: "",
  secretAccessKey: "",
  region: ""
});

amazonaws_pinpoint.GetApps({}).then(data => {
  console.log(data);
});

Description

Actions

GetApps

amazonaws_pinpoint.GetApps({}, context)

Input

• input object

Output

• output GetAppsResponse

CreateApp

amazonaws_pinpoint.CreateApp({
  "CreateApplicationRequest": {}
}, context)

Input

• input object
  • CreateApplicationRequest required CreateApplicationRequest

Output

Output schema unknown

DeleteApp

amazonaws_pinpoint.DeleteApp({
  "application-id": ""
}, context)

Input

• input object
  • application-id required string

Output

• output DeleteAppResponse

GetApp

amazonaws_pinpoint.GetApp({
  "application-id": ""
}, context)

Input

• input object
  • application-id required string

Output

• output GetAppResponse

GetCampaigns

amazonaws_pinpoint.GetCampaigns({
  "application-id": ""
}, context)

Input

• input object
  • application-id required string

Output

• output GetCampaignsResponse

CreateCampaign

amazonaws_pinpoint.CreateCampaign({
  "application-id": "",
  "WriteCampaignRequest": {}
}, context)

Input

• input object
  • application-id required string
  • WriteCampaignRequest required WriteCampaignRequest

Output

Output schema unknown

DeleteCampaign

amazonaws_pinpoint.DeleteCampaign({
  "application-id": "",
  "campaign-id": ""
}, context)

Input

• input object
  • application-id required string
  • campaign-id required string

Output

• output DeleteCampaignResponse

GetCampaign

amazonaws_pinpoint.GetCampaign({
  "application-id": "",
  "campaign-id": ""
}, context)

Input

• input object
  • application-id required string
  • campaign-id required string

Output

• output GetCampaignResponse

UpdateCampaign

amazonaws_pinpoint.UpdateCampaign({
  "application-id": "",
  "campaign-id": "",
  "WriteCampaignRequest": {}
}, context)

Input

• input object
  • application-id required string
  • campaign-id required string
  • WriteCampaignRequest required WriteCampaignRequest

Output

• output UpdateCampaignResponse

GetCampaignActivities

amazonaws_pinpoint.GetCampaignActivities({
  "application-id": "",
  "campaign-id": ""
}, context)

Input

• input object
  • application-id required string
  • campaign-id required string

Output

• output GetCampaignActivitiesResponse

GetCampaignVersions

amazonaws_pinpoint.GetCampaignVersions({
  "application-id": "",
  "campaign-id": ""
}, context)

Input

• input object
  • application-id required string
  • campaign-id required string

Output

• output GetCampaignVersionsResponse

GetCampaignVersion

amazonaws_pinpoint.GetCampaignVersion({
  "application-id": "",
  "campaign-id": "",
  "version": ""
}, context)

Input

• input object
  • application-id required string
  • campaign-id required string
  • version required string

Output

• output GetCampaignVersionResponse

DeleteAdmChannel

amazonaws_pinpoint.DeleteAdmChannel({
  "application-id": ""
}, context)

Input

• input object
  • application-id required string

Output

• output DeleteAdmChannelResponse

GetAdmChannel

amazonaws_pinpoint.GetAdmChannel({
  "application-id": ""
}, context)

Input

• input object
  • application-id required string

Output

• output GetAdmChannelResponse

UpdateAdmChannel

amazonaws_pinpoint.UpdateAdmChannel({
  "application-id": "",
  "ADMChannelRequest": {}
}, context)

Input

• input object
  • application-id required string
  • ADMChannelRequest required ADMChannelRequest

Output

• output UpdateAdmChannelResponse

DeleteApnsChannel

amazonaws_pinpoint.DeleteApnsChannel({
  "application-id": ""
}, context)

Input

• input object
  • application-id required string

Output

• output DeleteApnsChannelResponse

GetApnsChannel

amazonaws_pinpoint.GetApnsChannel({
  "application-id": ""
}, context)

Input

• input object
  • application-id required string

Output

• output GetApnsChannelResponse

UpdateApnsChannel

amazonaws_pinpoint.UpdateApnsChannel({
  "application-id": "",
  "APNSChannelRequest": {}
}, context)

Input

• input object
  • application-id required string
  • APNSChannelRequest required APNSChannelRequest

Output

• output UpdateApnsChannelResponse

DeleteApnsSandboxChannel

amazonaws_pinpoint.DeleteApnsSandboxChannel({
  "application-id": ""
}, context)

Input

• input object
  • application-id required string

Output

• output DeleteApnsSandboxChannelResponse

GetApnsSandboxChannel

amazonaws_pinpoint.GetApnsSandboxChannel({
  "application-id": ""
}, context)

Input

• input object
  • application-id required string

Output

• output GetApnsSandboxChannelResponse

UpdateApnsSandboxChannel

amazonaws_pinpoint.UpdateApnsSandboxChannel({
  "application-id": "",
  "APNSSandboxChannelRequest": {}
}, context)

Input

• input object
  • application-id required string
  • APNSSandboxChannelRequest required APNSSandboxChannelRequest

Output

• output UpdateApnsSandboxChannelResponse

DeleteApnsVoipChannel

amazonaws_pinpoint.DeleteApnsVoipChannel({
  "application-id": ""
}, context)

Input

• input object
  • application-id required string

Output

• output DeleteApnsVoipChannelResponse

GetApnsVoipChannel

amazonaws_pinpoint.GetApnsVoipChannel({
  "application-id": ""
}, context)

Input

• input object
  • application-id required string

Output

• output GetApnsVoipChannelResponse

UpdateApnsVoipChannel

amazonaws_pinpoint.UpdateApnsVoipChannel({
  "application-id": "",
  "APNSVoipChannelRequest": {}
}, context)

Input

• input object
  • application-id required string
  • APNSVoipChannelRequest required APNSVoipChannelRequest

Output

• output UpdateApnsVoipChannelResponse

DeleteApnsVoipSandboxChannel

amazonaws_pinpoint.DeleteApnsVoipSandboxChannel({
  "application-id": ""
}, context)

Input

• input object
  • application-id required string

Output

• output DeleteApnsVoipSandboxChannelResponse

GetApnsVoipSandboxChannel

amazonaws_pinpoint.GetApnsVoipSandboxChannel({
  "application-id": ""
}, context)

Input

• input object
  • application-id required string

Output

• output GetApnsVoipSandboxChannelResponse

UpdateApnsVoipSandboxChannel

amazonaws_pinpoint.UpdateApnsVoipSandboxChannel({
  "application-id": "",
  "APNSVoipSandboxChannelRequest": {}
}, context)

Input

• input object
  • application-id required string
  • APNSVoipSandboxChannelRequest required APNSVoipSandboxChannelRequest

Output

• output UpdateApnsVoipSandboxChannelResponse

DeleteBaiduChannel

amazonaws_pinpoint.DeleteBaiduChannel({
  "application-id": ""
}, context)

Input

• input object
  • application-id required string

Output

• output DeleteBaiduChannelResponse

GetBaiduChannel

amazonaws_pinpoint.GetBaiduChannel({
  "application-id": ""
}, context)

Input

• input object
  • application-id required string

Output

• output GetBaiduChannelResponse

UpdateBaiduChannel

amazonaws_pinpoint.UpdateBaiduChannel({
  "application-id": "",
  "BaiduChannelRequest": {}
}, context)

Input

• input object
  • application-id required string
  • BaiduChannelRequest required BaiduChannelRequest

Output

• output UpdateBaiduChannelResponse

DeleteEmailChannel

amazonaws_pinpoint.DeleteEmailChannel({
  "application-id": ""
}, context)

Input

• input object
  • application-id required string

Output

• output DeleteEmailChannelResponse

GetEmailChannel

amazonaws_pinpoint.GetEmailChannel({
  "application-id": ""
}, context)

Input

• input object
  • application-id required string

Output

• output GetEmailChannelResponse

UpdateEmailChannel

amazonaws_pinpoint.UpdateEmailChannel({
  "application-id": "",
  "EmailChannelRequest": {}
}, context)

Input

• input object
  • application-id required string
  • EmailChannelRequest required EmailChannelRequest

Output

• output UpdateEmailChannelResponse

DeleteGcmChannel

amazonaws_pinpoint.DeleteGcmChannel({
  "application-id": ""
}, context)

Input

• input object
  • application-id required string

Output

• output DeleteGcmChannelResponse

GetGcmChannel

amazonaws_pinpoint.GetGcmChannel({
  "application-id": ""
}, context)

Input

• input object
  • application-id required string

Output

• output GetGcmChannelResponse

UpdateGcmChannel

amazonaws_pinpoint.UpdateGcmChannel({
  "application-id": "",
  "GCMChannelRequest": {}
}, context)

Input

• input object
  • application-id required string
  • GCMChannelRequest required GCMChannelRequest

Output

• output UpdateGcmChannelResponse

DeleteSmsChannel

amazonaws_pinpoint.DeleteSmsChannel({
  "application-id": ""
}, context)

Input

• input object
  • application-id required string

Output

• output DeleteSmsChannelResponse

GetSmsChannel

amazonaws_pinpoint.GetSmsChannel({
  "application-id": ""
}, context)

Input

• input object
  • application-id required string

Output

• output GetSmsChannelResponse

UpdateSmsChannel

amazonaws_pinpoint.UpdateSmsChannel({
  "application-id": "",
  "SMSChannelRequest": {}
}, context)

Input

• input object
  • application-id required string
  • SMSChannelRequest required SMSChannelRequest

Output

• output UpdateSmsChannelResponse

UpdateEndpointsBatch

amazonaws_pinpoint.UpdateEndpointsBatch({
  "application-id": "",
  "EndpointBatchRequest": {}
}, context)

Input

• input object
  • application-id required string
  • EndpointBatchRequest required EndpointBatchRequest

Output

Output schema unknown

GetEndpoint

amazonaws_pinpoint.GetEndpoint({
  "application-id": "",
  "endpoint-id": ""
}, context)

Input

• input object
  • application-id required string
  • endpoint-id required string

Output

• output GetEndpointResponse

UpdateEndpoint

amazonaws_pinpoint.UpdateEndpoint({
  "application-id": "",
  "endpoint-id": "",
  "EndpointRequest": {}
}, context)

Input

• input object
  • application-id required string
  • endpoint-id required string
  • EndpointRequest required EndpointRequest

Output

Output schema unknown

DeleteEventStream

amazonaws_pinpoint.DeleteEventStream({
  "application-id": ""
}, context)

Input

• input object
  • application-id required string

Output

• output DeleteEventStreamResponse

GetEventStream

amazonaws_pinpoint.GetEventStream({
  "application-id": ""
}, context)

Input

• input object
  • application-id required string

Output

• output GetEventStreamResponse

PutEventStream

amazonaws_pinpoint.PutEventStream({
  "application-id": "",
  "WriteEventStream": {}
}, context)

Input

• input object
  • application-id required string
  • WriteEventStream required WriteEventStream

Output

• output PutEventStreamResponse

GetImportJobs

amazonaws_pinpoint.GetImportJobs({
  "application-id": ""
}, context)

Input

• input object
  • application-id required string

Output

• output GetImportJobsResponse

CreateImportJob

amazonaws_pinpoint.CreateImportJob({
  "application-id": "",
  "ImportJobRequest": {}
}, context)

Input

• input object
  • application-id required string
  • ImportJobRequest required ImportJobRequest

Output

Output schema unknown

GetImportJob

amazonaws_pinpoint.GetImportJob({
  "application-id": "",
  "job-id": ""
}, context)

Input

• input object
  • application-id required string
  • job-id required string

Output

• output GetImportJobResponse

SendMessages

amazonaws_pinpoint.SendMessages({
  "application-id": "",
  "MessageRequest": {}
}, context)

Input

• input object
  • application-id required string
  • MessageRequest required MessageRequest

Output

• output SendMessagesResponse

GetSegments

amazonaws_pinpoint.GetSegments({
  "application-id": ""
}, context)

Input

• input object
  • application-id required string

Output

• output GetSegmentsResponse

CreateSegment

amazonaws_pinpoint.CreateSegment({
  "application-id": "",
  "WriteSegmentRequest": {}
}, context)

Input

• input object
  • application-id required string
  • WriteSegmentRequest required WriteSegmentRequest

Output

Output schema unknown

DeleteSegment

amazonaws_pinpoint.DeleteSegment({
  "application-id": "",
  "segment-id": ""
}, context)

Input

• input object
  • application-id required string
  • segment-id required string

Output

• output DeleteSegmentResponse

GetSegment

amazonaws_pinpoint.GetSegment({
  "application-id": "",
  "segment-id": ""
}, context)

Input

• input object
  • application-id required string
  • segment-id required string

Output

• output GetSegmentResponse

UpdateSegment

amazonaws_pinpoint.UpdateSegment({
  "application-id": "",
  "segment-id": "",
  "WriteSegmentRequest": {}
}, context)

Input

• input object
  • application-id required string
  • segment-id required string
  • WriteSegmentRequest required WriteSegmentRequest

Output

• output UpdateSegmentResponse

GetSegmentImportJobs

amazonaws_pinpoint.GetSegmentImportJobs({
  "application-id": "",
  "segment-id": ""
}, context)

Input

• input object
  • application-id required string
  • segment-id required string

Output

• output GetSegmentImportJobsResponse

GetSegmentVersions

amazonaws_pinpoint.GetSegmentVersions({
  "application-id": "",
  "segment-id": ""
}, context)

Input

• input object
  • application-id required string
  • segment-id required string

Output

• output GetSegmentVersionsResponse

GetSegmentVersion

amazonaws_pinpoint.GetSegmentVersion({
  "application-id": "",
  "segment-id": "",
  "version": ""
}, context)

Input

• input object
  • application-id required string
  • segment-id required string
  • version required string

Output

• output GetSegmentVersionResponse

GetApplicationSettings

amazonaws_pinpoint.GetApplicationSettings({
  "application-id": ""
}, context)

Input

• input object
  • application-id required string

Output

• output GetApplicationSettingsResponse

UpdateApplicationSettings

amazonaws_pinpoint.UpdateApplicationSettings({
  "application-id": "",
  "WriteApplicationSettingsRequest": {}
}, context)

Input

• input object
  • application-id required string
  • WriteApplicationSettingsRequest required WriteApplicationSettingsRequest

Output

• output UpdateApplicationSettingsResponse

SendUsersMessages

amazonaws_pinpoint.SendUsersMessages({
  "application-id": "",
  "SendUsersMessageRequest": {}
}, context)

Input

• input object
  • application-id required string
  • SendUsersMessageRequest required SendUsersMessageRequest

Output

• output SendUsersMessagesResponse

Definitions

ADMChannelRequest

• ADMChannelRequest object: Amazon Device Messaging channel definition.
  • ClientId __string
  • ClientSecret __string
  • Enabled __boolean

ADMChannelResponse

• ADMChannelResponse object: Amazon Device Messaging channel definition.
  • ApplicationId __string
  • CreationDate __string
  • Enabled __boolean
  • HasCredential __boolean
  • Id __string
  • IsArchived __boolean
  • LastModifiedBy __string
  • LastModifiedDate __string
  • Platform __string
  • Version __integer

ADMMessage

• ADMMessage object: ADM Message.
  • Action Action
  • Body __string
  • ConsolidationKey __string
  • Data MapOf__string
  • ExpiresAfter __string
  • IconReference __string
  • ImageIconUrl __string
  • ImageUrl __string
  • MD5 __string
  • RawContent __string
  • SilentPush __boolean
  • SmallImageIconUrl __string
  • Sound __string
  • Substitutions MapOfListOf__string
  • Title __string
  • Url __string

APNSChannelRequest

• APNSChannelRequest object: Apple Push Notification Service channel definition.
  • BundleId __string
  • Certificate __string
  • DefaultAuthenticationMethod __string
  • Enabled __boolean
  • PrivateKey __string
  • TeamId __string
  • TokenKey __string
  • TokenKeyId __string

APNSChannelResponse

• APNSChannelResponse object: Apple Distribution Push Notification Service channel definition.
  • ApplicationId __string
  • CreationDate __string
  • DefaultAuthenticationMethod __string
  • Enabled __boolean
  • HasCredential __boolean
  • HasTokenKey __boolean
  • Id __string
  • IsArchived __boolean
  • LastModifiedBy __string
  • LastModifiedDate __string
  • Platform __string
  • Version __integer

APNSMessage

• APNSMessage object: APNS Message.
  • Action Action
  • Badge __integer
  • Body __string
  • Category __string
  • CollapseId __string
  • Data MapOf__string
  • MediaUrl __string
  • PreferredAuthenticationMethod __string
  • Priority __string
  • RawContent __string
  • SilentPush __boolean
  • Sound __string
  • Substitutions MapOfListOf__string
  • ThreadId __string
  • TimeToLive __integer
  • Title __string
  • Url __string

APNSSandboxChannelRequest

• APNSSandboxChannelRequest object: Apple Development Push Notification Service channel definition.
  • BundleId __string
  • Certificate __string
  • DefaultAuthenticationMethod __string
  • Enabled __boolean
  • PrivateKey __string
  • TeamId __string
  • TokenKey __string
  • TokenKeyId __string

APNSSandboxChannelResponse

• APNSSandboxChannelResponse object: Apple Development Push Notification Service channel definition.
  • ApplicationId __string
  • CreationDate __string
  • DefaultAuthenticationMethod __string
  • Enabled __boolean
  • HasCredential __boolean
  • HasTokenKey __boolean
  • Id __string
  • IsArchived __boolean
  • LastModifiedBy __string
  • LastModifiedDate __string
  • Platform __string
  • Version __integer

APNSVoipChannelRequest

• APNSVoipChannelRequest object: Apple VoIP Push Notification Service channel definition.
  • BundleId __string
  • Certificate __string
  • DefaultAuthenticationMethod __string
  • Enabled __boolean
  • PrivateKey __string
  • TeamId __string
  • TokenKey __string
  • TokenKeyId __string

APNSVoipChannelResponse

• APNSVoipChannelResponse object: Apple VoIP Push Notification Service channel definition.
  • ApplicationId __string
  • CreationDate __string
  • DefaultAuthenticationMethod __string
  • Enabled __boolean
  • HasCredential __boolean
  • HasTokenKey __boolean
  • Id __string
  • IsArchived __boolean
  • LastModifiedBy __string
  • LastModifiedDate __string
  • Platform __string
  • Version __integer

APNSVoipSandboxChannelRequest

• APNSVoipSandboxChannelRequest object: Apple VoIP Developer Push Notification Service channel definition.
  • BundleId __string
  • Certificate __string
  • DefaultAuthenticationMethod __string
  • Enabled __boolean
  • PrivateKey __string
  • TeamId __string
  • TokenKey __string
  • TokenKeyId __string

APNSVoipSandboxChannelResponse

• APNSVoipSandboxChannelResponse object: Apple VoIP Developer Push Notification Service channel definition.
  • ApplicationId __string
  • CreationDate __string
  • DefaultAuthenticationMethod __string
  • Enabled __boolean
  • HasCredential __boolean
  • HasTokenKey __boolean
  • Id __string
  • IsArchived __boolean
  • LastModifiedBy __string
  • LastModifiedDate __string
  • Platform __string
  • Version __integer

Action

• Action string (values: OPEN_APP, DEEP_LINK, URL)

ActivitiesResponse

• ActivitiesResponse object: Activities for campaign.
  • Item ListOfActivityResponse

ActivityResponse

• ActivityResponse object: Activity definition
  • ApplicationId __string
  • CampaignId __string
  • End __string
  • Id __string
  • Result __string
  • ScheduledStart __string
  • Start __string
  • State __string
  • SuccessfulEndpointCount __integer
  • TimezonesCompletedCount __integer
  • TimezonesTotalCount __integer
  • TotalEndpointCount __integer
  • TreatmentId __string

AddressConfiguration

• AddressConfiguration object: Address configuration.
  • BodyOverride __string
  • ChannelType ChannelType
  • Context MapOf__string
  • RawContent __string
  • Substitutions MapOfListOf__string
  • TitleOverride __string

ApplicationResponse

• ApplicationResponse object: Application Response.
  • Id __string
  • Name __string

ApplicationSettingsResource

• ApplicationSettingsResource object: Application settings.
  • ApplicationId __string
  • LastModifiedDate __string
  • Limits CampaignLimits
  • QuietTime QuietTime

ApplicationsResponse

• ApplicationsResponse object: Get Applications Result.
  • Item ListOfApplicationResponse
  • NextToken __string

AttributeDimension

• AttributeDimension object: Custom attibute dimension
  • AttributeType AttributeType
  • Values ListOf__string

AttributeType

• AttributeType string (values: INCLUSIVE, EXCLUSIVE)

BadRequestException

• BadRequestException object: Simple message object.
  • Message __string
  • RequestID __string

BaiduChannelRequest

• BaiduChannelRequest object: Baidu Cloud Push credentials
  • ApiKey __string
  • Enabled __boolean
  • SecretKey __string

BaiduChannelResponse

• BaiduChannelResponse object: Baidu Cloud Messaging channel definition
  • ApplicationId __string
  • CreationDate __string
  • Credential __string
  • Enabled __boolean
  • HasCredential __boolean
  • Id __string
  • IsArchived __boolean
  • LastModifiedBy __string
  • LastModifiedDate __string
  • Platform __string
  • Version __integer

BaiduMessage

• BaiduMessage object: Baidu Message.
  • Action Action
  • Body __string
  • Data MapOf__string
  • IconReference __string
  • ImageIconUrl __string
  • ImageUrl __string
  • RawContent __string
  • SilentPush __boolean
  • SmallImageIconUrl __string
  • Sound __string
  • Substitutions MapOfListOf__string
  • Title __string
  • Url __string

CampaignEmailMessage

• CampaignEmailMessage object: The email message configuration.
  • Body __string
  • FromAddress __string
  • HtmlBody __string
  • Title __string

CampaignLimits

• CampaignLimits object: Campaign Limits are used to limit the number of messages that can be sent to a user.
  • Daily __integer
  • MaximumDuration __integer
  • MessagesPerSecond __integer
  • Total __integer

CampaignResponse

• CampaignResponse object: Campaign definition
  • AdditionalTreatments ListOfTreatmentResource
  • ApplicationId __string
  • CreationDate __string
  • DefaultState CampaignState
  • Description __string
  • HoldoutPercent __integer
  • Id __string
  • IsPaused __boolean
  • LastModifiedDate __string
  • Limits CampaignLimits
  • MessageConfiguration MessageConfiguration
  • Name __string
  • Schedule Schedule
  • SegmentId __string
  • SegmentVersion __integer
  • State CampaignState
  • TreatmentDescription __string
  • TreatmentName __string
  • Version __integer

CampaignSmsMessage

• CampaignSmsMessage object: SMS message configuration.
  • Body __string
  • MessageType MessageType
  • SenderId __string

CampaignState

• CampaignState object: State of the Campaign
  • CampaignStatus CampaignStatus

CampaignStatus

• CampaignStatus string (values: SCHEDULED, EXECUTING, PENDING_NEXT_RUN, COMPLETED, PAUSED)

CampaignsResponse

• CampaignsResponse object: List of available campaigns.
  • Item ListOfCampaignResponse
  • NextToken __string

ChannelType

• ChannelType string (values: GCM, APNS, APNS_SANDBOX, APNS_VOIP, APNS_VOIP_SANDBOX, ADM, SMS, EMAIL, BAIDU)

CreateAppRequest

• CreateAppRequest object
  • CreateApplicationRequest required CreateApplicationRequest

CreateAppResponse

• CreateAppResponse object
  • ApplicationResponse required ApplicationResponse

CreateApplicationRequest

• CreateApplicationRequest object: Application Request.
  • Name __string

CreateCampaignRequest

• CreateCampaignRequest object
  • WriteCampaignRequest required WriteCampaignRequest

CreateCampaignResponse

• CreateCampaignResponse object
  • CampaignResponse required CampaignResponse

CreateImportJobRequest

• CreateImportJobRequest object
  • ImportJobRequest required ImportJobRequest

CreateImportJobResponse

• CreateImportJobResponse object
  • ImportJobResponse required ImportJobResponse

CreateSegmentRequest

• CreateSegmentRequest object
  • WriteSegmentRequest required WriteSegmentRequest

CreateSegmentResponse

• CreateSegmentResponse object
  • SegmentResponse required SegmentResponse

DefaultMessage

• DefaultMessage object: Default Message across push notification, email, and sms.
  • Body __string
  • Substitutions MapOfListOf__string

DefaultPushNotificationMessage

• DefaultPushNotificationMessage object: Default Push Notification Message.
  • Action Action
  • Body __string
  • Data MapOf__string
  • SilentPush __boolean
  • Substitutions MapOfListOf__string
  • Title __string
  • Url __string

DeleteAdmChannelRequest

• DeleteAdmChannelRequest object

DeleteAdmChannelResponse

• DeleteAdmChannelResponse object
  • ADMChannelResponse required ADMChannelResponse

DeleteApnsChannelRequest

• DeleteApnsChannelRequest object

DeleteApnsChannelResponse

• DeleteApnsChannelResponse object
  • APNSChannelResponse required APNSChannelResponse

DeleteApnsSandboxChannelRequest

• DeleteApnsSandboxChannelRequest object

DeleteApnsSandboxChannelResponse

• DeleteApnsSandboxChannelResponse object
  • APNSSandboxChannelResponse required APNSSandboxChannelResponse

DeleteApnsVoipChannelRequest

• DeleteApnsVoipChannelRequest object

DeleteApnsVoipChannelResponse

• DeleteApnsVoipChannelResponse object
  • APNSVoipChannelResponse required APNSVoipChannelResponse

DeleteApnsVoipSandboxChannelRequest

• DeleteApnsVoipSandboxChannelRequest object

DeleteApnsVoipSandboxChannelResponse

• DeleteApnsVoipSandboxChannelResponse object
  • APNSVoipSandboxChannelResponse required APNSVoipSandboxChannelResponse

DeleteAppRequest

• DeleteAppRequest object

DeleteAppResponse

• DeleteAppResponse object
  • ApplicationResponse required ApplicationResponse

DeleteBaiduChannelRequest

• DeleteBaiduChannelRequest object

DeleteBaiduChannelResponse

• DeleteBaiduChannelResponse object
  • BaiduChannelResponse required BaiduChannelResponse

DeleteCampaignRequest

• DeleteCampaignRequest object

DeleteCampaignResponse

• DeleteCampaignResponse object
  • CampaignResponse required CampaignResponse

DeleteEmailChannelRequest

• DeleteEmailChannelRequest object

DeleteEmailChannelResponse

• DeleteEmailChannelResponse object
  • EmailChannelResponse required EmailChannelResponse

DeleteEventStreamRequest

• DeleteEventStreamRequest object: DeleteEventStream Request

DeleteEventStreamResponse

• DeleteEventStreamResponse object
  • EventStream required EventStream

DeleteGcmChannelRequest

• DeleteGcmChannelRequest object

DeleteGcmChannelResponse

• DeleteGcmChannelResponse object
  • GCMChannelResponse required GCMChannelResponse

DeleteSegmentRequest

• DeleteSegmentRequest object

DeleteSegmentResponse

• DeleteSegmentResponse object
  • SegmentResponse required SegmentResponse

DeleteSmsChannelRequest

• DeleteSmsChannelRequest object

DeleteSmsChannelResponse

• DeleteSmsChannelResponse object
  • SMSChannelResponse required SMSChannelResponse

DeliveryStatus

• DeliveryStatus string (values: SUCCESSFUL, THROTTLED, TEMPORARY_FAILURE, PERMANENT_FAILURE, UNKNOWN_FAILURE, OPT_OUT, DUPLICATE)

DimensionType

• DimensionType string (values: INCLUSIVE, EXCLUSIVE)

DirectMessageConfiguration

• DirectMessageConfiguration object: The message configuration.
  • ADMMessage ADMMessage
  • APNSMessage APNSMessage
  • BaiduMessage BaiduMessage
  • DefaultMessage DefaultMessage
  • DefaultPushNotificationMessage DefaultPushNotificationMessage
  • GCMMessage GCMMessage
  • SMSMessage SMSMessage

Duration

• Duration string (values: HR_24, DAY_7, DAY_14, DAY_30)

EmailChannelRequest

• EmailChannelRequest object: Email Channel Request
  • Enabled __boolean
  • FromAddress __string
  • Identity __string
  • RoleArn __string

EmailChannelResponse

• EmailChannelResponse object: Email Channel Response.
  • ApplicationId __string
  • CreationDate __string
  • Enabled __boolean
  • FromAddress __string
  • HasCredential __boolean
  • Id __string
  • Identity __string
  • IsArchived __boolean
  • LastModifiedBy __string
  • LastModifiedDate __string
  • Platform __string
  • RoleArn __string
  • Version __integer

EndpointBatchItem

• EndpointBatchItem object: Endpoint update request
  • Address __string
  • Attributes MapOfListOf__string
  • ChannelType ChannelType
  • Demographic EndpointDemographic
  • EffectiveDate __string
  • EndpointStatus __string
  • Id __string
  • Location EndpointLocation
  • Metrics MapOf__double
  • OptOut __string
  • RequestId __string
  • User EndpointUser

EndpointBatchRequest

• EndpointBatchRequest object: Endpoint batch update request.
  • Item ListOfEndpointBatchItem

EndpointDemographic

• EndpointDemographic object: Endpoint demographic data
  • AppVersion __string
  • Locale __string
  • Make __string
  • Model __string
  • ModelVersion __string
  • Platform __string
  • PlatformVersion __string
  • Timezone __string

EndpointLocation

• EndpointLocation object: Endpoint location data
  • City __string
  • Country __string
  • Latitude __double
  • Longitude __double
  • PostalCode __string
  • Region __string

EndpointMessageResult

• EndpointMessageResult object: The result from sending a message to an endpoint.
  • Address __string
  • DeliveryStatus DeliveryStatus
  • StatusCode __integer
  • StatusMessage __string
  • UpdatedToken __string

EndpointRequest

• EndpointRequest object: Endpoint update request
  • Address __string
  • Attributes MapOfListOf__string
  • ChannelType ChannelType
  • Demographic EndpointDemographic
  • EffectiveDate __string
  • EndpointStatus __string
  • Location EndpointLocation
  • Metrics MapOf__double
  • OptOut __string
  • RequestId __string
  • User EndpointUser

EndpointResponse

• EndpointResponse object: Endpoint response
  • Address __string
  • ApplicationId __string
  • Attributes MapOfListOf__string
  • ChannelType ChannelType
  • CohortId __string
  • CreationDate __string
  • Demographic EndpointDemographic
  • EffectiveDate __string
  • EndpointStatus __string
  • Id __string
  • Location EndpointLocation
  • Metrics MapOf__double
  • OptOut __string
  • RequestId __string
  • User EndpointUser

EndpointSendConfiguration

• EndpointSendConfiguration object: Endpoint send configuration.
  • BodyOverride __string
  • Context MapOf__string
  • RawContent __string
  • Substitutions MapOfListOf__string
  • TitleOverride __string

EndpointUser

• EndpointUser object: Endpoint user specific custom userAttributes
  • UserAttributes MapOfListOf__string
  • UserId __string

EventStream

• EventStream object: Model for an event publishing subscription export.
  • ApplicationId __string
  • DestinationStreamArn __string
  • ExternalId __string
  • LastModifiedDate __string
  • LastUpdatedBy __string
  • RoleArn __string

ForbiddenException

• ForbiddenException object: Simple message object.
  • Message __string
  • RequestID __string

Format

• Format string (values: CSV, JSON)

Frequency

• Frequency string (values: ONCE, HOURLY, DAILY, WEEKLY, MONTHLY)

GCMChannelRequest

• GCMChannelRequest object: Google Cloud Messaging credentials
  • ApiKey __string
  • Enabled __boolean

GCMChannelResponse

• GCMChannelResponse object: Google Cloud Messaging channel definition
  • ApplicationId __string
  • CreationDate __string
  • Credential __string
  • Enabled __boolean
  • HasCredential __boolean
  • Id __string
  • IsArchived __boolean
  • LastModifiedBy __string
  • LastModifiedDate __string
  • Platform __string
  • Version __integer

GCMMessage

• GCMMessage object: GCM Message.
  • Action Action
  • Body __string
  • CollapseKey __string
  • Data MapOf__string
  • IconReference __string
  • ImageIconUrl __string
  • ImageUrl __string
  • Priority __string
  • RawContent __string
  • RestrictedPackageName __string
  • SilentPush __boolean
  • SmallImageIconUrl __string
  • Sound __string
  • Substitutions MapOfListOf__string
  • TimeToLive __integer
  • Title __string
  • Url __string

GetAdmChannelRequest

• GetAdmChannelRequest object

GetAdmChannelResponse

• GetAdmChannelResponse object
  • ADMChannelResponse required ADMChannelResponse

GetApnsChannelRequest

• GetApnsChannelRequest object

GetApnsChannelResponse

• GetApnsChannelResponse object
  • APNSChannelResponse required APNSChannelResponse

GetApnsSandboxChannelRequest

• GetApnsSandboxChannelRequest object

GetApnsSandboxChannelResponse

• GetApnsSandboxChannelResponse object
  • APNSSandboxChannelResponse required APNSSandboxChannelResponse

GetApnsVoipChannelRequest

• GetApnsVoipChannelRequest object

GetApnsVoipChannelResponse

• GetApnsVoipChannelResponse object
  • APNSVoipChannelResponse required APNSVoipChannelResponse

GetApnsVoipSandboxChannelRequest

• GetApnsVoipSandboxChannelRequest object

GetApnsVoipSandboxChannelResponse

• GetApnsVoipSandboxChannelResponse object
  • APNSVoipSandboxChannelResponse required APNSVoipSandboxChannelResponse

GetAppRequest

• GetAppRequest object

GetAppResponse

• GetAppResponse object
  • ApplicationResponse required ApplicationResponse

GetApplicationSettingsRequest

• GetApplicationSettingsRequest object

GetApplicationSettingsResponse

• GetApplicationSettingsResponse object
  • ApplicationSettingsResource required ApplicationSettingsResource

GetAppsRequest

• GetAppsRequest object

GetAppsResponse

• GetAppsResponse object
  • ApplicationsResponse required ApplicationsResponse

GetBaiduChannelRequest

• GetBaiduChannelRequest object

GetBaiduChannelResponse

• GetBaiduChannelResponse object
  • BaiduChannelResponse required BaiduChannelResponse

GetCampaignActivitiesRequest

• GetCampaignActivitiesRequest object

GetCampaignActivitiesResponse

• GetCampaignActivitiesResponse object
  • ActivitiesResponse required ActivitiesResponse

GetCampaignRequest

• GetCampaignRequest object

GetCampaignResponse

• GetCampaignResponse object
  • CampaignResponse required CampaignResponse

GetCampaignVersionRequest

• GetCampaignVersionRequest object

GetCampaignVersionResponse

• GetCampaignVersionResponse object
  • CampaignResponse required CampaignResponse

GetCampaignVersionsRequest

• GetCampaignVersionsRequest object

GetCampaignVersionsResponse

• GetCampaignVersionsResponse object
  • CampaignsResponse required CampaignsResponse

GetCampaignsRequest

• GetCampaignsRequest object

GetCampaignsResponse

• GetCampaignsResponse object
  • CampaignsResponse required CampaignsResponse

GetEmailChannelRequest

• GetEmailChannelRequest object

GetEmailChannelResponse

• GetEmailChannelResponse object
  • EmailChannelResponse required EmailChannelResponse

GetEndpointRequest

• GetEndpointRequest object

GetEndpointResponse

• GetEndpointResponse object
  • EndpointResponse required EndpointResponse

GetEventStreamRequest

• GetEventStreamRequest object: GetEventStreamRequest

GetEventStreamResponse

• GetEventStreamResponse object
  • EventStream required EventStream

GetGcmChannelRequest

• GetGcmChannelRequest object

GetGcmChannelResponse

• GetGcmChannelResponse object
  • GCMChannelResponse required GCMChannelResponse

GetImportJobRequest

• GetImportJobRequest object

GetImportJobResponse

• GetImportJobResponse object
  • ImportJobResponse required ImportJobResponse

GetImportJobsRequest

• GetImportJobsRequest object

GetImportJobsResponse

• GetImportJobsResponse object
  • ImportJobsResponse required ImportJobsResponse

GetSegmentImportJobsRequest

• GetSegmentImportJobsRequest object

GetSegmentImportJobsResponse

• GetSegmentImportJobsResponse object
  • ImportJobsResponse required ImportJobsResponse

GetSegmentRequest

• GetSegmentRequest object

GetSegmentResponse

• GetSegmentResponse object
  • SegmentResponse required SegmentResponse

GetSegmentVersionRequest

• GetSegmentVersionRequest object

GetSegmentVersionResponse

• GetSegmentVersionResponse object
  • SegmentResponse required SegmentResponse

GetSegmentVersionsRequest

• GetSegmentVersionsRequest object

GetSegmentVersionsResponse

• GetSegmentVersionsResponse object
  • SegmentsResponse required SegmentsResponse

GetSegmentsRequest

• GetSegmentsRequest object

GetSegmentsResponse

• GetSegmentsResponse object
  • SegmentsResponse required SegmentsResponse

GetSmsChannelRequest

• GetSmsChannelRequest object

GetSmsChannelResponse

• GetSmsChannelResponse object
  • SMSChannelResponse required SMSChannelResponse

ImportJobRequest

• ImportJobRequest object
  • DefineSegment __boolean
  • ExternalId __string
  • Format Format
  • RegisterEndpoints __boolean
  • RoleArn __string
  • S3Url __string
  • SegmentId __string
  • SegmentName __string

ImportJobResource

• ImportJobResource object
  • DefineSegment __boolean
  • ExternalId __string
  • Format Format
  • RegisterEndpoints __boolean
  • RoleArn __string
  • S3Url __string
  • SegmentId __string
  • SegmentName __string

ImportJobResponse

• ImportJobResponse object
  • ApplicationId __string
  • CompletedPieces __integer
  • CompletionDate __string
  • CreationDate __string
  • Definition ImportJobResource
  • FailedPieces __integer
  • Failures ListOf__string
  • Id __string
  • JobStatus JobStatus
  • TotalFailures __integer
  • TotalPieces __integer
  • TotalProcessed __integer
  • Type __string

ImportJobsResponse

• ImportJobsResponse object: Import job list.
  • Item ListOfImportJobResponse
  • NextToken __string

InternalServerErrorException

• InternalServerErrorException object: Simple message object.
  • Message __string
  • RequestID __string

JobStatus

• JobStatus string (values: CREATED, INITIALIZING, PROCESSING, COMPLETING, COMPLETED, FAILING, FAILED)

ListOfActivityResponse

• ListOfActivityResponse array
  • items ActivityResponse

ListOfApplicationResponse

• ListOfApplicationResponse array
  • items ApplicationResponse

ListOfCampaignResponse

• ListOfCampaignResponse array
  • items CampaignResponse

ListOfEndpointBatchItem

• ListOfEndpointBatchItem array
  • items EndpointBatchItem

ListOfImportJobResponse

• ListOfImportJobResponse array
  • items ImportJobResponse

ListOfSegmentResponse

• ListOfSegmentResponse array
  • items SegmentResponse

ListOfTreatmentResource

• ListOfTreatmentResource array
  • items TreatmentResource

ListOfWriteTreatmentResource

• ListOfWriteTreatmentResource array
  • items WriteTreatmentResource

ListOf__string

• ListOf__string array
  • items __string

MapOfAddressConfiguration

• MapOfAddressConfiguration array
  • items object
    • key __string
    • value AddressConfiguration

MapOfAttributeDimension

• MapOfAttributeDimension array
  • items object
    • key __string
    • value AttributeDimension

MapOfEndpointMessageResult

• MapOfEndpointMessageResult array
  • items object
    • key __string
    • value EndpointMessageResult

MapOfEndpointSendConfiguration

• MapOfEndpointSendConfiguration array
  • items object
    • key __string
    • value EndpointSendConfiguration

MapOfListOf__string

• MapOfListOf__string array
  • items object
    • key __string
    • value ListOf__string

MapOfMapOfEndpointMessageResult

• MapOfMapOfEndpointMessageResult array
  • items object
    • key __string
    • value MapOfEndpointMessageResult

MapOfMessageResult

• MapOfMessageResult array
  • items object
    • key __string
    • value MessageResult

MapOf__double

• MapOf__double array
  • items object
    • key __string
    • value __double

MapOf__integer

• MapOf__integer array
  • items object
    • key __string
    • value __integer

MapOf__string

• MapOf__string array
  • items object
    • key __string
    • value __string

Message

• Message object
  • Action Action
  • Body __string
  • ImageIconUrl __string
  • ImageSmallIconUrl __string
  • ImageUrl __string
  • JsonBody __string
  • MediaUrl __string
  • RawContent __string
  • SilentPush __boolean
  • Title __string
  • Url __string

MessageBody

• MessageBody object: Simple message object.
  • Message __string
  • RequestID __string

MessageConfiguration

• MessageConfiguration object: Message configuration for a campaign.
  • ADMMessage Message
  • APNSMessage Message
  • BaiduMessage Message
  • DefaultMessage Message
  • EmailMessage CampaignEmailMessage
  • GCMMessage Message
  • SMSMessage CampaignSmsMessage

MessageRequest

• MessageRequest object: Send message request.
  • Addresses MapOfAddressConfiguration
  • Context MapOf__string
  • Endpoints MapOfEndpointSendConfiguration
  • MessageConfiguration DirectMessageConfiguration

MessageResponse

• MessageResponse object: Send message response.
  • ApplicationId __string
  • EndpointResult MapOfEndpointMessageResult
  • RequestId __string
  • Result MapOfMessageResult

MessageResult

• MessageResult object: The result from sending a message to an address.
  • DeliveryStatus DeliveryStatus
  • StatusCode __integer
  • StatusMessage __string
  • UpdatedToken __string

MessageType

• MessageType string (values: TRANSACTIONAL, PROMOTIONAL)

MethodNotAllowedException

• MethodNotAllowedException object: Simple message object.
  • Message __string
  • RequestID __string

NotFoundException

• NotFoundException object: Simple message object.
  • Message __string
  • RequestID __string

PutEventStreamRequest

• PutEventStreamRequest object
  • WriteEventStream required WriteEventStream

PutEventStreamResponse

• PutEventStreamResponse object
  • EventStream required EventStream

QuietTime

• QuietTime object: Quiet Time
  • End __string
  • Start __string

RecencyDimension

• RecencyDimension object: Define how a segment based on recency of use.
  • Duration Duration
  • RecencyType RecencyType

RecencyType

• RecencyType string (values: ACTIVE, INACTIVE)

SMSChannelRequest

• SMSChannelRequest object: SMS Channel Request
  • Enabled __boolean
  • SenderId __string
  • ShortCode __string

SMSChannelResponse

• SMSChannelResponse object: SMS Channel Response.
  • ApplicationId __string
  • CreationDate __string
  • Enabled __boolean
  • HasCredential __boolean
  • Id __string
  • IsArchived __boolean
  • LastModifiedBy __string
  • LastModifiedDate __string
  • Platform __string
  • SenderId __string
  • ShortCode __string
  • Version __integer

SMSMessage

• SMSMessage object: SMS Message.
  • Body __string
  • MessageType MessageType
  • SenderId __string
  • Substitutions MapOfListOf__string

Schedule

• Schedule object: Shcedule that defines when a campaign is run.
  • EndTime __string
  • Frequency Frequency
  • IsLocalTime __boolean
  • QuietTime QuietTime
  • StartTime __string
  • Timezone __string

SegmentBehaviors

• SegmentBehaviors object: Segment behavior dimensions
  • Recency RecencyDimension

SegmentDemographics

• SegmentDemographics object: Segment demographic dimensions
  • AppVersion SetDimension
  • Channel SetDimension
  • DeviceType SetDimension
  • Make SetDimension
  • Model SetDimension
  • Platform SetDimension

SegmentDimensions

• SegmentDimensions object: Segment dimensions
  • Attributes MapOfAttributeDimension
  • Behavior SegmentBehaviors
  • Demographic SegmentDemographics
  • Location SegmentLocation
  • UserAttributes MapOfAttributeDimension

SegmentImportResource

• SegmentImportResource object: Segment import definition.
  • ChannelCounts MapOf__integer
  • ExternalId __string
  • Format Format
  • RoleArn __string
  • S3Url __string
  • Size __integer

SegmentLocation

• SegmentLocation object: Segment location dimensions
  • Country SetDimension

SegmentResponse

• SegmentResponse object: Segment definition.
  • ApplicationId __string
  • CreationDate __string
  • Dimensions SegmentDimensions
  • Id __string
  • ImportDefinition SegmentImportResource
  • LastModifiedDate __string
  • Name __string
  • SegmentType SegmentType
  • Version __integer

SegmentType

• SegmentType string (values: DIMENSIONAL, IMPORT)

SegmentsResponse

• SegmentsResponse object: Segments in your account.
  • Item ListOfSegmentResponse
  • NextToken __string

SendMessagesRequest

• SendMessagesRequest object
  • MessageRequest required MessageRequest

SendMessagesResponse

• SendMessagesResponse object
  • MessageResponse required MessageResponse

SendUsersMessageRequest

• SendUsersMessageRequest object: Send message request.
  • Context MapOf__string
  • MessageConfiguration DirectMessageConfiguration
  • Users MapOfEndpointSendConfiguration

SendUsersMessageResponse

• SendUsersMessageResponse object: User send message response.
  • ApplicationId __string
  • RequestId __string
  • Result MapOfMapOfEndpointMessageResult

SendUsersMessagesRequest

• SendUsersMessagesRequest object
  • SendUsersMessageRequest required SendUsersMessageRequest

SendUsersMessagesResponse

• SendUsersMessagesResponse object
  • SendUsersMessageResponse required SendUsersMessageResponse

SetDimension

• SetDimension object: Dimension specification of a segment.
  • DimensionType DimensionType
  • Values ListOf__string

TooManyRequestsException

• TooManyRequestsException object: Simple message object.
  • Message __string
  • RequestID __string

TreatmentResource

• TreatmentResource object: Treatment resource
  • Id __string
  • MessageConfiguration MessageConfiguration
  • Schedule Schedule
  • SizePercent __integer
  • State CampaignState
  • TreatmentDescription __string
  • TreatmentName __string

UpdateAdmChannelRequest

• UpdateAdmChannelRequest object
  • ADMChannelRequest required ADMChannelRequest

UpdateAdmChannelResponse

• UpdateAdmChannelResponse object
  • ADMChannelResponse required ADMChannelResponse

UpdateApnsChannelRequest

• UpdateApnsChannelRequest object
  • APNSChannelRequest required APNSChannelRequest

UpdateApnsChannelResponse

• UpdateApnsChannelResponse object
  • APNSChannelResponse required APNSChannelResponse

UpdateApnsSandboxChannelRequest

• UpdateApnsSandboxChannelRequest object
  • APNSSandboxChannelRequest required APNSSandboxChannelRequest

UpdateApnsSandboxChannelResponse

• UpdateApnsSandboxChannelResponse object
  • APNSSandboxChannelResponse required APNSSandboxChannelResponse

UpdateApnsVoipChannelRequest

• UpdateApnsVoipChannelRequest object
  • APNSVoipChannelRequest required APNSVoipChannelRequest

UpdateApnsVoipChannelResponse

• UpdateApnsVoipChannelResponse object
  • APNSVoipChannelResponse required APNSVoipChannelResponse

UpdateApnsVoipSandboxChannelRequest

• UpdateApnsVoipSandboxChannelRequest object
  • APNSVoipSandboxChannelRequest required APNSVoipSandboxChannelRequest

UpdateApnsVoipSandboxChannelResponse

• UpdateApnsVoipSandboxChannelResponse object
  • APNSVoipSandboxChannelResponse required APNSVoipSandboxChannelResponse

UpdateApplicationSettingsRequest

• UpdateApplicationSettingsRequest object
  • WriteApplicationSettingsRequest required WriteApplicationSettingsRequest

UpdateApplicationSettingsResponse

• UpdateApplicationSettingsResponse object
  • ApplicationSettingsResource required ApplicationSettingsResource

UpdateBaiduChannelRequest

• UpdateBaiduChannelRequest object
  • BaiduChannelRequest required BaiduChannelRequest

UpdateBaiduChannelResponse

• UpdateBaiduChannelResponse object
  • BaiduChannelResponse required BaiduChannelResponse

UpdateCampaignRequest

• UpdateCampaignRequest object
  • WriteCampaignRequest required WriteCampaignRequest

UpdateCampaignResponse

• UpdateCampaignResponse object
  • CampaignResponse required CampaignResponse

UpdateEmailChannelRequest

• UpdateEmailChannelRequest object
  • EmailChannelRequest required EmailChannelRequest

UpdateEmailChannelResponse

• UpdateEmailChannelResponse object
  • EmailChannelResponse required EmailChannelResponse

UpdateEndpointRequest

• UpdateEndpointRequest object
  • EndpointRequest required EndpointRequest

UpdateEndpointResponse

• UpdateEndpointResponse object
  • MessageBody required MessageBody

UpdateEndpointsBatchRequest

• UpdateEndpointsBatchRequest object
  • EndpointBatchRequest required EndpointBatchRequest

UpdateEndpointsBatchResponse

• UpdateEndpointsBatchResponse object
  • MessageBody required MessageBody

UpdateGcmChannelRequest

• UpdateGcmChannelRequest object
  • GCMChannelRequest required GCMChannelRequest

UpdateGcmChannelResponse

• UpdateGcmChannelResponse object
  • GCMChannelResponse required GCMChannelResponse

UpdateSegmentRequest

• UpdateSegmentRequest object
  • WriteSegmentRequest required WriteSegmentRequest

UpdateSegmentResponse

• UpdateSegmentResponse object
  • SegmentResponse required SegmentResponse

UpdateSmsChannelRequest

• UpdateSmsChannelRequest object
  • SMSChannelRequest required SMSChannelRequest

UpdateSmsChannelResponse

• UpdateSmsChannelResponse object
  • SMSChannelResponse required SMSChannelResponse

WriteApplicationSettingsRequest

• WriteApplicationSettingsRequest object: Creating application setting request
  • Limits CampaignLimits
  • QuietTime QuietTime

WriteCampaignRequest

• WriteCampaignRequest object: Used to create a campaign.
  • AdditionalTreatments ListOfWriteTreatmentResource
  • Description __string
  • HoldoutPercent __integer
  • IsPaused __boolean
  • Limits CampaignLimits
  • MessageConfiguration MessageConfiguration
  • Name __string
  • Schedule Schedule
  • SegmentId __string
  • SegmentVersion __integer
  • TreatmentDescription __string
  • TreatmentName __string

WriteEventStream

• WriteEventStream object: Request to save an EventStream.
  • DestinationStreamArn __string
  • RoleArn __string

WriteSegmentRequest

• WriteSegmentRequest object: Segment definition.
  • Dimensions SegmentDimensions
  • Name __string

WriteTreatmentResource

• WriteTreatmentResource object: Used to create a campaign treatment.
  • MessageConfiguration MessageConfiguration
  • Schedule Schedule
  • SizePercent __integer
  • TreatmentDescription __string
  • TreatmentName __string

__boolean

• __boolean boolean

__double

• __double number

__integer

• __integer `integ