AWSSDK.Pinpoint
This document is generated from apis/pinpoint-2016-12-01.normal.json. See JuliaCloud/AWSCore.jl.
AWSSDK.Pinpoint.create_appAWSSDK.Pinpoint.create_campaignAWSSDK.Pinpoint.create_import_jobAWSSDK.Pinpoint.create_segmentAWSSDK.Pinpoint.delete_adm_channelAWSSDK.Pinpoint.delete_apns_channelAWSSDK.Pinpoint.delete_apns_sandbox_channelAWSSDK.Pinpoint.delete_apns_voip_channelAWSSDK.Pinpoint.delete_apns_voip_sandbox_channelAWSSDK.Pinpoint.delete_appAWSSDK.Pinpoint.delete_baidu_channelAWSSDK.Pinpoint.delete_campaignAWSSDK.Pinpoint.delete_email_channelAWSSDK.Pinpoint.delete_event_streamAWSSDK.Pinpoint.delete_gcm_channelAWSSDK.Pinpoint.delete_segmentAWSSDK.Pinpoint.delete_sms_channelAWSSDK.Pinpoint.get_adm_channelAWSSDK.Pinpoint.get_apns_channelAWSSDK.Pinpoint.get_apns_sandbox_channelAWSSDK.Pinpoint.get_apns_voip_channelAWSSDK.Pinpoint.get_apns_voip_sandbox_channelAWSSDK.Pinpoint.get_appAWSSDK.Pinpoint.get_application_settingsAWSSDK.Pinpoint.get_appsAWSSDK.Pinpoint.get_baidu_channelAWSSDK.Pinpoint.get_campaignAWSSDK.Pinpoint.get_campaign_activitiesAWSSDK.Pinpoint.get_campaign_versionAWSSDK.Pinpoint.get_campaign_versionsAWSSDK.Pinpoint.get_campaignsAWSSDK.Pinpoint.get_email_channelAWSSDK.Pinpoint.get_endpointAWSSDK.Pinpoint.get_event_streamAWSSDK.Pinpoint.get_gcm_channelAWSSDK.Pinpoint.get_import_jobAWSSDK.Pinpoint.get_import_jobsAWSSDK.Pinpoint.get_segmentAWSSDK.Pinpoint.get_segment_import_jobsAWSSDK.Pinpoint.get_segment_versionAWSSDK.Pinpoint.get_segment_versionsAWSSDK.Pinpoint.get_segmentsAWSSDK.Pinpoint.get_sms_channelAWSSDK.Pinpoint.put_event_streamAWSSDK.Pinpoint.send_messagesAWSSDK.Pinpoint.send_users_messagesAWSSDK.Pinpoint.update_adm_channelAWSSDK.Pinpoint.update_apns_channelAWSSDK.Pinpoint.update_apns_sandbox_channelAWSSDK.Pinpoint.update_apns_voip_channelAWSSDK.Pinpoint.update_apns_voip_sandbox_channelAWSSDK.Pinpoint.update_application_settingsAWSSDK.Pinpoint.update_baidu_channelAWSSDK.Pinpoint.update_campaignAWSSDK.Pinpoint.update_email_channelAWSSDK.Pinpoint.update_endpointAWSSDK.Pinpoint.update_endpoints_batchAWSSDK.Pinpoint.update_gcm_channelAWSSDK.Pinpoint.update_segmentAWSSDK.Pinpoint.update_sms_channel
AWSSDK.Pinpoint.create_app — Function.using AWSSDK.Pinpoint.create_app
create_app([::AWSConfig], arguments::Dict)
create_app([::AWSConfig]; CreateApplicationRequest=)
using AWSCore.Services.pinpoint
pinpoint([::AWSConfig], "POST", "/v1/apps", arguments::Dict)
pinpoint([::AWSConfig], "POST", "/v1/apps", CreateApplicationRequest=)CreateApp Operation
Creates or updates an app.
Arguments
CreateApplicationRequest = ["Name" => ::String] – Required
Returns
CreateAppResponse
Exceptions
BadRequestException, InternalServerErrorException, ForbiddenException, NotFoundException, MethodNotAllowedException or TooManyRequestsException.
See also: AWS API Documentation
AWSSDK.Pinpoint.create_campaign — Function.using AWSSDK.Pinpoint.create_campaign
create_campaign([::AWSConfig], arguments::Dict)
create_campaign([::AWSConfig]; application-id=, WriteCampaignRequest=)
using AWSCore.Services.pinpoint
pinpoint([::AWSConfig], "POST", "/v1/apps/{application-id}/campaigns", arguments::Dict)
pinpoint([::AWSConfig], "POST", "/v1/apps/{application-id}/campaigns", application-id=, WriteCampaignRequest=)CreateCampaign Operation
Creates or updates a campaign.
Arguments
application-id = ::String – Required
WriteCampaignRequest = [ ... ] – Required
WriteCampaignRequest = [
"AdditionalTreatments" => [[
"MessageConfiguration" => [
"ADMMessage" => [
"Action" => "OPEN_APP", "DEEP_LINK" or "URL",
"Body" => ::String,
"ImageIconUrl" => ::String,
"ImageSmallIconUrl" => ::String,
"ImageUrl" => ::String,
"JsonBody" => ::String,
"MediaUrl" => ::String,
"RawContent" => ::String,
"SilentPush" => ::Bool,
"Title" => ::String,
"Url" => ::String
],
"APNSMessage" => [
"Action" => "OPEN_APP", "DEEP_LINK" or "URL",
"Body" => ::String,
"ImageIconUrl" => ::String,
"ImageSmallIconUrl" => ::String,
"ImageUrl" => ::String,
"JsonBody" => ::String,
"MediaUrl" => ::String,
"RawContent" => ::String,
"SilentPush" => ::Bool,
"Title" => ::String,
"Url" => ::String
],
"BaiduMessage" => [
"Action" => "OPEN_APP", "DEEP_LINK" or "URL",
"Body" => ::String,
"ImageIconUrl" => ::String,
"ImageSmallIconUrl" => ::String,
"ImageUrl" => ::String,
"JsonBody" => ::String,
"MediaUrl" => ::String,
"RawContent" => ::String,
"SilentPush" => ::Bool,
"Title" => ::String,
"Url" => ::String
],
"DefaultMessage" => [
"Action" => "OPEN_APP", "DEEP_LINK" or "URL",
"Body" => ::String,
"ImageIconUrl" => ::String,
"ImageSmallIconUrl" => ::String,
"ImageUrl" => ::String,
"JsonBody" => ::String,
"MediaUrl" => ::String,
"RawContent" => ::String,
"SilentPush" => ::Bool,
"Title" => ::String,
"Url" => ::String
],
"EmailMessage" => [
"Body" => ::String,
"FromAddress" => ::String,
"HtmlBody" => ::String,
"Title" => ::String
],
"GCMMessage" => [
"Action" => "OPEN_APP", "DEEP_LINK" or "URL",
"Body" => ::String,
"ImageIconUrl" => ::String,
"ImageSmallIconUrl" => ::String,
"ImageUrl" => ::String,
"JsonBody" => ::String,
"MediaUrl" => ::String,
"RawContent" => ::String,
"SilentPush" => ::Bool,
"Title" => ::String,
"Url" => ::String
],
"SMSMessage" => [
"Body" => ::String,
"MessageType" => "TRANSACTIONAL" or "PROMOTIONAL",
"SenderId" => ::String
]
],
"Schedule" => [
"EndTime" => ::String,
"Frequency" => "ONCE", "HOURLY", "DAILY", "WEEKLY" or "MONTHLY",
"IsLocalTime" => ::Bool,
"QuietTime" => [
"End" => ::String,
"Start" => ::String
],
"StartTime" => ::String,
"Timezone" => ::String
],
"SizePercent" => ::Int,
"TreatmentDescription" => ::String,
"TreatmentName" => ::String
], ...],
"Description" => ::String,
"HoldoutPercent" => ::Int,
"IsPaused" => ::Bool,
"Limits" => [
"Daily" => ::Int,
"MaximumDuration" => ::Int,
"MessagesPerSecond" => ::Int,
"Total" => ::Int
],
"MessageConfiguration" => [
"ADMMessage" => [
"Action" => "OPEN_APP", "DEEP_LINK" or "URL",
"Body" => ::String,
"ImageIconUrl" => ::String,
"ImageSmallIconUrl" => ::String,
"ImageUrl" => ::String,
"JsonBody" => ::String,
"MediaUrl" => ::String,
"RawContent" => ::String,
"SilentPush" => ::Bool,
"Title" => ::String,
"Url" => ::String
],
"APNSMessage" => [
"Action" => "OPEN_APP", "DEEP_LINK" or "URL",
"Body" => ::String,
"ImageIconUrl" => ::String,
"ImageSmallIconUrl" => ::String,
"ImageUrl" => ::String,
"JsonBody" => ::String,
"MediaUrl" => ::String,
"RawContent" => ::String,
"SilentPush" => ::Bool,
"Title" => ::String,
"Url" => ::String
],
"BaiduMessage" => [
"Action" => "OPEN_APP", "DEEP_LINK" or "URL",
"Body" => ::String,
"ImageIconUrl" => ::String,
"ImageSmallIconUrl" => ::String,
"ImageUrl" => ::String,
"JsonBody" => ::String,
"MediaUrl" => ::String,
"RawContent" => ::String,
"SilentPush" => ::Bool,
"Title" => ::String,
"Url" => ::String
],
"DefaultMessage" => [
"Action" => "OPEN_APP", "DEEP_LINK" or "URL",
"Body" => ::String,
"ImageIconUrl" => ::String,
"ImageSmallIconUrl" => ::String,
"ImageUrl" => ::String,
"JsonBody" => ::String,
"MediaUrl" => ::String,
"RawContent" => ::String,
"SilentPush" => ::Bool,
"Title" => ::String,
"Url" => ::String
],
"EmailMessage" => [
"Body" => ::String,
"FromAddress" => ::String,
"HtmlBody" => ::String,
"Title" => ::String
],
"GCMMessage" => [
"Action" => "OPEN_APP", "DEEP_LINK" or "URL",
"Body" => ::String,
"ImageIconUrl" => ::String,
"ImageSmallIconUrl" => ::String,
"ImageUrl" => ::String,
"JsonBody" => ::String,
"MediaUrl" => ::String,
"RawContent" => ::String,
"SilentPush" => ::Bool,
"Title" => ::String,
"Url" => ::String
],
"SMSMessage" => [
"Body" => ::String,
"MessageType" => "TRANSACTIONAL" or "PROMOTIONAL",
"SenderId" => ::String
]
],
"Name" => ::String,
"Schedule" => [
"EndTime" => ::String,
"Frequency" => "ONCE", "HOURLY", "DAILY", "WEEKLY" or "MONTHLY",
"IsLocalTime" => ::Bool,
"QuietTime" => [
"End" => ::String,
"Start" => ::String
],
"StartTime" => ::String,
"Timezone" => ::String
],
"SegmentId" => ::String,
"SegmentVersion" => ::Int,
"TreatmentDescription" => ::String,
"TreatmentName" => ::String
]Returns
CreateCampaignResponse
Exceptions
BadRequestException, InternalServerErrorException, ForbiddenException, NotFoundException, MethodNotAllowedException or TooManyRequestsException.
See also: AWS API Documentation
AWSSDK.Pinpoint.create_import_job — Function.using AWSSDK.Pinpoint.create_import_job
create_import_job([::AWSConfig], arguments::Dict)
create_import_job([::AWSConfig]; application-id=, ImportJobRequest=)
using AWSCore.Services.pinpoint
pinpoint([::AWSConfig], "POST", "/v1/apps/{application-id}/jobs/import", arguments::Dict)
pinpoint([::AWSConfig], "POST", "/v1/apps/{application-id}/jobs/import", application-id=, ImportJobRequest=)CreateImportJob Operation
Creates or updates an import job.
Arguments
application-id = ::String – Required
ImportJobRequest = [ ... ] – Required
ImportJobRequest = [
"DefineSegment" => ::Bool,
"ExternalId" => ::String,
"Format" => "CSV" or "JSON",
"RegisterEndpoints" => ::Bool,
"RoleArn" => ::String,
"S3Url" => ::String,
"SegmentId" => ::String,
"SegmentName" => ::String
]Returns
CreateImportJobResponse
Exceptions
BadRequestException, InternalServerErrorException, ForbiddenException, NotFoundException, MethodNotAllowedException or TooManyRequestsException.
See also: AWS API Documentation
AWSSDK.Pinpoint.create_segment — Function.using AWSSDK.Pinpoint.create_segment
create_segment([::AWSConfig], arguments::Dict)
create_segment([::AWSConfig]; application-id=, WriteSegmentRequest=)
using AWSCore.Services.pinpoint
pinpoint([::AWSConfig], "POST", "/v1/apps/{application-id}/segments", arguments::Dict)
pinpoint([::AWSConfig], "POST", "/v1/apps/{application-id}/segments", application-id=, WriteSegmentRequest=)CreateSegment Operation
Used to create or update a segment.
Arguments
application-id = ::String – Required
WriteSegmentRequest = [ ... ] – Required
WriteSegmentRequest = [
"Dimensions" => [
"Attributes" => ::Dict{String,String},
"Behavior" => ["Recency" => [
"Duration" => "HR_24", "DAY_7", "DAY_14" or "DAY_30",
"RecencyType" => "ACTIVE" or "INACTIVE"
]],
"Demographic" => [
"AppVersion" => [
"DimensionType" => "INCLUSIVE" or "EXCLUSIVE",
"Values" => [::String, ...]
],
"Channel" => [
"DimensionType" => "INCLUSIVE" or "EXCLUSIVE",
"Values" => [::String, ...]
],
"DeviceType" => [
"DimensionType" => "INCLUSIVE" or "EXCLUSIVE",
"Values" => [::String, ...]
],
"Make" => [
"DimensionType" => "INCLUSIVE" or "EXCLUSIVE",
"Values" => [::String, ...]
],
"Model" => [
"DimensionType" => "INCLUSIVE" or "EXCLUSIVE",
"Values" => [::String, ...]
],
"Platform" => [
"DimensionType" => "INCLUSIVE" or "EXCLUSIVE",
"Values" => [::String, ...]
]
],
"Location" => ["Country" => [
"DimensionType" => "INCLUSIVE" or "EXCLUSIVE",
"Values" => [::String, ...]
]],
"UserAttributes" => ::Dict{String,String}
],
"Name" => ::String
]Returns
CreateSegmentResponse
Exceptions
BadRequestException, InternalServerErrorException, ForbiddenException, NotFoundException, MethodNotAllowedException or TooManyRequestsException.
See also: AWS API Documentation
AWSSDK.Pinpoint.delete_adm_channel — Function.using AWSSDK.Pinpoint.delete_adm_channel
delete_adm_channel([::AWSConfig], arguments::Dict)
delete_adm_channel([::AWSConfig]; application-id=)
using AWSCore.Services.pinpoint
pinpoint([::AWSConfig], "DELETE", "/v1/apps/{application-id}/channels/adm", arguments::Dict)
pinpoint([::AWSConfig], "DELETE", "/v1/apps/{application-id}/channels/adm", application-id=)DeleteAdmChannel Operation
Delete an ADM channel
Arguments
application-id = ::String – Required
Returns
DeleteAdmChannelResponse
Exceptions
BadRequestException, InternalServerErrorException, ForbiddenException, NotFoundException, MethodNotAllowedException or TooManyRequestsException.
See also: AWS API Documentation
AWSSDK.Pinpoint.delete_apns_channel — Function.using AWSSDK.Pinpoint.delete_apns_channel
delete_apns_channel([::AWSConfig], arguments::Dict)
delete_apns_channel([::AWSConfig]; application-id=)
using AWSCore.Services.pinpoint
pinpoint([::AWSConfig], "DELETE", "/v1/apps/{application-id}/channels/apns", arguments::Dict)
pinpoint([::AWSConfig], "DELETE", "/v1/apps/{application-id}/channels/apns", application-id=)DeleteApnsChannel Operation
Deletes the APNs channel for an app.
Arguments
application-id = ::String – Required
Returns
DeleteApnsChannelResponse
Exceptions
BadRequestException, InternalServerErrorException, ForbiddenException, NotFoundException, MethodNotAllowedException or TooManyRequestsException.
See also: AWS API Documentation
AWSSDK.Pinpoint.delete_apns_sandbox_channel — Function.using AWSSDK.Pinpoint.delete_apns_sandbox_channel
delete_apns_sandbox_channel([::AWSConfig], arguments::Dict)
delete_apns_sandbox_channel([::AWSConfig]; application-id=)
using AWSCore.Services.pinpoint
pinpoint([::AWSConfig], "DELETE", "/v1/apps/{application-id}/channels/apns_sandbox", arguments::Dict)
pinpoint([::AWSConfig], "DELETE", "/v1/apps/{application-id}/channels/apns_sandbox", application-id=)DeleteApnsSandboxChannel Operation
Delete an APNS sandbox channel
Arguments
application-id = ::String – Required
Returns
DeleteApnsSandboxChannelResponse
Exceptions
BadRequestException, InternalServerErrorException, ForbiddenException, NotFoundException, MethodNotAllowedException or TooManyRequestsException.
See also: AWS API Documentation
AWSSDK.Pinpoint.delete_apns_voip_channel — Function.using AWSSDK.Pinpoint.delete_apns_voip_channel
delete_apns_voip_channel([::AWSConfig], arguments::Dict)
delete_apns_voip_channel([::AWSConfig]; application-id=)
using AWSCore.Services.pinpoint
pinpoint([::AWSConfig], "DELETE", "/v1/apps/{application-id}/channels/apns_voip", arguments::Dict)
pinpoint([::AWSConfig], "DELETE", "/v1/apps/{application-id}/channels/apns_voip", application-id=)DeleteApnsVoipChannel Operation
Delete an APNS VoIP channel
Arguments
application-id = ::String – Required
Returns
DeleteApnsVoipChannelResponse
Exceptions
BadRequestException, InternalServerErrorException, ForbiddenException, NotFoundException, MethodNotAllowedException or TooManyRequestsException.
See also: AWS API Documentation
AWSSDK.Pinpoint.delete_apns_voip_sandbox_channel — Function.using AWSSDK.Pinpoint.delete_apns_voip_sandbox_channel
delete_apns_voip_sandbox_channel([::AWSConfig], arguments::Dict)
delete_apns_voip_sandbox_channel([::AWSConfig]; application-id=)
using AWSCore.Services.pinpoint
pinpoint([::AWSConfig], "DELETE", "/v1/apps/{application-id}/channels/apns_voip_sandbox", arguments::Dict)
pinpoint([::AWSConfig], "DELETE", "/v1/apps/{application-id}/channels/apns_voip_sandbox", application-id=)DeleteApnsVoipSandboxChannel Operation
Delete an APNS VoIP sandbox channel
Arguments
application-id = ::String – Required
Returns
DeleteApnsVoipSandboxChannelResponse
Exceptions
BadRequestException, InternalServerErrorException, ForbiddenException, NotFoundException, MethodNotAllowedException or TooManyRequestsException.
See also: AWS API Documentation
AWSSDK.Pinpoint.delete_app — Function.using AWSSDK.Pinpoint.delete_app
delete_app([::AWSConfig], arguments::Dict)
delete_app([::AWSConfig]; application-id=)
using AWSCore.Services.pinpoint
pinpoint([::AWSConfig], "DELETE", "/v1/apps/{application-id}", arguments::Dict)
pinpoint([::AWSConfig], "DELETE", "/v1/apps/{application-id}", application-id=)DeleteApp Operation
Deletes an app.
Arguments
application-id = ::String – Required
Returns
DeleteAppResponse
Exceptions
BadRequestException, InternalServerErrorException, ForbiddenException, NotFoundException, MethodNotAllowedException or TooManyRequestsException.
See also: AWS API Documentation
AWSSDK.Pinpoint.delete_baidu_channel — Function.using AWSSDK.Pinpoint.delete_baidu_channel
delete_baidu_channel([::AWSConfig], arguments::Dict)
delete_baidu_channel([::AWSConfig]; application-id=)
using AWSCore.Services.pinpoint
pinpoint([::AWSConfig], "DELETE", "/v1/apps/{application-id}/channels/baidu", arguments::Dict)
pinpoint([::AWSConfig], "DELETE", "/v1/apps/{application-id}/channels/baidu", application-id=)DeleteBaiduChannel Operation
Delete a BAIDU GCM channel
Arguments
application-id = ::String – Required
Returns
DeleteBaiduChannelResponse
Exceptions
BadRequestException, InternalServerErrorException, ForbiddenException, NotFoundException, MethodNotAllowedException or TooManyRequestsException.
See also: AWS API Documentation
AWSSDK.Pinpoint.delete_campaign — Function.using AWSSDK.Pinpoint.delete_campaign
delete_campaign([::AWSConfig], arguments::Dict)
delete_campaign([::AWSConfig]; application-id=, campaign-id=)
using AWSCore.Services.pinpoint
pinpoint([::AWSConfig], "DELETE", "/v1/apps/{application-id}/campaigns/{campaign-id}", arguments::Dict)
pinpoint([::AWSConfig], "DELETE", "/v1/apps/{application-id}/campaigns/{campaign-id}", application-id=, campaign-id=)DeleteCampaign Operation
Deletes a campaign.
Arguments
application-id = ::String – Required
campaign-id = ::String – Required
Returns
DeleteCampaignResponse
Exceptions
BadRequestException, InternalServerErrorException, ForbiddenException, NotFoundException, MethodNotAllowedException or TooManyRequestsException.
See also: AWS API Documentation
AWSSDK.Pinpoint.delete_email_channel — Function.using AWSSDK.Pinpoint.delete_email_channel
delete_email_channel([::AWSConfig], arguments::Dict)
delete_email_channel([::AWSConfig]; application-id=)
using AWSCore.Services.pinpoint
pinpoint([::AWSConfig], "DELETE", "/v1/apps/{application-id}/channels/email", arguments::Dict)
pinpoint([::AWSConfig], "DELETE", "/v1/apps/{application-id}/channels/email", application-id=)DeleteEmailChannel Operation
Delete an email channel
Arguments
application-id = ::String – Required
Returns
DeleteEmailChannelResponse
Exceptions
BadRequestException, InternalServerErrorException, ForbiddenException, NotFoundException, MethodNotAllowedException or TooManyRequestsException.
See also: AWS API Documentation
AWSSDK.Pinpoint.delete_event_stream — Function.using AWSSDK.Pinpoint.delete_event_stream
delete_event_stream([::AWSConfig], arguments::Dict)
delete_event_stream([::AWSConfig]; application-id=)
using AWSCore.Services.pinpoint
pinpoint([::AWSConfig], "DELETE", "/v1/apps/{application-id}/eventstream", arguments::Dict)
pinpoint([::AWSConfig], "DELETE", "/v1/apps/{application-id}/eventstream", application-id=)DeleteEventStream Operation
Deletes the event stream for an app.
Arguments
application-id = ::String – Required
ApplicationId
Returns
DeleteEventStreamResponse
Exceptions
BadRequestException, InternalServerErrorException, ForbiddenException, NotFoundException, MethodNotAllowedException or TooManyRequestsException.
See also: AWS API Documentation
AWSSDK.Pinpoint.delete_gcm_channel — Function.using AWSSDK.Pinpoint.delete_gcm_channel
delete_gcm_channel([::AWSConfig], arguments::Dict)
delete_gcm_channel([::AWSConfig]; application-id=)
using AWSCore.Services.pinpoint
pinpoint([::AWSConfig], "DELETE", "/v1/apps/{application-id}/channels/gcm", arguments::Dict)
pinpoint([::AWSConfig], "DELETE", "/v1/apps/{application-id}/channels/gcm", application-id=)DeleteGcmChannel Operation
Deletes the GCM channel for an app.
Arguments
application-id = ::String – Required
Returns
DeleteGcmChannelResponse
Exceptions
BadRequestException, InternalServerErrorException, ForbiddenException, NotFoundException, MethodNotAllowedException or TooManyRequestsException.
See also: AWS API Documentation
AWSSDK.Pinpoint.delete_segment — Function.using AWSSDK.Pinpoint.delete_segment
delete_segment([::AWSConfig], arguments::Dict)
delete_segment([::AWSConfig]; application-id=, segment-id=)
using AWSCore.Services.pinpoint
pinpoint([::AWSConfig], "DELETE", "/v1/apps/{application-id}/segments/{segment-id}", arguments::Dict)
pinpoint([::AWSConfig], "DELETE", "/v1/apps/{application-id}/segments/{segment-id}", application-id=, segment-id=)DeleteSegment Operation
Deletes a segment.
Arguments
application-id = ::String – Required
segment-id = ::String – Required
Returns
DeleteSegmentResponse
Exceptions
BadRequestException, InternalServerErrorException, ForbiddenException, NotFoundException, MethodNotAllowedException or TooManyRequestsException.
See also: AWS API Documentation
AWSSDK.Pinpoint.delete_sms_channel — Function.using AWSSDK.Pinpoint.delete_sms_channel
delete_sms_channel([::AWSConfig], arguments::Dict)
delete_sms_channel([::AWSConfig]; application-id=)
using AWSCore.Services.pinpoint
pinpoint([::AWSConfig], "DELETE", "/v1/apps/{application-id}/channels/sms", arguments::Dict)
pinpoint([::AWSConfig], "DELETE", "/v1/apps/{application-id}/channels/sms", application-id=)DeleteSmsChannel Operation
Delete an SMS channel
Arguments
application-id = ::String – Required
Returns
DeleteSmsChannelResponse
Exceptions
BadRequestException, InternalServerErrorException, ForbiddenException, NotFoundException, MethodNotAllowedException or TooManyRequestsException.
See also: AWS API Documentation
AWSSDK.Pinpoint.get_adm_channel — Function.using AWSSDK.Pinpoint.get_adm_channel
get_adm_channel([::AWSConfig], arguments::Dict)
get_adm_channel([::AWSConfig]; application-id=)
using AWSCore.Services.pinpoint
pinpoint([::AWSConfig], "GET", "/v1/apps/{application-id}/channels/adm", arguments::Dict)
pinpoint([::AWSConfig], "GET", "/v1/apps/{application-id}/channels/adm", application-id=)GetAdmChannel Operation
Get an ADM channel
Arguments
application-id = ::String – Required
Returns
GetAdmChannelResponse
Exceptions
BadRequestException, InternalServerErrorException, ForbiddenException, NotFoundException, MethodNotAllowedException or TooManyRequestsException.
See also: AWS API Documentation
AWSSDK.Pinpoint.get_apns_channel — Function.using AWSSDK.Pinpoint.get_apns_channel
get_apns_channel([::AWSConfig], arguments::Dict)
get_apns_channel([::AWSConfig]; application-id=)
using AWSCore.Services.pinpoint
pinpoint([::AWSConfig], "GET", "/v1/apps/{application-id}/channels/apns", arguments::Dict)
pinpoint([::AWSConfig], "GET", "/v1/apps/{application-id}/channels/apns", application-id=)GetApnsChannel Operation
Returns information about the APNs channel for an app.
Arguments
application-id = ::String – Required
Returns
GetApnsChannelResponse
Exceptions
BadRequestException, InternalServerErrorException, ForbiddenException, NotFoundException, MethodNotAllowedException or TooManyRequestsException.
See also: AWS API Documentation
AWSSDK.Pinpoint.get_apns_sandbox_channel — Function.using AWSSDK.Pinpoint.get_apns_sandbox_channel
get_apns_sandbox_channel([::AWSConfig], arguments::Dict)
get_apns_sandbox_channel([::AWSConfig]; application-id=)
using AWSCore.Services.pinpoint
pinpoint([::AWSConfig], "GET", "/v1/apps/{application-id}/channels/apns_sandbox", arguments::Dict)
pinpoint([::AWSConfig], "GET", "/v1/apps/{application-id}/channels/apns_sandbox", application-id=)GetApnsSandboxChannel Operation
Get an APNS sandbox channel
Arguments
application-id = ::String – Required
Returns
GetApnsSandboxChannelResponse
Exceptions
BadRequestException, InternalServerErrorException, ForbiddenException, NotFoundException, MethodNotAllowedException or TooManyRequestsException.
See also: AWS API Documentation
AWSSDK.Pinpoint.get_apns_voip_channel — Function.using AWSSDK.Pinpoint.get_apns_voip_channel
get_apns_voip_channel([::AWSConfig], arguments::Dict)
get_apns_voip_channel([::AWSConfig]; application-id=)
using AWSCore.Services.pinpoint
pinpoint([::AWSConfig], "GET", "/v1/apps/{application-id}/channels/apns_voip", arguments::Dict)
pinpoint([::AWSConfig], "GET", "/v1/apps/{application-id}/channels/apns_voip", application-id=)GetApnsVoipChannel Operation
Get an APNS VoIP channel
Arguments
application-id = ::String – Required
Returns
GetApnsVoipChannelResponse
Exceptions
BadRequestException, InternalServerErrorException, ForbiddenException, NotFoundException, MethodNotAllowedException or TooManyRequestsException.
See also: AWS API Documentation
AWSSDK.Pinpoint.get_apns_voip_sandbox_channel — Function.using AWSSDK.Pinpoint.get_apns_voip_sandbox_channel
get_apns_voip_sandbox_channel([::AWSConfig], arguments::Dict)
get_apns_voip_sandbox_channel([::AWSConfig]; application-id=)
using AWSCore.Services.pinpoint
pinpoint([::AWSConfig], "GET", "/v1/apps/{application-id}/channels/apns_voip_sandbox", arguments::Dict)
pinpoint([::AWSConfig], "GET", "/v1/apps/{application-id}/channels/apns_voip_sandbox", application-id=)GetApnsVoipSandboxChannel Operation
Get an APNS VoipSandbox channel
Arguments
application-id = ::String – Required
Returns
GetApnsVoipSandboxChannelResponse
Exceptions
BadRequestException, InternalServerErrorException, ForbiddenException, NotFoundException, MethodNotAllowedException or TooManyRequestsException.
See also: AWS API Documentation
AWSSDK.Pinpoint.get_app — Function.using AWSSDK.Pinpoint.get_app
get_app([::AWSConfig], arguments::Dict)
get_app([::AWSConfig]; application-id=)
using AWSCore.Services.pinpoint
pinpoint([::AWSConfig], "GET", "/v1/apps/{application-id}", arguments::Dict)
pinpoint([::AWSConfig], "GET", "/v1/apps/{application-id}", application-id=)GetApp Operation
Returns information about an app.
Arguments
application-id = ::String – Required
Returns
GetAppResponse
Exceptions
BadRequestException, InternalServerErrorException, ForbiddenException, NotFoundException, MethodNotAllowedException or TooManyRequestsException.
See also: AWS API Documentation
AWSSDK.Pinpoint.get_application_settings — Function.using AWSSDK.Pinpoint.get_application_settings
get_application_settings([::AWSConfig], arguments::Dict)
get_application_settings([::AWSConfig]; application-id=)
using AWSCore.Services.pinpoint
pinpoint([::AWSConfig], "GET", "/v1/apps/{application-id}/settings", arguments::Dict)
pinpoint([::AWSConfig], "GET", "/v1/apps/{application-id}/settings", application-id=)GetApplicationSettings Operation
Used to request the settings for an app.
Arguments
application-id = ::String – Required
Returns
GetApplicationSettingsResponse
Exceptions
BadRequestException, InternalServerErrorException, ForbiddenException, NotFoundException, MethodNotAllowedException or TooManyRequestsException.
See also: AWS API Documentation
AWSSDK.Pinpoint.get_apps — Function.using AWSSDK.Pinpoint.get_apps
get_apps([::AWSConfig], arguments::Dict)
get_apps([::AWSConfig]; <keyword arguments>)
using AWSCore.Services.pinpoint
pinpoint([::AWSConfig], "GET", "/v1/apps", arguments::Dict)
pinpoint([::AWSConfig], "GET", "/v1/apps", <keyword arguments>)GetApps Operation
Returns information about your apps.
Arguments
page-size = ::String
token = ::String
Returns
GetAppsResponse
Exceptions
BadRequestException, InternalServerErrorException, ForbiddenException, NotFoundException, MethodNotAllowedException or TooManyRequestsException.
See also: AWS API Documentation
AWSSDK.Pinpoint.get_baidu_channel — Function.using AWSSDK.Pinpoint.get_baidu_channel
get_baidu_channel([::AWSConfig], arguments::Dict)
get_baidu_channel([::AWSConfig]; application-id=)
using AWSCore.Services.pinpoint
pinpoint([::AWSConfig], "GET", "/v1/apps/{application-id}/channels/baidu", arguments::Dict)
pinpoint([::AWSConfig], "GET", "/v1/apps/{application-id}/channels/baidu", application-id=)GetBaiduChannel Operation
Get a BAIDU GCM channel
Arguments
application-id = ::String – Required
Returns
GetBaiduChannelResponse
Exceptions
BadRequestException, InternalServerErrorException, ForbiddenException, NotFoundException, MethodNotAllowedException or TooManyRequestsException.
See also: AWS API Documentation
AWSSDK.Pinpoint.get_campaign — Function.using AWSSDK.Pinpoint.get_campaign
get_campaign([::AWSConfig], arguments::Dict)
get_campaign([::AWSConfig]; application-id=, campaign-id=)
using AWSCore.Services.pinpoint
pinpoint([::AWSConfig], "GET", "/v1/apps/{application-id}/campaigns/{campaign-id}", arguments::Dict)
pinpoint([::AWSConfig], "GET", "/v1/apps/{application-id}/campaigns/{campaign-id}", application-id=, campaign-id=)GetCampaign Operation
Returns information about a campaign.
Arguments
application-id = ::String – Required
campaign-id = ::String – Required
Returns
GetCampaignResponse
Exceptions
BadRequestException, InternalServerErrorException, ForbiddenException, NotFoundException, MethodNotAllowedException or TooManyRequestsException.
See also: AWS API Documentation
AWSSDK.Pinpoint.get_campaign_activities — Function.using AWSSDK.Pinpoint.get_campaign_activities
get_campaign_activities([::AWSConfig], arguments::Dict)
get_campaign_activities([::AWSConfig]; application-id=, campaign-id=, <keyword arguments>)
using AWSCore.Services.pinpoint
pinpoint([::AWSConfig], "GET", "/v1/apps/{application-id}/campaigns/{campaign-id}/activities", arguments::Dict)
pinpoint([::AWSConfig], "GET", "/v1/apps/{application-id}/campaigns/{campaign-id}/activities", application-id=, campaign-id=, <keyword arguments>)GetCampaignActivities Operation
Returns information about the activity performed by a campaign.
Arguments
application-id = ::String – Required
campaign-id = ::String – Required
page-size = ::String
The number of entries you want on each page in the response.
token = ::String
The NextToken string returned on a previous page that you use to get the next page of results in a paginated response.
Returns
GetCampaignActivitiesResponse
Exceptions
BadRequestException, InternalServerErrorException, ForbiddenException, NotFoundException, MethodNotAllowedException or TooManyRequestsException.
See also: AWS API Documentation
AWSSDK.Pinpoint.get_campaign_version — Function.using AWSSDK.Pinpoint.get_campaign_version
get_campaign_version([::AWSConfig], arguments::Dict)
get_campaign_version([::AWSConfig]; application-id=, campaign-id=, version=)
using AWSCore.Services.pinpoint
pinpoint([::AWSConfig], "GET", "/v1/apps/{application-id}/campaigns/{campaign-id}/versions/{version}", arguments::Dict)
pinpoint([::AWSConfig], "GET", "/v1/apps/{application-id}/campaigns/{campaign-id}/versions/{version}", application-id=, campaign-id=, version=)GetCampaignVersion Operation
Returns information about a specific version of a campaign.
Arguments
application-id = ::String – Required
campaign-id = ::String – Required
version = ::String – Required
Returns
GetCampaignVersionResponse
Exceptions
BadRequestException, InternalServerErrorException, ForbiddenException, NotFoundException, MethodNotAllowedException or TooManyRequestsException.
See also: AWS API Documentation
AWSSDK.Pinpoint.get_campaign_versions — Function.using AWSSDK.Pinpoint.get_campaign_versions
get_campaign_versions([::AWSConfig], arguments::Dict)
get_campaign_versions([::AWSConfig]; application-id=, campaign-id=, <keyword arguments>)
using AWSCore.Services.pinpoint
pinpoint([::AWSConfig], "GET", "/v1/apps/{application-id}/campaigns/{campaign-id}/versions", arguments::Dict)
pinpoint([::AWSConfig], "GET", "/v1/apps/{application-id}/campaigns/{campaign-id}/versions", application-id=, campaign-id=, <keyword arguments>)GetCampaignVersions Operation
Returns information about your campaign versions.
Arguments
application-id = ::String – Required
campaign-id = ::String – Required
page-size = ::String
The number of entries you want on each page in the response.
token = ::String
The NextToken string returned on a previous page that you use to get the next page of results in a paginated response.
Returns
GetCampaignVersionsResponse
Exceptions
BadRequestException, InternalServerErrorException, ForbiddenException, NotFoundException, MethodNotAllowedException or TooManyRequestsException.
See also: AWS API Documentation
AWSSDK.Pinpoint.get_campaigns — Function.using AWSSDK.Pinpoint.get_campaigns
get_campaigns([::AWSConfig], arguments::Dict)
get_campaigns([::AWSConfig]; application-id=, <keyword arguments>)
using AWSCore.Services.pinpoint
pinpoint([::AWSConfig], "GET", "/v1/apps/{application-id}/campaigns", arguments::Dict)
pinpoint([::AWSConfig], "GET", "/v1/apps/{application-id}/campaigns", application-id=, <keyword arguments>)GetCampaigns Operation
Returns information about your campaigns.
Arguments
application-id = ::String – Required
page-size = ::String
The number of entries you want on each page in the response.
token = ::String
The NextToken string returned on a previous page that you use to get the next page of results in a paginated response.
Returns
GetCampaignsResponse
Exceptions
BadRequestException, InternalServerErrorException, ForbiddenException, NotFoundException, MethodNotAllowedException or TooManyRequestsException.
See also: AWS API Documentation
AWSSDK.Pinpoint.get_email_channel — Function.using AWSSDK.Pinpoint.get_email_channel
get_email_channel([::AWSConfig], arguments::Dict)
get_email_channel([::AWSConfig]; application-id=)
using AWSCore.Services.pinpoint
pinpoint([::AWSConfig], "GET", "/v1/apps/{application-id}/channels/email", arguments::Dict)
pinpoint([::AWSConfig], "GET", "/v1/apps/{application-id}/channels/email", application-id=)GetEmailChannel Operation
Get an email channel
Arguments
application-id = ::String – Required
Returns
GetEmailChannelResponse
Exceptions
BadRequestException, InternalServerErrorException, ForbiddenException, NotFoundException, MethodNotAllowedException or TooManyRequestsException.
See also: AWS API Documentation
AWSSDK.Pinpoint.get_endpoint — Function.using AWSSDK.Pinpoint.get_endpoint
get_endpoint([::AWSConfig], arguments::Dict)
get_endpoint([::AWSConfig]; application-id=, endpoint-id=)
using AWSCore.Services.pinpoint
pinpoint([::AWSConfig], "GET", "/v1/apps/{application-id}/endpoints/{endpoint-id}", arguments::Dict)
pinpoint([::AWSConfig], "GET", "/v1/apps/{application-id}/endpoints/{endpoint-id}", application-id=, endpoint-id=)GetEndpoint Operation
Returns information about an endpoint.
Arguments
application-id = ::String – Required
endpoint-id = ::String – Required
Returns
GetEndpointResponse
Exceptions
BadRequestException, InternalServerErrorException, ForbiddenException, NotFoundException, MethodNotAllowedException or TooManyRequestsException.
See also: AWS API Documentation
AWSSDK.Pinpoint.get_event_stream — Function.using AWSSDK.Pinpoint.get_event_stream
get_event_stream([::AWSConfig], arguments::Dict)
get_event_stream([::AWSConfig]; application-id=)
using AWSCore.Services.pinpoint
pinpoint([::AWSConfig], "GET", "/v1/apps/{application-id}/eventstream", arguments::Dict)
pinpoint([::AWSConfig], "GET", "/v1/apps/{application-id}/eventstream", application-id=)GetEventStream Operation
Returns the event stream for an app.
Arguments
application-id = ::String – Required
ApplicationId
Returns
GetEventStreamResponse
Exceptions
BadRequestException, InternalServerErrorException, ForbiddenException, NotFoundException, MethodNotAllowedException or TooManyRequestsException.
See also: AWS API Documentation
AWSSDK.Pinpoint.get_gcm_channel — Function.using AWSSDK.Pinpoint.get_gcm_channel
get_gcm_channel([::AWSConfig], arguments::Dict)
get_gcm_channel([::AWSConfig]; application-id=)
using AWSCore.Services.pinpoint
pinpoint([::AWSConfig], "GET", "/v1/apps/{application-id}/channels/gcm", arguments::Dict)
pinpoint([::AWSConfig], "GET", "/v1/apps/{application-id}/channels/gcm", application-id=)GetGcmChannel Operation
Returns information about the GCM channel for an app.
Arguments
application-id = ::String – Required
Returns
GetGcmChannelResponse
Exceptions
BadRequestException, InternalServerErrorException, ForbiddenException, NotFoundException, MethodNotAllowedException or TooManyRequestsException.
See also: AWS API Documentation
AWSSDK.Pinpoint.get_import_job — Function.using AWSSDK.Pinpoint.get_import_job
get_import_job([::AWSConfig], arguments::Dict)
get_import_job([::AWSConfig]; application-id=, job-id=)
using AWSCore.Services.pinpoint
pinpoint([::AWSConfig], "GET", "/v1/apps/{application-id}/jobs/import/{job-id}", arguments::Dict)
pinpoint([::AWSConfig], "GET", "/v1/apps/{application-id}/jobs/import/{job-id}", application-id=, job-id=)GetImportJob Operation
Returns information about an import job.
Arguments
application-id = ::String – Required
job-id = ::String – Required
Returns
GetImportJobResponse
Exceptions
BadRequestException, InternalServerErrorException, ForbiddenException, NotFoundException, MethodNotAllowedException or TooManyRequestsException.
See also: AWS API Documentation
AWSSDK.Pinpoint.get_import_jobs — Function.using AWSSDK.Pinpoint.get_import_jobs
get_import_jobs([::AWSConfig], arguments::Dict)
get_import_jobs([::AWSConfig]; application-id=, <keyword arguments>)
using AWSCore.Services.pinpoint
pinpoint([::AWSConfig], "GET", "/v1/apps/{application-id}/jobs/import", arguments::Dict)
pinpoint([::AWSConfig], "GET", "/v1/apps/{application-id}/jobs/import", application-id=, <keyword arguments>)GetImportJobs Operation
Returns information about your import jobs.
Arguments
application-id = ::String – Required
page-size = ::String
The number of entries you want on each page in the response.
token = ::String
The NextToken string returned on a previous page that you use to get the next page of results in a paginated response.
Returns
GetImportJobsResponse
Exceptions
BadRequestException, InternalServerErrorException, ForbiddenException, NotFoundException, MethodNotAllowedException or TooManyRequestsException.
See also: AWS API Documentation
AWSSDK.Pinpoint.get_segment — Function.using AWSSDK.Pinpoint.get_segment
get_segment([::AWSConfig], arguments::Dict)
get_segment([::AWSConfig]; application-id=, segment-id=)
using AWSCore.Services.pinpoint
pinpoint([::AWSConfig], "GET", "/v1/apps/{application-id}/segments/{segment-id}", arguments::Dict)
pinpoint([::AWSConfig], "GET", "/v1/apps/{application-id}/segments/{segment-id}", application-id=, segment-id=)GetSegment Operation
Returns information about a segment.
Arguments
application-id = ::String – Required
segment-id = ::String – Required
Returns
GetSegmentResponse
Exceptions
BadRequestException, InternalServerErrorException, ForbiddenException, NotFoundException, MethodNotAllowedException or TooManyRequestsException.
See also: AWS API Documentation
AWSSDK.Pinpoint.get_segment_import_jobs — Function.using AWSSDK.Pinpoint.get_segment_import_jobs
get_segment_import_jobs([::AWSConfig], arguments::Dict)
get_segment_import_jobs([::AWSConfig]; application-id=, segment-id=, <keyword arguments>)
using AWSCore.Services.pinpoint
pinpoint([::AWSConfig], "GET", "/v1/apps/{application-id}/segments/{segment-id}/jobs/import", arguments::Dict)
pinpoint([::AWSConfig], "GET", "/v1/apps/{application-id}/segments/{segment-id}/jobs/import", application-id=, segment-id=, <keyword arguments>)GetSegmentImportJobs Operation
Returns a list of import jobs for a specific segment.
Arguments
application-id = ::String – Required
page-size = ::String
The number of entries you want on each page in the response.
segment-id = ::String – Required
token = ::String
The NextToken string returned on a previous page that you use to get the next page of results in a paginated response.
Returns
GetSegmentImportJobsResponse
Exceptions
BadRequestException, InternalServerErrorException, ForbiddenException, NotFoundException, MethodNotAllowedException or TooManyRequestsException.
See also: AWS API Documentation
AWSSDK.Pinpoint.get_segment_version — Function.using AWSSDK.Pinpoint.get_segment_version
get_segment_version([::AWSConfig], arguments::Dict)
get_segment_version([::AWSConfig]; application-id=, segment-id=, version=)
using AWSCore.Services.pinpoint
pinpoint([::AWSConfig], "GET", "/v1/apps/{application-id}/segments/{segment-id}/versions/{version}", arguments::Dict)
pinpoint([::AWSConfig], "GET", "/v1/apps/{application-id}/segments/{segment-id}/versions/{version}", application-id=, segment-id=, version=)GetSegmentVersion Operation
Returns information about a segment version.
Arguments
application-id = ::String – Required
segment-id = ::String – Required
version = ::String – Required
Returns
GetSegmentVersionResponse
Exceptions
BadRequestException, InternalServerErrorException, ForbiddenException, NotFoundException, MethodNotAllowedException or TooManyRequestsException.
See also: AWS API Documentation
AWSSDK.Pinpoint.get_segment_versions — Function.using AWSSDK.Pinpoint.get_segment_versions
get_segment_versions([::AWSConfig], arguments::Dict)
get_segment_versions([::AWSConfig]; application-id=, segment-id=, <keyword arguments>)
using AWSCore.Services.pinpoint
pinpoint([::AWSConfig], "GET", "/v1/apps/{application-id}/segments/{segment-id}/versions", arguments::Dict)
pinpoint([::AWSConfig], "GET", "/v1/apps/{application-id}/segments/{segment-id}/versions", application-id=, segment-id=, <keyword arguments>)GetSegmentVersions Operation
Returns information about your segment versions.
Arguments
application-id = ::String – Required
page-size = ::String
The number of entries you want on each page in the response.
segment-id = ::String – Required
token = ::String
The NextToken string returned on a previous page that you use to get the next page of results in a paginated response.
Returns
GetSegmentVersionsResponse
Exceptions
BadRequestException, InternalServerErrorException, ForbiddenException, NotFoundException, MethodNotAllowedException or TooManyRequestsException.
See also: AWS API Documentation
AWSSDK.Pinpoint.get_segments — Function.using AWSSDK.Pinpoint.get_segments
get_segments([::AWSConfig], arguments::Dict)
get_segments([::AWSConfig]; application-id=, <keyword arguments>)
using AWSCore.Services.pinpoint
pinpoint([::AWSConfig], "GET", "/v1/apps/{application-id}/segments", arguments::Dict)
pinpoint([::AWSConfig], "GET", "/v1/apps/{application-id}/segments", application-id=, <keyword arguments>)GetSegments Operation
Used to get information about your segments.
Arguments
application-id = ::String – Required
page-size = ::String
The number of entries you want on each page in the response.
token = ::String
The NextToken string returned on a previous page that you use to get the next page of results in a paginated response.
Returns
GetSegmentsResponse
Exceptions
BadRequestException, InternalServerErrorException, ForbiddenException, NotFoundException, MethodNotAllowedException or TooManyRequestsException.
See also: AWS API Documentation
AWSSDK.Pinpoint.get_sms_channel — Function.using AWSSDK.Pinpoint.get_sms_channel
get_sms_channel([::AWSConfig], arguments::Dict)
get_sms_channel([::AWSConfig]; application-id=)
using AWSCore.Services.pinpoint
pinpoint([::AWSConfig], "GET", "/v1/apps/{application-id}/channels/sms", arguments::Dict)
pinpoint([::AWSConfig], "GET", "/v1/apps/{application-id}/channels/sms", application-id=)GetSmsChannel Operation
Get an SMS channel
Arguments
application-id = ::String – Required
Returns
GetSmsChannelResponse
Exceptions
BadRequestException, InternalServerErrorException, ForbiddenException, NotFoundException, MethodNotAllowedException or TooManyRequestsException.
See also: AWS API Documentation
AWSSDK.Pinpoint.put_event_stream — Function.using AWSSDK.Pinpoint.put_event_stream
put_event_stream([::AWSConfig], arguments::Dict)
put_event_stream([::AWSConfig]; application-id=, WriteEventStream=)
using AWSCore.Services.pinpoint
pinpoint([::AWSConfig], "POST", "/v1/apps/{application-id}/eventstream", arguments::Dict)
pinpoint([::AWSConfig], "POST", "/v1/apps/{application-id}/eventstream", application-id=, WriteEventStream=)PutEventStream Operation
Use to create or update the event stream for an app.
Arguments
application-id = ::String – Required
ApplicationId
WriteEventStream = [ ... ] – Required
EventStream to write.
WriteEventStream = [
"DestinationStreamArn" => ::String,
"RoleArn" => ::String
]Returns
PutEventStreamResponse
Exceptions
BadRequestException, InternalServerErrorException, ForbiddenException, NotFoundException, MethodNotAllowedException or TooManyRequestsException.
See also: AWS API Documentation
AWSSDK.Pinpoint.send_messages — Function.using AWSSDK.Pinpoint.send_messages
send_messages([::AWSConfig], arguments::Dict)
send_messages([::AWSConfig]; application-id=, MessageRequest=)
using AWSCore.Services.pinpoint
pinpoint([::AWSConfig], "POST", "/v1/apps/{application-id}/messages", arguments::Dict)
pinpoint([::AWSConfig], "POST", "/v1/apps/{application-id}/messages", application-id=, MessageRequest=)SendMessages Operation
Send a batch of messages
Arguments
application-id = ::String – Required
MessageRequest = [ ... ] – Required
MessageRequest = [
"Addresses" => ::Dict{String,String},
"Context" => ::Dict{String,String},
"Endpoints" => ::Dict{String,String},
"MessageConfiguration" => [
"ADMMessage" => [
"Action" => "OPEN_APP", "DEEP_LINK" or "URL",
"Body" => ::String,
"ConsolidationKey" => ::String,
"Data" => ::Dict{String,String},
"ExpiresAfter" => ::String,
"IconReference" => ::String,
"ImageIconUrl" => ::String,
"ImageUrl" => ::String,
"MD5" => ::String,
"RawContent" => ::String,
"SilentPush" => ::Bool,
"SmallImageIconUrl" => ::String,
"Sound" => ::String,
"Substitutions" => ::Dict{String,String},
"Title" => ::String,
"Url" => ::String
],
"APNSMessage" => [
"Action" => "OPEN_APP", "DEEP_LINK" or "URL",
"Badge" => ::Int,
"Body" => ::String,
"Category" => ::String,
"CollapseId" => ::String,
"Data" => ::Dict{String,String},
"MediaUrl" => ::String,
"PreferredAuthenticationMethod" => ::String,
"Priority" => ::String,
"RawContent" => ::String,
"SilentPush" => ::Bool,
"Sound" => ::String,
"Substitutions" => ::Dict{String,String},
"ThreadId" => ::String,
"TimeToLive" => ::Int,
"Title" => ::String,
"Url" => ::String
],
"BaiduMessage" => [
"Action" => "OPEN_APP", "DEEP_LINK" or "URL",
"Body" => ::String,
"Data" => ::Dict{String,String},
"IconReference" => ::String,
"ImageIconUrl" => ::String,
"ImageUrl" => ::String,
"RawContent" => ::String,
"SilentPush" => ::Bool,
"SmallImageIconUrl" => ::String,
"Sound" => ::String,
"Substitutions" => ::Dict{String,String},
"Title" => ::String,
"Url" => ::String
],
"DefaultMessage" => [
"Body" => ::String,
"Substitutions" => ::Dict{String,String}
],
"DefaultPushNotificationMessage" => [
"Action" => "OPEN_APP", "DEEP_LINK" or "URL",
"Body" => ::String,
"Data" => ::Dict{String,String},
"SilentPush" => ::Bool,
"Substitutions" => ::Dict{String,String},
"Title" => ::String,
"Url" => ::String
],
"GCMMessage" => [
"Action" => "OPEN_APP", "DEEP_LINK" or "URL",
"Body" => ::String,
"CollapseKey" => ::String,
"Data" => ::Dict{String,String},
"IconReference" => ::String,
"ImageIconUrl" => ::String,
"ImageUrl" => ::String,
"Priority" => ::String,
"RawContent" => ::String,
"RestrictedPackageName" => ::String,
"SilentPush" => ::Bool,
"SmallImageIconUrl" => ::String,
"Sound" => ::String,
"Substitutions" => ::Dict{String,String},
"TimeToLive" => ::Int,
"Title" => ::String,
"Url" => ::String
],
"SMSMessage" => [
"Body" => ::String,
"MessageType" => "TRANSACTIONAL" or "PROMOTIONAL",
"SenderId" => ::String,
"Substitutions" => ::Dict{String,String}
]
]
]Returns
SendMessagesResponse
Exceptions
BadRequestException, InternalServerErrorException, ForbiddenException, NotFoundException, MethodNotAllowedException or TooManyRequestsException.
See also: AWS API Documentation
AWSSDK.Pinpoint.send_users_messages — Function.using AWSSDK.Pinpoint.send_users_messages
send_users_messages([::AWSConfig], arguments::Dict)
send_users_messages([::AWSConfig]; application-id=, SendUsersMessageRequest=)
using AWSCore.Services.pinpoint
pinpoint([::AWSConfig], "POST", "/v1/apps/{application-id}/users-messages", arguments::Dict)
pinpoint([::AWSConfig], "POST", "/v1/apps/{application-id}/users-messages", application-id=, SendUsersMessageRequest=)SendUsersMessages Operation
Send a batch of messages to users
Arguments
application-id = ::String – Required
SendUsersMessageRequest = [ ... ] – Required
SendUsersMessageRequest = [
"Context" => ::Dict{String,String},
"MessageConfiguration" => [
"ADMMessage" => [
"Action" => "OPEN_APP", "DEEP_LINK" or "URL",
"Body" => ::String,
"ConsolidationKey" => ::String,
"Data" => ::Dict{String,String},
"ExpiresAfter" => ::String,
"IconReference" => ::String,
"ImageIconUrl" => ::String,
"ImageUrl" => ::String,
"MD5" => ::String,
"RawContent" => ::String,
"SilentPush" => ::Bool,
"SmallImageIconUrl" => ::String,
"Sound" => ::String,
"Substitutions" => ::Dict{String,String},
"Title" => ::String,
"Url" => ::String
],
"APNSMessage" => [
"Action" => "OPEN_APP", "DEEP_LINK" or "URL",
"Badge" => ::Int,
"Body" => ::String,
"Category" => ::String,
"CollapseId" => ::String,
"Data" => ::Dict{String,String},
"MediaUrl" => ::String,
"PreferredAuthenticationMethod" => ::String,
"Priority" => ::String,
"RawContent" => ::String,
"SilentPush" => ::Bool,
"Sound" => ::String,
"Substitutions" => ::Dict{String,String},
"ThreadId" => ::String,
"TimeToLive" => ::Int,
"Title" => ::String,
"Url" => ::String
],
"BaiduMessage" => [
"Action" => "OPEN_APP", "DEEP_LINK" or "URL",
"Body" => ::String,
"Data" => ::Dict{String,String},
"IconReference" => ::String,
"ImageIconUrl" => ::String,
"ImageUrl" => ::String,
"RawContent" => ::String,
"SilentPush" => ::Bool,
"SmallImageIconUrl" => ::String,
"Sound" => ::String,
"Substitutions" => ::Dict{String,String},
"Title" => ::String,
"Url" => ::String
],
"DefaultMessage" => [
"Body" => ::String,
"Substitutions" => ::Dict{String,String}
],
"DefaultPushNotificationMessage" => [
"Action" => "OPEN_APP", "DEEP_LINK" or "URL",
"Body" => ::String,
"Data" => ::Dict{String,String},
"SilentPush" => ::Bool,
"Substitutions" => ::Dict{String,String},
"Title" => ::String,
"Url" => ::String
],
"GCMMessage" => [
"Action" => "OPEN_APP", "DEEP_LINK" or "URL",
"Body" => ::String,
"CollapseKey" => ::String,
"Data" => ::Dict{String,String},
"IconReference" => ::String,
"ImageIconUrl" => ::String,
"ImageUrl" => ::String,
"Priority" => ::String,
"RawContent" => ::String,
"RestrictedPackageName" => ::String,
"SilentPush" => ::Bool,
"SmallImageIconUrl" => ::String,
"Sound" => ::String,
"Substitutions" => ::Dict{String,String},
"TimeToLive" => ::Int,
"Title" => ::String,
"Url" => ::String
],
"SMSMessage" => [
"Body" => ::String,
"MessageType" => "TRANSACTIONAL" or "PROMOTIONAL",
"SenderId" => ::String,
"Substitutions" => ::Dict{String,String}
]
],
"Users" => ::Dict{String,String}
]Returns
SendUsersMessagesResponse
Exceptions
BadRequestException, InternalServerErrorException, ForbiddenException, NotFoundException, MethodNotAllowedException or TooManyRequestsException.
See also: AWS API Documentation
AWSSDK.Pinpoint.update_adm_channel — Function.using AWSSDK.Pinpoint.update_adm_channel
update_adm_channel([::AWSConfig], arguments::Dict)
update_adm_channel([::AWSConfig]; ADMChannelRequest=, application-id=)
using AWSCore.Services.pinpoint
pinpoint([::AWSConfig], "PUT", "/v1/apps/{application-id}/channels/adm", arguments::Dict)
pinpoint([::AWSConfig], "PUT", "/v1/apps/{application-id}/channels/adm", ADMChannelRequest=, application-id=)UpdateAdmChannel Operation
Update an ADM channel
Arguments
ADMChannelRequest = [ ... ] – Required
ADMChannelRequest = [
"ClientId" => ::String,
"ClientSecret" => ::String,
"Enabled" => ::Bool
]application-id = ::String – Required
Returns
UpdateAdmChannelResponse
Exceptions
BadRequestException, InternalServerErrorException, ForbiddenException, NotFoundException, MethodNotAllowedException or TooManyRequestsException.
See also: AWS API Documentation
AWSSDK.Pinpoint.update_apns_channel — Function.using AWSSDK.Pinpoint.update_apns_channel
update_apns_channel([::AWSConfig], arguments::Dict)
update_apns_channel([::AWSConfig]; APNSChannelRequest=, application-id=)
using AWSCore.Services.pinpoint
pinpoint([::AWSConfig], "PUT", "/v1/apps/{application-id}/channels/apns", arguments::Dict)
pinpoint([::AWSConfig], "PUT", "/v1/apps/{application-id}/channels/apns", APNSChannelRequest=, application-id=)UpdateApnsChannel Operation
Use to update the APNs channel for an app.
Arguments
APNSChannelRequest = [ ... ] – Required
APNSChannelRequest = [
"BundleId" => ::String,
"Certificate" => ::String,
"DefaultAuthenticationMethod" => ::String,
"Enabled" => ::Bool,
"PrivateKey" => ::String,
"TeamId" => ::String,
"TokenKey" => ::String,
"TokenKeyId" => ::String
]application-id = ::String – Required
Returns
UpdateApnsChannelResponse
Exceptions
BadRequestException, InternalServerErrorException, ForbiddenException, NotFoundException, MethodNotAllowedException or TooManyRequestsException.
See also: AWS API Documentation
AWSSDK.Pinpoint.update_apns_sandbox_channel — Function.using AWSSDK.Pinpoint.update_apns_sandbox_channel
update_apns_sandbox_channel([::AWSConfig], arguments::Dict)
update_apns_sandbox_channel([::AWSConfig]; APNSSandboxChannelRequest=, application-id=)
using AWSCore.Services.pinpoint
pinpoint([::AWSConfig], "PUT", "/v1/apps/{application-id}/channels/apns_sandbox", arguments::Dict)
pinpoint([::AWSConfig], "PUT", "/v1/apps/{application-id}/channels/apns_sandbox", APNSSandboxChannelRequest=, application-id=)UpdateApnsSandboxChannel Operation
Update an APNS sandbox channel
Arguments
APNSSandboxChannelRequest = [ ... ] – Required
APNSSandboxChannelRequest = [
"BundleId" => ::String,
"Certificate" => ::String,
"DefaultAuthenticationMethod" => ::String,
"Enabled" => ::Bool,
"PrivateKey" => ::String,
"TeamId" => ::String,
"TokenKey" => ::String,
"TokenKeyId" => ::String
]application-id = ::String – Required
Returns
UpdateApnsSandboxChannelResponse
Exceptions
BadRequestException, InternalServerErrorException, ForbiddenException, NotFoundException, MethodNotAllowedException or TooManyRequestsException.
See also: AWS API Documentation
AWSSDK.Pinpoint.update_apns_voip_channel — Function.using AWSSDK.Pinpoint.update_apns_voip_channel
update_apns_voip_channel([::AWSConfig], arguments::Dict)
update_apns_voip_channel([::AWSConfig]; APNSVoipChannelRequest=, application-id=)
using AWSCore.Services.pinpoint
pinpoint([::AWSConfig], "PUT", "/v1/apps/{application-id}/channels/apns_voip", arguments::Dict)
pinpoint([::AWSConfig], "PUT", "/v1/apps/{application-id}/channels/apns_voip", APNSVoipChannelRequest=, application-id=)UpdateApnsVoipChannel Operation
Update an APNS VoIP channel
Arguments
APNSVoipChannelRequest = [ ... ] – Required
APNSVoipChannelRequest = [
"BundleId" => ::String,
"Certificate" => ::String,
"DefaultAuthenticationMethod" => ::String,
"Enabled" => ::Bool,
"PrivateKey" => ::String,
"TeamId" => ::String,
"TokenKey" => ::String,
"TokenKeyId" => ::String
]application-id = ::String – Required
Returns
UpdateApnsVoipChannelResponse
Exceptions
BadRequestException, InternalServerErrorException, ForbiddenException, NotFoundException, MethodNotAllowedException or TooManyRequestsException.
See also: AWS API Documentation
AWSSDK.Pinpoint.update_apns_voip_sandbox_channel — Function.using AWSSDK.Pinpoint.update_apns_voip_sandbox_channel
update_apns_voip_sandbox_channel([::AWSConfig], arguments::Dict)
update_apns_voip_sandbox_channel([::AWSConfig]; APNSVoipSandboxChannelRequest=, application-id=)
using AWSCore.Services.pinpoint
pinpoint([::AWSConfig], "PUT", "/v1/apps/{application-id}/channels/apns_voip_sandbox", arguments::Dict)
pinpoint([::AWSConfig], "PUT", "/v1/apps/{application-id}/channels/apns_voip_sandbox", APNSVoipSandboxChannelRequest=, application-id=)UpdateApnsVoipSandboxChannel Operation
Update an APNS VoIP sandbox channel
Arguments
APNSVoipSandboxChannelRequest = [ ... ] – Required
APNSVoipSandboxChannelRequest = [
"BundleId" => ::String,
"Certificate" => ::String,
"DefaultAuthenticationMethod" => ::String,
"Enabled" => ::Bool,
"PrivateKey" => ::String,
"TeamId" => ::String,
"TokenKey" => ::String,
"TokenKeyId" => ::String
]application-id = ::String – Required
Returns
UpdateApnsVoipSandboxChannelResponse
Exceptions
BadRequestException, InternalServerErrorException, ForbiddenException, NotFoundException, MethodNotAllowedException or TooManyRequestsException.
See also: AWS API Documentation
AWSSDK.Pinpoint.update_application_settings — Function.using AWSSDK.Pinpoint.update_application_settings
update_application_settings([::AWSConfig], arguments::Dict)
update_application_settings([::AWSConfig]; application-id=, WriteApplicationSettingsRequest=)
using AWSCore.Services.pinpoint
pinpoint([::AWSConfig], "PUT", "/v1/apps/{application-id}/settings", arguments::Dict)
pinpoint([::AWSConfig], "PUT", "/v1/apps/{application-id}/settings", application-id=, WriteApplicationSettingsRequest=)UpdateApplicationSettings Operation
Used to update the settings for an app.
Arguments
application-id = ::String – Required
WriteApplicationSettingsRequest = [ ... ] – Required
WriteApplicationSettingsRequest = [
"Limits" => [
"Daily" => ::Int,
"MaximumDuration" => ::Int,
"MessagesPerSecond" => ::Int,
"Total" => ::Int
],
"QuietTime" => [
"End" => ::String,
"Start" => ::String
]
]Returns
UpdateApplicationSettingsResponse
Exceptions
BadRequestException, InternalServerErrorException, ForbiddenException, NotFoundException, MethodNotAllowedException or TooManyRequestsException.
See also: AWS API Documentation
AWSSDK.Pinpoint.update_baidu_channel — Function.using AWSSDK.Pinpoint.update_baidu_channel
update_baidu_channel([::AWSConfig], arguments::Dict)
update_baidu_channel([::AWSConfig]; application-id=, BaiduChannelRequest=)
using AWSCore.Services.pinpoint
pinpoint([::AWSConfig], "PUT", "/v1/apps/{application-id}/channels/baidu", arguments::Dict)
pinpoint([::AWSConfig], "PUT", "/v1/apps/{application-id}/channels/baidu", application-id=, BaiduChannelRequest=)UpdateBaiduChannel Operation
Update a BAIDU GCM channel
Arguments
application-id = ::String – Required
BaiduChannelRequest = [ ... ] – Required
BaiduChannelRequest = [
"ApiKey" => ::String,
"Enabled" => ::Bool,
"SecretKey" => ::String
]Returns
UpdateBaiduChannelResponse
Exceptions
BadRequestException, InternalServerErrorException, ForbiddenException, NotFoundException, MethodNotAllowedException or TooManyRequestsException.
See also: AWS API Documentation
AWSSDK.Pinpoint.update_campaign — Function.using AWSSDK.Pinpoint.update_campaign
update_campaign([::AWSConfig], arguments::Dict)
update_campaign([::AWSConfig]; application-id=, campaign-id=, WriteCampaignRequest=)
using AWSCore.Services.pinpoint
pinpoint([::AWSConfig], "PUT", "/v1/apps/{application-id}/campaigns/{campaign-id}", arguments::Dict)
pinpoint([::AWSConfig], "PUT", "/v1/apps/{application-id}/campaigns/{campaign-id}", application-id=, campaign-id=, WriteCampaignRequest=)UpdateCampaign Operation
Use to update a campaign.
Arguments
application-id = ::String – Required
campaign-id = ::String – Required
WriteCampaignRequest = [ ... ] – Required
WriteCampaignRequest = [
"AdditionalTreatments" => [[
"MessageConfiguration" => [
"ADMMessage" => [
"Action" => "OPEN_APP", "DEEP_LINK" or "URL",
"Body" => ::String,
"ImageIconUrl" => ::String,
"ImageSmallIconUrl" => ::String,
"ImageUrl" => ::String,
"JsonBody" => ::String,
"MediaUrl" => ::String,
"RawContent" => ::String,
"SilentPush" => ::Bool,
"Title" => ::String,
"Url" => ::String
],
"APNSMessage" => [
"Action" => "OPEN_APP", "DEEP_LINK" or "URL",
"Body" => ::String,
"ImageIconUrl" => ::String,
"ImageSmallIconUrl" => ::String,
"ImageUrl" => ::String,
"JsonBody" => ::String,
"MediaUrl" => ::String,
"RawContent" => ::String,
"SilentPush" => ::Bool,
"Title" => ::String,
"Url" => ::String
],
"BaiduMessage" => [
"Action" => "OPEN_APP", "DEEP_LINK" or "URL",
"Body" => ::String,
"ImageIconUrl" => ::String,
"ImageSmallIconUrl" => ::String,
"ImageUrl" => ::String,
"JsonBody" => ::String,
"MediaUrl" => ::String,
"RawContent" => ::String,
"SilentPush" => ::Bool,
"Title" => ::String,
"Url" => ::String
],
"DefaultMessage" => [
"Action" => "OPEN_APP", "DEEP_LINK" or "URL",
"Body" => ::String,
"ImageIconUrl" => ::String,
"ImageSmallIconUrl" => ::String,
"ImageUrl" => ::String,
"JsonBody" => ::String,
"MediaUrl" => ::String,
"RawContent" => ::String,
"SilentPush" => ::Bool,
"Title" => ::String,
"Url" => ::String
],
"EmailMessage" => [
"Body" => ::String,
"FromAddress" => ::String,
"HtmlBody" => ::String,
"Title" => ::String
],
"GCMMessage" => [
"Action" => "OPEN_APP", "DEEP_LINK" or "URL",
"Body" => ::String,
"ImageIconUrl" => ::String,
"ImageSmallIconUrl" => ::String,
"ImageUrl" => ::String,
"JsonBody" => ::String,
"MediaUrl" => ::String,
"RawContent" => ::String,
"SilentPush" => ::Bool,
"Title" => ::String,
"Url" => ::String
],
"SMSMessage" => [
"Body" => ::String,
"MessageType" => "TRANSACTIONAL" or "PROMOTIONAL",
"SenderId" => ::String
]
],
"Schedule" => [
"EndTime" => ::String,
"Frequency" => "ONCE", "HOURLY", "DAILY", "WEEKLY" or "MONTHLY",
"IsLocalTime" => ::Bool,
"QuietTime" => [
"End" => ::String,
"Start" => ::String
],
"StartTime" => ::String,
"Timezone" => ::String
],
"SizePercent" => ::Int,
"TreatmentDescription" => ::String,
"TreatmentName" => ::String
], ...],
"Description" => ::String,
"HoldoutPercent" => ::Int,
"IsPaused" => ::Bool,
"Limits" => [
"Daily" => ::Int,
"MaximumDuration" => ::Int,
"MessagesPerSecond" => ::Int,
"Total" => ::Int
],
"MessageConfiguration" => [
"ADMMessage" => [
"Action" => "OPEN_APP", "DEEP_LINK" or "URL",
"Body" => ::String,
"ImageIconUrl" => ::String,
"ImageSmallIconUrl" => ::String,
"ImageUrl" => ::String,
"JsonBody" => ::String,
"MediaUrl" => ::String,
"RawContent" => ::String,
"SilentPush" => ::Bool,
"Title" => ::String,
"Url" => ::String
],
"APNSMessage" => [
"Action" => "OPEN_APP", "DEEP_LINK" or "URL",
"Body" => ::String,
"ImageIconUrl" => ::String,
"ImageSmallIconUrl" => ::String,
"ImageUrl" => ::String,
"JsonBody" => ::String,
"MediaUrl" => ::String,
"RawContent" => ::String,
"SilentPush" => ::Bool,
"Title" => ::String,
"Url" => ::String
],
"BaiduMessage" => [
"Action" => "OPEN_APP", "DEEP_LINK" or "URL",
"Body" => ::String,
"ImageIconUrl" => ::String,
"ImageSmallIconUrl" => ::String,
"ImageUrl" => ::String,
"JsonBody" => ::String,
"MediaUrl" => ::String,
"RawContent" => ::String,
"SilentPush" => ::Bool,
"Title" => ::String,
"Url" => ::String
],
"DefaultMessage" => [
"Action" => "OPEN_APP", "DEEP_LINK" or "URL",
"Body" => ::String,
"ImageIconUrl" => ::String,
"ImageSmallIconUrl" => ::String,
"ImageUrl" => ::String,
"JsonBody" => ::String,
"MediaUrl" => ::String,
"RawContent" => ::String,
"SilentPush" => ::Bool,
"Title" => ::String,
"Url" => ::String
],
"EmailMessage" => [
"Body" => ::String,
"FromAddress" => ::String,
"HtmlBody" => ::String,
"Title" => ::String
],
"GCMMessage" => [
"Action" => "OPEN_APP", "DEEP_LINK" or "URL",
"Body" => ::String,
"ImageIconUrl" => ::String,
"ImageSmallIconUrl" => ::String,
"ImageUrl" => ::String,
"JsonBody" => ::String,
"MediaUrl" => ::String,
"RawContent" => ::String,
"SilentPush" => ::Bool,
"Title" => ::String,
"Url" => ::String
],
"SMSMessage" => [
"Body" => ::String,
"MessageType" => "TRANSACTIONAL" or "PROMOTIONAL",
"SenderId" => ::String
]
],
"Name" => ::String,
"Schedule" => [
"EndTime" => ::String,
"Frequency" => "ONCE", "HOURLY", "DAILY", "WEEKLY" or "MONTHLY",
"IsLocalTime" => ::Bool,
"QuietTime" => [
"End" => ::String,
"Start" => ::String
],
"StartTime" => ::String,
"Timezone" => ::String
],
"SegmentId" => ::String,
"SegmentVersion" => ::Int,
"TreatmentDescription" => ::String,
"TreatmentName" => ::String
]Returns
UpdateCampaignResponse
Exceptions
BadRequestException, InternalServerErrorException, ForbiddenException, NotFoundException, MethodNotAllowedException or TooManyRequestsException.
See also: AWS API Documentation
AWSSDK.Pinpoint.update_email_channel — Function.using AWSSDK.Pinpoint.update_email_channel
update_email_channel([::AWSConfig], arguments::Dict)
update_email_channel([::AWSConfig]; application-id=, EmailChannelRequest=)
using AWSCore.Services.pinpoint
pinpoint([::AWSConfig], "PUT", "/v1/apps/{application-id}/channels/email", arguments::Dict)
pinpoint([::AWSConfig], "PUT", "/v1/apps/{application-id}/channels/email", application-id=, EmailChannelRequest=)UpdateEmailChannel Operation
Update an email channel
Arguments
application-id = ::String – Required
EmailChannelRequest = [ ... ] – Required
EmailChannelRequest = [
"Enabled" => ::Bool,
"FromAddress" => ::String,
"Identity" => ::String,
"RoleArn" => ::String
]Returns
UpdateEmailChannelResponse
Exceptions
BadRequestException, InternalServerErrorException, ForbiddenException, NotFoundException, MethodNotAllowedException or TooManyRequestsException.
See also: AWS API Documentation
AWSSDK.Pinpoint.update_endpoint — Function.using AWSSDK.Pinpoint.update_endpoint
update_endpoint([::AWSConfig], arguments::Dict)
update_endpoint([::AWSConfig]; application-id=, endpoint-id=, EndpointRequest=)
using AWSCore.Services.pinpoint
pinpoint([::AWSConfig], "PUT", "/v1/apps/{application-id}/endpoints/{endpoint-id}", arguments::Dict)
pinpoint([::AWSConfig], "PUT", "/v1/apps/{application-id}/endpoints/{endpoint-id}", application-id=, endpoint-id=, EndpointRequest=)UpdateEndpoint Operation
Use to update an endpoint.
Arguments
application-id = ::String – Required
endpoint-id = ::String – Required
EndpointRequest = [ ... ] – Required
EndpointRequest = [
"Address" => ::String,
"Attributes" => ::Dict{String,String},
"ChannelType" => "GCM", "APNS", "APNS_SANDBOX", "APNS_VOIP", "APNS_VOIP_SANDBOX", "ADM", "SMS", "EMAIL" or "BAIDU",
"Demographic" => [
"AppVersion" => ::String,
"Locale" => ::String,
"Make" => ::String,
"Model" => ::String,
"ModelVersion" => ::String,
"Platform" => ::String,
"PlatformVersion" => ::String,
"Timezone" => ::String
],
"EffectiveDate" => ::String,
"EndpointStatus" => ::String,
"Location" => [
"City" => ::String,
"Country" => ::String,
"Latitude" => double,
"Longitude" => double,
"PostalCode" => ::String,
"Region" => ::String
],
"Metrics" => ::Dict{String,String},
"OptOut" => ::String,
"RequestId" => ::String,
"User" => [
"UserAttributes" => ::Dict{String,String},
"UserId" => ::String
]
]Returns
UpdateEndpointResponse
Exceptions
BadRequestException, InternalServerErrorException, ForbiddenException, NotFoundException, MethodNotAllowedException or TooManyRequestsException.
See also: AWS API Documentation
AWSSDK.Pinpoint.update_endpoints_batch — Function.using AWSSDK.Pinpoint.update_endpoints_batch
update_endpoints_batch([::AWSConfig], arguments::Dict)
update_endpoints_batch([::AWSConfig]; application-id=, EndpointBatchRequest=)
using AWSCore.Services.pinpoint
pinpoint([::AWSConfig], "PUT", "/v1/apps/{application-id}/endpoints", arguments::Dict)
pinpoint([::AWSConfig], "PUT", "/v1/apps/{application-id}/endpoints", application-id=, EndpointBatchRequest=)UpdateEndpointsBatch Operation
Use to update a batch of endpoints.
Arguments
application-id = ::String – Required
EndpointBatchRequest = ["Item" => [[ ... ], ...]] – Required
EndpointBatchRequest = ["Item" => [[
"Address" => ::String,
"Attributes" => ::Dict{String,String},
"ChannelType" => "GCM", "APNS", "APNS_SANDBOX", "APNS_VOIP", "APNS_VOIP_SANDBOX", "ADM", "SMS", "EMAIL" or "BAIDU",
"Demographic" => [
"AppVersion" => ::String,
"Locale" => ::String,
"Make" => ::String,
"Model" => ::String,
"ModelVersion" => ::String,
"Platform" => ::String,
"PlatformVersion" => ::String,
"Timezone" => ::String
],
"EffectiveDate" => ::String,
"EndpointStatus" => ::String,
"Id" => ::String,
"Location" => [
"City" => ::String,
"Country" => ::String,
"Latitude" => double,
"Longitude" => double,
"PostalCode" => ::String,
"Region" => ::String
],
"Metrics" => ::Dict{String,String},
"OptOut" => ::String,
"RequestId" => ::String,
"User" => [
"UserAttributes" => ::Dict{String,String},
"UserId" => ::String
]
], ...]]Returns
UpdateEndpointsBatchResponse
Exceptions
BadRequestException, InternalServerErrorException, ForbiddenException, NotFoundException, MethodNotAllowedException or TooManyRequestsException.
See also: AWS API Documentation
AWSSDK.Pinpoint.update_gcm_channel — Function.using AWSSDK.Pinpoint.update_gcm_channel
update_gcm_channel([::AWSConfig], arguments::Dict)
update_gcm_channel([::AWSConfig]; application-id=, GCMChannelRequest=)
using AWSCore.Services.pinpoint
pinpoint([::AWSConfig], "PUT", "/v1/apps/{application-id}/channels/gcm", arguments::Dict)
pinpoint([::AWSConfig], "PUT", "/v1/apps/{application-id}/channels/gcm", application-id=, GCMChannelRequest=)UpdateGcmChannel Operation
Use to update the GCM channel for an app.
Arguments
application-id = ::String – Required
GCMChannelRequest = [ ... ] – Required
GCMChannelRequest = [
"ApiKey" => ::String,
"Enabled" => ::Bool
]Returns
UpdateGcmChannelResponse
Exceptions
BadRequestException, InternalServerErrorException, ForbiddenException, NotFoundException, MethodNotAllowedException or TooManyRequestsException.
See also: AWS API Documentation
AWSSDK.Pinpoint.update_segment — Function.using AWSSDK.Pinpoint.update_segment
update_segment([::AWSConfig], arguments::Dict)
update_segment([::AWSConfig]; application-id=, segment-id=, WriteSegmentRequest=)
using AWSCore.Services.pinpoint
pinpoint([::AWSConfig], "PUT", "/v1/apps/{application-id}/segments/{segment-id}", arguments::Dict)
pinpoint([::AWSConfig], "PUT", "/v1/apps/{application-id}/segments/{segment-id}", application-id=, segment-id=, WriteSegmentRequest=)UpdateSegment Operation
Use to update a segment.
Arguments
application-id = ::String – Required
segment-id = ::String – Required
WriteSegmentRequest = [ ... ] – Required
WriteSegmentRequest = [
"Dimensions" => [
"Attributes" => ::Dict{String,String},
"Behavior" => ["Recency" => [
"Duration" => "HR_24", "DAY_7", "DAY_14" or "DAY_30",
"RecencyType" => "ACTIVE" or "INACTIVE"
]],
"Demographic" => [
"AppVersion" => [
"DimensionType" => "INCLUSIVE" or "EXCLUSIVE",
"Values" => [::String, ...]
],
"Channel" => [
"DimensionType" => "INCLUSIVE" or "EXCLUSIVE",
"Values" => [::String, ...]
],
"DeviceType" => [
"DimensionType" => "INCLUSIVE" or "EXCLUSIVE",
"Values" => [::String, ...]
],
"Make" => [
"DimensionType" => "INCLUSIVE" or "EXCLUSIVE",
"Values" => [::String, ...]
],
"Model" => [
"DimensionType" => "INCLUSIVE" or "EXCLUSIVE",
"Values" => [::String, ...]
],
"Platform" => [
"DimensionType" => "INCLUSIVE" or "EXCLUSIVE",
"Values" => [::String, ...]
]
],
"Location" => ["Country" => [
"DimensionType" => "INCLUSIVE" or "EXCLUSIVE",
"Values" => [::String, ...]
]],
"UserAttributes" => ::Dict{String,String}
],
"Name" => ::String
]Returns
UpdateSegmentResponse
Exceptions
BadRequestException, InternalServerErrorException, ForbiddenException, NotFoundException, MethodNotAllowedException or TooManyRequestsException.
See also: AWS API Documentation
AWSSDK.Pinpoint.update_sms_channel — Function.using AWSSDK.Pinpoint.update_sms_channel
update_sms_channel([::AWSConfig], arguments::Dict)
update_sms_channel([::AWSConfig]; application-id=, SMSChannelRequest=)
using AWSCore.Services.pinpoint
pinpoint([::AWSConfig], "PUT", "/v1/apps/{application-id}/channels/sms", arguments::Dict)
pinpoint([::AWSConfig], "PUT", "/v1/apps/{application-id}/channels/sms", application-id=, SMSChannelRequest=)UpdateSmsChannel Operation
Update an SMS channel
Arguments
application-id = ::String – Required
SMSChannelRequest = [ ... ] – Required
SMSChannelRequest = [
"Enabled" => ::Bool,
"SenderId" => ::String,
"ShortCode" => ::String
]Returns
UpdateSmsChannelResponse
Exceptions
BadRequestException, InternalServerErrorException, ForbiddenException, NotFoundException, MethodNotAllowedException or TooManyRequestsException.
See also: AWS API Documentation