Classes

The following classes are available globally.

  • Undocumented

    See more

    Declaration

    Objective-C

    @interface AWSPinpointAnalyticsClient : NSObject
    
    /**
     Returns the `AWSPinpointEventRecorder` which is the low level client used to record events to local storage.
     
     You can use it for more advanced fine grained control over the events recorded.
     
     @returns the `AWSPinpointEventRecorder` used for storing events.
     */
    @property (nonatomic, readonly) AWSPinpointEventRecorder * eventRecorder;
    
    /**
     Adds the specified attribute to all subsequent recorded events.
     
     @param theValue the value of the attribute.
     @param theKey the name of the attribute to add.
     */
    - (void)addGlobalAttribute:(NSString *)theValue
                        forKey:(NSString *)theKey;
    
    /**
     Adds the specified attribute to all subsequent recorded events with the specified event type.
     
     @param theValue the value of the attribute.
     @param theKey the name of the attribute to add.
     @param theEventType the type of events to add the attribute to.
     */
    - (void)addGlobalAttribute:(NSString *)theValue
                        forKey:(NSString *)theKey
                  forEventType:(NSString *)theEventType;
    
    /**
     Adds the specified metric to all subsequent recorded events.
     
     @param theValue the value of the metric
     @param theKey the name of the metric to add
     */
    - (void)addGlobalMetric:(NSNumber *)theValue
                     forKey:(NSString *)theKey;
    
    /**
     Adds the specified metric to all subsequent recorded events with the specified event type.
     
     @param theValue the value of the metric
     @param theKey the name of the metric to add
     @param theEventType the type of events to add the metric to
     */
    - (void)addGlobalMetric:(NSNumber *)theValue
                     forKey:(NSString *)theKey
               forEventType:(NSString *)theEventType;
    
    /**
     Removes the specified attribute. All subsequent recorded events will no longer have this global attribute.
     
     @param theKey the key of the attribute to remove
     */
    - (void)removeGlobalAttributeForKey:(NSString*) theKey;
    
    /**
     Removes the specified attribute. All subsequent recorded events with the specified event type will no longer have this global attribute.
     
     @param theKey the key of the attribute to remove
     @param theEventType the type of events to remove the attribute from
     */
    - (void)removeGlobalAttributeForKey:(NSString*) theKey
                           forEventType:(NSString*) theEventType;
    
    /**
     Removes the specified metric. All subsequent recorded events will no longer have this global metric.
     
     @param theKey the key of the metric to remove
     */
    - (void)removeGlobalMetricForKey:(NSString*) theKey;
    
    /**
     Removes the specified metric. All subsequent recorded events with the specified event type will no longer have this global metric.
     
     @param theKey the key of the metric to remove
     @param theEventType the type of events to remove the metric from
     */
    - (void)removeGlobalMetricForKey:(NSString*) theKey
                        forEventType:(NSString*) theEventType;
    
    /**
     Records the specified AWSPinpointEvent to the local filestore.
     
     @param theEvent The AWSPinpointEvent to persist
     
     @return AWSTask - task.result is always nil.
     */
    -(AWSTask *) recordEvent:(AWSPinpointEvent *) theEvent;
    
    /**
     Create an AWSPinpointEvent with the specified theEventType
     
     @param theEventType the type of event to create
     
     @returns an AWSPinpointEvent with the specified event type
     */
    - (AWSPinpointEvent *)createEventWithEventType:(NSString *)theEventType;
    
    /**
     Create an Apple monetization AWSPinpointEvent of type "_monetization.purchase" with the specified parameters.
     
     @param transaction A SKPaymentTransaction object returned from an IAP
     @param product A SKProduct object of the an IAP
     
     @returns an AWSPinpointEvent with the specified event type
     */
    - (AWSPinpointEvent *)createAppleMonetizationEventWithTransaction:(SKPaymentTransaction *) transaction withProduct:(SKProduct *) product;
    
    /**
     Create a Virtual monetization AWSPinpointEvent of type "_monetization.purchase" with the specified parameters.
     
     @param theProductId A product identifier for your virtual monitization event
     @param theItemPrice An item price for your virtual monitization event
     @param theQuantity A quantity of how many products sold for your virtual monitization event
     @param theCurrency The currency for your virtual monitization event
     
     @returns an AWSPinpointEvent with the specified event type
     */
    - (AWSPinpointEvent *)createVirtualMonetizationEventWithProductId:(NSString *)theProductId
                                                        withItemPrice:(double)theItemPrice
                                                         withQuantity:(NSInteger)theQuantity
                                                         withCurrency:(NSString *)theCurrency;
    /**
     Submits all recorded events to Pinpoint.
     Events are automatically submitted when the application goes into the background.
     
     @return AWSTask - task.result contains successful submitted events.
     */
    - (AWSTask *) submitEvents;
    
    /**
     Submits all recorded events to Pinpoint.
     Events are automatically submitted when the application goes into the background.
     
     @param completionBlock The block to be executed after submission has completed.
     
     @return AWSTask - task.result is always nil.
     */
    - (AWSTask *) submitEventsWithCompletionBlock:(AWSPinpointCompletionBlock) completionBlock;
    
    @end

    Swift

    class AWSPinpointAnalyticsClient : NSObject
  • AWS Pinpoint Configuration. This class is used to configure an instance of the AWSPinpoint class.

    You must specify an instance of this class in order to initialize the AWSPinpoint SDK.

    You may use the defaultPinpointConfigurationWithLaunchOptions: initializer to default your settings from the Info.plist file.

    See more

    Declaration

    Objective-C

    @interface AWSPinpointConfiguration : NSObject

    Swift

    class AWSPinpointConfiguration : NSObject
  • AWS Pinpoint Environment.

    See more

    Declaration

    Objective-C

    @interface AWSPinpointEnvironment : NSObject

    Swift

    class AWSPinpointEnvironment : NSObject
  • The Endpoint profile contains information about the device/user to be target for messaging.

    See more

    Declaration

    Objective-C

    @interface AWSPinpointEndpointProfile : NSObject <NSSecureCoding>

    Swift

    class AWSPinpointEndpointProfile : NSObject, NSSecureCoding
  • The Endpoint Demographic contains information about the device to be target for messaging.

    See more

    Declaration

    Objective-C

    @interface AWSPinpointEndpointProfileDemographic : NSObject <NSSecureCoding>

    Swift

    class AWSPinpointEndpointProfileDemographic : NSObject, NSSecureCoding
  • The Endpoint profile contains information about the location of the device/user to be target for messaging.

    See more

    Declaration

    Objective-C

    @interface AWSPinpointEndpointProfileLocation : NSObject <NSSecureCoding>

    Swift

    class AWSPinpointEndpointProfileLocation : NSObject, NSSecureCoding
  • The Endpoint profile contains information about the user to be target for messaging.

    See more

    Declaration

    Objective-C

    @interface AWSPinpointEndpointProfileUser : NSObject <NSSecureCoding>

    Swift

    class AWSPinpointEndpointProfileUser : NSObject, NSSecureCoding
  • Represents an analytics event. An event must have an event type.

    See more

    Declaration

    Objective-C

    @interface AWSPinpointEvent : NSObject

    Swift

    class AWSPinpointEvent : NSObject
  • AWSPinpointEventRecorder stores events to a local SQLite database and submits them to Pinpoint.

    This is the low level client used to record events to local storage.

    You should only use this class for more advanced controls over your events stored locally. Please use AWSPinpointAnalyticsClient for recording events.

    See more

    Declaration

    Objective-C

    @interface AWSPinpointEventRecorder

    Swift

    class AWSPinpointEventRecorder
  • Undocumented

    See more

    Declaration

    Objective-C

    @interface AWSPinpointNotificationManager : NSObject
    
    typedef NS_ENUM(NSInteger, AWSPinpointPushActionType) {
        AWSPinpointPushActionTypeOpened,
        AWSPinpointPushActionTypeReceivedForeground,
        AWSPinpointPushActionTypeReceivedBackground,
        AWSPinpointPushActionTypeUnknown
    };
    
    typedef NS_ENUM(NSInteger, AWSPinpointPushEventSourceType) {
        AWSPinpointPushEventSourceTypeCampaign,
        AWSPinpointPushEventSourceTypeJourney,
        AWSPinpointPushEventSourceTypeUnknown
    };
    
    #pragma mark - Notification Helpers
    /**
     Returns a Boolean indicating whether the app is currently registered for remote notifications.
     @return BOOL YES if the app is registered for remote notifications and received its device token or NO if registration
     has not occurred, has failed, or has been denied by the user.
     */
    + (BOOL)isNotificationEnabled;
    
    #pragma mark - Interceptors
    /**
     Invoke this method from the `- application:didFinishLaunchingWithOptions:` application delegate method.
     
     The Pinpoint targeting client must intercept this callback in order to report campaign analytics correctly.
     
     @param launchOptions A dictionary indicating the reason the app was launched (if any). The contents of this dictionary
     may be empty in situations where the user launched the app directly.
     */
    - (BOOL)interceptDidFinishLaunchingWithOptions:(nullable NSDictionary *)launchOptions;
    
    /**
     Invoke this method from the `- application:didRegisterForRemoteNotificationsWithDeviceToken:` application delegate
     method.
     
     The Pinpoint targeting client must intercept this callback in order to report campaign analytics correctly.
     
     @param deviceToken A token that identifies the device to APNs.
     */
    - (void)interceptDidRegisterForRemoteNotificationsWithDeviceToken:(NSData *)deviceToken;
    
    /**
     Invoke this method from the `application(_:didReceiveRemoteNotification:fetchCompletionHandler:)` application delegate
     method.
    
     The Pinpoint targeting client must intercept this callback in order to report campaign analytics correctly.
     
     @param userInfo    A dictionary that contains information related to the remote notification, potentially including a
     badge number for the app icon, an alert sound, an alert message to display to the user, a notification identifier, and
     custom data. The provider originates it as a JSON-defined dictionary that iOS converts to an `NSDictionary` object; the
     dictionary may contain only property-list objects plus `NSNull`.
     @param handler     The block to execute when the download operation is complete. When calling this block, pass in the
     fetch result value that best describes the results of your download operation. You must call this handler and should do
     so as soon as possible. For a list of possible values, see the UIBackgroundFetchResult type.
     */
    - (void)interceptDidReceiveRemoteNotification:(NSDictionary *)userInfo
                           fetchCompletionHandler:(void (^)(UIBackgroundFetchResult result))handler __attribute__((deprecated("Replaced by -interceptDidReceiveRemoteNotification:")));
    
    /**
     For iOS 9 and below, invoke this method from the `application(_:didReceiveRemoteNotification:fetchCompletionHandler:)`
     application delegate method.
    
     For iOS 10 and above, invoke this method from the `userNotificationCenter(_:willPresent:withCompletionHandler:)` and
     `userNotificationCenter(_:didReceive:withCompletionHandler:)` UserNotificationCenter methods. When invoking this method
     from `willPresent`, pass in `notification.request.content.userInfo` as userInfo. When invoking this method on
     `didReceive`, pass in `response.notification.request.content.userInfo` as `userInfo`.
    
     The Pinpoint targeting client must intercept this callback in order to report campaign analytics correctly.
    
     @param userInfo    A dictionary that contains information related to the remote notification, potentially including a
     badge number for the app icon, an alert sound, an alert message to display to the user, a notification identifier, and
     custom data. The provider originates it as a JSON-defined dictionary that iOS converts to an `NSDictionary` object; the
     dictionary may contain only property-list objects plus `NSNull`.
     */
    - (void)interceptDidReceiveRemoteNotification:(NSDictionary *)userInfo;
    
    /**
     Invoke this method from the `application:didReceiveRemoteNotification:fetchCompletionHandler:shouldHandleNotificationDeepLink:`
     application delegate method.
    
     The Pinpoint targeting client must intercept this callback in order to report campaign analytics correctly. Optionally
     specify 'shouldHandleNotificationDeepLink' to control whether or not the notification manager should attempt to open
     the remote notification deeplink, if present.
    
     @param userInfo        A dictionary that contains information related to the remote notification, potentially including
     a badge number for the app icon, an alert sound, an alert message to display to the user, a notification identifier,
     and custom data. The provider originates it as a JSON-defined dictionary that iOS converts to an `NSDictionary` object;
     the dictionary may contain only property-list objects plus `NSNull`.
     @param handler         The block to execute when the download operation is complete. When calling this block, pass in
     the fetch result value that best describes the results of your download operation. You must call this handler and
     should do so as soon as possible. For a list of possible values, see the UIBackgroundFetchResult type.
     @param handleDeepLink  Whether or not notification manager should attempt to open the remote notification deeplink, if
     present
     */
    - (void)interceptDidReceiveRemoteNotification:(NSDictionary *)userInfo
                           fetchCompletionHandler:(void (^)(UIBackgroundFetchResult result))handler
                 shouldHandleNotificationDeepLink:(BOOL) handleDeepLink __attribute__((deprecated("Replaced by -interceptDidReceiveRemoteNotification:shouldHandleNotificationDeepLink:")));
    
    /**
     For iOS 9 and below, intercept the `application(_:didReceiveRemoteNotification:fetchCompletionHandler:)` application
     delegate.
    
     For iOS 10 and above, invoke this method from the `userNotificationCenter(_:willPresent:withCompletionHandler:)` and
     `userNotificationCenter(_:didReceive:withCompletionHandler:)` UserNotificationCenter methods. When invoking this method
     from `willPresent`, pass in `notification.request.content.userInfo` as userInfo. When invoking this method on
     `didReceive`, pass in `response.notification.request.content.userInfo` as `userInfo`.
    
     The Pinpoint targeting client must intercept this callback in order to report campaign analytics correctly. Optionally
     specify 'shouldHandleNotificationDeepLink' to control whether or not the notification manager should attempt to open
     the remote notification deeplink, if present.
    
     @param userInfo        A dictionary that contains information related to the remote notification, potentially including
     a badge number for the app icon, an alert sound, an alert message to display to the user, a notification identifier,
     and custom data. The provider originates it as a JSON-defined dictionary that iOS converts to an `NSDictionary` object;
     the dictionary may contain only property-list objects plus `NSNull`.
     @param handleDeepLink  Whether or not notification manager should attempt to open the remote notification deeplink, if
     present
     */
    - (void)interceptDidReceiveRemoteNotification:(NSDictionary *)userInfo
                 shouldHandleNotificationDeepLink:(BOOL) handleDeepLink;
    
    @end

    Swift

    class AWSPinpointNotificationManager : NSObject
  • Amazon Pinpoint

    See more

    Declaration

    Objective-C

    @interface AWSPinpoint : NSObject

    Swift

    class AWSPinpoint : NSObject
  • The session object needs that the session client keeps track of, the session information is added to each event recorded.

    See more

    Declaration

    Objective-C

    @interface AWSPinpointSession : NSObject <NSSecureCoding, NSCopying>

    Swift

    class AWSPinpointSession : NSObject, NSSecureCoding, NSCopying
  • The session client records analytics session events.

    You should only use this class to manually control session events if you have enableAutoSessionRecording set to false. See AWSPinpointConfiguration.

    See more

    Declaration

    Objective-C

    @interface AWSPinpointSessionClient : NSObject

    Swift

    class AWSPinpointSessionClient : NSObject
  • Specifies the status and settings of the ADM (Amazon Device Messaging) channel for an application.

    Required parameters: [ClientSecret, ClientId]

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingADMChannelRequest

    Swift

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

    Required parameters: [Platform]

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingADMChannelResponse

    Swift

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

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingADMMessage

    Swift

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

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingAPNSChannelRequest

    Swift

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

    Required parameters: [Platform]

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingAPNSChannelResponse

    Swift

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

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingAPNSMessage

    Swift

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

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingAPNSPushNotificationTemplate

    Swift

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

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingAPNSSandboxChannelRequest

    Swift

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

    Required parameters: [Platform]

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingAPNSSandboxChannelResponse

    Swift

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

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingAPNSVoipChannelRequest

    Swift

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

    Required parameters: [Platform]

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingAPNSVoipChannelResponse

    Swift

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

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingAPNSVoipSandboxChannelRequest

    Swift

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

    Required parameters: [Platform]

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingAPNSVoipSandboxChannelResponse

    Swift

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

    Required parameters: [Item]

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingActivitiesResponse

    Swift

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

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingActivity

    Swift

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

    Required parameters: [CampaignId, Id, ApplicationId]

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingActivityResponse

    Swift

    class AWSPinpointTargetingActivityResponse
  • Specifies address-based configuration settings for a message that’s sent directly to an endpoint.

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingAddressConfiguration

    Swift

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

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingAndroidPushNotificationTemplate

    Swift

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

    Required parameters: [KpiResult, KpiName, EndTime, StartTime, ApplicationId]

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingApplicationDateRangeKpiResponse

    Swift

    class AWSPinpointTargetingApplicationDateRangeKpiResponse
  • Provides information about an application.

    Required parameters: [Id, Arn, Name]

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingApplicationResponse

    Swift

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

    Required parameters: [ApplicationId]

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingApplicationSettingsResource

    Swift

    class AWSPinpointTargetingApplicationSettingsResource
  • Provides information about all of your applications.

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingApplicationsResponse

    Swift

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

    Required parameters: [Values]

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingAttributeDimension

    Swift

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

    Required parameters: [AttributeType, ApplicationId]

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingAttributesResource

    Swift

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

    Required parameters: [SecretKey, ApiKey]

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingBaiduChannelRequest

    Swift

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

    Required parameters: [Credential, Platform]

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingBaiduChannelResponse

    Swift

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

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingBaiduMessage

    Swift

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

    Required parameters: [Rows]

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingBaseKpiResult

    Swift

    class AWSPinpointTargetingBaseKpiResult
  • Specifies the contents of a message that’s sent through a custom channel to recipients of a campaign.

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingCampaignCustomMessage

    Swift

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

    Required parameters: [KpiResult, KpiName, EndTime, CampaignId, StartTime, ApplicationId]

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingCampaignDateRangeKpiResponse

    Swift

    class AWSPinpointTargetingCampaignDateRangeKpiResponse
  • Specifies the content and “From” address for an email message that’s sent to recipients of a campaign.

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingCampaignEmailMessage

    Swift

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

    Required parameters: [FilterType, Dimensions]

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingCampaignEventFilter

    Swift

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

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingCampaignHook

    Swift

    class AWSPinpointTargetingCampaignHook
  • For a campaign, specifies limits on the messages that the campaign can send. For an application, specifies the default limits for messages that campaigns and journeys in the application can send.

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingCampaignLimits

    Swift

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

    Required parameters: [LastModifiedDate, CreationDate, SegmentId, SegmentVersion, Id, Arn, ApplicationId]

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingCampaignResponse

    Swift

    class AWSPinpointTargetingCampaignResponse
  • Specifies the content and settings for an SMS message that’s sent to recipients of a campaign.

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingCampaignSmsMessage

    Swift

    class AWSPinpointTargetingCampaignSmsMessage
  • Provides information about the status of a campaign.

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingCampaignState

    Swift

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

    Required parameters: [Item]

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingCampaignsResponse

    Swift

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

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingChannelResponse

    Swift

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

    Required parameters: [Channels]

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingChannelsResponse

    Swift

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

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingCondition

    Swift

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

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingConditionalSplitActivity

    Swift

    class AWSPinpointTargetingConditionalSplitActivity
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingCreateAppRequest

    Swift

    class AWSPinpointTargetingCreateAppRequest
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingCreateAppResponse

    Swift

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

    Required parameters: [Name]

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingCreateApplicationRequest

    Swift

    class AWSPinpointTargetingCreateApplicationRequest
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingCreateCampaignRequest

    Swift

    class AWSPinpointTargetingCreateCampaignRequest
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingCreateCampaignResponse

    Swift

    class AWSPinpointTargetingCreateCampaignResponse
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingCreateEmailTemplateRequest

    Swift

    class AWSPinpointTargetingCreateEmailTemplateRequest
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingCreateEmailTemplateResponse

    Swift

    class AWSPinpointTargetingCreateEmailTemplateResponse
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingCreateExportJobRequest

    Swift

    class AWSPinpointTargetingCreateExportJobRequest
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingCreateExportJobResponse

    Swift

    class AWSPinpointTargetingCreateExportJobResponse
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingCreateImportJobRequest

    Swift

    class AWSPinpointTargetingCreateImportJobRequest
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingCreateImportJobResponse

    Swift

    class AWSPinpointTargetingCreateImportJobResponse
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingCreateJourneyRequest

    Swift

    class AWSPinpointTargetingCreateJourneyRequest
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingCreateJourneyResponse

    Swift

    class AWSPinpointTargetingCreateJourneyResponse
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingCreatePushTemplateRequest

    Swift

    class AWSPinpointTargetingCreatePushTemplateRequest
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingCreatePushTemplateResponse

    Swift

    class AWSPinpointTargetingCreatePushTemplateResponse
  • Specifies Amazon Pinpoint configuration settings for retrieving and processing recommendation data from a recommender model.

    Required parameters: [RecommendationProviderUri, RecommendationProviderRoleArn]

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingCreateRecommenderConfiguration

    Swift

    class AWSPinpointTargetingCreateRecommenderConfiguration
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingCreateRecommenderConfigurationRequest

    Swift

    class AWSPinpointTargetingCreateRecommenderConfigurationRequest
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingCreateRecommenderConfigurationResponse

    Swift

    class AWSPinpointTargetingCreateRecommenderConfigurationResponse
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingCreateSegmentRequest

    Swift

    class AWSPinpointTargetingCreateSegmentRequest
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingCreateSegmentResponse

    Swift

    class AWSPinpointTargetingCreateSegmentResponse
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingCreateSmsTemplateRequest

    Swift

    class AWSPinpointTargetingCreateSmsTemplateRequest
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingCreateSmsTemplateResponse

    Swift

    class AWSPinpointTargetingCreateSmsTemplateResponse
  • Provides information about a request to create a message template.

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingCreateTemplateMessageBody

    Swift

    class AWSPinpointTargetingCreateTemplateMessageBody
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingCreateVoiceTemplateRequest

    Swift

    class AWSPinpointTargetingCreateVoiceTemplateRequest
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingCreateVoiceTemplateResponse

    Swift

    class AWSPinpointTargetingCreateVoiceTemplateResponse
  • Specifies the delivery configuration settings for sending a campaign or campaign treatment through a custom channel. This object is required if you use the CampaignCustomMessage object to define the message to send for the campaign or campaign treatment.

    Required parameters: [DeliveryUri]

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingCustomDeliveryConfiguration

    Swift

    class AWSPinpointTargetingCustomDeliveryConfiguration
  • The settings for a custom message activity. This type of activity calls an AWS Lambda function or web hook that sends messages to participants.

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingCustomMessageActivity

    Swift

    class AWSPinpointTargetingCustomMessageActivity
  • Specifies the default message for all channels.

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingDefaultMessage

    Swift

    class AWSPinpointTargetingDefaultMessage
  • Specifies the default settings and content for a push notification that’s sent directly to an endpoint.

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingDefaultPushNotificationMessage

    Swift

    class AWSPinpointTargetingDefaultPushNotificationMessage
  • Specifies the default settings and content for a message template that can be used in messages that are sent through a push notification channel.

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingDefaultPushNotificationTemplate

    Swift

    class AWSPinpointTargetingDefaultPushNotificationTemplate
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingDeleteAdmChannelRequest

    Swift

    class AWSPinpointTargetingDeleteAdmChannelRequest
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingDeleteAdmChannelResponse

    Swift

    class AWSPinpointTargetingDeleteAdmChannelResponse
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingDeleteApnsChannelRequest

    Swift

    class AWSPinpointTargetingDeleteApnsChannelRequest
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingDeleteApnsChannelResponse

    Swift

    class AWSPinpointTargetingDeleteApnsChannelResponse
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingDeleteApnsSandboxChannelRequest

    Swift

    class AWSPinpointTargetingDeleteApnsSandboxChannelRequest
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingDeleteApnsSandboxChannelResponse

    Swift

    class AWSPinpointTargetingDeleteApnsSandboxChannelResponse
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingDeleteApnsVoipChannelRequest

    Swift

    class AWSPinpointTargetingDeleteApnsVoipChannelRequest
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingDeleteApnsVoipChannelResponse

    Swift

    class AWSPinpointTargetingDeleteApnsVoipChannelResponse
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingDeleteApnsVoipSandboxChannelRequest

    Swift

    class AWSPinpointTargetingDeleteApnsVoipSandboxChannelRequest
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingDeleteApnsVoipSandboxChannelResponse

    Swift

    class AWSPinpointTargetingDeleteApnsVoipSandboxChannelResponse
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingDeleteAppRequest

    Swift

    class AWSPinpointTargetingDeleteAppRequest
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingDeleteAppResponse

    Swift

    class AWSPinpointTargetingDeleteAppResponse
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingDeleteBaiduChannelRequest

    Swift

    class AWSPinpointTargetingDeleteBaiduChannelRequest
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingDeleteBaiduChannelResponse

    Swift

    class AWSPinpointTargetingDeleteBaiduChannelResponse
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingDeleteCampaignRequest

    Swift

    class AWSPinpointTargetingDeleteCampaignRequest
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingDeleteCampaignResponse

    Swift

    class AWSPinpointTargetingDeleteCampaignResponse
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingDeleteEmailChannelRequest

    Swift

    class AWSPinpointTargetingDeleteEmailChannelRequest
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingDeleteEmailChannelResponse

    Swift

    class AWSPinpointTargetingDeleteEmailChannelResponse
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingDeleteEmailTemplateRequest

    Swift

    class AWSPinpointTargetingDeleteEmailTemplateRequest
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingDeleteEmailTemplateResponse

    Swift

    class AWSPinpointTargetingDeleteEmailTemplateResponse
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingDeleteEndpointRequest

    Swift

    class AWSPinpointTargetingDeleteEndpointRequest
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingDeleteEndpointResponse

    Swift

    class AWSPinpointTargetingDeleteEndpointResponse
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingDeleteEventStreamRequest

    Swift

    class AWSPinpointTargetingDeleteEventStreamRequest
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingDeleteEventStreamResponse

    Swift

    class AWSPinpointTargetingDeleteEventStreamResponse
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingDeleteGcmChannelRequest

    Swift

    class AWSPinpointTargetingDeleteGcmChannelRequest
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingDeleteGcmChannelResponse

    Swift

    class AWSPinpointTargetingDeleteGcmChannelResponse
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingDeleteJourneyRequest

    Swift

    class AWSPinpointTargetingDeleteJourneyRequest
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingDeleteJourneyResponse

    Swift

    class AWSPinpointTargetingDeleteJourneyResponse
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingDeletePushTemplateRequest

    Swift

    class AWSPinpointTargetingDeletePushTemplateRequest
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingDeletePushTemplateResponse

    Swift

    class AWSPinpointTargetingDeletePushTemplateResponse
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingDeleteRecommenderConfigurationRequest

    Swift

    class AWSPinpointTargetingDeleteRecommenderConfigurationRequest
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingDeleteRecommenderConfigurationResponse

    Swift

    class AWSPinpointTargetingDeleteRecommenderConfigurationResponse
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingDeleteSegmentRequest

    Swift

    class AWSPinpointTargetingDeleteSegmentRequest
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingDeleteSegmentResponse

    Swift

    class AWSPinpointTargetingDeleteSegmentResponse
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingDeleteSmsChannelRequest

    Swift

    class AWSPinpointTargetingDeleteSmsChannelRequest
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingDeleteSmsChannelResponse

    Swift

    class AWSPinpointTargetingDeleteSmsChannelResponse
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingDeleteSmsTemplateRequest

    Swift

    class AWSPinpointTargetingDeleteSmsTemplateRequest
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingDeleteSmsTemplateResponse

    Swift

    class AWSPinpointTargetingDeleteSmsTemplateResponse
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingDeleteUserEndpointsRequest

    Swift

    class AWSPinpointTargetingDeleteUserEndpointsRequest
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingDeleteUserEndpointsResponse

    Swift

    class AWSPinpointTargetingDeleteUserEndpointsResponse
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingDeleteVoiceChannelRequest

    Swift

    class AWSPinpointTargetingDeleteVoiceChannelRequest
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingDeleteVoiceChannelResponse

    Swift

    class AWSPinpointTargetingDeleteVoiceChannelResponse
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingDeleteVoiceTemplateRequest

    Swift

    class AWSPinpointTargetingDeleteVoiceTemplateRequest
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingDeleteVoiceTemplateResponse

    Swift

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

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingDirectMessageConfiguration

    Swift

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

    Required parameters: [FromAddress, Identity]

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingEmailChannelRequest

    Swift

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

    Required parameters: [Platform]

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingEmailChannelResponse

    Swift

    class AWSPinpointTargetingEmailChannelResponse
  • Specifies the default settings and content for a one-time email message that’s sent directly to an endpoint.

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingEmailMessage

    Swift

    class AWSPinpointTargetingEmailMessage
  • Specifies the settings for an email activity in a journey. This type of activity sends an email message to participants.

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingEmailMessageActivity

    Swift

    class AWSPinpointTargetingEmailMessageActivity
  • Specifies the content and settings for a message template that can be used in messages that are sent through the email channel.

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingEmailTemplateRequest

    Swift

    class AWSPinpointTargetingEmailTemplateRequest
  • Provides information about the content and settings for a message template that can be used in messages that are sent through the email channel.

    Required parameters: [LastModifiedDate, CreationDate, TemplateName, TemplateType]

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingEmailTemplateResponse

    Swift

    class AWSPinpointTargetingEmailTemplateResponse
  • Specifies an endpoint to create or update and the settings and attributes to set or change for the endpoint.

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingEndpointBatchItem

    Swift

    class AWSPinpointTargetingEndpointBatchItem
  • Specifies a batch of endpoints to create or update and the settings and attributes to set or change for each endpoint.

    Required parameters: [Item]

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingEndpointBatchRequest

    Swift

    class AWSPinpointTargetingEndpointBatchRequest
  • Specifies demographic information about an endpoint, such as the applicable time zone and platform.

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingEndpointDemographic

    Swift

    class AWSPinpointTargetingEndpointDemographic
  • Provides the status code and message that result from processing data for an endpoint.

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingEndpointItemResponse

    Swift

    class AWSPinpointTargetingEndpointItemResponse
  • Specifies geographic information about an endpoint.

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingEndpointLocation

    Swift

    class AWSPinpointTargetingEndpointLocation
  • Provides information about the delivery status and results of sending a message directly to an endpoint.

    Required parameters: [DeliveryStatus, StatusCode]

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingEndpointMessageResult

    Swift

    class AWSPinpointTargetingEndpointMessageResult
  • Specifies the channel type and other settings for an endpoint.

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingEndpointRequest

    Swift

    class AWSPinpointTargetingEndpointRequest
  • Provides information about the channel type and other settings for an endpoint.

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingEndpointResponse

    Swift

    class AWSPinpointTargetingEndpointResponse
  • Specifies the content, including message variables and attributes, to use in a message that’s sent directly to an endpoint.

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingEndpointSendConfiguration

    Swift

    class AWSPinpointTargetingEndpointSendConfiguration
  • Specifies data for one or more attributes that describe the user who’s associated with an endpoint.

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingEndpointUser

    Swift

    class AWSPinpointTargetingEndpointUser
  • Provides information about all the endpoints that are associated with a user ID.

    Required parameters: [Item]

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingEndpointsResponse

    Swift

    class AWSPinpointTargetingEndpointsResponse
  • Specifies information about an event that reports data to Amazon Pinpoint.

    Required parameters: [EventType, Timestamp]

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingEvent

    Swift

    class AWSPinpointTargetingEvent
  • Specifies the conditions to evaluate for an event that applies to an activity in a journey.

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingEventCondition

    Swift

    class AWSPinpointTargetingEventCondition
  • Specifies the dimensions for an event filter that determines when a campaign is sent or a journey activity is performed.

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingEventDimensions

    Swift

    class AWSPinpointTargetingEventDimensions
  • Provides the status code and message that result from processing an event.

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingEventItemResponse

    Swift

    class AWSPinpointTargetingEventItemResponse
  • Specifies settings for publishing event data to an Amazon Kinesis data stream or an Amazon Kinesis Data Firehose delivery stream.

    Required parameters: [ApplicationId, RoleArn, DestinationStreamArn]

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingEventStream

    Swift

    class AWSPinpointTargetingEventStream
  • Specifies a batch of endpoints and events to process.

    Required parameters: [Endpoint, Events]

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingEventsBatch

    Swift

    class AWSPinpointTargetingEventsBatch
  • Specifies a batch of events to process.

    Required parameters: [BatchItem]

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingEventsRequest

    Swift

    class AWSPinpointTargetingEventsRequest
  • Provides information about endpoints and the events that they’re associated with.

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingEventsResponse

    Swift

    class AWSPinpointTargetingEventsResponse
  • Specifies the settings for a job that exports endpoint definitions to an Amazon Simple Storage Service (Amazon S3) bucket.

    Required parameters: [S3UrlPrefix, RoleArn]

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingExportJobRequest

    Swift

    class AWSPinpointTargetingExportJobRequest
  • Provides information about the resource settings for a job that exports endpoint definitions to a file. The file can be added directly to an Amazon Simple Storage Service (Amazon S3) bucket by using the Amazon Pinpoint API or downloaded directly to a computer by using the Amazon Pinpoint console.

    Required parameters: [S3UrlPrefix, RoleArn]

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingExportJobResource

    Swift

    class AWSPinpointTargetingExportJobResource
  • Provides information about the status and settings of a job that exports endpoint definitions to a file. The file can be added directly to an Amazon Simple Storage Service (Amazon S3) bucket by using the Amazon Pinpoint API or downloaded directly to a computer by using the Amazon Pinpoint console.

    Required parameters: [JobStatus, CreationDate, Type, Definition, Id, ApplicationId]

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingExportJobResponse

    Swift

    class AWSPinpointTargetingExportJobResponse
  • Provides information about all the export jobs that are associated with an application or segment. An export job is a job that exports endpoint definitions to a file.

    Required parameters: [Item]

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingExportJobsResponse

    Swift

    class AWSPinpointTargetingExportJobsResponse
  • Specifies the status and settings of the GCM channel for an application. This channel enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service.

    Required parameters: [ApiKey]

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingGCMChannelRequest

    Swift

    class AWSPinpointTargetingGCMChannelRequest
  • Provides information about the status and settings of the GCM channel for an application. The GCM channel enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service.

    Required parameters: [Credential, Platform]

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingGCMChannelResponse

    Swift

    class AWSPinpointTargetingGCMChannelResponse
  • Specifies the settings for a one-time message that’s sent directly to an endpoint through the GCM channel. The GCM channel enables Amazon Pinpoint to send messages to the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service.

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingGCMMessage

    Swift

    class AWSPinpointTargetingGCMMessage
  • Specifies the GPS coordinates of a location.

    Required parameters: [Latitude, Longitude]

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingGPSCoordinates

    Swift

    class AWSPinpointTargetingGPSCoordinates
  • Specifies GPS-based criteria for including or excluding endpoints from a segment.

    Required parameters: [Coordinates]

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingGPSPointDimension

    Swift

    class AWSPinpointTargetingGPSPointDimension
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingGetAdmChannelRequest

    Swift

    class AWSPinpointTargetingGetAdmChannelRequest
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingGetAdmChannelResponse

    Swift

    class AWSPinpointTargetingGetAdmChannelResponse
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingGetApnsChannelRequest

    Swift

    class AWSPinpointTargetingGetApnsChannelRequest
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingGetApnsChannelResponse

    Swift

    class AWSPinpointTargetingGetApnsChannelResponse
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingGetApnsSandboxChannelRequest

    Swift

    class AWSPinpointTargetingGetApnsSandboxChannelRequest
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingGetApnsSandboxChannelResponse

    Swift

    class AWSPinpointTargetingGetApnsSandboxChannelResponse
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingGetApnsVoipChannelRequest

    Swift

    class AWSPinpointTargetingGetApnsVoipChannelRequest
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingGetApnsVoipChannelResponse

    Swift

    class AWSPinpointTargetingGetApnsVoipChannelResponse
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingGetApnsVoipSandboxChannelRequest

    Swift

    class AWSPinpointTargetingGetApnsVoipSandboxChannelRequest
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingGetApnsVoipSandboxChannelResponse

    Swift

    class AWSPinpointTargetingGetApnsVoipSandboxChannelResponse
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingGetAppRequest

    Swift

    class AWSPinpointTargetingGetAppRequest
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingGetAppResponse

    Swift

    class AWSPinpointTargetingGetAppResponse
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingGetApplicationDateRangeKpiRequest

    Swift

    class AWSPinpointTargetingGetApplicationDateRangeKpiRequest
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingGetApplicationDateRangeKpiResponse

    Swift

    class AWSPinpointTargetingGetApplicationDateRangeKpiResponse
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingGetApplicationSettingsRequest

    Swift

    class AWSPinpointTargetingGetApplicationSettingsRequest
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingGetApplicationSettingsResponse

    Swift

    class AWSPinpointTargetingGetApplicationSettingsResponse
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingGetAppsRequest

    Swift

    class AWSPinpointTargetingGetAppsRequest
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingGetAppsResponse

    Swift

    class AWSPinpointTargetingGetAppsResponse
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingGetBaiduChannelRequest

    Swift

    class AWSPinpointTargetingGetBaiduChannelRequest
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingGetBaiduChannelResponse

    Swift

    class AWSPinpointTargetingGetBaiduChannelResponse
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingGetCampaignActivitiesRequest

    Swift

    class AWSPinpointTargetingGetCampaignActivitiesRequest
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingGetCampaignActivitiesResponse

    Swift

    class AWSPinpointTargetingGetCampaignActivitiesResponse
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingGetCampaignDateRangeKpiRequest

    Swift

    class AWSPinpointTargetingGetCampaignDateRangeKpiRequest
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingGetCampaignDateRangeKpiResponse

    Swift

    class AWSPinpointTargetingGetCampaignDateRangeKpiResponse
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingGetCampaignRequest

    Swift

    class AWSPinpointTargetingGetCampaignRequest
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingGetCampaignResponse

    Swift

    class AWSPinpointTargetingGetCampaignResponse
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingGetCampaignVersionRequest

    Swift

    class AWSPinpointTargetingGetCampaignVersionRequest
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingGetCampaignVersionResponse

    Swift

    class AWSPinpointTargetingGetCampaignVersionResponse
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingGetCampaignVersionsRequest

    Swift

    class AWSPinpointTargetingGetCampaignVersionsRequest
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingGetCampaignVersionsResponse

    Swift

    class AWSPinpointTargetingGetCampaignVersionsResponse
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingGetCampaignsRequest

    Swift

    class AWSPinpointTargetingGetCampaignsRequest
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingGetCampaignsResponse

    Swift

    class AWSPinpointTargetingGetCampaignsResponse
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingGetChannelsRequest

    Swift

    class AWSPinpointTargetingGetChannelsRequest
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingGetChannelsResponse

    Swift

    class AWSPinpointTargetingGetChannelsResponse
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingGetEmailChannelRequest

    Swift

    class AWSPinpointTargetingGetEmailChannelRequest
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingGetEmailChannelResponse

    Swift

    class AWSPinpointTargetingGetEmailChannelResponse
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingGetEmailTemplateRequest

    Swift

    class AWSPinpointTargetingGetEmailTemplateRequest
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingGetEmailTemplateResponse

    Swift

    class AWSPinpointTargetingGetEmailTemplateResponse
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingGetEndpointRequest

    Swift

    class AWSPinpointTargetingGetEndpointRequest
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingGetEndpointResponse

    Swift

    class AWSPinpointTargetingGetEndpointResponse
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingGetEventStreamRequest

    Swift

    class AWSPinpointTargetingGetEventStreamRequest
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingGetEventStreamResponse

    Swift

    class AWSPinpointTargetingGetEventStreamResponse
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingGetExportJobRequest

    Swift

    class AWSPinpointTargetingGetExportJobRequest
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingGetExportJobResponse

    Swift

    class AWSPinpointTargetingGetExportJobResponse
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingGetExportJobsRequest

    Swift

    class AWSPinpointTargetingGetExportJobsRequest
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingGetExportJobsResponse

    Swift

    class AWSPinpointTargetingGetExportJobsResponse
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingGetGcmChannelRequest

    Swift

    class AWSPinpointTargetingGetGcmChannelRequest
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingGetGcmChannelResponse

    Swift

    class AWSPinpointTargetingGetGcmChannelResponse
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingGetImportJobRequest

    Swift

    class AWSPinpointTargetingGetImportJobRequest
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingGetImportJobResponse

    Swift

    class AWSPinpointTargetingGetImportJobResponse
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingGetImportJobsRequest

    Swift

    class AWSPinpointTargetingGetImportJobsRequest
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingGetImportJobsResponse

    Swift

    class AWSPinpointTargetingGetImportJobsResponse
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingGetJourneyDateRangeKpiRequest

    Swift

    class AWSPinpointTargetingGetJourneyDateRangeKpiRequest
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingGetJourneyDateRangeKpiResponse

    Swift

    class AWSPinpointTargetingGetJourneyDateRangeKpiResponse
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingGetJourneyExecutionActivityMetricsRequest

    Swift

    class AWSPinpointTargetingGetJourneyExecutionActivityMetricsRequest
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingGetJourneyExecutionActivityMetricsResponse

    Swift

    class AWSPinpointTargetingGetJourneyExecutionActivityMetricsResponse
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingGetJourneyExecutionMetricsRequest

    Swift

    class AWSPinpointTargetingGetJourneyExecutionMetricsRequest
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingGetJourneyExecutionMetricsResponse

    Swift

    class AWSPinpointTargetingGetJourneyExecutionMetricsResponse
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingGetJourneyRequest

    Swift

    class AWSPinpointTargetingGetJourneyRequest
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingGetJourneyResponse

    Swift

    class AWSPinpointTargetingGetJourneyResponse
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingGetPushTemplateRequest

    Swift

    class AWSPinpointTargetingGetPushTemplateRequest
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingGetPushTemplateResponse

    Swift

    class AWSPinpointTargetingGetPushTemplateResponse
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingGetRecommenderConfigurationRequest

    Swift

    class AWSPinpointTargetingGetRecommenderConfigurationRequest
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingGetRecommenderConfigurationResponse

    Swift

    class AWSPinpointTargetingGetRecommenderConfigurationResponse
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingGetRecommenderConfigurationsRequest

    Swift

    class AWSPinpointTargetingGetRecommenderConfigurationsRequest
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingGetRecommenderConfigurationsResponse

    Swift

    class AWSPinpointTargetingGetRecommenderConfigurationsResponse
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingGetSegmentExportJobsRequest

    Swift

    class AWSPinpointTargetingGetSegmentExportJobsRequest
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingGetSegmentExportJobsResponse

    Swift

    class AWSPinpointTargetingGetSegmentExportJobsResponse
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingGetSegmentImportJobsRequest

    Swift

    class AWSPinpointTargetingGetSegmentImportJobsRequest
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingGetSegmentImportJobsResponse

    Swift

    class AWSPinpointTargetingGetSegmentImportJobsResponse
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingGetSegmentRequest

    Swift

    class AWSPinpointTargetingGetSegmentRequest
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingGetSegmentResponse

    Swift

    class AWSPinpointTargetingGetSegmentResponse
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingGetSegmentVersionRequest

    Swift

    class AWSPinpointTargetingGetSegmentVersionRequest
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingGetSegmentVersionResponse

    Swift

    class AWSPinpointTargetingGetSegmentVersionResponse
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingGetSegmentVersionsRequest

    Swift

    class AWSPinpointTargetingGetSegmentVersionsRequest
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingGetSegmentVersionsResponse

    Swift

    class AWSPinpointTargetingGetSegmentVersionsResponse
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingGetSegmentsRequest

    Swift

    class AWSPinpointTargetingGetSegmentsRequest
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingGetSegmentsResponse

    Swift

    class AWSPinpointTargetingGetSegmentsResponse
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingGetSmsChannelRequest

    Swift

    class AWSPinpointTargetingGetSmsChannelRequest
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingGetSmsChannelResponse

    Swift

    class AWSPinpointTargetingGetSmsChannelResponse
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingGetSmsTemplateRequest

    Swift

    class AWSPinpointTargetingGetSmsTemplateRequest
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingGetSmsTemplateResponse

    Swift

    class AWSPinpointTargetingGetSmsTemplateResponse
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingGetUserEndpointsRequest

    Swift

    class AWSPinpointTargetingGetUserEndpointsRequest
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingGetUserEndpointsResponse

    Swift

    class AWSPinpointTargetingGetUserEndpointsResponse
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingGetVoiceChannelRequest

    Swift

    class AWSPinpointTargetingGetVoiceChannelRequest
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingGetVoiceChannelResponse

    Swift

    class AWSPinpointTargetingGetVoiceChannelResponse
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingGetVoiceTemplateRequest

    Swift

    class AWSPinpointTargetingGetVoiceTemplateRequest
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingGetVoiceTemplateResponse

    Swift

    class AWSPinpointTargetingGetVoiceTemplateResponse
  • Specifies the settings for a holdout activity in a journey. This type of activity stops a journey for a specified percentage of participants.

    Required parameters: [Percentage]

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingHoldoutActivity

    Swift

    class AWSPinpointTargetingHoldoutActivity
  • Specifies the settings for a job that imports endpoint definitions from an Amazon Simple Storage Service (Amazon S3) bucket.

    Required parameters: [Format, S3Url, RoleArn]

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingImportJobRequest

    Swift

    class AWSPinpointTargetingImportJobRequest
  • Provides information about the resource settings for a job that imports endpoint definitions from one or more files. The files can be stored in an Amazon Simple Storage Service (Amazon S3) bucket or uploaded directly from a computer by using the Amazon Pinpoint console.

    Required parameters: [Format, S3Url, RoleArn]

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingImportJobResource

    Swift

    class AWSPinpointTargetingImportJobResource
  • Provides information about the status and settings of a job that imports endpoint definitions from one or more files. The files can be stored in an Amazon Simple Storage Service (Amazon S3) bucket or uploaded directly from a computer by using the Amazon Pinpoint console.

    Required parameters: [JobStatus, CreationDate, Type, Definition, Id, ApplicationId]

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingImportJobResponse

    Swift

    class AWSPinpointTargetingImportJobResponse
  • Provides information about the status and settings of all the import jobs that are associated with an application or segment. An import job is a job that imports endpoint definitions from one or more files.

    Required parameters: [Item]

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingImportJobsResponse

    Swift

    class AWSPinpointTargetingImportJobsResponse
  • Provides information about the results of a request to create or update an endpoint that’s associated with an event.

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingItemResponse

    Swift

    class AWSPinpointTargetingItemResponse
  • Specifies the message content for a custom channel message that’s sent to participants in a journey.

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingJourneyCustomMessage

    Swift

    class AWSPinpointTargetingJourneyCustomMessage
  • Provides the results of a query that retrieved the data for a standard engagement metric that applies to a journey, and provides information about that query.

    Required parameters: [KpiResult, KpiName, JourneyId, EndTime, StartTime, ApplicationId]

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingJourneyDateRangeKpiResponse

    Swift

    class AWSPinpointTargetingJourneyDateRangeKpiResponse
  • Specifies the “From” address for an email message that’s sent to participants in a journey.

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingJourneyEmailMessage

    Swift

    class AWSPinpointTargetingJourneyEmailMessage
  • Provides the results of a query that retrieved the data for a standard execution metric that applies to a journey activity, and provides information about that query.

    Required parameters: [Metrics, JourneyId, LastEvaluatedTime, JourneyActivityId, ActivityType, ApplicationId]

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingJourneyExecutionActivityMetricsResponse

    Swift

    class AWSPinpointTargetingJourneyExecutionActivityMetricsResponse
  • Provides the results of a query that retrieved the data for a standard execution metric that applies to a journey, and provides information about that query.

    Required parameters: [Metrics, JourneyId, LastEvaluatedTime, ApplicationId]

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingJourneyExecutionMetricsResponse

    Swift

    class AWSPinpointTargetingJourneyExecutionMetricsResponse
  • Specifies limits on the messages that a journey can send and the number of times participants can enter a journey.

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingJourneyLimits

    Swift

    class AWSPinpointTargetingJourneyLimits
  • Specifies the message configuration for a push notification that’s sent to participants in a journey.

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingJourneyPushMessage

    Swift

    class AWSPinpointTargetingJourneyPushMessage
  • Provides information about the status, configuration, and other settings for a journey.

    Required parameters: [Name, Id, ApplicationId]

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingJourneyResponse

    Swift

    class AWSPinpointTargetingJourneyResponse
  • Specifies the sender ID and message type for an SMS message that’s sent to participants in a journey.

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingJourneySMSMessage

    Swift

    class AWSPinpointTargetingJourneySMSMessage
  • Specifies the schedule settings for a journey.

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingJourneySchedule

    Swift

    class AWSPinpointTargetingJourneySchedule
  • Changes the status of a journey.

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingJourneyStateRequest

    Swift

    class AWSPinpointTargetingJourneyStateRequest
  • Provides information about the status, configuration, and other settings for all the journeys that are associated with an application.

    Required parameters: [Item]

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingJourneysResponse

    Swift

    class AWSPinpointTargetingJourneysResponse
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingListJourneysRequest

    Swift

    class AWSPinpointTargetingListJourneysRequest
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingListJourneysResponse

    Swift

    class AWSPinpointTargetingListJourneysResponse
  • Provides information about all the recommender model configurations that are associated with your Amazon Pinpoint account.

    Required parameters: [Item]

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingListRecommenderConfigurationsResponse

    Swift

    class AWSPinpointTargetingListRecommenderConfigurationsResponse
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingListTagsForResourceRequest

    Swift

    class AWSPinpointTargetingListTagsForResourceRequest
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingListTagsForResourceResponse

    Swift

    class AWSPinpointTargetingListTagsForResourceResponse
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingListTemplateVersionsRequest

    Swift

    class AWSPinpointTargetingListTemplateVersionsRequest
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingListTemplateVersionsResponse

    Swift

    class AWSPinpointTargetingListTemplateVersionsResponse
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingListTemplatesRequest

    Swift

    class AWSPinpointTargetingListTemplatesRequest
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingListTemplatesResponse

    Swift

    class AWSPinpointTargetingListTemplatesResponse
  • Specifies the content and settings for a push notification that’s sent to recipients of a campaign.

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingMessage

    Swift

    class AWSPinpointTargetingMessage
  • Provides information about an API request or response.

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingMessageBody

    Swift

    class AWSPinpointTargetingMessageBody
  • Specifies the message configuration settings for a campaign.

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingMessageConfiguration

    Swift

    class AWSPinpointTargetingMessageConfiguration
  • Specifies the configuration and other settings for a message.

    Required parameters: [MessageConfiguration]

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingMessageRequest

    Swift

    class AWSPinpointTargetingMessageRequest
  • Provides information about the results of a request to send a message to an endpoint address.

    Required parameters: [ApplicationId]

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingMessageResponse

    Swift

    class AWSPinpointTargetingMessageResponse
  • Provides information about the results of sending a message directly to an endpoint address.

    Required parameters: [DeliveryStatus, StatusCode]

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingMessageResult

    Swift

    class AWSPinpointTargetingMessageResult
  • Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.

    Required parameters: [ComparisonOperator, Value]

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingMetricDimension

    Swift

    class AWSPinpointTargetingMetricDimension
  • Specifies a condition to evaluate for an activity path in a journey.

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingMultiConditionalBranch

    Swift

    class AWSPinpointTargetingMultiConditionalBranch
  • Specifies the settings for a multivariate split activity in a journey. This type of activity sends participants down one of as many as five paths (including a default Else path) in a journey, based on conditions that you specify.

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingMultiConditionalSplitActivity

    Swift

    class AWSPinpointTargetingMultiConditionalSplitActivity
  • Specifies a phone number to validate and retrieve information about.

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingNumberValidateRequest

    Swift

    class AWSPinpointTargetingNumberValidateRequest
  • Provides information about a phone number.

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingNumberValidateResponse

    Swift

    class AWSPinpointTargetingNumberValidateResponse
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingPhoneNumberValidateRequest

    Swift

    class AWSPinpointTargetingPhoneNumberValidateRequest
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingPhoneNumberValidateResponse

    Swift

    class AWSPinpointTargetingPhoneNumberValidateResponse
  • Specifies the properties and attributes of an endpoint that’s associated with an event.

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingPublicEndpoint

    Swift

    class AWSPinpointTargetingPublicEndpoint
  • Specifies the settings for a push notification activity in a journey. This type of activity sends a push notification to participants.

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingPushMessageActivity

    Swift

    class AWSPinpointTargetingPushMessageActivity
  • Specifies the content and settings for a message template that can be used in messages that are sent through a push notification channel.

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingPushNotificationTemplateRequest

    Swift

    class AWSPinpointTargetingPushNotificationTemplateRequest
  • Provides information about the content and settings for a message template that can be used in messages that are sent through a push notification channel.

    Required parameters: [LastModifiedDate, CreationDate, TemplateType, TemplateName]

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingPushNotificationTemplateResponse

    Swift

    class AWSPinpointTargetingPushNotificationTemplateResponse
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingPutEventStreamRequest

    Swift

    class AWSPinpointTargetingPutEventStreamRequest
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingPutEventStreamResponse

    Swift

    class AWSPinpointTargetingPutEventStreamResponse
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingPutEventsRequest

    Swift

    class AWSPinpointTargetingPutEventsRequest
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingPutEventsResponse

    Swift

    class AWSPinpointTargetingPutEventsResponse
  • Specifies the start and end times that define a time range when messages aren’t sent to endpoints.

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingQuietTime

    Swift

    class AWSPinpointTargetingQuietTime
  • Specifies the settings for a random split activity in a journey. This type of activity randomly sends specified percentages of participants down one of as many as five paths in a journey, based on conditions that you specify.

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingRandomSplitActivity

    Swift

    class AWSPinpointTargetingRandomSplitActivity
  • Specifies the settings for a path in a random split activity in a journey.

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingRandomSplitEntry

    Swift

    class AWSPinpointTargetingRandomSplitEntry
  • Specifies the contents of an email message, represented as a raw MIME message.

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingRawEmail

    Swift

    class AWSPinpointTargetingRawEmail
  • Specifies criteria for including or excluding endpoints from a segment based on how recently an endpoint was active.

    Required parameters: [Duration, RecencyType]

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingRecencyDimension

    Swift

    class AWSPinpointTargetingRecencyDimension
  • Provides information about Amazon Pinpoint configuration settings for retrieving and processing data from a recommender model.

    Required parameters: [RecommendationProviderUri, LastModifiedDate, CreationDate, RecommendationProviderRoleArn, Id]

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingRecommenderConfigurationResponse

    Swift

    class AWSPinpointTargetingRecommenderConfigurationResponse
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingRemoveAttributesRequest

    Swift

    class AWSPinpointTargetingRemoveAttributesRequest
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingRemoveAttributesResponse

    Swift

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

    Required parameters: [GroupedBys, Values]

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingResultRow

    Swift

    class AWSPinpointTargetingResultRow
  • Provides a single value and metadata about that value as part of an array of query results for a standard metric that applies to an application, campaign, or journey.

    Required parameters: [Type, Value, Key]

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingResultRowValue

    Swift

    class AWSPinpointTargetingResultRowValue
  • Specifies the status and settings of the SMS channel for an application.

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingSMSChannelRequest

    Swift

    class AWSPinpointTargetingSMSChannelRequest
  • Provides information about the status and settings of the SMS channel for an application.

    Required parameters: [Platform]

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingSMSChannelResponse

    Swift

    class AWSPinpointTargetingSMSChannelResponse
  • Specifies the default settings for a one-time SMS message that’s sent directly to an endpoint.

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingSMSMessage

    Swift

    class AWSPinpointTargetingSMSMessage
  • Specifies the settings for an SMS activity in a journey. This type of activity sends a text message to participants.

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingSMSMessageActivity

    Swift

    class AWSPinpointTargetingSMSMessageActivity
  • Specifies the content and settings for a message template that can be used in text messages that are sent through the SMS channel.

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingSMSTemplateRequest

    Swift

    class AWSPinpointTargetingSMSTemplateRequest
  • Provides information about the content and settings for a message template that can be used in text messages that are sent through the SMS channel.

    Required parameters: [LastModifiedDate, CreationDate, TemplateName, TemplateType]

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingSMSTemplateResponse

    Swift

    class AWSPinpointTargetingSMSTemplateResponse
  • Specifies the schedule settings for a campaign.

    Required parameters: [StartTime]

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingSchedule

    Swift

    class AWSPinpointTargetingSchedule
  • Specifies dimension settings for including or excluding endpoints from a segment based on how recently an endpoint was active.

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingSegmentBehaviors

    Swift

    class AWSPinpointTargetingSegmentBehaviors
  • Specifies a segment to associate with an activity in a journey.

    Required parameters: [SegmentId]

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingSegmentCondition

    Swift

    class AWSPinpointTargetingSegmentCondition
  • Specifies demographic-based dimension settings for including or excluding endpoints from a segment. These settings derive from characteristics of endpoint devices, such as platform, make, and model.

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingSegmentDemographics

    Swift

    class AWSPinpointTargetingSegmentDemographics
  • Specifies the dimension settings for a segment.

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingSegmentDimensions

    Swift

    class AWSPinpointTargetingSegmentDimensions
  • Specifies the base segments and dimensions for a segment, and the relationships between these base segments and dimensions.

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingSegmentGroup

    Swift

    class AWSPinpointTargetingSegmentGroup
  • Specifies the settings that define the relationships between segment groups for a segment.

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingSegmentGroupList

    Swift

    class AWSPinpointTargetingSegmentGroupList
  • Provides information about the import job that created a segment. An import job is a job that creates a user segment by importing endpoint definitions.

    Required parameters: [Format, S3Url, Size, ExternalId, RoleArn]

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingSegmentImportResource

    Swift

    class AWSPinpointTargetingSegmentImportResource
  • Specifies geographical dimension settings for a segment.

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingSegmentLocation

    Swift

    class AWSPinpointTargetingSegmentLocation
  • Specifies the segment identifier and version of a segment.

    Required parameters: [Id]

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingSegmentReference

    Swift

    class AWSPinpointTargetingSegmentReference
  • Provides information about the configuration, dimension, and other settings for a segment.

    Required parameters: [SegmentType, CreationDate, Id, Arn, ApplicationId]

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingSegmentResponse

    Swift

    class AWSPinpointTargetingSegmentResponse
  • Provides information about all the segments that are associated with an application.

    Required parameters: [Item]

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingSegmentsResponse

    Swift

    class AWSPinpointTargetingSegmentsResponse
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingSendMessagesRequest

    Swift

    class AWSPinpointTargetingSendMessagesRequest
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingSendMessagesResponse

    Swift

    class AWSPinpointTargetingSendMessagesResponse
  • Specifies the configuration and other settings for a message to send to all the endpoints that are associated with a list of users.

    Required parameters: [MessageConfiguration, Users]

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingSendUsersMessageRequest

    Swift

    class AWSPinpointTargetingSendUsersMessageRequest
  • Provides information about which users and endpoints a message was sent to.

    Required parameters: [ApplicationId]

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingSendUsersMessageResponse

    Swift

    class AWSPinpointTargetingSendUsersMessageResponse
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingSendUsersMessagesRequest

    Swift

    class AWSPinpointTargetingSendUsersMessagesRequest
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingSendUsersMessagesResponse

    Swift

    class AWSPinpointTargetingSendUsersMessagesResponse
  • Provides information about a session.

    Required parameters: [StartTimestamp, Id]

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingSession

    Swift

    class AWSPinpointTargetingSession
  • Specifies the dimension type and values for a segment dimension.

    Required parameters: [Values]

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingSetDimension

    Swift

    class AWSPinpointTargetingSetDimension
  • Specifies a condition to evaluate for an activity in a journey.

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingSimpleCondition

    Swift

    class AWSPinpointTargetingSimpleCondition
  • Specifies the contents of an email message, composed of a subject, a text part, and an HTML part.

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingSimpleEmail

    Swift

    class AWSPinpointTargetingSimpleEmail
  • Specifies the subject or body of an email message, represented as textual email data and the applicable character set.

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingSimpleEmailPart

    Swift

    class AWSPinpointTargetingSimpleEmailPart
  • Specifies the conditions for the first activity in a journey. This activity and its conditions determine which users are participants in a journey.

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingStartCondition

    Swift

    class AWSPinpointTargetingStartCondition
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingTagResourceRequest

    Swift

    class AWSPinpointTargetingTagResourceRequest
  • Specifies the tags (keys and values) for an application, campaign, message template, or segment.

    Required parameters: [tags]

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingTagsModel

    Swift

    class AWSPinpointTargetingTagsModel
  • Specifies the name and version of the message template to use for the message.

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingTemplate

    Swift

    class AWSPinpointTargetingTemplate
  • Specifies which version of a message template to use as the active version of the template.

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingTemplateActiveVersionRequest

    Swift

    class AWSPinpointTargetingTemplateActiveVersionRequest
  • Specifies the message template to use for the message, for each type of channel.

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingTemplateConfiguration

    Swift

    class AWSPinpointTargetingTemplateConfiguration
  • Provides information about a message template that’s associated with your Amazon Pinpoint account.

    Required parameters: [LastModifiedDate, CreationDate, TemplateName, TemplateType]

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingTemplateResponse

    Swift

    class AWSPinpointTargetingTemplateResponse
  • Provides information about a specific version of a message template.

    Required parameters: [LastModifiedDate, CreationDate, TemplateName, TemplateType]

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingTemplateVersionResponse

    Swift

    class AWSPinpointTargetingTemplateVersionResponse
  • Provides information about all the versions of a specific message template.

    Required parameters: [Item]

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingTemplateVersionsResponse

    Swift

    class AWSPinpointTargetingTemplateVersionsResponse
  • Provides information about all the message templates that are associated with your Amazon Pinpoint account.

    Required parameters: [Item]

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingTemplatesResponse

    Swift

    class AWSPinpointTargetingTemplatesResponse
  • Specifies the settings for a campaign treatment. A treatment is a variation of a campaign that’s used for A/B testing of a campaign.

    Required parameters: [Id, SizePercent]

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingTreatmentResource

    Swift

    class AWSPinpointTargetingTreatmentResource
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingUntagResourceRequest

    Swift

    class AWSPinpointTargetingUntagResourceRequest
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingUpdateAdmChannelRequest

    Swift

    class AWSPinpointTargetingUpdateAdmChannelRequest
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingUpdateAdmChannelResponse

    Swift

    class AWSPinpointTargetingUpdateAdmChannelResponse
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingUpdateApnsChannelRequest

    Swift

    class AWSPinpointTargetingUpdateApnsChannelRequest
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingUpdateApnsChannelResponse

    Swift

    class AWSPinpointTargetingUpdateApnsChannelResponse
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingUpdateApnsSandboxChannelRequest

    Swift

    class AWSPinpointTargetingUpdateApnsSandboxChannelRequest
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingUpdateApnsSandboxChannelResponse

    Swift

    class AWSPinpointTargetingUpdateApnsSandboxChannelResponse
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingUpdateApnsVoipChannelRequest

    Swift

    class AWSPinpointTargetingUpdateApnsVoipChannelRequest
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingUpdateApnsVoipChannelResponse

    Swift

    class AWSPinpointTargetingUpdateApnsVoipChannelResponse
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingUpdateApnsVoipSandboxChannelRequest

    Swift

    class AWSPinpointTargetingUpdateApnsVoipSandboxChannelRequest
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingUpdateApnsVoipSandboxChannelResponse

    Swift

    class AWSPinpointTargetingUpdateApnsVoipSandboxChannelResponse
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingUpdateApplicationSettingsRequest

    Swift

    class AWSPinpointTargetingUpdateApplicationSettingsRequest
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingUpdateApplicationSettingsResponse

    Swift

    class AWSPinpointTargetingUpdateApplicationSettingsResponse
  • Specifies one or more attributes to remove from all the endpoints that are associated with an application.

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingUpdateAttributesRequest

    Swift

    class AWSPinpointTargetingUpdateAttributesRequest
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingUpdateBaiduChannelRequest

    Swift

    class AWSPinpointTargetingUpdateBaiduChannelRequest
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingUpdateBaiduChannelResponse

    Swift

    class AWSPinpointTargetingUpdateBaiduChannelResponse
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingUpdateCampaignRequest

    Swift

    class AWSPinpointTargetingUpdateCampaignRequest
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingUpdateCampaignResponse

    Swift

    class AWSPinpointTargetingUpdateCampaignResponse
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingUpdateEmailChannelRequest

    Swift

    class AWSPinpointTargetingUpdateEmailChannelRequest
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingUpdateEmailChannelResponse

    Swift

    class AWSPinpointTargetingUpdateEmailChannelResponse
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingUpdateEmailTemplateRequest

    Swift

    class AWSPinpointTargetingUpdateEmailTemplateRequest
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingUpdateEmailTemplateResponse

    Swift

    class AWSPinpointTargetingUpdateEmailTemplateResponse
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingUpdateEndpointRequest

    Swift

    class AWSPinpointTargetingUpdateEndpointRequest
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingUpdateEndpointResponse

    Swift

    class AWSPinpointTargetingUpdateEndpointResponse
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingUpdateEndpointsBatchRequest

    Swift

    class AWSPinpointTargetingUpdateEndpointsBatchRequest
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingUpdateEndpointsBatchResponse

    Swift

    class AWSPinpointTargetingUpdateEndpointsBatchResponse
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingUpdateGcmChannelRequest

    Swift

    class AWSPinpointTargetingUpdateGcmChannelRequest
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingUpdateGcmChannelResponse

    Swift

    class AWSPinpointTargetingUpdateGcmChannelResponse
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingUpdateJourneyRequest

    Swift

    class AWSPinpointTargetingUpdateJourneyRequest
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingUpdateJourneyResponse

    Swift

    class AWSPinpointTargetingUpdateJourneyResponse
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingUpdateJourneyStateRequest

    Swift

    class AWSPinpointTargetingUpdateJourneyStateRequest
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingUpdateJourneyStateResponse

    Swift

    class AWSPinpointTargetingUpdateJourneyStateResponse
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingUpdatePushTemplateRequest

    Swift

    class AWSPinpointTargetingUpdatePushTemplateRequest
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingUpdatePushTemplateResponse

    Swift

    class AWSPinpointTargetingUpdatePushTemplateResponse
  • Specifies Amazon Pinpoint configuration settings for retrieving and processing recommendation data from a recommender model.

    Required parameters: [RecommendationProviderUri, RecommendationProviderRoleArn]

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingUpdateRecommenderConfiguration

    Swift

    class AWSPinpointTargetingUpdateRecommenderConfiguration
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingUpdateRecommenderConfigurationRequest

    Swift

    class AWSPinpointTargetingUpdateRecommenderConfigurationRequest
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingUpdateRecommenderConfigurationResponse

    Swift

    class AWSPinpointTargetingUpdateRecommenderConfigurationResponse
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingUpdateSegmentRequest

    Swift

    class AWSPinpointTargetingUpdateSegmentRequest
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingUpdateSegmentResponse

    Swift

    class AWSPinpointTargetingUpdateSegmentResponse
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingUpdateSmsChannelRequest

    Swift

    class AWSPinpointTargetingUpdateSmsChannelRequest
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingUpdateSmsChannelResponse

    Swift

    class AWSPinpointTargetingUpdateSmsChannelResponse
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingUpdateSmsTemplateRequest

    Swift

    class AWSPinpointTargetingUpdateSmsTemplateRequest
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingUpdateSmsTemplateResponse

    Swift

    class AWSPinpointTargetingUpdateSmsTemplateResponse
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingUpdateTemplateActiveVersionRequest

    Swift

    class AWSPinpointTargetingUpdateTemplateActiveVersionRequest
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingUpdateTemplateActiveVersionResponse

    Swift

    class AWSPinpointTargetingUpdateTemplateActiveVersionResponse
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingUpdateVoiceChannelRequest

    Swift

    class AWSPinpointTargetingUpdateVoiceChannelRequest
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingUpdateVoiceChannelResponse

    Swift

    class AWSPinpointTargetingUpdateVoiceChannelResponse
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingUpdateVoiceTemplateRequest

    Swift

    class AWSPinpointTargetingUpdateVoiceTemplateRequest
  • Declaration

    Objective-C

    @interface AWSPinpointTargetingUpdateVoiceTemplateResponse

    Swift

    class AWSPinpointTargetingUpdateVoiceTemplateResponse
  • Specifies the status and settings of the voice channel for an application.

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingVoiceChannelRequest

    Swift

    class AWSPinpointTargetingVoiceChannelRequest
  • Provides information about the status and settings of the voice channel for an application.

    Required parameters: [Platform]

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingVoiceChannelResponse

    Swift

    class AWSPinpointTargetingVoiceChannelResponse
  • Specifies the settings for a one-time voice message that’s sent directly to an endpoint through the voice channel.

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingVoiceMessage

    Swift

    class AWSPinpointTargetingVoiceMessage
  • Specifies the content and settings for a message template that can be used in messages that are sent through the voice channel.

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingVoiceTemplateRequest

    Swift

    class AWSPinpointTargetingVoiceTemplateRequest
  • Provides information about the content and settings for a message template that can be used in messages that are sent through the voice channel.

    Required parameters: [LastModifiedDate, CreationDate, TemplateName, TemplateType]

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingVoiceTemplateResponse

    Swift

    class AWSPinpointTargetingVoiceTemplateResponse
  • Specifies the settings for a wait activity in a journey. This type of activity waits for a certain amount of time or until a specific date and time before moving participants to the next activity in a journey.

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingWaitActivity

    Swift

    class AWSPinpointTargetingWaitActivity
  • Specifies a duration or a date and time that indicates when Amazon Pinpoint determines whether an activity’s conditions have been met or an activity moves participants to the next activity in a journey.

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingWaitTime

    Swift

    class AWSPinpointTargetingWaitTime
  • Specifies the default settings for an application.

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingWriteApplicationSettingsRequest

    Swift

    class AWSPinpointTargetingWriteApplicationSettingsRequest
  • Specifies the configuration and other settings for a campaign.

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingWriteCampaignRequest

    Swift

    class AWSPinpointTargetingWriteCampaignRequest
  • Specifies the Amazon Resource Name (ARN) of an event stream to publish events to and the AWS Identity and Access Management (IAM) role to use when publishing those events.

    Required parameters: [RoleArn, DestinationStreamArn]

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingWriteEventStream

    Swift

    class AWSPinpointTargetingWriteEventStream
  • Specifies the configuration and other settings for a journey.

    Required parameters: [Name]

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingWriteJourneyRequest

    Swift

    class AWSPinpointTargetingWriteJourneyRequest
  • Specifies the configuration, dimension, and other settings for a segment. A WriteSegmentRequest object can include a Dimensions object or a SegmentGroups object, but not both.

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingWriteSegmentRequest

    Swift

    class AWSPinpointTargetingWriteSegmentRequest
  • Specifies the settings for a campaign treatment. A treatment is a variation of a campaign that’s used for A/B testing of a campaign.

    Required parameters: [SizePercent]

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingWriteTreatmentResource

    Swift

    class AWSPinpointTargetingWriteTreatmentResource
  • Undocumented

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingResources : NSObject
    
    + (instancetype)sharedInstance;
    
    - (NSDictionary *)JSONObject;
    
    @end

    Swift

    class AWSPinpointTargetingResources : NSObject
  • Doc Engage API - Amazon Pinpoint API

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargeting

    Swift

    class AWSPinpointTargeting
  • Undocumented

    See more

    Declaration

    Objective-C

    @interface AWSPinpointTargetingClient : NSObject
    
    /**
     * Returns the current endpoint.
     * @return (id<AWSPinpointEndpoint>)
     */
    - (AWSPinpointEndpointProfile*) currentEndpointProfile;
    
    /**
     * Sends an update of the current endpoint
     */
    - (AWSTask *)updateEndpointProfile;
    
    /**
     * Updates with the provided endpoint profile, AWSPinpointTargetingClient attributes and metrics are added to the profile.
     */
    - (AWSTask *)updateEndpointProfile:(AWSPinpointEndpointProfile*) endpointProfile;
    
    /**
     * Adds the specified attribute to the current endpoint profile generated by this client.
     * @param theValue A list of strings with the values of the attribute
     * @param theKey the name of the attribute to add
     */
    - (void)addAttribute:(NSArray *)theValue
                  forKey:(NSString *)theKey;
    
    /**
     * Removes the specified attribute from the current endpoint profile generated by this client.
     * @param theKey the key of the attribute to remove
     */
    - (void)removeAttributeForKey:(NSString*) theKey;
    
    /**
     * Adds the specified metric to the current endpoint profile generated by this client.
     * @param theValue the value of the metric
     * @param theKey the name of the metric to add
     */
    - (void)addMetric:(NSNumber *)theValue
               forKey:(NSString *)theKey;
    
    /**
     * Removes the specified metric from the current endpoint profile generated by this client.
     * @param theKey the key of the metric to remove
     */
    - (void)removeMetricForKey:(NSString*) theKey;
    
    @end

    Swift

    class AWSPinpointTargetingClient : NSObject