Soto icon

Soto

Pinpoint

Service object for interacting with AWS Pinpoint service.

public struct Pinpoint: AWSService

Doc Engage API - Amazon Pinpoint API

Inheritance

AWSService

Initializers

init(client:region:partition:endpoint:timeout:byteBufferAllocator:options:)

Initialize the Pinpoint client

public init(client: AWSClient, region: SotoCore.Region? = nil, partition: AWSPartition = .aws, endpoint: String? = nil, timeout: TimeAmount? = nil, byteBufferAllocator: ByteBufferAllocator = ByteBufferAllocator(), options: AWSServiceConfig.Options = [])

Parameters

  • client: AWSClient used to process requests
  • region: Region of server you want to communicate with. This will override the partition parameter.
  • partition: AWS partition where service resides, standard (.aws), china (.awscn), government (.awsusgov).
  • endpoint: Custom endpoint URL to use instead of standard AWS servers
  • timeout: Timeout value for HTTP requests

init(from:patch:)

Initializer required by AWSService.with(middlewares:​timeout:​byteBufferAllocator:​options). You are not able to use this initializer directly as there are no public initializers for AWSServiceConfig.Patch. Please use AWSService.with(middlewares:​timeout:​byteBufferAllocator:​options) instead.

public init(from: Pinpoint, patch: AWSServiceConfig.Patch)

Properties

client

Client used for communication with AWS

let client: AWSClient

config

Service configuration

let config: AWSServiceConfig

Methods

createApp(_:logger:on:)

public func createApp(_ input: CreateAppRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<CreateAppResponse>

Creates an application.

createCampaign(_:logger:on:)

public func createCampaign(_ input: CreateCampaignRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<CreateCampaignResponse>

Creates a new campaign for an application or updates the settings of an existing campaign for an application.

createEmailTemplate(_:logger:on:)

public func createEmailTemplate(_ input: CreateEmailTemplateRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<CreateEmailTemplateResponse>

Creates a message template for messages that are sent through the email channel.

createExportJob(_:logger:on:)

public func createExportJob(_ input: CreateExportJobRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<CreateExportJobResponse>

Creates an export job for an application.

createImportJob(_:logger:on:)

public func createImportJob(_ input: CreateImportJobRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<CreateImportJobResponse>

Creates an import job for an application.

createJourney(_:logger:on:)

public func createJourney(_ input: CreateJourneyRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<CreateJourneyResponse>

Creates a journey for an application.

createPushTemplate(_:logger:on:)

public func createPushTemplate(_ input: CreatePushTemplateRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<CreatePushTemplateResponse>

Creates a message template for messages that are sent through a push notification channel.

createRecommenderConfiguration(_:logger:on:)

public func createRecommenderConfiguration(_ input: CreateRecommenderConfigurationRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<CreateRecommenderConfigurationResponse>

Creates an Amazon Pinpoint configuration for a recommender model.

createSegment(_:logger:on:)

public func createSegment(_ input: CreateSegmentRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<CreateSegmentResponse>

Creates a new segment for an application or updates the configuration, dimension, and other settings for an existing segment that's associated with an application.

createSmsTemplate(_:logger:on:)

public func createSmsTemplate(_ input: CreateSmsTemplateRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<CreateSmsTemplateResponse>

Creates a message template for messages that are sent through the SMS channel.

createVoiceTemplate(_:logger:on:)

public func createVoiceTemplate(_ input: CreateVoiceTemplateRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<CreateVoiceTemplateResponse>

Creates a message template for messages that are sent through the voice channel.

deleteAdmChannel(_:logger:on:)

public func deleteAdmChannel(_ input: DeleteAdmChannelRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DeleteAdmChannelResponse>

Disables the ADM channel for an application and deletes any existing settings for the channel.

deleteApnsChannel(_:logger:on:)

public func deleteApnsChannel(_ input: DeleteApnsChannelRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DeleteApnsChannelResponse>

Disables the APNs channel for an application and deletes any existing settings for the channel.

deleteApnsSandboxChannel(_:logger:on:)

public func deleteApnsSandboxChannel(_ input: DeleteApnsSandboxChannelRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DeleteApnsSandboxChannelResponse>

Disables the APNs sandbox channel for an application and deletes any existing settings for the channel.

deleteApnsVoipChannel(_:logger:on:)

public func deleteApnsVoipChannel(_ input: DeleteApnsVoipChannelRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DeleteApnsVoipChannelResponse>

Disables the APNs VoIP channel for an application and deletes any existing settings for the channel.

deleteApnsVoipSandboxChannel(_:logger:on:)

public func deleteApnsVoipSandboxChannel(_ input: DeleteApnsVoipSandboxChannelRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DeleteApnsVoipSandboxChannelResponse>

Disables the APNs VoIP sandbox channel for an application and deletes any existing settings for the channel.

deleteApp(_:logger:on:)

public func deleteApp(_ input: DeleteAppRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DeleteAppResponse>

Deletes an application.

deleteBaiduChannel(_:logger:on:)

public func deleteBaiduChannel(_ input: DeleteBaiduChannelRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DeleteBaiduChannelResponse>

Disables the Baidu channel for an application and deletes any existing settings for the channel.

deleteCampaign(_:logger:on:)

public func deleteCampaign(_ input: DeleteCampaignRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DeleteCampaignResponse>

Deletes a campaign from an application.

deleteEmailChannel(_:logger:on:)

public func deleteEmailChannel(_ input: DeleteEmailChannelRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DeleteEmailChannelResponse>

Disables the email channel for an application and deletes any existing settings for the channel.

deleteEmailTemplate(_:logger:on:)

public func deleteEmailTemplate(_ input: DeleteEmailTemplateRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DeleteEmailTemplateResponse>

Deletes a message template for messages that were sent through the email channel.

deleteEndpoint(_:logger:on:)

public func deleteEndpoint(_ input: DeleteEndpointRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DeleteEndpointResponse>

Deletes an endpoint from an application.

deleteEventStream(_:logger:on:)

public func deleteEventStream(_ input: DeleteEventStreamRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DeleteEventStreamResponse>

Deletes the event stream for an application.

deleteGcmChannel(_:logger:on:)

public func deleteGcmChannel(_ input: DeleteGcmChannelRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DeleteGcmChannelResponse>

Disables the GCM channel for an application and deletes any existing settings for the channel.

deleteJourney(_:logger:on:)

public func deleteJourney(_ input: DeleteJourneyRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DeleteJourneyResponse>

Deletes a journey from an application.

deletePushTemplate(_:logger:on:)

public func deletePushTemplate(_ input: DeletePushTemplateRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DeletePushTemplateResponse>

Deletes a message template for messages that were sent through a push notification channel.

deleteRecommenderConfiguration(_:logger:on:)

public func deleteRecommenderConfiguration(_ input: DeleteRecommenderConfigurationRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DeleteRecommenderConfigurationResponse>

Deletes an Amazon Pinpoint configuration for a recommender model.

deleteSegment(_:logger:on:)

public func deleteSegment(_ input: DeleteSegmentRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DeleteSegmentResponse>

Deletes a segment from an application.

deleteSmsChannel(_:logger:on:)

public func deleteSmsChannel(_ input: DeleteSmsChannelRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DeleteSmsChannelResponse>

Disables the SMS channel for an application and deletes any existing settings for the channel.

deleteSmsTemplate(_:logger:on:)

public func deleteSmsTemplate(_ input: DeleteSmsTemplateRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DeleteSmsTemplateResponse>

Deletes a message template for messages that were sent through the SMS channel.

deleteUserEndpoints(_:logger:on:)

public func deleteUserEndpoints(_ input: DeleteUserEndpointsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DeleteUserEndpointsResponse>

Deletes all the endpoints that are associated with a specific user ID.

deleteVoiceChannel(_:logger:on:)

public func deleteVoiceChannel(_ input: DeleteVoiceChannelRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DeleteVoiceChannelResponse>

Disables the voice channel for an application and deletes any existing settings for the channel.

deleteVoiceTemplate(_:logger:on:)

public func deleteVoiceTemplate(_ input: DeleteVoiceTemplateRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DeleteVoiceTemplateResponse>

Deletes a message template for messages that were sent through the voice channel.

getAdmChannel(_:logger:on:)

public func getAdmChannel(_ input: GetAdmChannelRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetAdmChannelResponse>

Retrieves information about the status and settings of the ADM channel for an application.

getApnsChannel(_:logger:on:)

public func getApnsChannel(_ input: GetApnsChannelRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetApnsChannelResponse>

Retrieves information about the status and settings of the APNs channel for an application.

getApnsSandboxChannel(_:logger:on:)

public func getApnsSandboxChannel(_ input: GetApnsSandboxChannelRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetApnsSandboxChannelResponse>

Retrieves information about the status and settings of the APNs sandbox channel for an application.

getApnsVoipChannel(_:logger:on:)

public func getApnsVoipChannel(_ input: GetApnsVoipChannelRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetApnsVoipChannelResponse>

Retrieves information about the status and settings of the APNs VoIP channel for an application.

getApnsVoipSandboxChannel(_:logger:on:)

public func getApnsVoipSandboxChannel(_ input: GetApnsVoipSandboxChannelRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetApnsVoipSandboxChannelResponse>

Retrieves information about the status and settings of the APNs VoIP sandbox channel for an application.

getApp(_:logger:on:)

public func getApp(_ input: GetAppRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetAppResponse>

Retrieves information about an application.

getApplicationDateRangeKpi(_:logger:on:)

public func getApplicationDateRangeKpi(_ input: GetApplicationDateRangeKpiRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetApplicationDateRangeKpiResponse>

Retrieves (queries) pre-aggregated data for a standard metric that applies to an application.

getApplicationSettings(_:logger:on:)

public func getApplicationSettings(_ input: GetApplicationSettingsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetApplicationSettingsResponse>

Retrieves information about the settings for an application.

getApps(_:logger:on:)

public func getApps(_ input: GetAppsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetAppsResponse>

Retrieves information about all the applications that are associated with your Amazon Pinpoint account.

getBaiduChannel(_:logger:on:)

public func getBaiduChannel(_ input: GetBaiduChannelRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetBaiduChannelResponse>

Retrieves information about the status and settings of the Baidu channel for an application.

getCampaign(_:logger:on:)

public func getCampaign(_ input: GetCampaignRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetCampaignResponse>

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

getCampaignActivities(_:logger:on:)

public func getCampaignActivities(_ input: GetCampaignActivitiesRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetCampaignActivitiesResponse>

Retrieves information about all the activities for a campaign.

getCampaignDateRangeKpi(_:logger:on:)

public func getCampaignDateRangeKpi(_ input: GetCampaignDateRangeKpiRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetCampaignDateRangeKpiResponse>

Retrieves (queries) pre-aggregated data for a standard metric that applies to a campaign.

getCampaignVersion(_:logger:on:)

public func getCampaignVersion(_ input: GetCampaignVersionRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetCampaignVersionResponse>

Retrieves information about the status, configuration, and other settings for a specific version of a campaign.

getCampaignVersions(_:logger:on:)

public func getCampaignVersions(_ input: GetCampaignVersionsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetCampaignVersionsResponse>

Retrieves information about the status, configuration, and other settings for all versions of a campaign.

getCampaigns(_:logger:on:)

public func getCampaigns(_ input: GetCampaignsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetCampaignsResponse>

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

getChannels(_:logger:on:)

public func getChannels(_ input: GetChannelsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetChannelsResponse>

Retrieves information about the history and status of each channel for an application.

getEmailChannel(_:logger:on:)

public func getEmailChannel(_ input: GetEmailChannelRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetEmailChannelResponse>

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

getEmailTemplate(_:logger:on:)

public func getEmailTemplate(_ input: GetEmailTemplateRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetEmailTemplateResponse>

Retrieves the content and settings of a message template for messages that are sent through the email channel.

getEndpoint(_:logger:on:)

public func getEndpoint(_ input: GetEndpointRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetEndpointResponse>

Retrieves information about the settings and attributes of a specific endpoint for an application.

getEventStream(_:logger:on:)

public func getEventStream(_ input: GetEventStreamRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetEventStreamResponse>

Retrieves information about the event stream settings for an application.

getExportJob(_:logger:on:)

public func getExportJob(_ input: GetExportJobRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetExportJobResponse>

Retrieves information about the status and settings of a specific export job for an application.

getExportJobs(_:logger:on:)

public func getExportJobs(_ input: GetExportJobsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetExportJobsResponse>

Retrieves information about the status and settings of all the export jobs for an application.

getGcmChannel(_:logger:on:)

public func getGcmChannel(_ input: GetGcmChannelRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetGcmChannelResponse>

Retrieves information about the status and settings of the GCM channel for an application.

getImportJob(_:logger:on:)

public func getImportJob(_ input: GetImportJobRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetImportJobResponse>

Retrieves information about the status and settings of a specific import job for an application.

getImportJobs(_:logger:on:)

public func getImportJobs(_ input: GetImportJobsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetImportJobsResponse>

Retrieves information about the status and settings of all the import jobs for an application.

getJourney(_:logger:on:)

public func getJourney(_ input: GetJourneyRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetJourneyResponse>

Retrieves information about the status, configuration, and other settings for a journey.

getJourneyDateRangeKpi(_:logger:on:)

public func getJourneyDateRangeKpi(_ input: GetJourneyDateRangeKpiRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetJourneyDateRangeKpiResponse>

Retrieves (queries) pre-aggregated data for a standard engagement metric that applies to a journey.

getJourneyExecutionActivityMetrics(_:logger:on:)

public func getJourneyExecutionActivityMetrics(_ input: GetJourneyExecutionActivityMetricsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetJourneyExecutionActivityMetricsResponse>

Retrieves (queries) pre-aggregated data for a standard execution metric that applies to a journey activity.

getJourneyExecutionMetrics(_:logger:on:)

public func getJourneyExecutionMetrics(_ input: GetJourneyExecutionMetricsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetJourneyExecutionMetricsResponse>

Retrieves (queries) pre-aggregated data for a standard execution metric that applies to a journey.

getPushTemplate(_:logger:on:)

public func getPushTemplate(_ input: GetPushTemplateRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetPushTemplateResponse>

Retrieves the content and settings of a message template for messages that are sent through a push notification channel.

getRecommenderConfiguration(_:logger:on:)

public func getRecommenderConfiguration(_ input: GetRecommenderConfigurationRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetRecommenderConfigurationResponse>

Retrieves information about an Amazon Pinpoint configuration for a recommender model.

getRecommenderConfigurations(_:logger:on:)

public func getRecommenderConfigurations(_ input: GetRecommenderConfigurationsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetRecommenderConfigurationsResponse>

Retrieves information about all the recommender model configurations that are associated with your Amazon Pinpoint account.

getSegment(_:logger:on:)

public func getSegment(_ input: GetSegmentRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetSegmentResponse>

Retrieves information about the configuration, dimension, and other settings for a specific segment that's associated with an application.

getSegmentExportJobs(_:logger:on:)

public func getSegmentExportJobs(_ input: GetSegmentExportJobsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetSegmentExportJobsResponse>

Retrieves information about the status and settings of the export jobs for a segment.

getSegmentImportJobs(_:logger:on:)

public func getSegmentImportJobs(_ input: GetSegmentImportJobsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetSegmentImportJobsResponse>

Retrieves information about the status and settings of the import jobs for a segment.

getSegmentVersion(_:logger:on:)

public func getSegmentVersion(_ input: GetSegmentVersionRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetSegmentVersionResponse>

Retrieves information about the configuration, dimension, and other settings for a specific version of a segment that's associated with an application.

getSegmentVersions(_:logger:on:)

public func getSegmentVersions(_ input: GetSegmentVersionsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetSegmentVersionsResponse>

Retrieves information about the configuration, dimension, and other settings for all the versions of a specific segment that's associated with an application.

getSegments(_:logger:on:)

public func getSegments(_ input: GetSegmentsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetSegmentsResponse>

Retrieves information about the configuration, dimension, and other settings for all the segments that are associated with an application.

getSmsChannel(_:logger:on:)

public func getSmsChannel(_ input: GetSmsChannelRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetSmsChannelResponse>

Retrieves information about the status and settings of the SMS channel for an application.

getSmsTemplate(_:logger:on:)

public func getSmsTemplate(_ input: GetSmsTemplateRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetSmsTemplateResponse>

Retrieves the content and settings of a message template for messages that are sent through the SMS channel.

getUserEndpoints(_:logger:on:)

public func getUserEndpoints(_ input: GetUserEndpointsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetUserEndpointsResponse>

Retrieves information about all the endpoints that are associated with a specific user ID.

getVoiceChannel(_:logger:on:)

public func getVoiceChannel(_ input: GetVoiceChannelRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetVoiceChannelResponse>

Retrieves information about the status and settings of the voice channel for an application.

getVoiceTemplate(_:logger:on:)

public func getVoiceTemplate(_ input: GetVoiceTemplateRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetVoiceTemplateResponse>

Retrieves the content and settings of a message template for messages that are sent through the voice channel.

listJourneys(_:logger:on:)

public func listJourneys(_ input: ListJourneysRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<ListJourneysResponse>

Retrieves information about the status, configuration, and other settings for all the journeys that are associated with an application.

listTagsForResource(_:logger:on:)

public func listTagsForResource(_ input: ListTagsForResourceRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<ListTagsForResourceResponse>

Retrieves all the tags (keys and values) that are associated with an application, campaign, message template, or segment.

listTemplateVersions(_:logger:on:)

public func listTemplateVersions(_ input: ListTemplateVersionsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<ListTemplateVersionsResponse>

Retrieves information about all the versions of a specific message template.

listTemplates(_:logger:on:)

public func listTemplates(_ input: ListTemplatesRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<ListTemplatesResponse>

Retrieves information about all the message templates that are associated with your Amazon Pinpoint account.

phoneNumberValidate(_:logger:on:)

public func phoneNumberValidate(_ input: PhoneNumberValidateRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<PhoneNumberValidateResponse>

Retrieves information about a phone number.

putEventStream(_:logger:on:)

public func putEventStream(_ input: PutEventStreamRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<PutEventStreamResponse>

Creates a new event stream for an application or updates the settings of an existing event stream for an application.

putEvents(_:logger:on:)

public func putEvents(_ input: PutEventsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<PutEventsResponse>

Creates a new event to record for endpoints, or creates or updates endpoint data that existing events are associated with.

removeAttributes(_:logger:on:)

public func removeAttributes(_ input: RemoveAttributesRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<RemoveAttributesResponse>

Removes one or more attributes, of the same attribute type, from all the endpoints that are associated with an application.

sendMessages(_:logger:on:)

public func sendMessages(_ input: SendMessagesRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<SendMessagesResponse>

Creates and sends a direct message.

sendUsersMessages(_:logger:on:)

public func sendUsersMessages(_ input: SendUsersMessagesRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<SendUsersMessagesResponse>

Creates and sends a message to a list of users.

tagResource(_:logger:on:)

@discardableResult public func tagResource(_ input: TagResourceRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<Void>

Adds one or more tags (keys and values) to an application, campaign, message template, or segment.

untagResource(_:logger:on:)

@discardableResult public func untagResource(_ input: UntagResourceRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<Void>

Removes one or more tags (keys and values) from an application, campaign, message template, or segment.

updateAdmChannel(_:logger:on:)

public func updateAdmChannel(_ input: UpdateAdmChannelRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<UpdateAdmChannelResponse>

Enables the ADM channel for an application or updates the status and settings of the ADM channel for an application.

updateApnsChannel(_:logger:on:)

public func updateApnsChannel(_ input: UpdateApnsChannelRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<UpdateApnsChannelResponse>

Enables the APNs channel for an application or updates the status and settings of the APNs channel for an application.

updateApnsSandboxChannel(_:logger:on:)

public func updateApnsSandboxChannel(_ input: UpdateApnsSandboxChannelRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<UpdateApnsSandboxChannelResponse>

Enables the APNs sandbox channel for an application or updates the status and settings of the APNs sandbox channel for an application.

updateApnsVoipChannel(_:logger:on:)

public func updateApnsVoipChannel(_ input: UpdateApnsVoipChannelRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<UpdateApnsVoipChannelResponse>

Enables the APNs VoIP channel for an application or updates the status and settings of the APNs VoIP channel for an application.

updateApnsVoipSandboxChannel(_:logger:on:)

public func updateApnsVoipSandboxChannel(_ input: UpdateApnsVoipSandboxChannelRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<UpdateApnsVoipSandboxChannelResponse>

Enables the APNs VoIP sandbox channel for an application or updates the status and settings of the APNs VoIP sandbox channel for an application.

updateApplicationSettings(_:logger:on:)

public func updateApplicationSettings(_ input: UpdateApplicationSettingsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<UpdateApplicationSettingsResponse>

Updates the settings for an application.

updateBaiduChannel(_:logger:on:)

public func updateBaiduChannel(_ input: UpdateBaiduChannelRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<UpdateBaiduChannelResponse>

Enables the Baidu channel for an application or updates the status and settings of the Baidu channel for an application.

updateCampaign(_:logger:on:)

public func updateCampaign(_ input: UpdateCampaignRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<UpdateCampaignResponse>

Updates the configuration and other settings for a campaign.

updateEmailChannel(_:logger:on:)

public func updateEmailChannel(_ input: UpdateEmailChannelRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<UpdateEmailChannelResponse>

Enables the email channel for an application or updates the status and settings of the email channel for an application.

updateEmailTemplate(_:logger:on:)

public func updateEmailTemplate(_ input: UpdateEmailTemplateRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<UpdateEmailTemplateResponse>

Updates an existing message template for messages that are sent through the email channel.

updateEndpoint(_:logger:on:)

public func updateEndpoint(_ input: UpdateEndpointRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<UpdateEndpointResponse>

Creates a new endpoint for an application or updates the settings and attributes of an existing endpoint for an application. You can also use this operation to define custom attributes for an endpoint. If an update includes one or more values for a custom attribute, Amazon Pinpoint replaces (overwrites) any existing values with the new values.

updateEndpointsBatch(_:logger:on:)

public func updateEndpointsBatch(_ input: UpdateEndpointsBatchRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<UpdateEndpointsBatchResponse>

Creates a new batch of endpoints for an application or updates the settings and attributes of a batch of existing endpoints for an application. You can also use this operation to define custom attributes for a batch of endpoints. If an update includes one or more values for a custom attribute, Amazon Pinpoint replaces (overwrites) any existing values with the new values.

updateGcmChannel(_:logger:on:)

public func updateGcmChannel(_ input: UpdateGcmChannelRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<UpdateGcmChannelResponse>

Enables the GCM channel for an application or updates the status and settings of the GCM channel for an application.

updateJourney(_:logger:on:)

public func updateJourney(_ input: UpdateJourneyRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<UpdateJourneyResponse>

Updates the configuration and other settings for a journey.

updateJourneyState(_:logger:on:)

public func updateJourneyState(_ input: UpdateJourneyStateRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<UpdateJourneyStateResponse>

Pause, resume or cancels (stops) a journey.

updatePushTemplate(_:logger:on:)

public func updatePushTemplate(_ input: UpdatePushTemplateRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<UpdatePushTemplateResponse>

Updates an existing message template for messages that are sent through a push notification channel.

updateRecommenderConfiguration(_:logger:on:)

public func updateRecommenderConfiguration(_ input: UpdateRecommenderConfigurationRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<UpdateRecommenderConfigurationResponse>

Updates an Amazon Pinpoint configuration for a recommender model.

updateSegment(_:logger:on:)

public func updateSegment(_ input: UpdateSegmentRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<UpdateSegmentResponse>

Creates a new segment for an application or updates the configuration, dimension, and other settings for an existing segment that's associated with an application.

updateSmsChannel(_:logger:on:)

public func updateSmsChannel(_ input: UpdateSmsChannelRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<UpdateSmsChannelResponse>

Enables the SMS channel for an application or updates the status and settings of the SMS channel for an application.

updateSmsTemplate(_:logger:on:)

public func updateSmsTemplate(_ input: UpdateSmsTemplateRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<UpdateSmsTemplateResponse>

Updates an existing message template for messages that are sent through the SMS channel.

updateTemplateActiveVersion(_:logger:on:)

public func updateTemplateActiveVersion(_ input: UpdateTemplateActiveVersionRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<UpdateTemplateActiveVersionResponse>

Changes the status of a specific version of a message template to active.

updateVoiceChannel(_:logger:on:)

public func updateVoiceChannel(_ input: UpdateVoiceChannelRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<UpdateVoiceChannelResponse>

Enables the voice channel for an application or updates the status and settings of the voice channel for an application.

updateVoiceTemplate(_:logger:on:)

public func updateVoiceTemplate(_ input: UpdateVoiceTemplateRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<UpdateVoiceTemplateResponse>

Updates an existing message template for messages that are sent through the voice channel.