//
// Copyright 2010-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License").
// You may not use this file except in compliance with the License.
// A copy of the License is located at
//
// http://aws.amazon.com/apache2.0
//
// or in the "license" file accompanying this file. This file is distributed
// on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
// express or implied. See the License for the specific language governing
// permissions and limitations under the License.
//
#import Specifies the status and settings of the ADM (Amazon Device Messaging) channel for an application. The Client ID that you received from Amazon to send messages by using ADM. The Client Secret that you received from Amazon to send messages by using ADM. Specifies whether to enable the ADM channel for the application. Provides information about the status and settings of the ADM (Amazon Device Messaging) channel for an application. The unique identifier for the application that the ADM channel applies to. The date and time when the ADM channel was enabled. Specifies whether the ADM channel is enabled for the application. (Not used) This property is retained only for backward compatibility. (Deprecated) An identifier for the ADM channel. This property is retained only for backward compatibility. Specifies whether the ADM channel is archived. The user who last modified the ADM channel. The date and time when the ADM channel was last modified. The type of messaging or notification platform for the channel. For the ADM channel, this value is ADM. The current version of the ADM channel. Specifies the settings for a one-time message that's sent directly to an endpoint through the ADM (Amazon Device Messaging) channel. The action to occur if the recipient taps the push notification. Valid values are: OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action. DEEP_LINK - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform. URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify. The body of the notification message. An arbitrary string that indicates that multiple messages are logically the same and that Amazon Device Messaging (ADM) can drop previously enqueued messages in favor of this message. The JSON data payload to use for the push notification, if the notification is a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification. The amount of time, in seconds, that ADM should store the message if the recipient's device is offline. Amazon Pinpoint specifies this value in the expiresAfter parameter when it sends the notification message to ADM. The icon image name of the asset saved in your app. The URL of the large icon image to display in the content view of the push notification. The URL of an image to display in the push notification. The base64-encoded, MD5 checksum of the value specified by the Data property. ADM uses the MD5 value to verify the integrity of the data. The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message. Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration or supporting phone home functionality. The URL of the small icon image to display in the status bar and the content view of the push notification. The sound to play when the recipient receives the push notification. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/. The default message variables to use in the notification message. You can override the default variables with individual address variables. The title to display above the notification message on the recipient's device. The URL to open in the recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL. Specifies the status and settings of the APNs (Apple Push Notification service) channel for an application. The bundle identifier that's assigned to your iOS app. This identifier is used for APNs tokens. The APNs client certificate that you received from Apple, if you want Amazon Pinpoint to communicate with APNs by using an APNs certificate. The default authentication method that you want Amazon Pinpoint to use when authenticating with APNs, key or certificate. Specifies whether to enable the APNs channel for the application. The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with APNs. The identifier that's assigned to your Apple developer account team. This identifier is used for APNs tokens. The authentication key to use for APNs tokens. The key identifier that's assigned to your APNs signing key, if you want Amazon Pinpoint to communicate with APNs by using APNs tokens. Provides information about the status and settings of the APNs (Apple Push Notification service) channel for an application. The unique identifier for the application that the APNs channel applies to. The date and time when the APNs channel was enabled. The default authentication method that Amazon Pinpoint uses to authenticate with APNs for this channel, key or certificate. Specifies whether the APNs channel is enabled for the application. (Not used) This property is retained only for backward compatibility. Specifies whether the APNs channel is configured to communicate with APNs by using APNs tokens. To provide an authentication key for APNs tokens, set the TokenKey property of the channel. (Deprecated) An identifier for the APNs channel. This property is retained only for backward compatibility. Specifies whether the APNs channel is archived. The user who last modified the APNs channel. The date and time when the APNs channel was last modified. The type of messaging or notification platform for the channel. For the APNs channel, this value is APNS. The current version of the APNs channel. Specifies the settings for a one-time message that's sent directly to an endpoint through the APNs (Apple Push Notification service) channel. The type of push notification to send. Valid values are: alert - For a standard notification that's displayed on recipients' devices and prompts a recipient to interact with the notification. background - For a silent notification that delivers content in the background and isn't displayed on recipients' devices. complication - For a notification that contains update information for an app’s complication timeline. fileprovider - For a notification that signals changes to a File Provider extension. mdm - For a notification that tells managed devices to contact the MDM server. voip - For a notification that provides information about an incoming VoIP call. Amazon Pinpoint specifies this value in the apns-push-type request header when it sends the notification message to APNs. If you don't specify a value for this property, Amazon Pinpoint sets the value to alert or background automatically, based on the value that you specify for the SilentPush or RawContent property of the message. For more information about the apns-push-type request header, see Sending Notification Requests to APNs on the Apple Developer website. The action to occur if the recipient taps the push notification. Valid values are: OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action. DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of the iOS platform. URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify. The key that indicates whether and how to modify the badge of your app's icon when the recipient receives the push notification. If this key isn't included in the dictionary, the badge doesn't change. To remove the badge, set this value to 0. The body of the notification message. The key that indicates the notification type for the push notification. This key is a value that's defined by the identifier property of one of your app's registered categories. An arbitrary identifier that, if assigned to multiple messages, APNs uses to coalesce the messages into a single push notification instead of delivering each message individually. This value can't exceed 64 bytes. Amazon Pinpoint specifies this value in the apns-collapse-id request header when it sends the notification message to APNs. The JSON payload to use for a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification. The URL of an image or video to display in the push notification. The authentication method that you want Amazon Pinpoint to use when authenticating with APNs, CERTIFICATE or TOKEN. para>5 - Low priority, the notification might be delayed, delivered as part of a group, or throttled. 10 - High priority, the notification is sent immediately. This is the default value. A high priority notification should trigger an alert, play a sound, or badge your app's icon on the recipient's device. Amazon Pinpoint specifies this value in the apns-priority request header when it sends the notification message to APNs. The equivalent values for Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), are normal, for 5, and high, for 10. If you specify an FCM value for this property, Amazon Pinpoint accepts and converts the value to the corresponding APNs value. The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message. If you specify the raw content of an APNs push notification, the message payload has to include the content-available key. The value of the content-available key has to be an integer, and can only be 0 or 1. If you're sending a standard notification, set the value of content-available to 0. If you're sending a silent (background) notification, set the value of content-available to 1. Additionally, silent notification payloads can't include the alert, badge, or sound keys. For more information, see Generating a Remote Notification and Pushing Background Updates to Your App on the Apple Developer website. Specifies whether the notification is a silent push notification. A silent (or background) push notification isn't displayed on recipients' devices. You can use silent push notifications to make small updates to your app, or to display messages in an in-app message center. Amazon Pinpoint uses this property to determine the correct value for the apns-push-type request header when it sends the notification message to APNs. If you specify a value of true for this property, Amazon Pinpoint sets the value for the apns-push-type header field to background. If you specify the raw content of an APNs push notification, the message payload has to include the content-available key. For silent (background) notifications, set the value of content-available to 1. Additionally, the message payload for a silent notification can't include the alert, badge, or sound keys. For more information, see Generating a Remote Notification and Pushing Background Updates to Your App on the Apple Developer website. Apple has indicated that they will throttle "excessive" background notifications based on current traffic volumes. To prevent your notifications being throttled, Apple recommends that you send no more than 3 silent push notifications to each recipient per hour. The key for the sound to play when the recipient receives the push notification. The value for this key is the name of a sound file in your app's main bundle or the Library/Sounds folder in your app's data container. If the sound file can't be found or you specify default for the value, the system plays the default alert sound. The default message variables to use in the notification message. You can override these default variables with individual address variables. The key that represents your app-specific identifier for grouping notifications. If you provide a Notification Content app extension, you can use this value to group your notifications together. The amount of time, in seconds, that APNs should store and attempt to deliver the push notification, if the service is unable to deliver the notification the first time. If this value is 0, APNs treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again. Amazon Pinpoint specifies this value in the apns-expiration request header when it sends the notification message to APNs. The title to display above the notification message on the recipient's device. The URL to open in the recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL. 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. The action to occur if a recipient taps a push notification that's based on the message template. Valid values are: OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action. DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of the iOS platform. URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify. The message body to use in push notifications that are based on the message template. The URL of an image or video to display in push notifications that are based on the message template. The raw, JSON-formatted string to use as the payload for push notifications that are based on the message template. If specified, this value overrides all other content for the message template. The key for the sound to play when the recipient receives a push notification that's based on the message template. The value for this key is the name of a sound file in your app's main bundle or the Library/Sounds folder in your app's data container. If the sound file can't be found or you specify default for the value, the system plays the default alert sound. The title to use in push notifications that are based on the message template. This title appears above the notification message on a recipient's device. The URL to open in the recipient's default mobile browser, if a recipient taps a push notification that's based on the message template and the value of the Action property is URL. Specifies the status and settings of the APNs (Apple Push Notification service) sandbox channel for an application. The bundle identifier that's assigned to your iOS app. This identifier is used for APNs tokens. The APNs client certificate that you received from Apple, if you want Amazon Pinpoint to communicate with the APNs sandbox environment by using an APNs certificate. The default authentication method that you want Amazon Pinpoint to use when authenticating with the APNs sandbox environment, key or certificate. Specifies whether to enable the APNs sandbox channel for the application. The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with the APNs sandbox environment. The identifier that's assigned to your Apple developer account team. This identifier is used for APNs tokens. The authentication key to use for APNs tokens. The key identifier that's assigned to your APNs signing key, if you want Amazon Pinpoint to communicate with the APNs sandbox environment by using APNs tokens. Provides information about the status and settings of the APNs (Apple Push Notification service) sandbox channel for an application. The unique identifier for the application that the APNs sandbox channel applies to. The date and time when the APNs sandbox channel was enabled. The default authentication method that Amazon Pinpoint uses to authenticate with the APNs sandbox environment for this channel, key or certificate. Specifies whether the APNs sandbox channel is enabled for the application. (Not used) This property is retained only for backward compatibility. Specifies whether the APNs sandbox channel is configured to communicate with APNs by using APNs tokens. To provide an authentication key for APNs tokens, set the TokenKey property of the channel. (Deprecated) An identifier for the APNs sandbox channel. This property is retained only for backward compatibility. Specifies whether the APNs sandbox channel is archived. The user who last modified the APNs sandbox channel. The date and time when the APNs sandbox channel was last modified. The type of messaging or notification platform for the channel. For the APNs sandbox channel, this value is APNS_SANDBOX. The current version of the APNs sandbox channel. Specifies the status and settings of the APNs (Apple Push Notification service) VoIP channel for an application. The bundle identifier that's assigned to your iOS app. This identifier is used for APNs tokens. The APNs client certificate that you received from Apple, if you want Amazon Pinpoint to communicate with APNs by using an APNs certificate. The default authentication method that you want Amazon Pinpoint to use when authenticating with APNs, key or certificate. Specifies whether to enable the APNs VoIP channel for the application. The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with APNs. The identifier that's assigned to your Apple developer account team. This identifier is used for APNs tokens. The authentication key to use for APNs tokens. The key identifier that's assigned to your APNs signing key, if you want Amazon Pinpoint to communicate with APNs by using APNs tokens. Provides information about the status and settings of the APNs (Apple Push Notification service) VoIP channel for an application. The unique identifier for the application that the APNs VoIP channel applies to. The date and time when the APNs VoIP channel was enabled. The default authentication method that Amazon Pinpoint uses to authenticate with APNs for this channel, key or certificate. Specifies whether the APNs VoIP channel is enabled for the application. (Not used) This property is retained only for backward compatibility. Specifies whether the APNs VoIP channel is configured to communicate with APNs by using APNs tokens. To provide an authentication key for APNs tokens, set the TokenKey property of the channel. (Deprecated) An identifier for the APNs VoIP channel. This property is retained only for backward compatibility. Specifies whether the APNs VoIP channel is archived. The user who last modified the APNs VoIP channel. The date and time when the APNs VoIP channel was last modified. The type of messaging or notification platform for the channel. For the APNs VoIP channel, this value is APNS_VOIP. The current version of the APNs VoIP channel. Specifies the status and settings of the APNs (Apple Push Notification service) VoIP sandbox channel for an application. The bundle identifier that's assigned to your iOS app. This identifier is used for APNs tokens. The APNs client certificate that you received from Apple, if you want Amazon Pinpoint to communicate with the APNs sandbox environment by using an APNs certificate. The default authentication method that you want Amazon Pinpoint to use when authenticating with the APNs sandbox environment for this channel, key or certificate. Specifies whether the APNs VoIP sandbox channel is enabled for the application. The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with the APNs sandbox environment. The identifier that's assigned to your Apple developer account team. This identifier is used for APNs tokens. The authentication key to use for APNs tokens. The key identifier that's assigned to your APNs signing key, if you want Amazon Pinpoint to communicate with the APNs sandbox environment by using APNs tokens. Provides information about the status and settings of the APNs (Apple Push Notification service) VoIP sandbox channel for an application. The unique identifier for the application that the APNs VoIP sandbox channel applies to. The date and time when the APNs VoIP sandbox channel was enabled. The default authentication method that Amazon Pinpoint uses to authenticate with the APNs sandbox environment for this channel, key or certificate. Specifies whether the APNs VoIP sandbox channel is enabled for the application. (Not used) This property is retained only for backward compatibility. Specifies whether the APNs VoIP sandbox channel is configured to communicate with APNs by using APNs tokens. To provide an authentication key for APNs tokens, set the TokenKey property of the channel. (Deprecated) An identifier for the APNs VoIP sandbox channel. This property is retained only for backward compatibility. Specifies whether the APNs VoIP sandbox channel is archived. The user who last modified the APNs VoIP sandbox channel. The date and time when the APNs VoIP sandbox channel was last modified. The type of messaging or notification platform for the channel. For the APNs VoIP sandbox channel, this value is APNS_VOIP_SANDBOX. The current version of the APNs VoIP sandbox channel. Provides information about the activities that were performed by a campaign. An array of responses, one for each activity that was performed by the campaign. The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages. Specifies the configuration and other settings for an activity in a journey. The settings for a custom message activity. This type of activity calls an AWS Lambda function or web hook that sends messages to participants. The settings for a yes/no split activity. This type of activity sends participants down one of two paths in a journey, based on conditions that you specify. The settings for a connect activity. This type of activity initiates a contact center call to participants. The custom description of the activity. The settings for an email activity. This type of activity sends an email message to participants. The settings for a holdout activity. This type of activity stops a journey for a specified percentage of participants. The settings for a multivariate split activity. This type of activity sends participants down one of as many as five paths (including a default Else path) in a journey, based on conditions that you specify. The settings for a push notification activity. This type of activity sends a push notification to participants. The settings for a random split activity. This type of activity randomly sends specified percentages of participants down one of as many as five paths in a journey, based on conditions that you specify. The settings for an SMS activity. This type of activity sends a text message to participants. The settings for a wait activity. This type of activity waits for a certain amount of time or until a specific date and time before moving participants to the next activity in a journey. Provides information about an activity that was performed by a campaign. The unique identifier for the application that the campaign applies to. The unique identifier for the campaign that the activity applies to. The actual time, in ISO 8601 format, when the activity was marked CANCELLED or COMPLETED. A JSON object that contains metrics relating to the campaign execution for this campaign activity. For information about the structure and contents of the results, see Standard Amazon Pinpoint analytics metrics in the Amazon Pinpoint Developer Guide. The unique identifier for the activity. Specifies whether the activity succeeded. Possible values are SUCCESS and FAIL. The scheduled start time, in ISO 8601 format, for the activity. The actual start time, in ISO 8601 format, of the activity. The current status of the activity. Possible values are: PENDING, INITIALIZING, RUNNING, PAUSED, CANCELLED, and COMPLETED. The total number of endpoints that the campaign successfully delivered messages to. The total number of time zones that were completed. The total number of unique time zones that are in the segment for the campaign. The total number of endpoints that the campaign attempted to deliver messages to. The unique identifier for the campaign treatment that the activity applies to. A treatment is a variation of a campaign that's used for A/B testing of a campaign. Specifies address-based configuration settings for a message that's sent directly to an endpoint. The message body to use instead of the default message body. This value overrides the default message body. The channel to use when sending the message. An object that maps custom attributes to attributes for the address and is attached to the message. Attribute names are case sensitive. For a push notification, this payload is added to the data.pinpoint object. For an email or text message, this payload is added to email/SMS delivery receipt event attributes. The raw, JSON-formatted string to use as the payload for the message. If specified, this value overrides all other values for the message. A map of the message variables to merge with the variables specified by properties of the DefaultMessage object. The variables specified in this map take precedence over all other variables. The message title to use instead of the default message title. This value overrides the default message title. 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. The action to occur if a recipient taps a push notification that's based on the message template. Valid values are: OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action. DEEP_LINK - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform. URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify. The message body to use in a push notification that's based on the message template. The URL of the large icon image to display in the content view of a push notification that's based on the message template. The URL of an image to display in a push notification that's based on the message template. The raw, JSON-formatted string to use as the payload for a push notification that's based on the message template. If specified, this value overrides all other content for the message template. The URL of the small icon image to display in the status bar and the content view of a push notification that's based on the message template. The sound to play when a recipient receives a push notification that's based on the message template. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/. The title to use in a push notification that's based on the message template. This title appears above the notification message on a recipient's device. The URL to open in a recipient's default mobile browser, if a recipient taps a push notification that's based on the message template and the value of the Action property is URL. 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. The unique identifier for the application that the metric applies to. The last date and time of the date range that was used to filter the query results, in extended ISO 8601 format. The date range is inclusive. The name of the metric, also referred to as a key performance indicator (KPI), that the data was retrieved for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. For a list of possible values, see the Amazon Pinpoint Developer Guide. An array of objects that contains the results of the query. Each object contains the value for the metric and metadata about that value. The string to use in a subsequent request to get the next page of results in a paginated response. This value is null for the Application Metrics resource because the resource returns all results in a single page. The first date and time of the date range that was used to filter the query results, in extended ISO 8601 format. The date range is inclusive. Provides information about an application. The Amazon Resource Name (ARN) of the application. The date and time when the Application was created. The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. The display name of the application. This name is displayed as the Project name on the Amazon Pinpoint console. A string-to-string map of key-value pairs that identifies the tags that are associated with the application. Each tag consists of a required tag key and an associated tag value. Provides information about an application, including the default settings for an application. The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. The settings for the AWS Lambda function to invoke by default as a code hook for campaigns in the application. You can use this hook to customize segments that are used by campaigns in the application. The date and time, in ISO 8601 format, when the application's settings were last modified. The default sending limits for campaigns in the application. The default quiet time for campaigns in the application. Quiet time is a specific time range when messages aren't sent to endpoints, if all the following conditions are met: The EndpointDemographic.Timezone property of the endpoint is set to a valid value. The current time in the endpoint's time zone is later than or equal to the time specified by the QuietTime.Start property for the application (or a campaign or journey that has custom quiet time settings). The current time in the endpoint's time zone is earlier than or equal to the time specified by the QuietTime.End property for the application (or a campaign or journey that has custom quiet time settings). If any of the preceding conditions isn't met, the endpoint will receive messages from a campaign or journey, even if quiet time is enabled. Provides information about all of your applications. An array of responses, one for each application that was returned. The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages. Specifies attribute-based criteria for including or excluding endpoints from a segment. The type of segment dimension to use. Valid values are:
*/
@property (nonatomic, assign) AWSPinpointTargetingAction action;
/**
*/
@property (nonatomic, assign) AWSPinpointTargetingAction action;
/**
*/
@property (nonatomic, assign) AWSPinpointTargetingAction action;
/**
*/
@property (nonatomic, assign) AWSPinpointTargetingAction action;
/**
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
*/ @property (nonatomic, strong) NSArrayProvides 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] */ @interface AWSPinpointTargetingAttributesResource : AWSModel /**The unique identifier for the application.
*/ @property (nonatomic, strong) NSString * _Nullable applicationId; /**The type of attribute or attributes that were removed from the endpoints. Valid values are:
endpoint-custom-attributes - Custom attributes that describe endpoints.
endpoint-metric-attributes - Custom metrics that your app reports to Amazon Pinpoint for endpoints.
endpoint-user-attributes - Custom attributes that describe users.
An array that specifies the names of the attributes that were removed from the endpoints.
*/ @property (nonatomic, strong) NSArraySpecifies the status and settings of the Baidu (Baidu Cloud Push) channel for an application.
Required parameters: [SecretKey, ApiKey] */ @interface AWSPinpointTargetingBaiduChannelRequest : AWSModel /**The API key that you received from the Baidu Cloud Push service to communicate with the service.
*/ @property (nonatomic, strong) NSString * _Nullable apiKey; /**Specifies whether to enable the Baidu channel for the application.
*/ @property (nonatomic, strong) NSNumber * _Nullable enabled; /**The secret key that you received from the Baidu Cloud Push service to communicate with the service.
*/ @property (nonatomic, strong) NSString * _Nullable secretKey; @end /**Provides information about the status and settings of the Baidu (Baidu Cloud Push) channel for an application.
Required parameters: [Credential, Platform] */ @interface AWSPinpointTargetingBaiduChannelResponse : AWSModel /**The unique identifier for the application that the Baidu channel applies to.
*/ @property (nonatomic, strong) NSString * _Nullable applicationId; /**The date and time when the Baidu channel was enabled.
*/ @property (nonatomic, strong) NSString * _Nullable creationDate; /**The API key that you received from the Baidu Cloud Push service to communicate with the service.
*/ @property (nonatomic, strong) NSString * _Nullable credential; /**Specifies whether the Baidu channel is enabled for the application.
*/ @property (nonatomic, strong) NSNumber * _Nullable enabled; /**(Not used) This property is retained only for backward compatibility.
*/ @property (nonatomic, strong) NSNumber * _Nullable hasCredential; /**(Deprecated) An identifier for the Baidu channel. This property is retained only for backward compatibility.
*/ @property (nonatomic, strong) NSString * _Nullable identifier; /**Specifies whether the Baidu channel is archived.
*/ @property (nonatomic, strong) NSNumber * _Nullable isArchived; /**The user who last modified the Baidu channel.
*/ @property (nonatomic, strong) NSString * _Nullable lastModifiedBy; /**The date and time when the Baidu channel was last modified.
*/ @property (nonatomic, strong) NSString * _Nullable lastModifiedDate; /**The type of messaging or notification platform for the channel. For the Baidu channel, this value is BAIDU.
*/ @property (nonatomic, strong) NSString * _Nullable platform; /**The current version of the Baidu channel.
*/ @property (nonatomic, strong) NSNumber * _Nullable version; @end /**Specifies the settings for a one-time message that's sent directly to an endpoint through the Baidu (Baidu Cloud Push) channel.
*/ @interface AWSPinpointTargetingBaiduMessage : AWSModel /**The action to occur if the recipient taps the push notification. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
The body of the notification message.
*/ @property (nonatomic, strong) NSString * _Nullable body; /**The JSON data payload to use for the push notification, if the notification is a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification.
*/ @property (nonatomic, strong) NSDictionaryThe icon image name of the asset saved in your app.
*/ @property (nonatomic, strong) NSString * _Nullable iconReference; /**The URL of the large icon image to display in the content view of the push notification.
*/ @property (nonatomic, strong) NSString * _Nullable imageIconUrl; /**The URL of an image to display in the push notification.
*/ @property (nonatomic, strong) NSString * _Nullable imageUrl; /**The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.
*/ @property (nonatomic, strong) NSString * _Nullable rawContent; /**Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration or supporting phone home functionality.
*/ @property (nonatomic, strong) NSNumber * _Nullable silentPush; /**The URL of the small icon image to display in the status bar and the content view of the push notification.
*/ @property (nonatomic, strong) NSString * _Nullable smallImageIconUrl; /**The sound to play when the recipient receives the push notification. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/.
*/ @property (nonatomic, strong) NSString * _Nullable sound; /**The default message variables to use in the notification message. You can override the default variables with individual address variables.
*/ @property (nonatomic, strong) NSDictionaryThe amount of time, in seconds, that the Baidu Cloud Push service should store the message if the recipient's device is offline. The default value and maximum supported time is 604,800 seconds (7 days).
*/ @property (nonatomic, strong) NSNumber * _Nullable timeToLive; /**The title to display above the notification message on the recipient's device.
*/ @property (nonatomic, strong) NSString * _Nullable title; /**The URL to open in the recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
*/ @property (nonatomic, strong) NSString * _Nullable url; @end /**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] */ @interface AWSPinpointTargetingBaseKpiResult : AWSModel /**An array of objects that provides the results of a query that retrieved the data for a standard metric that applies to an application, campaign, or journey.
*/ @property (nonatomic, strong) NSArraySpecifies the contents of a message that's sent through a custom channel to recipients of a campaign.
*/ @interface AWSPinpointTargetingCampaignCustomMessage : AWSModel /**The raw, JSON-formatted string to use as the payload for the message. The maximum size is 5 KB.
*/ @property (nonatomic, strong) NSString * _Nullable data; @end /**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] */ @interface AWSPinpointTargetingCampaignDateRangeKpiResponse : AWSModel /**The unique identifier for the application that the metric applies to.
*/ @property (nonatomic, strong) NSString * _Nullable applicationId; /**The unique identifier for the campaign that the metric applies to.
*/ @property (nonatomic, strong) NSString * _Nullable campaignId; /**The last date and time of the date range that was used to filter the query results, in extended ISO 8601 format. The date range is inclusive.
*/ @property (nonatomic, strong) NSDate * _Nullable endTime; /**The name of the metric, also referred to as a key performance indicator (KPI), that the data was retrieved for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. For a list of possible values, see the Amazon Pinpoint Developer Guide.
*/ @property (nonatomic, strong) NSString * _Nullable kpiName; /**An array of objects that contains the results of the query. Each object contains the value for the metric and metadata about that value.
*/ @property (nonatomic, strong) AWSPinpointTargetingBaseKpiResult * _Nullable kpiResult; /**The string to use in a subsequent request to get the next page of results in a paginated response. This value is null for the Campaign Metrics resource because the resource returns all results in a single page.
*/ @property (nonatomic, strong) NSString * _Nullable nextToken; /**The first date and time of the date range that was used to filter the query results, in extended ISO 8601 format. The date range is inclusive.
*/ @property (nonatomic, strong) NSDate * _Nullable startTime; @end /**Specifies the content and "From" address for an email message that's sent to recipients of a campaign.
*/ @interface AWSPinpointTargetingCampaignEmailMessage : AWSModel /**The body of the email for recipients whose email clients don't render HTML content.
*/ @property (nonatomic, strong) NSString * _Nullable body; /**The verified email address to send the email from. The default address is the FromAddress specified for the email channel for the application.
*/ @property (nonatomic, strong) NSString * _Nullable fromAddress; /**The body of the email, in HTML format, for recipients whose email clients render HTML content.
*/ @property (nonatomic, strong) NSString * _Nullable htmlBody; /**The subject line, or title, of the email.
*/ @property (nonatomic, strong) NSString * _Nullable title; @end /**Specifies the settings for events that cause a campaign to be sent.
Required parameters: [FilterType, Dimensions] */ @interface AWSPinpointTargetingCampaignEventFilter : AWSModel /**The dimension settings of the event filter for the campaign.
*/ @property (nonatomic, strong) AWSPinpointTargetingEventDimensions * _Nullable dimensions; /**The type of event that causes the campaign to be sent. Valid values are: SYSTEM, sends the campaign when a system event occurs; and, ENDPOINT, sends the campaign when an endpoint event (
Specifies settings for invoking an AWS Lambda function that customizes a segment for a campaign.
*/ @interface AWSPinpointTargetingCampaignHook : AWSModel /**The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon Pinpoint invokes to customize a segment for a campaign.
*/ @property (nonatomic, strong) NSString * _Nullable lambdaFunctionName; /**The mode that Amazon Pinpoint uses to invoke the AWS Lambda function. Possible values are:
FILTER - Invoke the function to customize the segment that's used by a campaign.
DELIVERY - (Deprecated) Previously, invoked the function to send a campaign through a custom channel. This functionality is not supported anymore. To send a campaign through a custom channel, use the CustomDeliveryConfiguration and CampaignCustomMessage objects of the campaign.
The web URL that Amazon Pinpoint calls to invoke the AWS Lambda function over HTTPS.
*/ @property (nonatomic, strong) NSString * _Nullable webUrl; @end /**In-app message configuration.
*/ @interface AWSPinpointTargetingCampaignInAppMessage : AWSModel /**The message body of the notification, the email body or the text message.
*/ @property (nonatomic, strong) NSString * _Nullable body; /**In-app message content.
*/ @property (nonatomic, strong) NSArrayCustom config to be sent to client.
*/ @property (nonatomic, strong) NSDictionaryIn-app message layout.
*/ @property (nonatomic, assign) AWSPinpointTargetingLayout layout; @end /**For a campaign, specifies limits on the messages that the campaign can send. For an application, specifies the default limits for messages that campaigns in the application can send.
*/ @interface AWSPinpointTargetingCampaignLimits : AWSModel /**The maximum number of messages that a campaign can send to a single endpoint during a 24-hour period. For an application, this value specifies the default limit for the number of messages that campaigns and journeys can send to a single endpoint during a 24-hour period. The maximum value is 100.
*/ @property (nonatomic, strong) NSNumber * _Nullable daily; /**The maximum amount of time, in seconds, that a campaign can attempt to deliver a message after the scheduled start time for the campaign. The minimum value is 60 seconds.
*/ @property (nonatomic, strong) NSNumber * _Nullable maximumDuration; /**The maximum number of messages that a campaign can send each second. For an application, this value specifies the default limit for the number of messages that campaigns can send each second. The minimum value is 50. The maximum value is 20,000.
*/ @property (nonatomic, strong) NSNumber * _Nullable messagesPerSecond; /**The maximum total number of messages that the campaign can send per user session.
*/ @property (nonatomic, strong) NSNumber * _Nullable session; /**The maximum number of messages that a campaign can send to a single endpoint during the course of the campaign. If a campaign recurs, this setting applies to all runs of the campaign. The maximum value is 100.
*/ @property (nonatomic, strong) NSNumber * _Nullable total; @end /**Provides information about the status, configuration, and other settings for a campaign.
Required parameters: [LastModifiedDate, CreationDate, SegmentId, SegmentVersion, Id, Arn, ApplicationId] */ @interface AWSPinpointTargetingCampaignResponse : AWSModel /**An array of responses, one for each treatment that you defined for the campaign, in addition to the default treatment.
*/ @property (nonatomic, strong) NSArrayThe unique identifier for the application that the campaign applies to.
*/ @property (nonatomic, strong) NSString * _Nullable applicationId; /**The Amazon Resource Name (ARN) of the campaign.
*/ @property (nonatomic, strong) NSString * _Nullable arn; /**The date, in ISO 8601 format, when the campaign was created.
*/ @property (nonatomic, strong) NSString * _Nullable creationDate; /**The delivery configuration settings for sending the campaign through a custom channel.
*/ @property (nonatomic, strong) AWSPinpointTargetingCustomDeliveryConfiguration * _Nullable customDeliveryConfiguration; /**The current status of the campaign's default treatment. This value exists only for campaigns that have more than one treatment.
*/ @property (nonatomic, strong) AWSPinpointTargetingCampaignState * _Nullable defaultState; /**The custom description of the campaign.
*/ @property (nonatomic, strong) NSString * _Nullable detail; /**The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.
*/ @property (nonatomic, strong) NSNumber * _Nullable holdoutPercent; /**The settings for the AWS Lambda function to use as a code hook for the campaign. You can use this hook to customize the segment that's used by the campaign.
*/ @property (nonatomic, strong) AWSPinpointTargetingCampaignHook * _Nullable hook; /**The unique identifier for the campaign.
*/ @property (nonatomic, strong) NSString * _Nullable identifier; /**Specifies whether the campaign is paused. A paused campaign doesn't run unless you resume it by changing this value to false.
*/ @property (nonatomic, strong) NSNumber * _Nullable isPaused; /**The date, in ISO 8601 format, when the campaign was last modified.
*/ @property (nonatomic, strong) NSString * _Nullable lastModifiedDate; /**The messaging limits for the campaign.
*/ @property (nonatomic, strong) AWSPinpointTargetingCampaignLimits * _Nullable limits; /**The message configuration settings for the campaign.
*/ @property (nonatomic, strong) AWSPinpointTargetingMessageConfiguration * _Nullable messageConfiguration; /**The name of the campaign.
*/ @property (nonatomic, strong) NSString * _Nullable name; /**Defines the priority of the campaign, used to decide the order of messages displayed to user if there are multiple messages scheduled to be displayed at the same moment.
*/ @property (nonatomic, strong) NSNumber * _Nullable priority; /**The schedule settings for the campaign.
*/ @property (nonatomic, strong) AWSPinpointTargetingSchedule * _Nullable schedule; /**The unique identifier for the segment that's associated with the campaign.
*/ @property (nonatomic, strong) NSString * _Nullable segmentId; /**The version number of the segment that's associated with the campaign.
*/ @property (nonatomic, strong) NSNumber * _Nullable segmentVersion; /**The current status of the campaign.
*/ @property (nonatomic, strong) AWSPinpointTargetingCampaignState * _Nullable state; /**The message template that’s used for the campaign.
*/ @property (nonatomic, strong) AWSPinpointTargetingTemplateConfiguration * _Nullable templateConfiguration; /**The custom description of the default treatment for the campaign.
*/ @property (nonatomic, strong) NSString * _Nullable treatmentDescription; /**The custom name of the default treatment for the campaign, if the campaign has multiple treatments. A treatment is a variation of a campaign that's used for A/B testing.
*/ @property (nonatomic, strong) NSString * _Nullable treatmentName; /**The version number of the campaign.
*/ @property (nonatomic, strong) NSNumber * _Nullable version; /**A string-to-string map of key-value pairs that identifies the tags that are associated with the campaign. Each tag consists of a required tag key and an associated tag value.
*/ @property (nonatomic, strong) NSDictionarySpecifies the content and settings for an SMS message that's sent to recipients of a campaign.
*/ @interface AWSPinpointTargetingCampaignSmsMessage : AWSModel /**The body of the SMS message.
*/ @property (nonatomic, strong) NSString * _Nullable body; /**The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.
*/ @property (nonatomic, strong) NSString * _Nullable entityId; /**The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages).
*/ @property (nonatomic, assign) AWSPinpointTargetingMessageType messageType; /**The long code to send the SMS message from. This value should be one of the dedicated long codes that's assigned to your AWS account. Although it isn't required, we recommend that you specify the long code using an E.164 format to ensure prompt and accurate delivery of the message. For example, +12065550100.
*/ @property (nonatomic, strong) NSString * _Nullable originationNumber; /**The sender ID to display on recipients' devices when they receive the SMS message.
*/ @property (nonatomic, strong) NSString * _Nullable senderId; /**The template ID received from the regulatory body for sending SMS in your country.
*/ @property (nonatomic, strong) NSString * _Nullable templateId; @end /**Provides information about the status of a campaign.
*/ @interface AWSPinpointTargetingCampaignState : AWSModel /**The current status of the campaign, or the current status of a treatment that belongs to an A/B test campaign.
If a campaign uses A/B testing, the campaign has a status of COMPLETED only if all campaign treatments have a status of COMPLETED. If you delete the segment that's associated with a campaign, the campaign fails and has a status of DELETED.
*/ @property (nonatomic, assign) AWSPinpointTargetingCampaignStatus campaignStatus; @end /**Provides information about the configuration and other settings for all the campaigns that are associated with an application.
Required parameters: [Item] */ @interface AWSPinpointTargetingCampaignsResponse : AWSModel /**An array of responses, one for each campaign that's associated with the application.
*/ @property (nonatomic, strong) NSArrayThe string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.
*/ @property (nonatomic, strong) NSString * _Nullable nextToken; @end /**Provides information about the general settings and status of a channel for an application.
*/ @interface AWSPinpointTargetingChannelResponse : AWSModel /**The unique identifier for the application.
*/ @property (nonatomic, strong) NSString * _Nullable applicationId; /**The date and time, in ISO 8601 format, when the channel was enabled.
*/ @property (nonatomic, strong) NSString * _Nullable creationDate; /**Specifies whether the channel is enabled for the application.
*/ @property (nonatomic, strong) NSNumber * _Nullable enabled; /**(Not used) This property is retained only for backward compatibility.
*/ @property (nonatomic, strong) NSNumber * _Nullable hasCredential; /**(Deprecated) An identifier for the channel. This property is retained only for backward compatibility.
*/ @property (nonatomic, strong) NSString * _Nullable identifier; /**Specifies whether the channel is archived.
*/ @property (nonatomic, strong) NSNumber * _Nullable isArchived; /**The user who last modified the channel.
*/ @property (nonatomic, strong) NSString * _Nullable lastModifiedBy; /**The date and time, in ISO 8601 format, when the channel was last modified.
*/ @property (nonatomic, strong) NSString * _Nullable lastModifiedDate; /**The current version of the channel.
*/ @property (nonatomic, strong) NSNumber * _Nullable version; @end /**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] */ @interface AWSPinpointTargetingChannelsResponse : AWSModel /**A map that contains a multipart response for each channel. For each item in this object, the ChannelType is the key and the Channel is the value.
*/ @property (nonatomic, strong) NSDictionarySpecifies the conditions to evaluate for an activity in a journey, and how to evaluate those conditions.
*/ @interface AWSPinpointTargetingCondition : AWSModel /**The conditions to evaluate for the activity.
*/ @property (nonatomic, strong) NSArraySpecifies how to handle multiple conditions for the activity. For example, if you specify two conditions for an activity, whether both or only one of the conditions must be met for the activity to be performed.
*/ @property (nonatomic, assign) AWSPinpointTargetingOperator operator; @end /**Specifies the settings for a yes/no split activity in a journey. This type of activity sends participants down one of two paths in a journey, based on conditions that you specify.
To create yes/no split activities that send participants down different paths based on push notification events (such as Open or Received events), your mobile app has to specify the User ID and Endpoint ID values. For more information, see Integrating Amazon Pinpoint with your application in the Amazon Pinpoint Developer Guide.
The conditions that define the paths for the activity, and the relationship between the conditions.
*/ @property (nonatomic, strong) AWSPinpointTargetingCondition * _Nullable condition; /**The amount of time to wait before determining whether the conditions are met, or the date and time when Amazon Pinpoint determines whether the conditions are met.
*/ @property (nonatomic, strong) AWSPinpointTargetingWaitTime * _Nullable evaluationWaitTime; /**The unique identifier for the activity to perform if the conditions aren't met.
*/ @property (nonatomic, strong) NSString * _Nullable falseActivity; /**The unique identifier for the activity to perform if the conditions are met.
*/ @property (nonatomic, strong) NSString * _Nullable trueActivity; @end /** */ @interface AWSPinpointTargetingContactCenterActivity : AWSModel /**The unique identifier for the next activity to perform after the this activity.
*/ @property (nonatomic, strong) NSString * _Nullable nextActivity; @end /** */ @interface AWSPinpointTargetingCreateAppRequest : AWSRequest /**Specifies the display name of an application and the tags to associate with the application.
*/ @property (nonatomic, strong) AWSPinpointTargetingCreateApplicationRequest * _Nullable createApplicationRequest; @end /** */ @interface AWSPinpointTargetingCreateAppResponse : AWSModel /**Provides information about an application.
*/ @property (nonatomic, strong) AWSPinpointTargetingApplicationResponse * _Nullable applicationResponse; @end /**Specifies the display name of an application and the tags to associate with the application.
Required parameters: [Name] */ @interface AWSPinpointTargetingCreateApplicationRequest : AWSModel /**The display name of the application. This name is displayed as the Project name on the Amazon Pinpoint console.
*/ @property (nonatomic, strong) NSString * _Nullable name; /**A string-to-string map of key-value pairs that defines the tags to associate with the application. Each tag consists of a required tag key and an associated tag value.
*/ @property (nonatomic, strong) NSDictionaryThe unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/ @property (nonatomic, strong) NSString * _Nullable applicationId; /**Specifies the configuration and other settings for a campaign.
*/ @property (nonatomic, strong) AWSPinpointTargetingWriteCampaignRequest * _Nullable writeCampaignRequest; @end /** */ @interface AWSPinpointTargetingCreateCampaignResponse : AWSModel /**Provides information about the status, configuration, and other settings for a campaign.
*/ @property (nonatomic, strong) AWSPinpointTargetingCampaignResponse * _Nullable campaignResponse; @end /** */ @interface AWSPinpointTargetingCreateEmailTemplateRequest : AWSRequest /**Specifies the content and settings for a message template that can be used in messages that are sent through the email channel.
*/ @property (nonatomic, strong) AWSPinpointTargetingEmailTemplateRequest * _Nullable emailTemplateRequest; /**The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
*/ @property (nonatomic, strong) NSString * _Nullable templateName; @end /** */ @interface AWSPinpointTargetingCreateEmailTemplateResponse : AWSModel /**Provides information about a request to create a message template.
*/ @property (nonatomic, strong) AWSPinpointTargetingCreateTemplateMessageBody * _Nullable createTemplateMessageBody; @end /** */ @interface AWSPinpointTargetingCreateExportJobRequest : AWSRequest /**The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/ @property (nonatomic, strong) NSString * _Nullable applicationId; /**Specifies the settings for a job that exports endpoint definitions to an Amazon Simple Storage Service (Amazon S3) bucket.
*/ @property (nonatomic, strong) AWSPinpointTargetingExportJobRequest * _Nullable exportJobRequest; @end /** */ @interface AWSPinpointTargetingCreateExportJobResponse : AWSModel /**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.
*/ @property (nonatomic, strong) AWSPinpointTargetingExportJobResponse * _Nullable exportJobResponse; @end /** */ @interface AWSPinpointTargetingCreateImportJobRequest : AWSRequest /**The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/ @property (nonatomic, strong) NSString * _Nullable applicationId; /**Specifies the settings for a job that imports endpoint definitions from an Amazon Simple Storage Service (Amazon S3) bucket.
*/ @property (nonatomic, strong) AWSPinpointTargetingImportJobRequest * _Nullable importJobRequest; @end /** */ @interface AWSPinpointTargetingCreateImportJobResponse : AWSModel /**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.
*/ @property (nonatomic, strong) AWSPinpointTargetingImportJobResponse * _Nullable importJobResponse; @end /** */ @interface AWSPinpointTargetingCreateInAppTemplateRequest : AWSRequest /**InApp Template Request.
*/ @property (nonatomic, strong) AWSPinpointTargetingInAppTemplateRequest * _Nullable inAppTemplateRequest; /**The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
*/ @property (nonatomic, strong) NSString * _Nullable templateName; @end /** */ @interface AWSPinpointTargetingCreateInAppTemplateResponse : AWSModel /**Provides information about a request to create a message template.
*/ @property (nonatomic, strong) AWSPinpointTargetingTemplateCreateMessageBody * _Nullable templateCreateMessageBody; @end /** */ @interface AWSPinpointTargetingCreateJourneyRequest : AWSRequest /**The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/ @property (nonatomic, strong) NSString * _Nullable applicationId; /**Specifies the configuration and other settings for a journey.
*/ @property (nonatomic, strong) AWSPinpointTargetingWriteJourneyRequest * _Nullable writeJourneyRequest; @end /** */ @interface AWSPinpointTargetingCreateJourneyResponse : AWSModel /**Provides information about the status, configuration, and other settings for a journey.
*/ @property (nonatomic, strong) AWSPinpointTargetingJourneyResponse * _Nullable journeyResponse; @end /** */ @interface AWSPinpointTargetingCreatePushTemplateRequest : AWSRequest /**Specifies the content and settings for a message template that can be used in messages that are sent through a push notification channel.
*/ @property (nonatomic, strong) AWSPinpointTargetingPushNotificationTemplateRequest * _Nullable pushNotificationTemplateRequest; /**The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
*/ @property (nonatomic, strong) NSString * _Nullable templateName; @end /** */ @interface AWSPinpointTargetingCreatePushTemplateResponse : AWSModel /**Provides information about a request to create a message template.
*/ @property (nonatomic, strong) AWSPinpointTargetingCreateTemplateMessageBody * _Nullable createTemplateMessageBody; @end /**Specifies Amazon Pinpoint configuration settings for retrieving and processing recommendation data from a recommender model.
Required parameters: [RecommendationProviderUri, RecommendationProviderRoleArn] */ @interface AWSPinpointTargetingCreateRecommenderConfiguration : AWSModel /**A map of key-value pairs that defines 1-10 custom endpoint or user attributes, depending on the value for the RecommendationProviderIdType property. Each of these attributes temporarily stores a recommended item that's retrieved from the recommender model and sent to an AWS Lambda function for additional processing. Each attribute can be used as a message variable in a message template.
In the map, the key is the name of a custom attribute and the value is a custom display name for that attribute. The display name appears in the Attribute finder of the template editor on the Amazon Pinpoint console. The following restrictions apply to these names:
An attribute name must start with a letter or number and it can contain up to 50 characters. The characters can be letters, numbers, underscores (_), or hyphens (-). Attribute names are case sensitive and must be unique.
An attribute display name must start with a letter or number and it can contain up to 25 characters. The characters can be letters, numbers, spaces, underscores (_), or hyphens (-).
This object is required if the configuration invokes an AWS Lambda function (RecommendationTransformerUri) to process recommendation data. Otherwise, don't include this object in your request.
*/ @property (nonatomic, strong) NSDictionaryA custom description of the configuration for the recommender model. The description can contain up to 128 characters. The characters can be letters, numbers, spaces, or the following symbols: _ ; () , ‐.
*/ @property (nonatomic, strong) NSString * _Nullable detail; /**A custom name of the configuration for the recommender model. The name must start with a letter or number and it can contain up to 128 characters. The characters can be letters, numbers, spaces, underscores (_), or hyphens (-).
*/ @property (nonatomic, strong) NSString * _Nullable name; /**The type of Amazon Pinpoint ID to associate with unique user IDs in the recommender model. This value enables the model to use attribute and event data that’s specific to a particular endpoint or user in an Amazon Pinpoint application. Valid values are:
PINPOINT_ENDPOINT_ID - Associate each user in the model with a particular endpoint in Amazon Pinpoint. The data is correlated based on endpoint IDs in Amazon Pinpoint. This is the default value.
PINPOINT_USER_ID - Associate each user in the model with a particular user and endpoint in Amazon Pinpoint. The data is correlated based on user IDs in Amazon Pinpoint. If you specify this value, an endpoint definition in Amazon Pinpoint has to specify both a user ID (UserId) and an endpoint ID. Otherwise, messages won’t be sent to the user's endpoint.
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to retrieve recommendation data from the recommender model.
*/ @property (nonatomic, strong) NSString * _Nullable recommendationProviderRoleArn; /**The Amazon Resource Name (ARN) of the recommender model to retrieve recommendation data from. This value must match the ARN of an Amazon Personalize campaign.
*/ @property (nonatomic, strong) NSString * _Nullable recommendationProviderUri; /**The name or Amazon Resource Name (ARN) of the AWS Lambda function to invoke for additional processing of recommendation data that's retrieved from the recommender model.
*/ @property (nonatomic, strong) NSString * _Nullable recommendationTransformerUri; /**A custom display name for the standard endpoint or user attribute (RecommendationItems) that temporarily stores recommended items for each endpoint or user, depending on the value for the RecommendationProviderIdType property. This value is required if the configuration doesn't invoke an AWS Lambda function (RecommendationTransformerUri) to perform additional processing of recommendation data.
This name appears in the Attribute finder of the template editor on the Amazon Pinpoint console. The name can contain up to 25 characters. The characters can be letters, numbers, spaces, underscores (_), or hyphens (-). These restrictions don't apply to attribute values.
*/ @property (nonatomic, strong) NSString * _Nullable recommendationsDisplayName; /**The number of recommended items to retrieve from the model for each endpoint or user, depending on the value for the RecommendationProviderIdType property. This number determines how many recommended items are available for use in message variables. The minimum value is 1. The maximum value is 5. The default value is 5.
To use multiple recommended items and custom attributes with message variables, you have to use an AWS Lambda function (RecommendationTransformerUri) to perform additional processing of recommendation data.
*/ @property (nonatomic, strong) NSNumber * _Nullable recommendationsPerMessage; @end /** */ @interface AWSPinpointTargetingCreateRecommenderConfigurationRequest : AWSRequest /**Specifies Amazon Pinpoint configuration settings for retrieving and processing recommendation data from a recommender model.
*/ @property (nonatomic, strong) AWSPinpointTargetingCreateRecommenderConfiguration * _Nullable createRecommenderConfiguration; @end /** */ @interface AWSPinpointTargetingCreateRecommenderConfigurationResponse : AWSModel /**Provides information about Amazon Pinpoint configuration settings for retrieving and processing data from a recommender model.
*/ @property (nonatomic, strong) AWSPinpointTargetingRecommenderConfigurationResponse * _Nullable recommenderConfigurationResponse; @end /** */ @interface AWSPinpointTargetingCreateSegmentRequest : AWSRequest /**The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/ @property (nonatomic, strong) NSString * _Nullable applicationId; /**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.
*/ @property (nonatomic, strong) AWSPinpointTargetingWriteSegmentRequest * _Nullable writeSegmentRequest; @end /** */ @interface AWSPinpointTargetingCreateSegmentResponse : AWSModel /**Provides information about the configuration, dimension, and other settings for a segment.
*/ @property (nonatomic, strong) AWSPinpointTargetingSegmentResponse * _Nullable segmentResponse; @end /** */ @interface AWSPinpointTargetingCreateSmsTemplateRequest : AWSRequest /**Specifies the content and settings for a message template that can be used in text messages that are sent through the SMS channel.
*/ @property (nonatomic, strong) AWSPinpointTargetingSMSTemplateRequest * _Nullable SMSTemplateRequest; /**The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
*/ @property (nonatomic, strong) NSString * _Nullable templateName; @end /** */ @interface AWSPinpointTargetingCreateSmsTemplateResponse : AWSModel /**Provides information about a request to create a message template.
*/ @property (nonatomic, strong) AWSPinpointTargetingCreateTemplateMessageBody * _Nullable createTemplateMessageBody; @end /**Provides information about a request to create a message template.
*/ @interface AWSPinpointTargetingCreateTemplateMessageBody : AWSModel /**The Amazon Resource Name (ARN) of the message template that was created.
*/ @property (nonatomic, strong) NSString * _Nullable arn; /**The message that's returned from the API for the request to create the message template.
*/ @property (nonatomic, strong) NSString * _Nullable message; /**The unique identifier for the request to create the message template.
*/ @property (nonatomic, strong) NSString * _Nullable requestID; @end /** */ @interface AWSPinpointTargetingCreateVoiceTemplateRequest : AWSRequest /**The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
*/ @property (nonatomic, strong) NSString * _Nullable templateName; /**Specifies the content and settings for a message template that can be used in messages that are sent through the voice channel.
*/ @property (nonatomic, strong) AWSPinpointTargetingVoiceTemplateRequest * _Nullable voiceTemplateRequest; @end /** */ @interface AWSPinpointTargetingCreateVoiceTemplateResponse : AWSModel /**Provides information about a request to create a message template.
*/ @property (nonatomic, strong) AWSPinpointTargetingCreateTemplateMessageBody * _Nullable createTemplateMessageBody; @end /**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] */ @interface AWSPinpointTargetingCustomDeliveryConfiguration : AWSModel /**The destination to send the campaign or treatment to. This value can be one of the following:
The name or Amazon Resource Name (ARN) of an AWS Lambda function to invoke to handle delivery of the campaign or treatment.
The URL for a web application or service that supports HTTPS and can receive the message. The URL has to be a full URL, including the HTTPS protocol.
The types of endpoints to send the campaign or treatment to. Each valid value maps to a type of channel that you can associate with an endpoint by using the ChannelType property of an endpoint.
*/ @property (nonatomic, strong) NSArrayThe settings for a custom message activity. This type of activity calls an AWS Lambda function or web hook that sends messages to participants.
*/ @interface AWSPinpointTargetingCustomMessageActivity : AWSModel /**The destination to send the campaign or treatment to. This value can be one of the following:
The name or Amazon Resource Name (ARN) of an AWS Lambda function to invoke to handle delivery of the campaign or treatment.
The URL for a web application or service that supports HTTPS and can receive the message. The URL has to be a full URL, including the HTTPS protocol.
The types of endpoints to send the custom message to. Each valid value maps to a type of channel that you can associate with an endpoint by using the ChannelType property of an endpoint.
*/ @property (nonatomic, strong) NSArraySpecifies the message data included in a custom channel message that's sent to participants in a journey.
*/ @property (nonatomic, strong) AWSPinpointTargetingJourneyCustomMessage * _Nullable messageConfig; /**The unique identifier for the next activity to perform, after Amazon Pinpoint calls the AWS Lambda function or web hook.
*/ @property (nonatomic, strong) NSString * _Nullable nextActivity; /**The name of the custom message template to use for the message. If specified, this value must match the name of an existing message template.
*/ @property (nonatomic, strong) NSString * _Nullable templateName; /**The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
*/ @property (nonatomic, strong) NSString * _Nullable templateVersion; @end /**Default button configuration.
Required parameters: [ButtonAction, Text] */ @interface AWSPinpointTargetingDefaultButtonConfiguration : AWSModel /**The background color of the button.
*/ @property (nonatomic, strong) NSString * _Nullable backgroundColor; /**The border radius of the button.
*/ @property (nonatomic, strong) NSNumber * _Nullable borderRadius; /**Action triggered by the button.
*/ @property (nonatomic, assign) AWSPinpointTargetingButtonAction buttonAction; /**Button destination.
*/ @property (nonatomic, strong) NSString * _Nullable link; /**Button text.
*/ @property (nonatomic, strong) NSString * _Nullable text; /**The text color of the button.
*/ @property (nonatomic, strong) NSString * _Nullable textColor; @end /**Specifies the default message for all channels.
*/ @interface AWSPinpointTargetingDefaultMessage : AWSModel /**The default body of the message.
*/ @property (nonatomic, strong) NSString * _Nullable body; /**The default message variables to use in the message. You can override these default variables with individual address variables.
*/ @property (nonatomic, strong) NSDictionarySpecifies the default settings and content for a push notification that's sent directly to an endpoint.
*/ @interface AWSPinpointTargetingDefaultPushNotificationMessage : AWSModel /**The default action to occur if a recipient taps the push notification. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of the iOS and Android platforms.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
The default body of the notification message.
*/ @property (nonatomic, strong) NSString * _Nullable body; /**The JSON data payload to use for the default push notification, if the notification is a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification.
*/ @property (nonatomic, strong) NSDictionarySpecifies whether the default notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration or delivering messages to an in-app notification center.
*/ @property (nonatomic, strong) NSNumber * _Nullable silentPush; /**The default message variables to use in the notification message. You can override the default variables with individual address variables.
*/ @property (nonatomic, strong) NSDictionaryThe default title to display above the notification message on a recipient's device.
*/ @property (nonatomic, strong) NSString * _Nullable title; /**The default URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
*/ @property (nonatomic, strong) NSString * _Nullable url; @end /**Specifies the default settings and content for a message template that can be used in messages that are sent through a push notification channel.
*/ @interface AWSPinpointTargetingDefaultPushNotificationTemplate : AWSModel /**The action to occur if a recipient taps a push notification that's based on the message template. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of the iOS and Android platforms.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
The message body to use in push notifications that are based on the message template.
*/ @property (nonatomic, strong) NSString * _Nullable body; /**The sound to play when a recipient receives a push notification that's based on the message template. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/.
For an iOS platform, this value is the key for the name of a sound file in your app's main bundle or the Library/Sounds folder in your app's data container. If the sound file can't be found or you specify default for the value, the system plays the default alert sound.
*/ @property (nonatomic, strong) NSString * _Nullable sound; /**The title to use in push notifications that are based on the message template. This title appears above the notification message on a recipient's device.
*/ @property (nonatomic, strong) NSString * _Nullable title; /**The URL to open in a recipient's default mobile browser, if a recipient taps a push notification that's based on the message template and the value of the Action property is URL.
*/ @property (nonatomic, strong) NSString * _Nullable url; @end /** */ @interface AWSPinpointTargetingDeleteAdmChannelRequest : AWSRequest /**The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/ @property (nonatomic, strong) NSString * _Nullable applicationId; @end /** */ @interface AWSPinpointTargetingDeleteAdmChannelResponse : AWSModel /**Provides information about the status and settings of the ADM (Amazon Device Messaging) channel for an application.
*/ @property (nonatomic, strong) AWSPinpointTargetingADMChannelResponse * _Nullable ADMChannelResponse; @end /** */ @interface AWSPinpointTargetingDeleteApnsChannelRequest : AWSRequest /**The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/ @property (nonatomic, strong) NSString * _Nullable applicationId; @end /** */ @interface AWSPinpointTargetingDeleteApnsChannelResponse : AWSModel /**Provides information about the status and settings of the APNs (Apple Push Notification service) channel for an application.
*/ @property (nonatomic, strong) AWSPinpointTargetingAPNSChannelResponse * _Nullable APNSChannelResponse; @end /** */ @interface AWSPinpointTargetingDeleteApnsSandboxChannelRequest : AWSRequest /**The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/ @property (nonatomic, strong) NSString * _Nullable applicationId; @end /** */ @interface AWSPinpointTargetingDeleteApnsSandboxChannelResponse : AWSModel /**Provides information about the status and settings of the APNs (Apple Push Notification service) sandbox channel for an application.
*/ @property (nonatomic, strong) AWSPinpointTargetingAPNSSandboxChannelResponse * _Nullable APNSSandboxChannelResponse; @end /** */ @interface AWSPinpointTargetingDeleteApnsVoipChannelRequest : AWSRequest /**The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/ @property (nonatomic, strong) NSString * _Nullable applicationId; @end /** */ @interface AWSPinpointTargetingDeleteApnsVoipChannelResponse : AWSModel /**Provides information about the status and settings of the APNs (Apple Push Notification service) VoIP channel for an application.
*/ @property (nonatomic, strong) AWSPinpointTargetingAPNSVoipChannelResponse * _Nullable APNSVoipChannelResponse; @end /** */ @interface AWSPinpointTargetingDeleteApnsVoipSandboxChannelRequest : AWSRequest /**The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/ @property (nonatomic, strong) NSString * _Nullable applicationId; @end /** */ @interface AWSPinpointTargetingDeleteApnsVoipSandboxChannelResponse : AWSModel /**Provides information about the status and settings of the APNs (Apple Push Notification service) VoIP sandbox channel for an application.
*/ @property (nonatomic, strong) AWSPinpointTargetingAPNSVoipSandboxChannelResponse * _Nullable APNSVoipSandboxChannelResponse; @end /** */ @interface AWSPinpointTargetingDeleteAppRequest : AWSRequest /**The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/ @property (nonatomic, strong) NSString * _Nullable applicationId; @end /** */ @interface AWSPinpointTargetingDeleteAppResponse : AWSModel /**Provides information about an application.
*/ @property (nonatomic, strong) AWSPinpointTargetingApplicationResponse * _Nullable applicationResponse; @end /** */ @interface AWSPinpointTargetingDeleteBaiduChannelRequest : AWSRequest /**The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/ @property (nonatomic, strong) NSString * _Nullable applicationId; @end /** */ @interface AWSPinpointTargetingDeleteBaiduChannelResponse : AWSModel /**Provides information about the status and settings of the Baidu (Baidu Cloud Push) channel for an application.
*/ @property (nonatomic, strong) AWSPinpointTargetingBaiduChannelResponse * _Nullable baiduChannelResponse; @end /** */ @interface AWSPinpointTargetingDeleteCampaignRequest : AWSRequest /**The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/ @property (nonatomic, strong) NSString * _Nullable applicationId; /**The unique identifier for the campaign.
*/ @property (nonatomic, strong) NSString * _Nullable campaignId; @end /** */ @interface AWSPinpointTargetingDeleteCampaignResponse : AWSModel /**Provides information about the status, configuration, and other settings for a campaign.
*/ @property (nonatomic, strong) AWSPinpointTargetingCampaignResponse * _Nullable campaignResponse; @end /** */ @interface AWSPinpointTargetingDeleteEmailChannelRequest : AWSRequest /**The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/ @property (nonatomic, strong) NSString * _Nullable applicationId; @end /** */ @interface AWSPinpointTargetingDeleteEmailChannelResponse : AWSModel /**Provides information about the status and settings of the email channel for an application.
*/ @property (nonatomic, strong) AWSPinpointTargetingEmailChannelResponse * _Nullable emailChannelResponse; @end /** */ @interface AWSPinpointTargetingDeleteEmailTemplateRequest : AWSRequest /**The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
*/ @property (nonatomic, strong) NSString * _Nullable templateName; /**The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the
If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.
If you don't specify a value for this parameter, Amazon Pinpoint does the following:
For a get operation, retrieves information about the active version of the template.
For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.
For a delete operation, deletes the template, including all versions of the template.
Provides information about an API request or response.
*/ @property (nonatomic, strong) AWSPinpointTargetingMessageBody * _Nullable messageBody; @end /** */ @interface AWSPinpointTargetingDeleteEndpointRequest : AWSRequest /**The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/ @property (nonatomic, strong) NSString * _Nullable applicationId; /**The unique identifier for the endpoint.
*/ @property (nonatomic, strong) NSString * _Nullable endpointId; @end /** */ @interface AWSPinpointTargetingDeleteEndpointResponse : AWSModel /**Provides information about the channel type and other settings for an endpoint.
*/ @property (nonatomic, strong) AWSPinpointTargetingEndpointResponse * _Nullable endpointResponse; @end /** */ @interface AWSPinpointTargetingDeleteEventStreamRequest : AWSRequest /**The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/ @property (nonatomic, strong) NSString * _Nullable applicationId; @end /** */ @interface AWSPinpointTargetingDeleteEventStreamResponse : AWSModel /**Specifies settings for publishing event data to an Amazon Kinesis data stream or an Amazon Kinesis Data Firehose delivery stream.
*/ @property (nonatomic, strong) AWSPinpointTargetingEventStream * _Nullable eventStream; @end /** */ @interface AWSPinpointTargetingDeleteGcmChannelRequest : AWSRequest /**The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/ @property (nonatomic, strong) NSString * _Nullable applicationId; @end /** */ @interface AWSPinpointTargetingDeleteGcmChannelResponse : AWSModel /**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.
*/ @property (nonatomic, strong) AWSPinpointTargetingGCMChannelResponse * _Nullable GCMChannelResponse; @end /** */ @interface AWSPinpointTargetingDeleteInAppTemplateRequest : AWSRequest /**The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
*/ @property (nonatomic, strong) NSString * _Nullable templateName; /**The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the
If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.
If you don't specify a value for this parameter, Amazon Pinpoint does the following:
For a get operation, retrieves information about the active version of the template.
For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.
For a delete operation, deletes the template, including all versions of the template.
Provides information about an API request or response.
*/ @property (nonatomic, strong) AWSPinpointTargetingMessageBody * _Nullable messageBody; @end /** */ @interface AWSPinpointTargetingDeleteJourneyRequest : AWSRequest /**The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/ @property (nonatomic, strong) NSString * _Nullable applicationId; /**The unique identifier for the journey.
*/ @property (nonatomic, strong) NSString * _Nullable journeyId; @end /** */ @interface AWSPinpointTargetingDeleteJourneyResponse : AWSModel /**Provides information about the status, configuration, and other settings for a journey.
*/ @property (nonatomic, strong) AWSPinpointTargetingJourneyResponse * _Nullable journeyResponse; @end /** */ @interface AWSPinpointTargetingDeletePushTemplateRequest : AWSRequest /**The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
*/ @property (nonatomic, strong) NSString * _Nullable templateName; /**The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the
If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.
If you don't specify a value for this parameter, Amazon Pinpoint does the following:
For a get operation, retrieves information about the active version of the template.
For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.
For a delete operation, deletes the template, including all versions of the template.
Provides information about an API request or response.
*/ @property (nonatomic, strong) AWSPinpointTargetingMessageBody * _Nullable messageBody; @end /** */ @interface AWSPinpointTargetingDeleteRecommenderConfigurationRequest : AWSRequest /**The unique identifier for the recommender model configuration. This identifier is displayed as the Recommender ID on the Amazon Pinpoint console.
*/ @property (nonatomic, strong) NSString * _Nullable recommenderId; @end /** */ @interface AWSPinpointTargetingDeleteRecommenderConfigurationResponse : AWSModel /**Provides information about Amazon Pinpoint configuration settings for retrieving and processing data from a recommender model.
*/ @property (nonatomic, strong) AWSPinpointTargetingRecommenderConfigurationResponse * _Nullable recommenderConfigurationResponse; @end /** */ @interface AWSPinpointTargetingDeleteSegmentRequest : AWSRequest /**The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/ @property (nonatomic, strong) NSString * _Nullable applicationId; /**The unique identifier for the segment.
*/ @property (nonatomic, strong) NSString * _Nullable segmentId; @end /** */ @interface AWSPinpointTargetingDeleteSegmentResponse : AWSModel /**Provides information about the configuration, dimension, and other settings for a segment.
*/ @property (nonatomic, strong) AWSPinpointTargetingSegmentResponse * _Nullable segmentResponse; @end /** */ @interface AWSPinpointTargetingDeleteSmsChannelRequest : AWSRequest /**The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/ @property (nonatomic, strong) NSString * _Nullable applicationId; @end /** */ @interface AWSPinpointTargetingDeleteSmsChannelResponse : AWSModel /**Provides information about the status and settings of the SMS channel for an application.
*/ @property (nonatomic, strong) AWSPinpointTargetingSMSChannelResponse * _Nullable SMSChannelResponse; @end /** */ @interface AWSPinpointTargetingDeleteSmsTemplateRequest : AWSRequest /**The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
*/ @property (nonatomic, strong) NSString * _Nullable templateName; /**The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the
If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.
If you don't specify a value for this parameter, Amazon Pinpoint does the following:
For a get operation, retrieves information about the active version of the template.
For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.
For a delete operation, deletes the template, including all versions of the template.
Provides information about an API request or response.
*/ @property (nonatomic, strong) AWSPinpointTargetingMessageBody * _Nullable messageBody; @end /** */ @interface AWSPinpointTargetingDeleteUserEndpointsRequest : AWSRequest /**The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/ @property (nonatomic, strong) NSString * _Nullable applicationId; /**The unique identifier for the user.
*/ @property (nonatomic, strong) NSString * _Nullable userId; @end /** */ @interface AWSPinpointTargetingDeleteUserEndpointsResponse : AWSModel /**Provides information about all the endpoints that are associated with a user ID.
*/ @property (nonatomic, strong) AWSPinpointTargetingEndpointsResponse * _Nullable endpointsResponse; @end /** */ @interface AWSPinpointTargetingDeleteVoiceChannelRequest : AWSRequest /**The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/ @property (nonatomic, strong) NSString * _Nullable applicationId; @end /** */ @interface AWSPinpointTargetingDeleteVoiceChannelResponse : AWSModel /**Provides information about the status and settings of the voice channel for an application.
*/ @property (nonatomic, strong) AWSPinpointTargetingVoiceChannelResponse * _Nullable voiceChannelResponse; @end /** */ @interface AWSPinpointTargetingDeleteVoiceTemplateRequest : AWSRequest /**The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
*/ @property (nonatomic, strong) NSString * _Nullable templateName; /**The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the
If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.
If you don't specify a value for this parameter, Amazon Pinpoint does the following:
For a get operation, retrieves information about the active version of the template.
For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.
For a delete operation, deletes the template, including all versions of the template.
Provides information about an API request or response.
*/ @property (nonatomic, strong) AWSPinpointTargetingMessageBody * _Nullable messageBody; @end /**Specifies the settings and content for the default message and any default messages that you tailored for specific channels.
*/ @interface AWSPinpointTargetingDirectMessageConfiguration : AWSModel /**The default push notification message for the ADM (Amazon Device Messaging) channel. This message overrides the default push notification message (DefaultPushNotificationMessage).
*/ @property (nonatomic, strong) AWSPinpointTargetingADMMessage * _Nullable ADMMessage; /**The default push notification message for the APNs (Apple Push Notification service) channel. This message overrides the default push notification message (DefaultPushNotificationMessage).
*/ @property (nonatomic, strong) AWSPinpointTargetingAPNSMessage * _Nullable APNSMessage; /**The default push notification message for the Baidu (Baidu Cloud Push) channel. This message overrides the default push notification message (DefaultPushNotificationMessage).
*/ @property (nonatomic, strong) AWSPinpointTargetingBaiduMessage * _Nullable baiduMessage; /**The default message for all channels.
*/ @property (nonatomic, strong) AWSPinpointTargetingDefaultMessage * _Nullable defaultMessage; /**The default push notification message for all push notification channels.
*/ @property (nonatomic, strong) AWSPinpointTargetingDefaultPushNotificationMessage * _Nullable defaultPushNotificationMessage; /**The default message for the email channel. This message overrides the default message (DefaultMessage).
*/ @property (nonatomic, strong) AWSPinpointTargetingEmailMessage * _Nullable emailMessage; /**The default push notification message for the GCM channel, which is used to send notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. This message overrides the default push notification message (DefaultPushNotificationMessage).
*/ @property (nonatomic, strong) AWSPinpointTargetingGCMMessage * _Nullable GCMMessage; /**The default message for the SMS channel. This message overrides the default message (DefaultMessage).
*/ @property (nonatomic, strong) AWSPinpointTargetingSMSMessage * _Nullable SMSMessage; /**The default message for the voice channel. This message overrides the default message (DefaultMessage).
*/ @property (nonatomic, strong) AWSPinpointTargetingVoiceMessage * _Nullable voiceMessage; @end /**Specifies the status and settings of the email channel for an application.
Required parameters: [FromAddress, Identity] */ @interface AWSPinpointTargetingEmailChannelRequest : AWSModel /**The Amazon SES configuration set that you want to apply to messages that you send through the channel.
*/ @property (nonatomic, strong) NSString * _Nullable configurationSet; /**Specifies whether to enable the email channel for the application.
*/ @property (nonatomic, strong) NSNumber * _Nullable enabled; /**The verified email address that you want to send email from when you send email through the channel.
*/ @property (nonatomic, strong) NSString * _Nullable fromAddress; /**The Amazon Resource Name (ARN) of the identity, verified with Amazon Simple Email Service (Amazon SES), that you want to use when you send email through the channel.
*/ @property (nonatomic, strong) NSString * _Nullable identity; /**The ARN of the AWS Identity and Access Management (IAM) role that you want Amazon Pinpoint to use when it submits email-related event data for the channel.
*/ @property (nonatomic, strong) NSString * _Nullable roleArn; @end /**Provides information about the status and settings of the email channel for an application.
Required parameters: [Platform] */ @interface AWSPinpointTargetingEmailChannelResponse : AWSModel /**The unique identifier for the application that the email channel applies to.
*/ @property (nonatomic, strong) NSString * _Nullable applicationId; /**The Amazon SES configuration set that's applied to messages that are sent through the channel.
*/ @property (nonatomic, strong) NSString * _Nullable configurationSet; /**The date and time, in ISO 8601 format, when the email channel was enabled.
*/ @property (nonatomic, strong) NSString * _Nullable creationDate; /**Specifies whether the email channel is enabled for the application.
*/ @property (nonatomic, strong) NSNumber * _Nullable enabled; /**The verified email address that email is sent from when you send email through the channel.
*/ @property (nonatomic, strong) NSString * _Nullable fromAddress; /**(Not used) This property is retained only for backward compatibility.
*/ @property (nonatomic, strong) NSNumber * _Nullable hasCredential; /**(Deprecated) An identifier for the email channel. This property is retained only for backward compatibility.
*/ @property (nonatomic, strong) NSString * _Nullable identifier; /**The Amazon Resource Name (ARN) of the identity, verified with Amazon Simple Email Service (Amazon SES), that's used when you send email through the channel.
*/ @property (nonatomic, strong) NSString * _Nullable identity; /**Specifies whether the email channel is archived.
*/ @property (nonatomic, strong) NSNumber * _Nullable isArchived; /**The user who last modified the email channel.
*/ @property (nonatomic, strong) NSString * _Nullable lastModifiedBy; /**The date and time, in ISO 8601 format, when the email channel was last modified.
*/ @property (nonatomic, strong) NSString * _Nullable lastModifiedDate; /**The maximum number of emails that can be sent through the channel each second.
*/ @property (nonatomic, strong) NSNumber * _Nullable messagesPerSecond; /**The type of messaging or notification platform for the channel. For the email channel, this value is EMAIL.
*/ @property (nonatomic, strong) NSString * _Nullable platform; /**The ARN of the AWS Identity and Access Management (IAM) role that Amazon Pinpoint uses to submit email-related event data for the channel.
*/ @property (nonatomic, strong) NSString * _Nullable roleArn; /**The current version of the email channel.
*/ @property (nonatomic, strong) NSNumber * _Nullable version; @end /**Specifies the default settings and content for a one-time email message that's sent directly to an endpoint.
*/ @interface AWSPinpointTargetingEmailMessage : AWSModel /**The body of the email message.
*/ @property (nonatomic, strong) NSString * _Nullable body; /**The email address to forward bounces and complaints to, if feedback forwarding is enabled.
*/ @property (nonatomic, strong) NSString * _Nullable feedbackForwardingAddress; /**The verified email address to send the email message from. The default value is the FromAddress specified for the email channel.
*/ @property (nonatomic, strong) NSString * _Nullable fromAddress; /**The email message, represented as a raw MIME message.
*/ @property (nonatomic, strong) AWSPinpointTargetingRawEmail * _Nullable rawEmail; /**The reply-to email address(es) for the email message. If a recipient replies to the email, each reply-to address receives the reply.
*/ @property (nonatomic, strong) NSArrayThe email message, composed of a subject, a text part, and an HTML part.
*/ @property (nonatomic, strong) AWSPinpointTargetingSimpleEmail * _Nullable simpleEmail; /**The default message variables to use in the email message. You can override the default variables with individual address variables.
*/ @property (nonatomic, strong) NSDictionarySpecifies the settings for an email activity in a journey. This type of activity sends an email message to participants.
*/ @interface AWSPinpointTargetingEmailMessageActivity : AWSModel /**Specifies the sender address for an email message that's sent to participants in the journey.
*/ @property (nonatomic, strong) AWSPinpointTargetingJourneyEmailMessage * _Nullable messageConfig; /**The unique identifier for the next activity to perform, after the message is sent.
*/ @property (nonatomic, strong) NSString * _Nullable nextActivity; /**The name of the email message template to use for the message. If specified, this value must match the name of an existing message template.
*/ @property (nonatomic, strong) NSString * _Nullable templateName; /**The unique identifier for the version of the email template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
*/ @property (nonatomic, strong) NSString * _Nullable templateVersion; @end /**Specifies the content and settings for a message template that can be used in messages that are sent through the email channel.
*/ @interface AWSPinpointTargetingEmailTemplateRequest : AWSModel /**A JSON object that specifies the default values to use for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable. When you create a message that's based on the template, you can override these defaults with message-specific and address-specific variables and values.
*/ @property (nonatomic, strong) NSString * _Nullable defaultSubstitutions; /**The message body, in HTML format, to use in email messages that are based on the message template. We recommend using HTML format for email clients that render HTML content. You can include links, formatted text, and more in an HTML message.
*/ @property (nonatomic, strong) NSString * _Nullable htmlPart; /**The unique identifier for the recommender model to use for the message template. Amazon Pinpoint uses this value to determine how to retrieve and process data from a recommender model when it sends messages that use the template, if the template contains message variables for recommendation data.
*/ @property (nonatomic, strong) NSString * _Nullable recommenderId; /**The subject line, or title, to use in email messages that are based on the message template.
*/ @property (nonatomic, strong) NSString * _Nullable subject; /**A custom description of the message template.
*/ @property (nonatomic, strong) NSString * _Nullable templateDescription; /**The message body, in plain text format, to use in email messages that are based on the message template. We recommend using plain text format for email clients that don't render HTML content and clients that are connected to high-latency networks, such as mobile devices.
*/ @property (nonatomic, strong) NSString * _Nullable textPart; /**As of 22-05-2023 tags has been deprecated for update operations. After this date any value in tags is not processed and an error code is not returned. To manage tags we recommend using either Tags in the API Reference for Amazon Pinpoint, resourcegroupstaggingapi commands in the AWS Command Line Interface Documentation or resourcegroupstaggingapi in the AWS SDK.
(Deprecated) A string-to-string map of key-value pairs that defines the tags to associate with the message template. Each tag consists of a required tag key and an associated tag value.
*/ @property (nonatomic, strong) NSDictionaryProvides 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] */ @interface AWSPinpointTargetingEmailTemplateResponse : AWSModel /**The Amazon Resource Name (ARN) of the message template.
*/ @property (nonatomic, strong) NSString * _Nullable arn; /**The date, in ISO 8601 format, when the message template was created.
*/ @property (nonatomic, strong) NSString * _Nullable creationDate; /**The JSON object that specifies the default values that are used for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable.
*/ @property (nonatomic, strong) NSString * _Nullable defaultSubstitutions; /**The message body, in HTML format, that's used in email messages that are based on the message template.
*/ @property (nonatomic, strong) NSString * _Nullable htmlPart; /**The date, in ISO 8601 format, when the message template was last modified.
*/ @property (nonatomic, strong) NSString * _Nullable lastModifiedDate; /**The unique identifier for the recommender model that's used by the message template.
*/ @property (nonatomic, strong) NSString * _Nullable recommenderId; /**The subject line, or title, that's used in email messages that are based on the message template.
*/ @property (nonatomic, strong) NSString * _Nullable subject; /**The custom description of the message template.
*/ @property (nonatomic, strong) NSString * _Nullable templateDescription; /**The name of the message template.
*/ @property (nonatomic, strong) NSString * _Nullable templateName; /**The type of channel that the message template is designed for. For an email template, this value is EMAIL.
*/ @property (nonatomic, assign) AWSPinpointTargetingTemplateType templateType; /**The message body, in plain text format, that's used in email messages that are based on the message template.
*/ @property (nonatomic, strong) NSString * _Nullable textPart; /**The unique identifier, as an integer, for the active version of the message template, or the version of the template that you specified by using the version parameter in your request.
*/ @property (nonatomic, strong) NSString * _Nullable version; /**A string-to-string map of key-value pairs that identifies the tags that are associated with the message template. Each tag consists of a required tag key and an associated tag value.
*/ @property (nonatomic, strong) NSDictionarySpecifies an endpoint to create or update and the settings and attributes to set or change for the endpoint.
*/ @interface AWSPinpointTargetingEndpointBatchItem : AWSModel /**The destination address for messages or push notifications that you send to the endpoint. The address varies by channel. For a push-notification channel, use the token provided by the push notification service, such as an Apple Push Notification service (APNs) device token or a Firebase Cloud Messaging (FCM) registration token. For the SMS channel, use a phone number in E.164 format, such as +12065550100. For the email channel, use an email address.
*/ @property (nonatomic, strong) NSString * _Nullable address; /**One or more custom attributes that describe the endpoint by associating a name with an array of values. For example, the value of a custom attribute named Interests might be: ["Science", "Music", "Travel"]. You can use these attributes as filter criteria when you create segments. Attribute names are case sensitive.
An attribute name can contain up to 50 characters. An attribute value can contain up to 100 characters. When you define the name of a custom attribute, avoid using the following characters: number sign (#), colon (:), question mark (?), backslash (\), and slash (/). The Amazon Pinpoint console can't display attribute names that contain these characters. This restriction doesn't apply to attribute values.
*/ @property (nonatomic, strong) NSDictionaryThe channel to use when sending messages or push notifications to the endpoint.
*/ @property (nonatomic, assign) AWSPinpointTargetingChannelType channelType; /**The demographic information for the endpoint, such as the time zone and platform.
*/ @property (nonatomic, strong) AWSPinpointTargetingEndpointDemographic * _Nullable demographic; /**The date and time, in ISO 8601 format, when the endpoint was created or updated.
*/ @property (nonatomic, strong) NSString * _Nullable effectiveDate; /**Specifies whether to send messages or push notifications to the endpoint. Valid values are: ACTIVE, messages are sent to the endpoint; and, INACTIVE, messages aren’t sent to the endpoint.
Amazon Pinpoint automatically sets this value to ACTIVE when you create an endpoint or update an existing endpoint. Amazon Pinpoint automatically sets this value to INACTIVE if you update another endpoint that has the same address specified by the Address property.
*/ @property (nonatomic, strong) NSString * _Nullable endpointStatus; /**The unique identifier for the endpoint in the context of the batch.
*/ @property (nonatomic, strong) NSString * _Nullable identifier; /**The geographic information for the endpoint.
*/ @property (nonatomic, strong) AWSPinpointTargetingEndpointLocation * _Nullable location; /**One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint.
*/ @property (nonatomic, strong) NSDictionarySpecifies whether the user who's associated with the endpoint has opted out of receiving messages and push notifications from you. Possible values are: ALL, the user has opted out and doesn't want to receive any messages or push notifications; and, NONE, the user hasn't opted out and wants to receive all messages and push notifications.
*/ @property (nonatomic, strong) NSString * _Nullable optOut; /**The unique identifier for the request to create or update the endpoint.
*/ @property (nonatomic, strong) NSString * _Nullable requestId; /**One or more custom attributes that describe the user who's associated with the endpoint.
*/ @property (nonatomic, strong) AWSPinpointTargetingEndpointUser * _Nullable user; @end /**Specifies a batch of endpoints to create or update and the settings and attributes to set or change for each endpoint.
Required parameters: [Item] */ @interface AWSPinpointTargetingEndpointBatchRequest : AWSModel /**An array that defines the endpoints to create or update and, for each endpoint, the property values to set or change. An array can contain a maximum of 100 items.
*/ @property (nonatomic, strong) NSArraySpecifies demographic information about an endpoint, such as the applicable time zone and platform.
*/ @interface AWSPinpointTargetingEndpointDemographic : AWSModel /**The version of the app that's associated with the endpoint.
*/ @property (nonatomic, strong) NSString * _Nullable appVersion; /**The locale of the endpoint, in the following format: the ISO 639-1 alpha-2 code, followed by an underscore (_), followed by an ISO 3166-1 alpha-2 value.
*/ @property (nonatomic, strong) NSString * _Nullable locale; /**The manufacturer of the endpoint device, such as apple or samsung.
*/ @property (nonatomic, strong) NSString * _Nullable make; /**The model name or number of the endpoint device, such as iPhone or SM-G900F.
*/ @property (nonatomic, strong) NSString * _Nullable model; /**The model version of the endpoint device.
*/ @property (nonatomic, strong) NSString * _Nullable modelVersion; /**The platform of the endpoint device, such as ios.
*/ @property (nonatomic, strong) NSString * _Nullable platform; /**The platform version of the endpoint device.
*/ @property (nonatomic, strong) NSString * _Nullable platformVersion; /**The time zone of the endpoint, specified as a tz database name value, such as America/Los_Angeles.
*/ @property (nonatomic, strong) NSString * _Nullable timezone; @end /**Provides the status code and message that result from processing data for an endpoint.
*/ @interface AWSPinpointTargetingEndpointItemResponse : AWSModel /**The custom message that's returned in the response as a result of processing the endpoint data.
*/ @property (nonatomic, strong) NSString * _Nullable message; /**The status code that's returned in the response as a result of processing the endpoint data.
*/ @property (nonatomic, strong) NSNumber * _Nullable statusCode; @end /**Specifies geographic information about an endpoint.
*/ @interface AWSPinpointTargetingEndpointLocation : AWSModel /**The name of the city where the endpoint is located.
*/ @property (nonatomic, strong) NSString * _Nullable city; /**The two-character code, in ISO 3166-1 alpha-2 format, for the country or region where the endpoint is located. For example, US for the United States.
*/ @property (nonatomic, strong) NSString * _Nullable country; /**The latitude coordinate of the endpoint location, rounded to one decimal place.
*/ @property (nonatomic, strong) NSNumber * _Nullable latitude; /**The longitude coordinate of the endpoint location, rounded to one decimal place.
*/ @property (nonatomic, strong) NSNumber * _Nullable longitude; /**The postal or ZIP code for the area where the endpoint is located.
*/ @property (nonatomic, strong) NSString * _Nullable postalCode; /**The name of the region where the endpoint is located. For locations in the United States, this value is the name of a state.
*/ @property (nonatomic, strong) NSString * _Nullable region; @end /**Provides information about the delivery status and results of sending a message directly to an endpoint.
Required parameters: [DeliveryStatus, StatusCode] */ @interface AWSPinpointTargetingEndpointMessageResult : AWSModel /**The endpoint address that the message was delivered to.
*/ @property (nonatomic, strong) NSString * _Nullable address; /**The delivery status of the message. Possible values are:
DUPLICATE - The endpoint address is a duplicate of another endpoint address. Amazon Pinpoint won't attempt to send the message again.
OPT_OUT - The user who's associated with the endpoint has opted out of receiving messages from you. Amazon Pinpoint won't attempt to send the message again.
PERMANENT_FAILURE - An error occurred when delivering the message to the endpoint. Amazon Pinpoint won't attempt to send the message again.
SUCCESSFUL - The message was successfully delivered to the endpoint.
TEMPORARY_FAILURE - A temporary error occurred. Amazon Pinpoint won't attempt to send the message again.
THROTTLED - Amazon Pinpoint throttled the operation to send the message to the endpoint.
TIMEOUT - The message couldn't be sent within the timeout period.
UNKNOWN_FAILURE - An unknown error occurred.
The unique identifier for the message that was sent.
*/ @property (nonatomic, strong) NSString * _Nullable messageId; /**The downstream service status code for delivering the message.
*/ @property (nonatomic, strong) NSNumber * _Nullable statusCode; /**The status message for delivering the message.
*/ @property (nonatomic, strong) NSString * _Nullable statusMessage; /**For push notifications that are sent through the GCM channel, specifies whether the endpoint's device registration token was updated as part of delivering the message.
*/ @property (nonatomic, strong) NSString * _Nullable updatedToken; @end /**Specifies the channel type and other settings for an endpoint.
*/ @interface AWSPinpointTargetingEndpointRequest : AWSModel /**The destination address for messages or push notifications that you send to the endpoint. The address varies by channel. For a push-notification channel, use the token provided by the push notification service, such as an Apple Push Notification service (APNs) device token or a Firebase Cloud Messaging (FCM) registration token. For the SMS channel, use a phone number in E.164 format, such as +12065550100. For the email channel, use an email address.
*/ @property (nonatomic, strong) NSString * _Nullable address; /**One or more custom attributes that describe the endpoint by associating a name with an array of values. For example, the value of a custom attribute named Interests might be: ["Science", "Music", "Travel"]. You can use these attributes as filter criteria when you create segments. Attribute names are case sensitive.
An attribute name can contain up to 50 characters. An attribute value can contain up to 100 characters. When you define the name of a custom attribute, avoid using the following characters: number sign (#), colon (:), question mark (?), backslash (\), and slash (/). The Amazon Pinpoint console can't display attribute names that contain these characters. This restriction doesn't apply to attribute values.
*/ @property (nonatomic, strong) NSDictionaryThe channel to use when sending messages or push notifications to the endpoint.
*/ @property (nonatomic, assign) AWSPinpointTargetingChannelType channelType; /**The demographic information for the endpoint, such as the time zone and platform.
*/ @property (nonatomic, strong) AWSPinpointTargetingEndpointDemographic * _Nullable demographic; /**The date and time, in ISO 8601 format, when the endpoint is updated.
*/ @property (nonatomic, strong) NSString * _Nullable effectiveDate; /**Specifies whether to send messages or push notifications to the endpoint. Valid values are: ACTIVE, messages are sent to the endpoint; and, INACTIVE, messages aren’t sent to the endpoint.
Amazon Pinpoint automatically sets this value to ACTIVE when you create an endpoint or update an existing endpoint. Amazon Pinpoint automatically sets this value to INACTIVE if you update another endpoint that has the same address specified by the Address property.
*/ @property (nonatomic, strong) NSString * _Nullable endpointStatus; /**The geographic information for the endpoint.
*/ @property (nonatomic, strong) AWSPinpointTargetingEndpointLocation * _Nullable location; /**One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint.
*/ @property (nonatomic, strong) NSDictionarySpecifies whether the user who's associated with the endpoint has opted out of receiving messages and push notifications from you. Possible values are: ALL, the user has opted out and doesn't want to receive any messages or push notifications; and, NONE, the user hasn't opted out and wants to receive all messages and push notifications.
*/ @property (nonatomic, strong) NSString * _Nullable optOut; /**The unique identifier for the most recent request to update the endpoint.
*/ @property (nonatomic, strong) NSString * _Nullable requestId; /**One or more custom attributes that describe the user who's associated with the endpoint.
*/ @property (nonatomic, strong) AWSPinpointTargetingEndpointUser * _Nullable user; @end /**Provides information about the channel type and other settings for an endpoint.
*/ @interface AWSPinpointTargetingEndpointResponse : AWSModel /**The destination address for messages or push notifications that you send to the endpoint. The address varies by channel. For example, the address for a push-notification channel is typically the token provided by a push notification service, such as an Apple Push Notification service (APNs) device token or a Firebase Cloud Messaging (FCM) registration token. The address for the SMS channel is a phone number in E.164 format, such as +12065550100. The address for the email channel is an email address.
*/ @property (nonatomic, strong) NSString * _Nullable address; /**The unique identifier for the application that's associated with the endpoint.
*/ @property (nonatomic, strong) NSString * _Nullable applicationId; /**One or more custom attributes that describe the endpoint by associating a name with an array of values. For example, the value of a custom attribute named Interests might be: ["Science", "Music", "Travel"]. You can use these attributes as filter criteria when you create segments.
*/ @property (nonatomic, strong) NSDictionaryThe channel that's used when sending messages or push notifications to the endpoint.
*/ @property (nonatomic, assign) AWSPinpointTargetingChannelType channelType; /**A number from 0-99 that represents the cohort that the endpoint is assigned to. Endpoints are grouped into cohorts randomly, and each cohort contains approximately 1 percent of the endpoints for an application. Amazon Pinpoint assigns cohorts to the holdout or treatment allocations for campaigns.
*/ @property (nonatomic, strong) NSString * _Nullable cohortId; /**The date and time, in ISO 8601 format, when the endpoint was created.
*/ @property (nonatomic, strong) NSString * _Nullable creationDate; /**The demographic information for the endpoint, such as the time zone and platform.
*/ @property (nonatomic, strong) AWSPinpointTargetingEndpointDemographic * _Nullable demographic; /**The date and time, in ISO 8601 format, when the endpoint was last updated.
*/ @property (nonatomic, strong) NSString * _Nullable effectiveDate; /**Specifies whether messages or push notifications are sent to the endpoint. Possible values are: ACTIVE, messages are sent to the endpoint; and, INACTIVE, messages aren’t sent to the endpoint.
Amazon Pinpoint automatically sets this value to ACTIVE when you create an endpoint or update an existing endpoint. Amazon Pinpoint automatically sets this value to INACTIVE if you update another endpoint that has the same address specified by the Address property.
*/ @property (nonatomic, strong) NSString * _Nullable endpointStatus; /**The unique identifier that you assigned to the endpoint. The identifier should be a globally unique identifier (GUID) to ensure that it doesn't conflict with other endpoint identifiers that are associated with the application.
*/ @property (nonatomic, strong) NSString * _Nullable identifier; /**The geographic information for the endpoint.
*/ @property (nonatomic, strong) AWSPinpointTargetingEndpointLocation * _Nullable location; /**One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint.
*/ @property (nonatomic, strong) NSDictionarySpecifies whether the user who's associated with the endpoint has opted out of receiving messages and push notifications from you. Possible values are: ALL, the user has opted out and doesn't want to receive any messages or push notifications; and, NONE, the user hasn't opted out and wants to receive all messages and push notifications.
*/ @property (nonatomic, strong) NSString * _Nullable optOut; /**The unique identifier for the most recent request to update the endpoint.
*/ @property (nonatomic, strong) NSString * _Nullable requestId; /**One or more custom user attributes that your app reports to Amazon Pinpoint for the user who's associated with the endpoint.
*/ @property (nonatomic, strong) AWSPinpointTargetingEndpointUser * _Nullable user; @end /**Specifies the content, including message variables and attributes, to use in a message that's sent directly to an endpoint.
*/ @interface AWSPinpointTargetingEndpointSendConfiguration : AWSModel /**The body of the message. If specified, this value overrides the default message body.
*/ @property (nonatomic, strong) NSString * _Nullable bodyOverride; /**A map of custom attributes to attach to the message for the address. Attribute names are case sensitive.
For a push notification, this payload is added to the data.pinpoint object. For an email or text message, this payload is added to email/SMS delivery receipt event attributes.
*/ @property (nonatomic, strong) NSDictionaryThe raw, JSON-formatted string to use as the payload for the message. If specified, this value overrides all other values for the message.
*/ @property (nonatomic, strong) NSString * _Nullable rawContent; /**A map of the message variables to merge with the variables specified for the default message (DefaultMessage.Substitutions). The variables specified in this map take precedence over all other variables.
*/ @property (nonatomic, strong) NSDictionaryThe title or subject line of the message. If specified, this value overrides the default message title or subject line.
*/ @property (nonatomic, strong) NSString * _Nullable titleOverride; @end /**Specifies data for one or more attributes that describe the user who's associated with an endpoint.
*/ @interface AWSPinpointTargetingEndpointUser : AWSModel /**One or more custom attributes that describe the user by associating a name with an array of values. For example, the value of an attribute named Interests might be: ["Science", "Music", "Travel"]. You can use these attributes as filter criteria when you create segments. Attribute names are case sensitive.
An attribute name can contain up to 50 characters. An attribute value can contain up to 100 characters. When you define the name of a custom attribute, avoid using the following characters: number sign (#), colon (:), question mark (?), backslash (\), and slash (/). The Amazon Pinpoint console can't display attribute names that contain these characters. This restriction doesn't apply to attribute values.
*/ @property (nonatomic, strong) NSDictionaryThe unique identifier for the user.
*/ @property (nonatomic, strong) NSString * _Nullable userId; @end /**Provides information about all the endpoints that are associated with a user ID.
Required parameters: [Item] */ @interface AWSPinpointTargetingEndpointsResponse : AWSModel /**An array of responses, one for each endpoint that's associated with the user ID.
*/ @property (nonatomic, strong) NSArraySpecifies information about an event that reports data to Amazon Pinpoint.
Required parameters: [EventType, Timestamp] */ @interface AWSPinpointTargetingEvent : AWSModel /**The package name of the app that's recording the event.
*/ @property (nonatomic, strong) NSString * _Nullable appPackageName; /**The title of the app that's recording the event.
*/ @property (nonatomic, strong) NSString * _Nullable appTitle; /**The version number of the app that's recording the event.
*/ @property (nonatomic, strong) NSString * _Nullable appVersionCode; /**One or more custom attributes that are associated with the event.
*/ @property (nonatomic, strong) NSDictionaryThe version of the SDK that's running on the client device.
*/ @property (nonatomic, strong) NSString * _Nullable clientSdkVersion; /**The name of the event.
*/ @property (nonatomic, strong) NSString * _Nullable eventType; /**One or more custom metrics that are associated with the event.
*/ @property (nonatomic, strong) NSDictionaryThe name of the SDK that's being used to record the event.
*/ @property (nonatomic, strong) NSString * _Nullable sdkName; /**Information about the session in which the event occurred.
*/ @property (nonatomic, strong) AWSPinpointTargetingSession * _Nullable session; /**The date and time, in ISO 8601 format, when the event occurred.
*/ @property (nonatomic, strong) NSString * _Nullable timestamp; @end /**Specifies the conditions to evaluate for an event that applies to an activity in a journey.
*/ @interface AWSPinpointTargetingEventCondition : AWSModel /**The dimensions for the event filter to use for the activity.
*/ @property (nonatomic, strong) AWSPinpointTargetingEventDimensions * _Nullable dimensions; /**The message identifier (message_id) for the message to use when determining whether message events meet the condition.
*/ @property (nonatomic, strong) NSString * _Nullable messageActivity; @end /**Specifies the dimensions for an event filter that determines when a campaign is sent or a journey activity is performed.
*/ @interface AWSPinpointTargetingEventDimensions : AWSModel /**One or more custom attributes that your application reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
*/ @property (nonatomic, strong) NSDictionaryThe name of the event that causes the campaign to be sent or the journey activity to be performed. This can be a standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can also be a custom event that's specific to your application. For information about standard events, see Streaming Amazon Pinpoint Events in the Amazon Pinpoint Developer Guide.
*/ @property (nonatomic, strong) AWSPinpointTargetingSetDimension * _Nullable eventType; /**One or more custom metrics that your application reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter.
*/ @property (nonatomic, strong) NSDictionarySpecifies the settings for an event that causes a campaign to be sent or a journey activity to be performed.
Required parameters: [FilterType, Dimensions] */ @interface AWSPinpointTargetingEventFilter : AWSModel /**The dimensions for the event filter to use for the campaign or the journey activity.
*/ @property (nonatomic, strong) AWSPinpointTargetingEventDimensions * _Nullable dimensions; /**The type of event that causes the campaign to be sent or the journey activity to be performed. Valid values are: SYSTEM, sends the campaign or performs the activity when a system event occurs; and, ENDPOINT, sends the campaign or performs the activity when an endpoint event (
Provides the status code and message that result from processing an event.
*/ @interface AWSPinpointTargetingEventItemResponse : AWSModel /**A custom message that's returned in the response as a result of processing the event.
*/ @property (nonatomic, strong) NSString * _Nullable message; /**The status code that's returned in the response as a result of processing the event. Possible values are: 202, for events that were accepted; and, 400, for events that weren't valid.
*/ @property (nonatomic, strong) NSNumber * _Nullable statusCode; @end /**Specifies the settings for an event that causes a journey activity to start.
*/ @interface AWSPinpointTargetingEventStartCondition : AWSModel /**Specifies the settings for an event that causes a campaign to be sent or a journey activity to be performed.
*/ @property (nonatomic, strong) AWSPinpointTargetingEventFilter * _Nullable eventFilter; /** */ @property (nonatomic, strong) NSString * _Nullable segmentId; @end /**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] */ @interface AWSPinpointTargetingEventStream : AWSModel /**The unique identifier for the application to publish event data for.
*/ @property (nonatomic, strong) NSString * _Nullable applicationId; /**The Amazon Resource Name (ARN) of the Amazon Kinesis data stream or Amazon Kinesis Data Firehose delivery stream to publish event data to.
For a Kinesis data stream, the ARN format is: arn:aws:kinesis:
For a Kinesis Data Firehose delivery stream, the ARN format is: arn:aws:firehose:
(Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy. Amazon Pinpoint previously used this value to assume an IAM role when publishing event data, but we removed this requirement. We don't recommend use of external IDs for IAM roles that are assumed by Amazon Pinpoint.
*/ @property (nonatomic, strong) NSString * _Nullable externalId; /**The date, in ISO 8601 format, when the event stream was last modified.
*/ @property (nonatomic, strong) NSString * _Nullable lastModifiedDate; /**The IAM user who last modified the event stream.
*/ @property (nonatomic, strong) NSString * _Nullable lastUpdatedBy; /**The AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to publish event data to the stream in your AWS account.
*/ @property (nonatomic, strong) NSString * _Nullable roleArn; @end /**Specifies a batch of endpoints and events to process.
Required parameters: [Endpoint, Events] */ @interface AWSPinpointTargetingEventsBatch : AWSModel /**A set of properties and attributes that are associated with the endpoint.
*/ @property (nonatomic, strong) AWSPinpointTargetingPublicEndpoint * _Nullable endpoint; /**A set of properties that are associated with the event.
*/ @property (nonatomic, strong) NSDictionarySpecifies a batch of events to process.
Required parameters: [BatchItem] */ @interface AWSPinpointTargetingEventsRequest : AWSModel /**The batch of events to process. For each item in a batch, the endpoint ID acts as a key that has an EventsBatch object as its value.
*/ @property (nonatomic, strong) NSDictionaryProvides information about endpoints and the events that they're associated with.
*/ @interface AWSPinpointTargetingEventsResponse : AWSModel /**A map that contains a multipart response for each endpoint. For each item in this object, the endpoint ID is the key and the item response is the value. If no item response exists, the value can also be one of the following: 202, the request was processed successfully; or 400, the payload wasn't valid or required fields were missing.
*/ @property (nonatomic, strong) NSDictionarySpecifies the settings for a job that exports endpoint definitions to an Amazon Simple Storage Service (Amazon S3) bucket.
Required parameters: [S3UrlPrefix, RoleArn] */ @interface AWSPinpointTargetingExportJobRequest : AWSModel /**The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to access the Amazon S3 location where you want to export endpoint definitions to.
*/ @property (nonatomic, strong) NSString * _Nullable roleArn; /**The URL of the location in an Amazon Simple Storage Service (Amazon S3) bucket where you want to export endpoint definitions to. This location is typically a folder that contains multiple files. The URL should be in the following format: s3://
The identifier for the segment to export endpoint definitions from. If you don't specify this value, Amazon Pinpoint exports definitions for all the endpoints that are associated with the application.
*/ @property (nonatomic, strong) NSString * _Nullable segmentId; /**The version of the segment to export endpoint definitions from, if specified.
*/ @property (nonatomic, strong) NSNumber * _Nullable segmentVersion; @end /**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] */ @interface AWSPinpointTargetingExportJobResource : AWSModel /**The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorized Amazon Pinpoint to access the Amazon S3 location where the endpoint definitions were exported to.
*/ @property (nonatomic, strong) NSString * _Nullable roleArn; /**The URL of the location in an Amazon Simple Storage Service (Amazon S3) bucket where the endpoint definitions were exported to. This location is typically a folder that contains multiple files. The URL should be in the following format: s3://
The identifier for the segment that the endpoint definitions were exported from. If this value isn't present, Amazon Pinpoint exported definitions for all the endpoints that are associated with the application.
*/ @property (nonatomic, strong) NSString * _Nullable segmentId; /**The version of the segment that the endpoint definitions were exported from.
*/ @property (nonatomic, strong) NSNumber * _Nullable segmentVersion; @end /**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] */ @interface AWSPinpointTargetingExportJobResponse : AWSModel /**The unique identifier for the application that's associated with the export job.
*/ @property (nonatomic, strong) NSString * _Nullable applicationId; /**The number of pieces that were processed successfully (completed) by the export job, as of the time of the request.
*/ @property (nonatomic, strong) NSNumber * _Nullable completedPieces; /**The date, in ISO 8601 format, when the export job was completed.
*/ @property (nonatomic, strong) NSString * _Nullable completionDate; /**The date, in ISO 8601 format, when the export job was created.
*/ @property (nonatomic, strong) NSString * _Nullable creationDate; /**The resource settings that apply to the export job.
*/ @property (nonatomic, strong) AWSPinpointTargetingExportJobResource * _Nullable definition; /**The number of pieces that weren't processed successfully (failed) by the export job, as of the time of the request.
*/ @property (nonatomic, strong) NSNumber * _Nullable failedPieces; /**An array of entries, one for each of the first 100 entries that weren't processed successfully (failed) by the export job, if any.
*/ @property (nonatomic, strong) NSArrayThe unique identifier for the export job.
*/ @property (nonatomic, strong) NSString * _Nullable identifier; /**The status of the export job. The job status is FAILED if Amazon Pinpoint wasn't able to process one or more pieces in the job.
*/ @property (nonatomic, assign) AWSPinpointTargetingJobStatus jobStatus; /**The total number of endpoint definitions that weren't processed successfully (failed) by the export job, typically because an error, such as a syntax error, occurred.
*/ @property (nonatomic, strong) NSNumber * _Nullable totalFailures; /**The total number of pieces that must be processed to complete the export job. Each piece consists of an approximately equal portion of the endpoint definitions that are part of the export job.
*/ @property (nonatomic, strong) NSNumber * _Nullable totalPieces; /**The total number of endpoint definitions that were processed by the export job.
*/ @property (nonatomic, strong) NSNumber * _Nullable totalProcessed; /**The job type. This value is EXPORT for export jobs.
*/ @property (nonatomic, strong) NSString * _Nullable types; @end /**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] */ @interface AWSPinpointTargetingExportJobsResponse : AWSModel /**An array of responses, one for each export job that's associated with the application (Export Jobs resource) or segment (Segment Export Jobs resource).
*/ @property (nonatomic, strong) NSArrayThe string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.
*/ @property (nonatomic, strong) NSString * _Nullable nextToken; @end /**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] */ @interface AWSPinpointTargetingGCMChannelRequest : AWSModel /**The Web API Key, also referred to as an API_KEY or server key, that you received from Google to communicate with Google services.
*/ @property (nonatomic, strong) NSString * _Nullable apiKey; /**Specifies whether to enable the GCM channel for the application.
*/ @property (nonatomic, strong) NSNumber * _Nullable enabled; @end /**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] */ @interface AWSPinpointTargetingGCMChannelResponse : AWSModel /**The unique identifier for the application that the GCM channel applies to.
*/ @property (nonatomic, strong) NSString * _Nullable applicationId; /**The date and time when the GCM channel was enabled.
*/ @property (nonatomic, strong) NSString * _Nullable creationDate; /**The Web API Key, also referred to as an API_KEY or server key, that you received from Google to communicate with Google services.
*/ @property (nonatomic, strong) NSString * _Nullable credential; /**Specifies whether the GCM channel is enabled for the application.
*/ @property (nonatomic, strong) NSNumber * _Nullable enabled; /**(Not used) This property is retained only for backward compatibility.
*/ @property (nonatomic, strong) NSNumber * _Nullable hasCredential; /**(Deprecated) An identifier for the GCM channel. This property is retained only for backward compatibility.
*/ @property (nonatomic, strong) NSString * _Nullable identifier; /**Specifies whether the GCM channel is archived.
*/ @property (nonatomic, strong) NSNumber * _Nullable isArchived; /**The user who last modified the GCM channel.
*/ @property (nonatomic, strong) NSString * _Nullable lastModifiedBy; /**The date and time when the GCM channel was last modified.
*/ @property (nonatomic, strong) NSString * _Nullable lastModifiedDate; /**The type of messaging or notification platform for the channel. For the GCM channel, this value is GCM.
*/ @property (nonatomic, strong) NSString * _Nullable platform; /**The current version of the GCM channel.
*/ @property (nonatomic, strong) NSNumber * _Nullable version; @end /**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.
*/ @interface AWSPinpointTargetingGCMMessage : AWSModel /**The action to occur if the recipient taps the push notification. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
The body of the notification message.
*/ @property (nonatomic, strong) NSString * _Nullable body; /**An arbitrary string that identifies a group of messages that can be collapsed to ensure that only the last message is sent when delivery can resume. This helps avoid sending too many instances of the same messages when the recipient's device comes online again or becomes active.
Amazon Pinpoint specifies this value in the Firebase Cloud Messaging (FCM) collapse_key parameter when it sends the notification message to FCM.
*/ @property (nonatomic, strong) NSString * _Nullable collapseKey; /**The JSON data payload to use for the push notification, if the notification is a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification.
*/ @property (nonatomic, strong) NSDictionaryThe icon image name of the asset saved in your app.
*/ @property (nonatomic, strong) NSString * _Nullable iconReference; /**The URL of the large icon image to display in the content view of the push notification.
*/ @property (nonatomic, strong) NSString * _Nullable imageIconUrl; /**The URL of an image to display in the push notification.
*/ @property (nonatomic, strong) NSString * _Nullable imageUrl; /**para>normal - The notification might be delayed. Delivery is optimized for battery usage on the recipient's device. Use this value unless immediate delivery is required.
/listitem>high - The notification is sent immediately and might wake a sleeping device.
Amazon Pinpoint specifies this value in the FCM priority parameter when it sends the notification message to FCM.
The equivalent values for Apple Push Notification service (APNs) are 5, for normal, and 10, for high. If you specify an APNs value for this property, Amazon Pinpoint accepts and converts the value to the corresponding FCM value.
*/ @property (nonatomic, strong) NSString * _Nullable priority; /**The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.
*/ @property (nonatomic, strong) NSString * _Nullable rawContent; /**The package name of the application where registration tokens must match in order for the recipient to receive the message.
*/ @property (nonatomic, strong) NSString * _Nullable restrictedPackageName; /**Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration or supporting phone home functionality.
*/ @property (nonatomic, strong) NSNumber * _Nullable silentPush; /**The URL of the small icon image to display in the status bar and the content view of the push notification.
*/ @property (nonatomic, strong) NSString * _Nullable smallImageIconUrl; /**The sound to play when the recipient receives the push notification. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/.
*/ @property (nonatomic, strong) NSString * _Nullable sound; /**The default message variables to use in the notification message. You can override the default variables with individual address variables.
*/ @property (nonatomic, strong) NSDictionaryThe amount of time, in seconds, that FCM should store and attempt to deliver the push notification, if the service is unable to deliver the notification the first time. If you don't specify this value, FCM defaults to the maximum value, which is 2,419,200 seconds (28 days).
Amazon Pinpoint specifies this value in the FCM time_to_live parameter when it sends the notification message to FCM.
*/ @property (nonatomic, strong) NSNumber * _Nullable timeToLive; /**The title to display above the notification message on the recipient's device.
*/ @property (nonatomic, strong) NSString * _Nullable title; /**The URL to open in the recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
*/ @property (nonatomic, strong) NSString * _Nullable url; @end /**Specifies the GPS coordinates of a location.
Required parameters: [Latitude, Longitude] */ @interface AWSPinpointTargetingGPSCoordinates : AWSModel /**The latitude coordinate of the location.
*/ @property (nonatomic, strong) NSNumber * _Nullable latitude; /**The longitude coordinate of the location.
*/ @property (nonatomic, strong) NSNumber * _Nullable longitude; @end /**Specifies GPS-based criteria for including or excluding endpoints from a segment.
Required parameters: [Coordinates] */ @interface AWSPinpointTargetingGPSPointDimension : AWSModel /**The GPS coordinates to measure distance from.
*/ @property (nonatomic, strong) AWSPinpointTargetingGPSCoordinates * _Nullable coordinates; /**The range, in kilometers, from the GPS coordinates.
*/ @property (nonatomic, strong) NSNumber * _Nullable rangeInKilometers; @end /** */ @interface AWSPinpointTargetingGetAdmChannelRequest : AWSRequest /**The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/ @property (nonatomic, strong) NSString * _Nullable applicationId; @end /** */ @interface AWSPinpointTargetingGetAdmChannelResponse : AWSModel /**Provides information about the status and settings of the ADM (Amazon Device Messaging) channel for an application.
*/ @property (nonatomic, strong) AWSPinpointTargetingADMChannelResponse * _Nullable ADMChannelResponse; @end /** */ @interface AWSPinpointTargetingGetApnsChannelRequest : AWSRequest /**The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/ @property (nonatomic, strong) NSString * _Nullable applicationId; @end /** */ @interface AWSPinpointTargetingGetApnsChannelResponse : AWSModel /**Provides information about the status and settings of the APNs (Apple Push Notification service) channel for an application.
*/ @property (nonatomic, strong) AWSPinpointTargetingAPNSChannelResponse * _Nullable APNSChannelResponse; @end /** */ @interface AWSPinpointTargetingGetApnsSandboxChannelRequest : AWSRequest /**The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/ @property (nonatomic, strong) NSString * _Nullable applicationId; @end /** */ @interface AWSPinpointTargetingGetApnsSandboxChannelResponse : AWSModel /**Provides information about the status and settings of the APNs (Apple Push Notification service) sandbox channel for an application.
*/ @property (nonatomic, strong) AWSPinpointTargetingAPNSSandboxChannelResponse * _Nullable APNSSandboxChannelResponse; @end /** */ @interface AWSPinpointTargetingGetApnsVoipChannelRequest : AWSRequest /**The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/ @property (nonatomic, strong) NSString * _Nullable applicationId; @end /** */ @interface AWSPinpointTargetingGetApnsVoipChannelResponse : AWSModel /**Provides information about the status and settings of the APNs (Apple Push Notification service) VoIP channel for an application.
*/ @property (nonatomic, strong) AWSPinpointTargetingAPNSVoipChannelResponse * _Nullable APNSVoipChannelResponse; @end /** */ @interface AWSPinpointTargetingGetApnsVoipSandboxChannelRequest : AWSRequest /**The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/ @property (nonatomic, strong) NSString * _Nullable applicationId; @end /** */ @interface AWSPinpointTargetingGetApnsVoipSandboxChannelResponse : AWSModel /**Provides information about the status and settings of the APNs (Apple Push Notification service) VoIP sandbox channel for an application.
*/ @property (nonatomic, strong) AWSPinpointTargetingAPNSVoipSandboxChannelResponse * _Nullable APNSVoipSandboxChannelResponse; @end /** */ @interface AWSPinpointTargetingGetAppRequest : AWSRequest /**The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/ @property (nonatomic, strong) NSString * _Nullable applicationId; @end /** */ @interface AWSPinpointTargetingGetAppResponse : AWSModel /**Provides information about an application.
*/ @property (nonatomic, strong) AWSPinpointTargetingApplicationResponse * _Nullable applicationResponse; @end /** */ @interface AWSPinpointTargetingGetApplicationDateRangeKpiRequest : AWSRequest /**The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/ @property (nonatomic, strong) NSString * _Nullable applicationId; /**The last date and time to retrieve data for, as part of an inclusive date range that filters the query results. This value should be in extended ISO 8601 format and use Coordinated Universal Time (UTC), for example: 2019-07-26T20:00:00Z for 8:00 PM UTC July 26, 2019.
*/ @property (nonatomic, strong) NSDate * _Nullable endTime; /**The name of the metric, also referred to as a key performance indicator (KPI), to retrieve data for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. Examples are email-open-rate and successful-delivery-rate. For a list of valid values, see the Amazon Pinpoint Developer Guide.
*/ @property (nonatomic, strong) NSString * _Nullable kpiName; /**Thestring that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics.
*/ @property (nonatomic, strong) NSString * _Nullable nextToken; /**The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.
*/ @property (nonatomic, strong) NSString * _Nullable pageSize; /**The first date and time to retrieve data for, as part of an inclusive date range that filters the query results. This value should be in extended ISO 8601 format and use Coordinated Universal Time (UTC), for example: 2019-07-19T20:00:00Z for 8:00 PM UTC July 19, 2019. This value should also be fewer than 90 days from the current day.
*/ @property (nonatomic, strong) NSDate * _Nullable startTime; @end /** */ @interface AWSPinpointTargetingGetApplicationDateRangeKpiResponse : AWSModel /**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.
*/ @property (nonatomic, strong) AWSPinpointTargetingApplicationDateRangeKpiResponse * _Nullable applicationDateRangeKpiResponse; @end /** */ @interface AWSPinpointTargetingGetApplicationSettingsRequest : AWSRequest /**The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/ @property (nonatomic, strong) NSString * _Nullable applicationId; @end /** */ @interface AWSPinpointTargetingGetApplicationSettingsResponse : AWSModel /**Provides information about an application, including the default settings for an application.
*/ @property (nonatomic, strong) AWSPinpointTargetingApplicationSettingsResource * _Nullable applicationSettingsResource; @end /** */ @interface AWSPinpointTargetingGetAppsRequest : AWSRequest /**The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.
*/ @property (nonatomic, strong) NSString * _Nullable pageSize; /**The NextToken string that specifies which page of results to return in a paginated response.
*/ @property (nonatomic, strong) NSString * _Nullable token; @end /** */ @interface AWSPinpointTargetingGetAppsResponse : AWSModel /**Provides information about all of your applications.
*/ @property (nonatomic, strong) AWSPinpointTargetingApplicationsResponse * _Nullable applicationsResponse; @end /** */ @interface AWSPinpointTargetingGetBaiduChannelRequest : AWSRequest /**The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/ @property (nonatomic, strong) NSString * _Nullable applicationId; @end /** */ @interface AWSPinpointTargetingGetBaiduChannelResponse : AWSModel /**Provides information about the status and settings of the Baidu (Baidu Cloud Push) channel for an application.
*/ @property (nonatomic, strong) AWSPinpointTargetingBaiduChannelResponse * _Nullable baiduChannelResponse; @end /** */ @interface AWSPinpointTargetingGetCampaignActivitiesRequest : AWSRequest /**The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/ @property (nonatomic, strong) NSString * _Nullable applicationId; /**The unique identifier for the campaign.
*/ @property (nonatomic, strong) NSString * _Nullable campaignId; /**The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.
*/ @property (nonatomic, strong) NSString * _Nullable pageSize; /**The NextToken string that specifies which page of results to return in a paginated response.
*/ @property (nonatomic, strong) NSString * _Nullable token; @end /** */ @interface AWSPinpointTargetingGetCampaignActivitiesResponse : AWSModel /**Provides information about the activities that were performed by a campaign.
*/ @property (nonatomic, strong) AWSPinpointTargetingActivitiesResponse * _Nullable activitiesResponse; @end /** */ @interface AWSPinpointTargetingGetCampaignDateRangeKpiRequest : AWSRequest /**The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/ @property (nonatomic, strong) NSString * _Nullable applicationId; /**The unique identifier for the campaign.
*/ @property (nonatomic, strong) NSString * _Nullable campaignId; /**The last date and time to retrieve data for, as part of an inclusive date range that filters the query results. This value should be in extended ISO 8601 format and use Coordinated Universal Time (UTC), for example: 2019-07-26T20:00:00Z for 8:00 PM UTC July 26, 2019.
*/ @property (nonatomic, strong) NSDate * _Nullable endTime; /**The name of the metric, also referred to as a key performance indicator (KPI), to retrieve data for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. Examples are email-open-rate and successful-delivery-rate. For a list of valid values, see the Amazon Pinpoint Developer Guide.
*/ @property (nonatomic, strong) NSString * _Nullable kpiName; /**Thestring that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics.
*/ @property (nonatomic, strong) NSString * _Nullable nextToken; /**The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.
*/ @property (nonatomic, strong) NSString * _Nullable pageSize; /**The first date and time to retrieve data for, as part of an inclusive date range that filters the query results. This value should be in extended ISO 8601 format and use Coordinated Universal Time (UTC), for example: 2019-07-19T20:00:00Z for 8:00 PM UTC July 19, 2019. This value should also be fewer than 90 days from the current day.
*/ @property (nonatomic, strong) NSDate * _Nullable startTime; @end /** */ @interface AWSPinpointTargetingGetCampaignDateRangeKpiResponse : AWSModel /**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.
*/ @property (nonatomic, strong) AWSPinpointTargetingCampaignDateRangeKpiResponse * _Nullable campaignDateRangeKpiResponse; @end /** */ @interface AWSPinpointTargetingGetCampaignRequest : AWSRequest /**The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/ @property (nonatomic, strong) NSString * _Nullable applicationId; /**The unique identifier for the campaign.
*/ @property (nonatomic, strong) NSString * _Nullable campaignId; @end /** */ @interface AWSPinpointTargetingGetCampaignResponse : AWSModel /**Provides information about the status, configuration, and other settings for a campaign.
*/ @property (nonatomic, strong) AWSPinpointTargetingCampaignResponse * _Nullable campaignResponse; @end /** */ @interface AWSPinpointTargetingGetCampaignVersionRequest : AWSRequest /**The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/ @property (nonatomic, strong) NSString * _Nullable applicationId; /**The unique identifier for the campaign.
*/ @property (nonatomic, strong) NSString * _Nullable campaignId; /**The unique version number (Version property) for the campaign version.
*/ @property (nonatomic, strong) NSString * _Nullable version; @end /** */ @interface AWSPinpointTargetingGetCampaignVersionResponse : AWSModel /**Provides information about the status, configuration, and other settings for a campaign.
*/ @property (nonatomic, strong) AWSPinpointTargetingCampaignResponse * _Nullable campaignResponse; @end /** */ @interface AWSPinpointTargetingGetCampaignVersionsRequest : AWSRequest /**The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/ @property (nonatomic, strong) NSString * _Nullable applicationId; /**The unique identifier for the campaign.
*/ @property (nonatomic, strong) NSString * _Nullable campaignId; /**The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.
*/ @property (nonatomic, strong) NSString * _Nullable pageSize; /**The NextToken string that specifies which page of results to return in a paginated response.
*/ @property (nonatomic, strong) NSString * _Nullable token; @end /** */ @interface AWSPinpointTargetingGetCampaignVersionsResponse : AWSModel /**Provides information about the configuration and other settings for all the campaigns that are associated with an application.
*/ @property (nonatomic, strong) AWSPinpointTargetingCampaignsResponse * _Nullable campaignsResponse; @end /** */ @interface AWSPinpointTargetingGetCampaignsRequest : AWSRequest /**The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/ @property (nonatomic, strong) NSString * _Nullable applicationId; /**The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.
*/ @property (nonatomic, strong) NSString * _Nullable pageSize; /**The NextToken string that specifies which page of results to return in a paginated response.
*/ @property (nonatomic, strong) NSString * _Nullable token; @end /** */ @interface AWSPinpointTargetingGetCampaignsResponse : AWSModel /**Provides information about the configuration and other settings for all the campaigns that are associated with an application.
*/ @property (nonatomic, strong) AWSPinpointTargetingCampaignsResponse * _Nullable campaignsResponse; @end /** */ @interface AWSPinpointTargetingGetChannelsRequest : AWSRequest /**The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/ @property (nonatomic, strong) NSString * _Nullable applicationId; @end /** */ @interface AWSPinpointTargetingGetChannelsResponse : AWSModel /**Provides information about the general settings and status of all channels for an application, including channels that aren't enabled for the application.
*/ @property (nonatomic, strong) AWSPinpointTargetingChannelsResponse * _Nullable channelsResponse; @end /** */ @interface AWSPinpointTargetingGetEmailChannelRequest : AWSRequest /**The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/ @property (nonatomic, strong) NSString * _Nullable applicationId; @end /** */ @interface AWSPinpointTargetingGetEmailChannelResponse : AWSModel /**Provides information about the status and settings of the email channel for an application.
*/ @property (nonatomic, strong) AWSPinpointTargetingEmailChannelResponse * _Nullable emailChannelResponse; @end /** */ @interface AWSPinpointTargetingGetEmailTemplateRequest : AWSRequest /**The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
*/ @property (nonatomic, strong) NSString * _Nullable templateName; /**The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the
If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.
If you don't specify a value for this parameter, Amazon Pinpoint does the following:
For a get operation, retrieves information about the active version of the template.
For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.
For a delete operation, deletes the template, including all versions of the template.
Provides information about the content and settings for a message template that can be used in messages that are sent through the email channel.
*/ @property (nonatomic, strong) AWSPinpointTargetingEmailTemplateResponse * _Nullable emailTemplateResponse; @end /** */ @interface AWSPinpointTargetingGetEndpointRequest : AWSRequest /**The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/ @property (nonatomic, strong) NSString * _Nullable applicationId; /**The unique identifier for the endpoint.
*/ @property (nonatomic, strong) NSString * _Nullable endpointId; @end /** */ @interface AWSPinpointTargetingGetEndpointResponse : AWSModel /**Provides information about the channel type and other settings for an endpoint.
*/ @property (nonatomic, strong) AWSPinpointTargetingEndpointResponse * _Nullable endpointResponse; @end /** */ @interface AWSPinpointTargetingGetEventStreamRequest : AWSRequest /**The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/ @property (nonatomic, strong) NSString * _Nullable applicationId; @end /** */ @interface AWSPinpointTargetingGetEventStreamResponse : AWSModel /**Specifies settings for publishing event data to an Amazon Kinesis data stream or an Amazon Kinesis Data Firehose delivery stream.
*/ @property (nonatomic, strong) AWSPinpointTargetingEventStream * _Nullable eventStream; @end /** */ @interface AWSPinpointTargetingGetExportJobRequest : AWSRequest /**The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/ @property (nonatomic, strong) NSString * _Nullable applicationId; /**The unique identifier for the job.
*/ @property (nonatomic, strong) NSString * _Nullable jobId; @end /** */ @interface AWSPinpointTargetingGetExportJobResponse : AWSModel /**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.
*/ @property (nonatomic, strong) AWSPinpointTargetingExportJobResponse * _Nullable exportJobResponse; @end /** */ @interface AWSPinpointTargetingGetExportJobsRequest : AWSRequest /**The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/ @property (nonatomic, strong) NSString * _Nullable applicationId; /**The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.
*/ @property (nonatomic, strong) NSString * _Nullable pageSize; /**The NextToken string that specifies which page of results to return in a paginated response.
*/ @property (nonatomic, strong) NSString * _Nullable token; @end /** */ @interface AWSPinpointTargetingGetExportJobsResponse : AWSModel /**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.
*/ @property (nonatomic, strong) AWSPinpointTargetingExportJobsResponse * _Nullable exportJobsResponse; @end /** */ @interface AWSPinpointTargetingGetGcmChannelRequest : AWSRequest /**The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/ @property (nonatomic, strong) NSString * _Nullable applicationId; @end /** */ @interface AWSPinpointTargetingGetGcmChannelResponse : AWSModel /**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.
*/ @property (nonatomic, strong) AWSPinpointTargetingGCMChannelResponse * _Nullable GCMChannelResponse; @end /** */ @interface AWSPinpointTargetingGetImportJobRequest : AWSRequest /**The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/ @property (nonatomic, strong) NSString * _Nullable applicationId; /**The unique identifier for the job.
*/ @property (nonatomic, strong) NSString * _Nullable jobId; @end /** */ @interface AWSPinpointTargetingGetImportJobResponse : AWSModel /**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.
*/ @property (nonatomic, strong) AWSPinpointTargetingImportJobResponse * _Nullable importJobResponse; @end /** */ @interface AWSPinpointTargetingGetImportJobsRequest : AWSRequest /**The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/ @property (nonatomic, strong) NSString * _Nullable applicationId; /**The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.
*/ @property (nonatomic, strong) NSString * _Nullable pageSize; /**The NextToken string that specifies which page of results to return in a paginated response.
*/ @property (nonatomic, strong) NSString * _Nullable token; @end /** */ @interface AWSPinpointTargetingGetImportJobsResponse : AWSModel /**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.
*/ @property (nonatomic, strong) AWSPinpointTargetingImportJobsResponse * _Nullable importJobsResponse; @end /** */ @interface AWSPinpointTargetingGetInAppMessagesRequest : AWSRequest /**The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/ @property (nonatomic, strong) NSString * _Nullable applicationId; /**The unique identifier for the endpoint.
*/ @property (nonatomic, strong) NSString * _Nullable endpointId; @end /** */ @interface AWSPinpointTargetingGetInAppMessagesResponse : AWSModel /**Get in-app messages response object.
*/ @property (nonatomic, strong) AWSPinpointTargetingInAppMessagesResponse * _Nullable inAppMessagesResponse; @end /** */ @interface AWSPinpointTargetingGetInAppTemplateRequest : AWSRequest /**The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
*/ @property (nonatomic, strong) NSString * _Nullable templateName; /**The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the
If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.
If you don't specify a value for this parameter, Amazon Pinpoint does the following:
For a get operation, retrieves information about the active version of the template.
For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.
For a delete operation, deletes the template, including all versions of the template.
In-App Template Response.
*/ @property (nonatomic, strong) AWSPinpointTargetingInAppTemplateResponse * _Nullable inAppTemplateResponse; @end /** */ @interface AWSPinpointTargetingGetJourneyDateRangeKpiRequest : AWSRequest /**The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/ @property (nonatomic, strong) NSString * _Nullable applicationId; /**The last date and time to retrieve data for, as part of an inclusive date range that filters the query results. This value should be in extended ISO 8601 format and use Coordinated Universal Time (UTC), for example: 2019-07-26T20:00:00Z for 8:00 PM UTC July 26, 2019.
*/ @property (nonatomic, strong) NSDate * _Nullable endTime; /**The unique identifier for the journey.
*/ @property (nonatomic, strong) NSString * _Nullable journeyId; /**The name of the metric, also referred to as a key performance indicator (KPI), to retrieve data for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. Examples are email-open-rate and successful-delivery-rate. For a list of valid values, see the Amazon Pinpoint Developer Guide.
*/ @property (nonatomic, strong) NSString * _Nullable kpiName; /**Thestring that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics.
*/ @property (nonatomic, strong) NSString * _Nullable nextToken; /**The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.
*/ @property (nonatomic, strong) NSString * _Nullable pageSize; /**The first date and time to retrieve data for, as part of an inclusive date range that filters the query results. This value should be in extended ISO 8601 format and use Coordinated Universal Time (UTC), for example: 2019-07-19T20:00:00Z for 8:00 PM UTC July 19, 2019. This value should also be fewer than 90 days from the current day.
*/ @property (nonatomic, strong) NSDate * _Nullable startTime; @end /** */ @interface AWSPinpointTargetingGetJourneyDateRangeKpiResponse : AWSModel /**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.
*/ @property (nonatomic, strong) AWSPinpointTargetingJourneyDateRangeKpiResponse * _Nullable journeyDateRangeKpiResponse; @end /** */ @interface AWSPinpointTargetingGetJourneyExecutionActivityMetricsRequest : AWSRequest /**The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/ @property (nonatomic, strong) NSString * _Nullable applicationId; /**The unique identifier for the journey activity.
*/ @property (nonatomic, strong) NSString * _Nullable journeyActivityId; /**The unique identifier for the journey.
*/ @property (nonatomic, strong) NSString * _Nullable journeyId; /**The string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics.
The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.
*/ @property (nonatomic, strong) NSString * _Nullable pageSize; @end /** */ @interface AWSPinpointTargetingGetJourneyExecutionActivityMetricsResponse : AWSModel /**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.
*/ @property (nonatomic, strong) AWSPinpointTargetingJourneyExecutionActivityMetricsResponse * _Nullable journeyExecutionActivityMetricsResponse; @end /** */ @interface AWSPinpointTargetingGetJourneyExecutionMetricsRequest : AWSRequest /**The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/ @property (nonatomic, strong) NSString * _Nullable applicationId; /**The unique identifier for the journey.
*/ @property (nonatomic, strong) NSString * _Nullable journeyId; /**The string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics.
The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.
*/ @property (nonatomic, strong) NSString * _Nullable pageSize; @end /** */ @interface AWSPinpointTargetingGetJourneyExecutionMetricsResponse : AWSModel /**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.
*/ @property (nonatomic, strong) AWSPinpointTargetingJourneyExecutionMetricsResponse * _Nullable journeyExecutionMetricsResponse; @end /** */ @interface AWSPinpointTargetingGetJourneyRequest : AWSRequest /**The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/ @property (nonatomic, strong) NSString * _Nullable applicationId; /**The unique identifier for the journey.
*/ @property (nonatomic, strong) NSString * _Nullable journeyId; @end /** */ @interface AWSPinpointTargetingGetJourneyResponse : AWSModel /**Provides information about the status, configuration, and other settings for a journey.
*/ @property (nonatomic, strong) AWSPinpointTargetingJourneyResponse * _Nullable journeyResponse; @end /** */ @interface AWSPinpointTargetingGetJourneyRunExecutionActivityMetricsRequest : AWSRequest /**The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/ @property (nonatomic, strong) NSString * _Nullable applicationId; /**The unique identifier for the journey activity.
*/ @property (nonatomic, strong) NSString * _Nullable journeyActivityId; /**The unique identifier for the journey.
*/ @property (nonatomic, strong) NSString * _Nullable journeyId; /**The string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics.
The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.
*/ @property (nonatomic, strong) NSString * _Nullable pageSize; /**The unique identifier for the journey run.
*/ @property (nonatomic, strong) NSString * _Nullable runId; @end /** */ @interface AWSPinpointTargetingGetJourneyRunExecutionActivityMetricsResponse : AWSModel /**Provides the results of a query that retrieved the data for a standard execution metric that applies to a journey activity for a particular journey run, and provides information about that query.
*/ @property (nonatomic, strong) AWSPinpointTargetingJourneyRunExecutionActivityMetricsResponse * _Nullable journeyRunExecutionActivityMetricsResponse; @end /** */ @interface AWSPinpointTargetingGetJourneyRunExecutionMetricsRequest : AWSRequest /**The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/ @property (nonatomic, strong) NSString * _Nullable applicationId; /**The unique identifier for the journey.
*/ @property (nonatomic, strong) NSString * _Nullable journeyId; /**The string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics.
The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.
*/ @property (nonatomic, strong) NSString * _Nullable pageSize; /**The unique identifier for the journey run.
*/ @property (nonatomic, strong) NSString * _Nullable runId; @end /** */ @interface AWSPinpointTargetingGetJourneyRunExecutionMetricsResponse : AWSModel /**Provides the results of a query that retrieved the data for a standard execution metric that applies to a journey run, and provides information about that query.
*/ @property (nonatomic, strong) AWSPinpointTargetingJourneyRunExecutionMetricsResponse * _Nullable journeyRunExecutionMetricsResponse; @end /** */ @interface AWSPinpointTargetingGetJourneyRunsRequest : AWSRequest /**The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/ @property (nonatomic, strong) NSString * _Nullable applicationId; /**The unique identifier for the journey.
*/ @property (nonatomic, strong) NSString * _Nullable journeyId; /**The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.
*/ @property (nonatomic, strong) NSString * _Nullable pageSize; /**The NextToken string that specifies which page of results to return in a paginated response.
*/ @property (nonatomic, strong) NSString * _Nullable token; @end /** */ @interface AWSPinpointTargetingGetJourneyRunsResponse : AWSModel /**Provides information from all runs of a journey.
*/ @property (nonatomic, strong) AWSPinpointTargetingJourneyRunsResponse * _Nullable journeyRunsResponse; @end /** */ @interface AWSPinpointTargetingGetPushTemplateRequest : AWSRequest /**The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
*/ @property (nonatomic, strong) NSString * _Nullable templateName; /**The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the
If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.
If you don't specify a value for this parameter, Amazon Pinpoint does the following:
For a get operation, retrieves information about the active version of the template.
For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.
For a delete operation, deletes the template, including all versions of the template.
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.
*/ @property (nonatomic, strong) AWSPinpointTargetingPushNotificationTemplateResponse * _Nullable pushNotificationTemplateResponse; @end /** */ @interface AWSPinpointTargetingGetRecommenderConfigurationRequest : AWSRequest /**The unique identifier for the recommender model configuration. This identifier is displayed as the Recommender ID on the Amazon Pinpoint console.
*/ @property (nonatomic, strong) NSString * _Nullable recommenderId; @end /** */ @interface AWSPinpointTargetingGetRecommenderConfigurationResponse : AWSModel /**Provides information about Amazon Pinpoint configuration settings for retrieving and processing data from a recommender model.
*/ @property (nonatomic, strong) AWSPinpointTargetingRecommenderConfigurationResponse * _Nullable recommenderConfigurationResponse; @end /** */ @interface AWSPinpointTargetingGetRecommenderConfigurationsRequest : AWSRequest /**The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.
*/ @property (nonatomic, strong) NSString * _Nullable pageSize; /**The NextToken string that specifies which page of results to return in a paginated response.
*/ @property (nonatomic, strong) NSString * _Nullable token; @end /** */ @interface AWSPinpointTargetingGetRecommenderConfigurationsResponse : AWSModel /**Provides information about all the recommender model configurations that are associated with your Amazon Pinpoint account.
*/ @property (nonatomic, strong) AWSPinpointTargetingListRecommenderConfigurationsResponse * _Nullable listRecommenderConfigurationsResponse; @end /** */ @interface AWSPinpointTargetingGetSegmentExportJobsRequest : AWSRequest /**The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/ @property (nonatomic, strong) NSString * _Nullable applicationId; /**The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.
*/ @property (nonatomic, strong) NSString * _Nullable pageSize; /**The unique identifier for the segment.
*/ @property (nonatomic, strong) NSString * _Nullable segmentId; /**The NextToken string that specifies which page of results to return in a paginated response.
*/ @property (nonatomic, strong) NSString * _Nullable token; @end /** */ @interface AWSPinpointTargetingGetSegmentExportJobsResponse : AWSModel /**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.
*/ @property (nonatomic, strong) AWSPinpointTargetingExportJobsResponse * _Nullable exportJobsResponse; @end /** */ @interface AWSPinpointTargetingGetSegmentImportJobsRequest : AWSRequest /**The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/ @property (nonatomic, strong) NSString * _Nullable applicationId; /**The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.
*/ @property (nonatomic, strong) NSString * _Nullable pageSize; /**The unique identifier for the segment.
*/ @property (nonatomic, strong) NSString * _Nullable segmentId; /**The NextToken string that specifies which page of results to return in a paginated response.
*/ @property (nonatomic, strong) NSString * _Nullable token; @end /** */ @interface AWSPinpointTargetingGetSegmentImportJobsResponse : AWSModel /**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.
*/ @property (nonatomic, strong) AWSPinpointTargetingImportJobsResponse * _Nullable importJobsResponse; @end /** */ @interface AWSPinpointTargetingGetSegmentRequest : AWSRequest /**The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/ @property (nonatomic, strong) NSString * _Nullable applicationId; /**The unique identifier for the segment.
*/ @property (nonatomic, strong) NSString * _Nullable segmentId; @end /** */ @interface AWSPinpointTargetingGetSegmentResponse : AWSModel /**Provides information about the configuration, dimension, and other settings for a segment.
*/ @property (nonatomic, strong) AWSPinpointTargetingSegmentResponse * _Nullable segmentResponse; @end /** */ @interface AWSPinpointTargetingGetSegmentVersionRequest : AWSRequest /**The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/ @property (nonatomic, strong) NSString * _Nullable applicationId; /**The unique identifier for the segment.
*/ @property (nonatomic, strong) NSString * _Nullable segmentId; /**The unique version number (Version property) for the campaign version.
*/ @property (nonatomic, strong) NSString * _Nullable version; @end /** */ @interface AWSPinpointTargetingGetSegmentVersionResponse : AWSModel /**Provides information about the configuration, dimension, and other settings for a segment.
*/ @property (nonatomic, strong) AWSPinpointTargetingSegmentResponse * _Nullable segmentResponse; @end /** */ @interface AWSPinpointTargetingGetSegmentVersionsRequest : AWSRequest /**The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/ @property (nonatomic, strong) NSString * _Nullable applicationId; /**The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.
*/ @property (nonatomic, strong) NSString * _Nullable pageSize; /**The unique identifier for the segment.
*/ @property (nonatomic, strong) NSString * _Nullable segmentId; /**The NextToken string that specifies which page of results to return in a paginated response.
*/ @property (nonatomic, strong) NSString * _Nullable token; @end /** */ @interface AWSPinpointTargetingGetSegmentVersionsResponse : AWSModel /**Provides information about all the segments that are associated with an application.
*/ @property (nonatomic, strong) AWSPinpointTargetingSegmentsResponse * _Nullable segmentsResponse; @end /** */ @interface AWSPinpointTargetingGetSegmentsRequest : AWSRequest /**The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/ @property (nonatomic, strong) NSString * _Nullable applicationId; /**The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.
*/ @property (nonatomic, strong) NSString * _Nullable pageSize; /**The NextToken string that specifies which page of results to return in a paginated response.
*/ @property (nonatomic, strong) NSString * _Nullable token; @end /** */ @interface AWSPinpointTargetingGetSegmentsResponse : AWSModel /**Provides information about all the segments that are associated with an application.
*/ @property (nonatomic, strong) AWSPinpointTargetingSegmentsResponse * _Nullable segmentsResponse; @end /** */ @interface AWSPinpointTargetingGetSmsChannelRequest : AWSRequest /**The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/ @property (nonatomic, strong) NSString * _Nullable applicationId; @end /** */ @interface AWSPinpointTargetingGetSmsChannelResponse : AWSModel /**Provides information about the status and settings of the SMS channel for an application.
*/ @property (nonatomic, strong) AWSPinpointTargetingSMSChannelResponse * _Nullable SMSChannelResponse; @end /** */ @interface AWSPinpointTargetingGetSmsTemplateRequest : AWSRequest /**The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
*/ @property (nonatomic, strong) NSString * _Nullable templateName; /**The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the
If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.
If you don't specify a value for this parameter, Amazon Pinpoint does the following:
For a get operation, retrieves information about the active version of the template.
For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.
For a delete operation, deletes the template, including all versions of the template.
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.
*/ @property (nonatomic, strong) AWSPinpointTargetingSMSTemplateResponse * _Nullable SMSTemplateResponse; @end /** */ @interface AWSPinpointTargetingGetUserEndpointsRequest : AWSRequest /**The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/ @property (nonatomic, strong) NSString * _Nullable applicationId; /**The unique identifier for the user.
*/ @property (nonatomic, strong) NSString * _Nullable userId; @end /** */ @interface AWSPinpointTargetingGetUserEndpointsResponse : AWSModel /**Provides information about all the endpoints that are associated with a user ID.
*/ @property (nonatomic, strong) AWSPinpointTargetingEndpointsResponse * _Nullable endpointsResponse; @end /** */ @interface AWSPinpointTargetingGetVoiceChannelRequest : AWSRequest /**The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/ @property (nonatomic, strong) NSString * _Nullable applicationId; @end /** */ @interface AWSPinpointTargetingGetVoiceChannelResponse : AWSModel /**Provides information about the status and settings of the voice channel for an application.
*/ @property (nonatomic, strong) AWSPinpointTargetingVoiceChannelResponse * _Nullable voiceChannelResponse; @end /** */ @interface AWSPinpointTargetingGetVoiceTemplateRequest : AWSRequest /**The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
*/ @property (nonatomic, strong) NSString * _Nullable templateName; /**The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the
If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.
If you don't specify a value for this parameter, Amazon Pinpoint does the following:
For a get operation, retrieves information about the active version of the template.
For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.
For a delete operation, deletes the template, including all versions of the template.
Provides information about the content and settings for a message template that can be used in messages that are sent through the voice channel.
*/ @property (nonatomic, strong) AWSPinpointTargetingVoiceTemplateResponse * _Nullable voiceTemplateResponse; @end /**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] */ @interface AWSPinpointTargetingHoldoutActivity : AWSModel /**The unique identifier for the next activity to perform, after performing the holdout activity.
*/ @property (nonatomic, strong) NSString * _Nullable nextActivity; /**The percentage of participants who shouldn't continue the journey.
To determine which participants are held out, Amazon Pinpoint applies a probability-based algorithm to the percentage that you specify. Therefore, the actual percentage of participants who are held out may not be equal to the percentage that you specify.
*/ @property (nonatomic, strong) NSNumber * _Nullable percentage; @end /**Specifies the settings for a job that imports endpoint definitions from an Amazon Simple Storage Service (Amazon S3) bucket.
Required parameters: [Format, S3Url, RoleArn] */ @interface AWSPinpointTargetingImportJobRequest : AWSModel /**Specifies whether to create a segment that contains the endpoints, when the endpoint definitions are imported.
*/ @property (nonatomic, strong) NSNumber * _Nullable defineSegment; /**(Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy. Amazon Pinpoint previously used this value to assume an IAM role when importing endpoint definitions, but we removed this requirement. We don't recommend use of external IDs for IAM roles that are assumed by Amazon Pinpoint.
*/ @property (nonatomic, strong) NSString * _Nullable externalId; /**The format of the files that contain the endpoint definitions to import. Valid values are: CSV, for comma-separated values format; and, JSON, for newline-delimited JSON format. If the Amazon S3 location stores multiple files that use different formats, Amazon Pinpoint imports data only from the files that use the specified format.
*/ @property (nonatomic, assign) AWSPinpointTargetingFormat format; /**Specifies whether to register the endpoints with Amazon Pinpoint, when the endpoint definitions are imported.
*/ @property (nonatomic, strong) NSNumber * _Nullable registerEndpoints; /**The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to access the Amazon S3 location to import endpoint definitions from.
*/ @property (nonatomic, strong) NSString * _Nullable roleArn; /**The URL of the Amazon Simple Storage Service (Amazon S3) bucket that contains the endpoint definitions to import. This location can be a folder or a single file. If the location is a folder, Amazon Pinpoint imports endpoint definitions from the files in this location, including any subfolders that the folder contains.
The URL should be in the following format: s3://
The identifier for the segment to update or add the imported endpoint definitions to, if the import job is meant to update an existing segment.
*/ @property (nonatomic, strong) NSString * _Nullable segmentId; /**A custom name for the segment that's created by the import job, if the value of the DefineSegment property is true.
*/ @property (nonatomic, strong) NSString * _Nullable segmentName; @end /**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] */ @interface AWSPinpointTargetingImportJobResource : AWSModel /**Specifies whether the import job creates a segment that contains the endpoints, when the endpoint definitions are imported.
*/ @property (nonatomic, strong) NSNumber * _Nullable defineSegment; /**(Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy. Amazon Pinpoint previously used this value to assume an IAM role when importing endpoint definitions, but we removed this requirement. We don't recommend use of external IDs for IAM roles that are assumed by Amazon Pinpoint.
*/ @property (nonatomic, strong) NSString * _Nullable externalId; /**The format of the files that contain the endpoint definitions to import. Valid values are: CSV, for comma-separated values format; and, JSON, for newline-delimited JSON format.
If the files are stored in an Amazon S3 location and that location contains multiple files that use different formats, Amazon Pinpoint imports data only from the files that use the specified format.
*/ @property (nonatomic, assign) AWSPinpointTargetingFormat format; /**Specifies whether the import job registers the endpoints with Amazon Pinpoint, when the endpoint definitions are imported.
*/ @property (nonatomic, strong) NSNumber * _Nullable registerEndpoints; /**The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to access the Amazon S3 location to import endpoint definitions from.
*/ @property (nonatomic, strong) NSString * _Nullable roleArn; /**The URL of the Amazon Simple Storage Service (Amazon S3) bucket that contains the endpoint definitions to import. This location can be a folder or a single file. If the location is a folder, Amazon Pinpoint imports endpoint definitions from the files in this location, including any subfolders that the folder contains.
The URL should be in the following format: s3://
The identifier for the segment that the import job updates or adds endpoint definitions to, if the import job updates an existing segment.
*/ @property (nonatomic, strong) NSString * _Nullable segmentId; /**The custom name for the segment that's created by the import job, if the value of the DefineSegment property is true.
*/ @property (nonatomic, strong) NSString * _Nullable segmentName; @end /**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] */ @interface AWSPinpointTargetingImportJobResponse : AWSModel /**The unique identifier for the application that's associated with the import job.
*/ @property (nonatomic, strong) NSString * _Nullable applicationId; /**The number of pieces that were processed successfully (completed) by the import job, as of the time of the request.
*/ @property (nonatomic, strong) NSNumber * _Nullable completedPieces; /**The date, in ISO 8601 format, when the import job was completed.
*/ @property (nonatomic, strong) NSString * _Nullable completionDate; /**The date, in ISO 8601 format, when the import job was created.
*/ @property (nonatomic, strong) NSString * _Nullable creationDate; /**The resource settings that apply to the import job.
*/ @property (nonatomic, strong) AWSPinpointTargetingImportJobResource * _Nullable definition; /**The number of pieces that weren't processed successfully (failed) by the import job, as of the time of the request.
*/ @property (nonatomic, strong) NSNumber * _Nullable failedPieces; /**An array of entries, one for each of the first 100 entries that weren't processed successfully (failed) by the import job, if any.
*/ @property (nonatomic, strong) NSArrayThe unique identifier for the import job.
*/ @property (nonatomic, strong) NSString * _Nullable identifier; /**The status of the import job. The job status is FAILED if Amazon Pinpoint wasn't able to process one or more pieces in the job.
*/ @property (nonatomic, assign) AWSPinpointTargetingJobStatus jobStatus; /**The total number of endpoint definitions that weren't processed successfully (failed) by the import job, typically because an error, such as a syntax error, occurred.
*/ @property (nonatomic, strong) NSNumber * _Nullable totalFailures; /**The total number of pieces that must be processed to complete the import job. Each piece consists of an approximately equal portion of the endpoint definitions that are part of the import job.
*/ @property (nonatomic, strong) NSNumber * _Nullable totalPieces; /**The total number of endpoint definitions that were processed by the import job.
*/ @property (nonatomic, strong) NSNumber * _Nullable totalProcessed; /**The job type. This value is IMPORT for import jobs.
*/ @property (nonatomic, strong) NSString * _Nullable types; @end /**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] */ @interface AWSPinpointTargetingImportJobsResponse : AWSModel /**An array of responses, one for each import job that's associated with the application (Import Jobs resource) or segment (Segment Import Jobs resource).
*/ @property (nonatomic, strong) NSArrayThe string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.
*/ @property (nonatomic, strong) NSString * _Nullable nextToken; @end /**Schedule of the campaign.
*/ @interface AWSPinpointTargetingInAppCampaignSchedule : AWSModel /**The scheduled time after which the in-app message should not be shown. Timestamp is in ISO 8601 format.
*/ @property (nonatomic, strong) NSString * _Nullable endDate; /**The event filter the SDK has to use to show the in-app message in the application.
*/ @property (nonatomic, strong) AWSPinpointTargetingCampaignEventFilter * _Nullable eventFilter; /**Time during which the in-app message should not be shown to the user.
*/ @property (nonatomic, strong) AWSPinpointTargetingQuietTime * _Nullable quietTime; @end /**Provides all fields required for building an in-app message.
*/ @interface AWSPinpointTargetingInAppMessage : AWSModel /**In-app message content.
*/ @property (nonatomic, strong) NSArrayCustom config to be sent to SDK.
*/ @property (nonatomic, strong) NSDictionaryThe layout of the message.
*/ @property (nonatomic, assign) AWSPinpointTargetingLayout layout; @end /**Text config for Message Body.
Required parameters: [Alignment, TextColor, Body] */ @interface AWSPinpointTargetingInAppMessageBodyConfig : AWSModel /**The alignment of the text. Valid values: LEFT, CENTER, RIGHT.
*/ @property (nonatomic, assign) AWSPinpointTargetingAlignment alignment; /**Message Body.
*/ @property (nonatomic, strong) NSString * _Nullable body; /**The text color.
*/ @property (nonatomic, strong) NSString * _Nullable textColor; @end /**Button Config for an in-app message.
*/ @interface AWSPinpointTargetingInAppMessageButton : AWSModel /**Default button content.
*/ @property (nonatomic, strong) AWSPinpointTargetingOverrideButtonConfiguration * _Nullable android; /**Default button content.
*/ @property (nonatomic, strong) AWSPinpointTargetingDefaultButtonConfiguration * _Nullable defaultConfig; /**Default button content.
*/ @property (nonatomic, strong) AWSPinpointTargetingOverrideButtonConfiguration * _Nullable IOS; /**Default button content.
*/ @property (nonatomic, strong) AWSPinpointTargetingOverrideButtonConfiguration * _Nullable web; @end /**Targeted in-app message campaign.
*/ @interface AWSPinpointTargetingInAppMessageCampaign : AWSModel /**Campaign id of the corresponding campaign.
*/ @property (nonatomic, strong) NSString * _Nullable campaignId; /**Daily cap which controls the number of times any in-app messages can be shown to the endpoint during a day.
*/ @property (nonatomic, strong) NSNumber * _Nullable dailyCap; /**In-app message content with all fields required for rendering an in-app message.
*/ @property (nonatomic, strong) AWSPinpointTargetingInAppMessage * _Nullable inAppMessage; /**Priority of the in-app message.
*/ @property (nonatomic, strong) NSNumber * _Nullable priority; /**Schedule of the campaign.
*/ @property (nonatomic, strong) AWSPinpointTargetingInAppCampaignSchedule * _Nullable schedule; /**Session cap which controls the number of times an in-app message can be shown to the endpoint during an application session.
*/ @property (nonatomic, strong) NSNumber * _Nullable sessionCap; /**Total cap which controls the number of times an in-app message can be shown to the endpoint.
*/ @property (nonatomic, strong) NSNumber * _Nullable totalCap; /**Treatment id of the campaign.
*/ @property (nonatomic, strong) NSString * _Nullable treatmentId; @end /**The configuration for the message content.
*/ @interface AWSPinpointTargetingInAppMessageContent : AWSModel /**The background color for the message.
*/ @property (nonatomic, strong) NSString * _Nullable backgroundColor; /**The configuration for the message body.
*/ @property (nonatomic, strong) AWSPinpointTargetingInAppMessageBodyConfig * _Nullable bodyConfig; /**The configuration for the message header.
*/ @property (nonatomic, strong) AWSPinpointTargetingInAppMessageHeaderConfig * _Nullable headerConfig; /**The image url for the background of message.
*/ @property (nonatomic, strong) NSString * _Nullable imageUrl; /**The first button inside the message.
*/ @property (nonatomic, strong) AWSPinpointTargetingInAppMessageButton * _Nullable primaryBtn; /**The second button inside message.
*/ @property (nonatomic, strong) AWSPinpointTargetingInAppMessageButton * _Nullable secondaryBtn; @end /**Text config for Message Header.
Required parameters: [Alignment, Header, TextColor] */ @interface AWSPinpointTargetingInAppMessageHeaderConfig : AWSModel /**The alignment of the text. Valid values: LEFT, CENTER, RIGHT.
*/ @property (nonatomic, assign) AWSPinpointTargetingAlignment alignment; /**Message Header.
*/ @property (nonatomic, strong) NSString * _Nullable header; /**The text color.
*/ @property (nonatomic, strong) NSString * _Nullable textColor; @end /**Get in-app messages response object.
*/ @interface AWSPinpointTargetingInAppMessagesResponse : AWSModel /**List of targeted in-app message campaigns.
*/ @property (nonatomic, strong) NSArrayInApp Template Request.
*/ @interface AWSPinpointTargetingInAppTemplateRequest : AWSModel /**The content of the message, can include up to 5 modals. Each modal must contain a message, a header, and background color. ImageUrl and buttons are optional.
*/ @property (nonatomic, strong) NSArrayCustom config to be sent to client.
*/ @property (nonatomic, strong) NSDictionaryThe layout of the message.
*/ @property (nonatomic, assign) AWSPinpointTargetingLayout layout; /**The description of the template.
*/ @property (nonatomic, strong) NSString * _Nullable templateDescription; /**As of 22-05-2023 tags has been deprecated for update operations. After this date any value in tags is not processed and an error code is not returned. To manage tags we recommend using either Tags in the API Reference for Amazon Pinpoint, resourcegroupstaggingapi commands in the AWS Command Line Interface Documentation or resourcegroupstaggingapi in the AWS SDK.
(Deprecated) A string-to-string map of key-value pairs that defines the tags to associate with the message template. Each tag consists of a required tag key and an associated tag value.
*/ @property (nonatomic, strong) NSDictionaryIn-App Template Response.
Required parameters: [LastModifiedDate, CreationDate, TemplateName, TemplateType] */ @interface AWSPinpointTargetingInAppTemplateResponse : AWSModel /**The resource arn of the template.
*/ @property (nonatomic, strong) NSString * _Nullable arn; /**The content of the message, can include up to 5 modals. Each modal must contain a message, a header, and background color. ImageUrl and buttons are optional.
*/ @property (nonatomic, strong) NSArrayThe creation date of the template.
*/ @property (nonatomic, strong) NSString * _Nullable creationDate; /**Custom config to be sent to client.
*/ @property (nonatomic, strong) NSDictionaryThe last modified date of the template.
*/ @property (nonatomic, strong) NSString * _Nullable lastModifiedDate; /**The layout of the message.
*/ @property (nonatomic, assign) AWSPinpointTargetingLayout layout; /**The description of the template.
*/ @property (nonatomic, strong) NSString * _Nullable templateDescription; /**The name of the template.
*/ @property (nonatomic, strong) NSString * _Nullable templateName; /**The type of the template.
*/ @property (nonatomic, assign) AWSPinpointTargetingTemplateType templateType; /**The version id of the template.
*/ @property (nonatomic, strong) NSString * _Nullable version; /**A string-to-string map of key-value pairs that defines the tags to associate with the message template. Each tag consists of a required tag key and an associated tag value.
*/ @property (nonatomic, strong) NSDictionaryProvides information about the results of a request to create or update an endpoint that's associated with an event.
*/ @interface AWSPinpointTargetingItemResponse : AWSModel /**The response that was received after the endpoint data was accepted.
*/ @property (nonatomic, strong) AWSPinpointTargetingEndpointItemResponse * _Nullable endpointItemResponse; /**A multipart response object that contains a key and a value for each event in the request. In each object, the event ID is the key and an EventItemResponse object is the value.
*/ @property (nonatomic, strong) NSDictionarySpecifies the message content for a custom channel message that's sent to participants in a journey.
*/ @interface AWSPinpointTargetingJourneyCustomMessage : AWSModel /**The message content that's passed to an AWS Lambda function or to a web hook.
*/ @property (nonatomic, strong) NSString * _Nullable data; @end /**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] */ @interface AWSPinpointTargetingJourneyDateRangeKpiResponse : AWSModel /**The unique identifier for the application that the metric applies to.
*/ @property (nonatomic, strong) NSString * _Nullable applicationId; /**The last date and time of the date range that was used to filter the query results, in extended ISO 8601 format. The date range is inclusive.
*/ @property (nonatomic, strong) NSDate * _Nullable endTime; /**The unique identifier for the journey that the metric applies to.
*/ @property (nonatomic, strong) NSString * _Nullable journeyId; /**The name of the metric, also referred to as a key performance indicator (KPI), that the data was retrieved for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. For a list of possible values, see the Amazon Pinpoint Developer Guide.
*/ @property (nonatomic, strong) NSString * _Nullable kpiName; /**An array of objects that contains the results of the query. Each object contains the value for the metric and metadata about that value.
*/ @property (nonatomic, strong) AWSPinpointTargetingBaseKpiResult * _Nullable kpiResult; /**The string to use in a subsequent request to get the next page of results in a paginated response. This value is null for the Journey Engagement Metrics resource because the resource returns all results in a single page.
*/ @property (nonatomic, strong) NSString * _Nullable nextToken; /**The first date and time of the date range that was used to filter the query results, in extended ISO 8601 format. The date range is inclusive.
*/ @property (nonatomic, strong) NSDate * _Nullable startTime; @end /**Specifies the "From" address for an email message that's sent to participants in a journey.
*/ @interface AWSPinpointTargetingJourneyEmailMessage : AWSModel /**The verified email address to send the email message from. The default address is the FromAddress specified for the email channel for the application.
*/ @property (nonatomic, strong) NSString * _Nullable fromAddress; @end /**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] */ @interface AWSPinpointTargetingJourneyExecutionActivityMetricsResponse : AWSModel /**The type of activity that the metric applies to. Possible values are:
CONDITIONAL_SPLIT – For a yes/no split activity, which is an activity that sends participants down one of two paths in a journey.
HOLDOUT – For a holdout activity, which is an activity that stops a journey for a specified percentage of participants.
MESSAGE – For an email activity, which is an activity that sends an email message to participants.
MULTI_CONDITIONAL_SPLIT – For a multivariate split activity, which is an activity that sends participants down one of as many as five paths in a journey.
RANDOM_SPLIT – For a random split activity, which is an activity that sends specified percentages of participants down one of as many as five paths in a journey.
WAIT – For a wait activity, which is an activity that waits for a certain amount of time or until a specific date and time before moving participants to the next activity in a journey.
The unique identifier for the application that the metric applies to.
*/ @property (nonatomic, strong) NSString * _Nullable applicationId; /**The unique identifier for the activity that the metric applies to.
*/ @property (nonatomic, strong) NSString * _Nullable journeyActivityId; /**The unique identifier for the journey that the metric applies to.
*/ @property (nonatomic, strong) NSString * _Nullable journeyId; /**The date and time, in ISO 8601 format, when Amazon Pinpoint last evaluated the execution status of the activity and updated the data for the metric.
*/ @property (nonatomic, strong) NSString * _Nullable lastEvaluatedTime; /**A JSON object that contains the results of the query. The results vary depending on the type of activity (ActivityType). For information about the structure and contents of the results, see the Amazon Pinpoint Developer Guide.
*/ @property (nonatomic, strong) NSDictionaryProvides 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] */ @interface AWSPinpointTargetingJourneyExecutionMetricsResponse : AWSModel /**The unique identifier for the application that the metric applies to.
*/ @property (nonatomic, strong) NSString * _Nullable applicationId; /**The unique identifier for the journey that the metric applies to.
*/ @property (nonatomic, strong) NSString * _Nullable journeyId; /**The date and time, in ISO 8601 format, when Amazon Pinpoint last evaluated the journey and updated the data for the metric.
*/ @property (nonatomic, strong) NSString * _Nullable lastEvaluatedTime; /**A JSON object that contains the results of the query. For information about the structure and contents of the results, see the Amazon Pinpoint Developer Guide.
*/ @property (nonatomic, strong) NSDictionarySpecifies limits on the messages that a journey can send and the number of times participants can enter a journey.
*/ @interface AWSPinpointTargetingJourneyLimits : AWSModel /**The maximum number of messages that the journey can send to a single participant during a 24-hour period. The maximum value is 100.
*/ @property (nonatomic, strong) NSNumber * _Nullable dailyCap; /**The maximum number of times that a participant can enter the journey. The maximum value is 100. To allow participants to enter the journey an unlimited number of times, set this value to 0.
*/ @property (nonatomic, strong) NSNumber * _Nullable endpointReentryCap; /**Minimum time that must pass before an endpoint can re-enter a given journey. The duration should use an ISO 8601 format, such as PT1H.
*/ @property (nonatomic, strong) NSString * _Nullable endpointReentryInterval; /**The maximum number of messages that the journey can send each second.
*/ @property (nonatomic, strong) NSNumber * _Nullable messagesPerSecond; @end /**Specifies the message configuration for a push notification that's sent to participants in a journey.
*/ @interface AWSPinpointTargetingJourneyPushMessage : AWSModel /**The number of seconds that the push notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
*/ @property (nonatomic, strong) NSString * _Nullable timeToLive; @end /**The channel-specific configurations for the journey.
*/ @interface AWSPinpointTargetingJourneyChannelSettings : AWSModel /**Amazon Resource Name (ARN) of the Connect Campaign.
*/ @property (nonatomic, strong) NSString * _Nullable connectCampaignArn; /**IAM role ARN to be assumed when invoking Connect campaign execution APIs for dialing.
*/ @property (nonatomic, strong) NSString * _Nullable connectCampaignExecutionRoleArn; @end /**Provides information about the status, configuration, and other settings for a journey.
Required parameters: [Name, Id, ApplicationId] */ @interface AWSPinpointTargetingJourneyResponse : AWSModel /**A map that contains a set of Activity objects, one object for each activity in the journey. For each Activity object, the key is the unique identifier (string) for an activity and the value is the settings for the activity.
*/ @property (nonatomic, strong) NSDictionaryThe unique identifier for the application that the journey applies to.
*/ @property (nonatomic, strong) NSString * _Nullable applicationId; /**The time when a journey will not send messages. QuietTime should be configured first and SendingSchedule should be set to true.
*/ @property (nonatomic, strong) AWSPinpointTargetingClosedDays * _Nullable closedDays; /**The date, in ISO 8601 format, when the journey was created.
*/ @property (nonatomic, strong) NSString * _Nullable creationDate; /**The unique identifier for the journey.
*/ @property (nonatomic, strong) NSString * _Nullable identifier; /**The channel-specific configurations for the journey.
*/ @property (nonatomic, strong) AWSPinpointTargetingJourneyChannelSettings * _Nullable journeyChannelSettings; /**The date, in ISO 8601 format, when the journey was last modified.
*/ @property (nonatomic, strong) NSString * _Nullable lastModifiedDate; /**The messaging and entry limits for the journey.
*/ @property (nonatomic, strong) AWSPinpointTargetingJourneyLimits * _Nullable limits; /**Specifies whether the journey's scheduled start and end times use each participant's local time. If this value is true, the schedule uses each participant's local time.
*/ @property (nonatomic, strong) NSNumber * _Nullable localTime; /**The name of the journey.
*/ @property (nonatomic, strong) NSString * _Nullable name; /**The time when a journey can send messages. QuietTime should be configured first and SendingSchedule should be set to true.
*/ @property (nonatomic, strong) AWSPinpointTargetingOpenHours * _Nullable openHours; /**The quiet time settings for the journey. Quiet time is a specific time range when a journey doesn't send messages to participants, if all the following conditions are met:
The EndpointDemographic.Timezone property of the endpoint for the participant is set to a valid value.
The current time in the participant's time zone is later than or equal to the time specified by the QuietTime.Start property for the journey.
The current time in the participant's time zone is earlier than or equal to the time specified by the QuietTime.End property for the journey.
If any of the preceding conditions isn't met, the participant will receive messages from the journey, even if quiet time is enabled.
*/ @property (nonatomic, strong) AWSPinpointTargetingQuietTime * _Nullable quietTime; /**The frequency with which Amazon Pinpoint evaluates segment and event data for the journey, as a duration in ISO 8601 format.
*/ @property (nonatomic, strong) NSString * _Nullable refreshFrequency; /**Indicates whether the journey participants should be refreshed when a segment is updated.
*/ @property (nonatomic, strong) NSNumber * _Nullable refreshOnSegmentUpdate; /**The schedule settings for the journey.
*/ @property (nonatomic, strong) AWSPinpointTargetingJourneySchedule * _Nullable schedule; /**Indicates if journey has Advance Quiet Time enabled. This flag should be set to true in order to allow using OpenHours and ClosedDays.
*/ @property (nonatomic, strong) NSNumber * _Nullable sendingSchedule; /**The unique identifier for the first activity in the journey.
*/ @property (nonatomic, strong) NSString * _Nullable startActivity; /**The segment that defines which users are participants in the journey.
*/ @property (nonatomic, strong) AWSPinpointTargetingStartCondition * _Nullable startCondition; /**The current status of the journey. Possible values are:
DRAFT - The journey is being developed and hasn't been published yet.
ACTIVE - The journey has been developed and published. Depending on the journey's schedule, the journey may currently be running or scheduled to start running at a later time. If a journey's status is ACTIVE, you can't add, change, or remove activities from it.
COMPLETED - The journey has been published and has finished running. All participants have entered the journey and no participants are waiting to complete the journey or any activities in the journey.
CANCELLED - The journey has been stopped. If a journey's status is CANCELLED, you can't add, change, or remove activities or segment settings from the journey.
CLOSED - The journey has been published and has started running. It may have also passed its scheduled end time, or passed its scheduled start time and a refresh frequency hasn't been specified for it. If a journey's status is CLOSED, you can't add participants to it, and no existing participants can enter the journey for the first time. However, any existing participants who are currently waiting to start an activity may continue the journey.
An array of time zone estimation methods, if any, to use for determining an Endpoints time zone if the Endpoint does not have a value for the Demographic.Timezone attribute.
PHONE_NUMBER - A time zone is determined based on the Endpoint.Address and Endpoint.Location.Country.
POSTAL_CODE - A time zone is determined based on the Endpoint.Location.PostalCode and Endpoint.Location.Country.
POSTAL_CODE detection is only supported in the United States, United Kingdom, Australia, New Zealand, Canada, France, Italy, Spain, Germany and in regions where Amazon Pinpoint is available.
Indicates whether endpoints in quiet hours should enter a wait activity until quiet hours have elapsed.
*/ @property (nonatomic, strong) NSNumber * _Nullable waitForQuietTime; /**This object is not used or supported.
*/ @property (nonatomic, strong) NSDictionaryProvides the results of a query that retrieved the data for a standard execution metric that applies to a journey activity for a particular journey run, and provides information about that query.
Required parameters: [Metrics, JourneyId, LastEvaluatedTime, JourneyActivityId, ActivityType, RunId, ApplicationId] */ @interface AWSPinpointTargetingJourneyRunExecutionActivityMetricsResponse : AWSModel /**The type of activity that the metric applies to. Possible values are:
CONDITIONAL_SPLIT – For a yes/no split activity, which is an activity that sends participants down one of two paths in a journey.
HOLDOUT – For a holdout activity, which is an activity that stops a journey for a specified percentage of participants.
MESSAGE – For an email activity, which is an activity that sends an email message to participants.
MULTI_CONDITIONAL_SPLIT – For a multivariate split activity, which is an activity that sends participants down one of as many as five paths in a journey.
RANDOM_SPLIT – For a random split activity, which is an activity that sends specified percentages of participants down one of as many as five paths in a journey.
WAIT – For a wait activity, which is an activity that waits for a certain amount of time or until a specific date and time before moving participants to the next activity in a journey.
The unique identifier for the application that the metric applies to.
*/ @property (nonatomic, strong) NSString * _Nullable applicationId; /**The unique identifier for the activity that the metric applies to.
*/ @property (nonatomic, strong) NSString * _Nullable journeyActivityId; /**The unique identifier for the journey that the metric applies to.
*/ @property (nonatomic, strong) NSString * _Nullable journeyId; /**The date and time, in ISO 8601 format, when Amazon Pinpoint last evaluated the execution status of the activity for this journey run and updated the data for the metric.
*/ @property (nonatomic, strong) NSString * _Nullable lastEvaluatedTime; /**A JSON object that contains the results of the query. For information about the structure and contents of the results, see see Standard Amazon Pinpoint analytics metrics in the Amazon Pinpoint Developer Guide.
*/ @property (nonatomic, strong) NSDictionaryThe unique identifier for the journey run that the metric applies to.
*/ @property (nonatomic, strong) NSString * _Nullable runId; @end /**Provides the results of a query that retrieved the data for a standard execution metric that applies to a journey run, and provides information about that query.
Required parameters: [Metrics, JourneyId, LastEvaluatedTime, RunId, ApplicationId] */ @interface AWSPinpointTargetingJourneyRunExecutionMetricsResponse : AWSModel /**The unique identifier for the application that the metric applies to.
*/ @property (nonatomic, strong) NSString * _Nullable applicationId; /**The unique identifier for the journey that the metric applies to.
*/ @property (nonatomic, strong) NSString * _Nullable journeyId; /**The date and time, in ISO 8601 format, when Amazon Pinpoint last evaluated the journey run and updated the data for the metric.
*/ @property (nonatomic, strong) NSString * _Nullable lastEvaluatedTime; /**A JSON object that contains the results of the query. For information about the structure and contents of the results, see the Standard Amazon Pinpoint analytics metrics in the Amazon Pinpoint Developer Guide.
*/ @property (nonatomic, strong) NSDictionaryThe unique identifier for the journey run that the metric applies to.
*/ @property (nonatomic, strong) NSString * _Nullable runId; @end /**Provides information from a specified run of a journey.
Required parameters: [Status, LastUpdateTime, CreationTime, RunId] */ @interface AWSPinpointTargetingJourneyRunResponse : AWSModel /**The time when the journey run was created or scheduled, in ISO 8601 format.
*/ @property (nonatomic, strong) NSString * _Nullable creationTime; /**The last time the journey run was updated, in ISO 8601 format..
*/ @property (nonatomic, strong) NSString * _Nullable lastUpdateTime; /**The unique identifier for the run.
*/ @property (nonatomic, strong) NSString * _Nullable runId; /**The current status of the journey run.
*/ @property (nonatomic, assign) AWSPinpointTargetingJourneyRunStatus status; @end /**Provides information from all runs of a journey.
Required parameters: [Item] */ @interface AWSPinpointTargetingJourneyRunsResponse : AWSModel /**An array of responses, one for each run of the journey
*/ @property (nonatomic, strong) NSArrayThe string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.
*/ @property (nonatomic, strong) NSString * _Nullable nextToken; @end /**Specifies the sender ID and message type for an SMS message that's sent to participants in a journey.
*/ @interface AWSPinpointTargetingJourneySMSMessage : AWSModel /**The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.
*/ @property (nonatomic, strong) NSString * _Nullable entityId; /**The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages).
*/ @property (nonatomic, assign) AWSPinpointTargetingMessageType messageType; /**The long code to send the SMS message from. This value should be one of the dedicated long codes that's assigned to your AWS account. Although it isn't required, we recommend that you specify the long code using an E.164 format to ensure prompt and accurate delivery of the message. For example, +12065550100.
*/ @property (nonatomic, strong) NSString * _Nullable originationNumber; /**The sender ID to display as the sender of the message on a recipient's device. Support for sender IDs varies by country or region. For more information, see Supported Countries and Regions in the Amazon Pinpoint User Guide.
*/ @property (nonatomic, strong) NSString * _Nullable senderId; /**The template ID received from the regulatory body for sending SMS in your country.
*/ @property (nonatomic, strong) NSString * _Nullable templateId; @end /**Specifies the schedule settings for a journey.
*/ @interface AWSPinpointTargetingJourneySchedule : AWSModel /**The scheduled time, in ISO 8601 format, when the journey ended or will end.
*/ @property (nonatomic, strong) NSDate * _Nullable endTime; /**The scheduled time, in ISO 8601 format, when the journey began or will begin.
*/ @property (nonatomic, strong) NSDate * _Nullable startTime; /**The starting UTC offset for the journey schedule, if the value of the journey's LocalTime property is true. Valid values are: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, UTC+05:30, UTC+05:45, UTC+06, UTC+06:30, UTC+07, UTC+08, UTC+08:45, UTC+09, UTC+09:30, UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+12:45, UTC+13, UTC+13:45, UTC-02, UTC-02:30, UTC-03, UTC-03:30, UTC-04, UTC-05, UTC-06, UTC-07, UTC-08, UTC-09, UTC-09:30, UTC-10, and UTC-11.
*/ @property (nonatomic, strong) NSString * _Nullable timezone; @end /**Changes the status of a journey.
*/ @interface AWSPinpointTargetingJourneyStateRequest : AWSModel /**The status of the journey. Currently, Supported values are ACTIVE, PAUSED, and CANCELLED
If you cancel a journey, Amazon Pinpoint continues to perform activities that are currently in progress, until those activities are complete. Amazon Pinpoint also continues to collect and aggregate analytics data for those activities, until they are complete, and any activities that were complete when you cancelled the journey.
After you cancel a journey, you can't add, change, or remove any activities from the journey. In addition, Amazon Pinpoint stops evaluating the journey and doesn't perform any activities that haven't started.
When the journey is paused, Amazon Pinpoint continues to perform activities that are currently in progress, until those activities are complete. Endpoints will stop entering journeys when the journey is paused and will resume entering the journey after the journey is resumed. For wait activities, wait time is paused when the journey is paused. Currently, PAUSED only supports journeys with a segment refresh interval.
*/ @property (nonatomic, assign) AWSPinpointTargetingState state; @end /**Provides information about the status, configuration, and other settings for all the journeys that are associated with an application.
Required parameters: [Item] */ @interface AWSPinpointTargetingJourneysResponse : AWSModel /**An array of responses, one for each journey that's associated with the application.
*/ @property (nonatomic, strong) NSArrayThe string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.
*/ @property (nonatomic, strong) NSString * _Nullable nextToken; @end /** */ @interface AWSPinpointTargetingListJourneysRequest : AWSRequest /**The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/ @property (nonatomic, strong) NSString * _Nullable applicationId; /**The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.
*/ @property (nonatomic, strong) NSString * _Nullable pageSize; /**The NextToken string that specifies which page of results to return in a paginated response.
*/ @property (nonatomic, strong) NSString * _Nullable token; @end /** */ @interface AWSPinpointTargetingListJourneysResponse : AWSModel /**Provides information about the status, configuration, and other settings for all the journeys that are associated with an application.
*/ @property (nonatomic, strong) AWSPinpointTargetingJourneysResponse * _Nullable journeysResponse; @end /**Provides information about all the recommender model configurations that are associated with your Amazon Pinpoint account.
Required parameters: [Item] */ @interface AWSPinpointTargetingListRecommenderConfigurationsResponse : AWSModel /**An array of responses, one for each recommender model configuration that's associated with your Amazon Pinpoint account.
*/ @property (nonatomic, strong) NSArrayThe string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.
*/ @property (nonatomic, strong) NSString * _Nullable nextToken; @end /** */ @interface AWSPinpointTargetingListTagsForResourceRequest : AWSRequest /**The Amazon Resource Name (ARN) of the resource.
*/ @property (nonatomic, strong) NSString * _Nullable resourceArn; @end /** */ @interface AWSPinpointTargetingListTagsForResourceResponse : AWSModel /**Specifies the tags (keys and values) for an application, campaign, message template, or segment.
*/ @property (nonatomic, strong) AWSPinpointTargetingTagsModel * _Nullable tagsModel; @end /** */ @interface AWSPinpointTargetingListTemplateVersionsRequest : AWSRequest /**Thestring that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics.
*/ @property (nonatomic, strong) NSString * _Nullable nextToken; /**The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.
*/ @property (nonatomic, strong) NSString * _Nullable pageSize; /**The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
*/ @property (nonatomic, strong) NSString * _Nullable templateName; /**The type of channel that the message template is designed for. Valid values are: EMAIL, PUSH, SMS, and VOICE.
*/ @property (nonatomic, strong) NSString * _Nullable templateType; @end /** */ @interface AWSPinpointTargetingListTemplateVersionsResponse : AWSModel /**Provides information about all the versions of a specific message template.
*/ @property (nonatomic, strong) AWSPinpointTargetingTemplateVersionsResponse * _Nullable templateVersionsResponse; @end /** */ @interface AWSPinpointTargetingListTemplatesRequest : AWSRequest /**Thestring that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics.
*/ @property (nonatomic, strong) NSString * _Nullable nextToken; /**The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.
*/ @property (nonatomic, strong) NSString * _Nullable pageSize; /**The substring to match in the names of the message templates to include in the results. If you specify this value, Amazon Pinpoint returns only those templates whose names begin with the value that you specify.
*/ @property (nonatomic, strong) NSString * _Nullable prefix; /**The type of message template to include in the results. Valid values are: EMAIL, PUSH, SMS, and VOICE. To include all types of templates in the results, don't include this parameter in your request.
*/ @property (nonatomic, strong) NSString * _Nullable templateType; @end /** */ @interface AWSPinpointTargetingListTemplatesResponse : AWSModel /**Provides information about all the message templates that are associated with your Amazon Pinpoint account.
*/ @property (nonatomic, strong) AWSPinpointTargetingTemplatesResponse * _Nullable templatesResponse; @end /**Specifies the content and settings for a push notification that's sent to recipients of a campaign.
*/ @interface AWSPinpointTargetingMessage : AWSModel /**The action to occur if a recipient taps the push notification. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
The body of the notification message. The maximum number of characters is 200.
*/ @property (nonatomic, strong) NSString * _Nullable body; /**The URL of the image to display as the push-notification icon, such as the icon for the app.
*/ @property (nonatomic, strong) NSString * _Nullable imageIconUrl; /**The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
*/ @property (nonatomic, strong) NSString * _Nullable imageSmallIconUrl; /**The URL of an image to display in the push notification.
*/ @property (nonatomic, strong) NSString * _Nullable imageUrl; /**The JSON payload to use for a silent push notification.
*/ @property (nonatomic, strong) NSString * _Nullable jsonBody; /**The URL of the image or video to display in the push notification.
*/ @property (nonatomic, strong) NSString * _Nullable mediaUrl; /**The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.
*/ @property (nonatomic, strong) NSString * _Nullable rawContent; /**Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
*/ @property (nonatomic, strong) NSNumber * _Nullable silentPush; /**The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
*/ @property (nonatomic, strong) NSNumber * _Nullable timeToLive; /**The title to display above the notification message on a recipient's device.
*/ @property (nonatomic, strong) NSString * _Nullable title; /**The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
*/ @property (nonatomic, strong) NSString * _Nullable url; @end /**Provides information about an API request or response.
*/ @interface AWSPinpointTargetingMessageBody : AWSModel /**The message that's returned from the API.
*/ @property (nonatomic, strong) NSString * _Nullable message; /**The unique identifier for the request or response.
*/ @property (nonatomic, strong) NSString * _Nullable requestID; @end /**Specifies the message configuration settings for a campaign.
*/ @interface AWSPinpointTargetingMessageConfiguration : AWSModel /**The message that the campaign sends through the ADM (Amazon Device Messaging) channel. If specified, this message overrides the default message.
*/ @property (nonatomic, strong) AWSPinpointTargetingMessage * _Nullable ADMMessage; /**The message that the campaign sends through the APNs (Apple Push Notification service) channel. If specified, this message overrides the default message.
*/ @property (nonatomic, strong) AWSPinpointTargetingMessage * _Nullable APNSMessage; /**The message that the campaign sends through the Baidu (Baidu Cloud Push) channel. If specified, this message overrides the default message.
*/ @property (nonatomic, strong) AWSPinpointTargetingMessage * _Nullable baiduMessage; /**The message that the campaign sends through a custom channel, as specified by the delivery configuration (CustomDeliveryConfiguration) settings for the campaign. If specified, this message overrides the default message.
*/ @property (nonatomic, strong) AWSPinpointTargetingCampaignCustomMessage * _Nullable customMessage; /**The default message that the campaign sends through all the channels that are configured for the campaign.
*/ @property (nonatomic, strong) AWSPinpointTargetingMessage * _Nullable defaultMessage; /**The message that the campaign sends through the email channel. If specified, this message overrides the default message.
*/ @property (nonatomic, strong) AWSPinpointTargetingCampaignEmailMessage * _Nullable emailMessage; /**The message that the campaign sends through the GCM channel, which enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. If specified, this message overrides the default message.
*/ @property (nonatomic, strong) AWSPinpointTargetingMessage * _Nullable GCMMessage; /**The in-app message configuration.
*/ @property (nonatomic, strong) AWSPinpointTargetingCampaignInAppMessage * _Nullable inAppMessage; /**The message that the campaign sends through the SMS channel. If specified, this message overrides the default message.
*/ @property (nonatomic, strong) AWSPinpointTargetingCampaignSmsMessage * _Nullable SMSMessage; @end /**Specifies the configuration and other settings for a message.
Required parameters: [MessageConfiguration] */ @interface AWSPinpointTargetingMessageRequest : AWSModel /**A map of key-value pairs, where each key is an address and each value is an AddressConfiguration object. An address can be a push notification token, a phone number, or an email address. You can use an AddressConfiguration object to tailor the message for an address by specifying settings such as content overrides and message variables.
*/ @property (nonatomic, strong) NSDictionaryA map of custom attributes to attach to the message. For a push notification, this payload is added to the data.pinpoint object. For an email or text message, this payload is added to email/SMS delivery receipt event attributes.
*/ @property (nonatomic, strong) NSDictionaryA map of key-value pairs, where each key is an endpoint ID and each value is an EndpointSendConfiguration object. You can use an EndpointSendConfiguration object to tailor the message for an endpoint by specifying settings such as content overrides and message variables.
*/ @property (nonatomic, strong) NSDictionaryThe settings and content for the default message and any default messages that you defined for specific channels.
*/ @property (nonatomic, strong) AWSPinpointTargetingDirectMessageConfiguration * _Nullable messageConfiguration; /**The message template to use for the message.
*/ @property (nonatomic, strong) AWSPinpointTargetingTemplateConfiguration * _Nullable templateConfiguration; /**The unique identifier for tracing the message. This identifier is visible to message recipients.
*/ @property (nonatomic, strong) NSString * _Nullable traceId; @end /**Provides information about the results of a request to send a message to an endpoint address.
Required parameters: [ApplicationId] */ @interface AWSPinpointTargetingMessageResponse : AWSModel /**The unique identifier for the application that was used to send the message.
*/ @property (nonatomic, strong) NSString * _Nullable applicationId; /**A map that contains a multipart response for each address that the message was sent to. In the map, the endpoint ID is the key and the result is the value.
*/ @property (nonatomic, strong) NSDictionaryThe identifier for the original request that the message was delivered for.
*/ @property (nonatomic, strong) NSString * _Nullable requestId; /**A map that contains a multipart response for each address (email address, phone number, or push notification token) that the message was sent to. In the map, the address is the key and the result is the value.
*/ @property (nonatomic, strong) NSDictionaryProvides information about the results of sending a message directly to an endpoint address.
Required parameters: [DeliveryStatus, StatusCode] */ @interface AWSPinpointTargetingMessageResult : AWSModel /**The delivery status of the message. Possible values are:
DUPLICATE - The endpoint address is a duplicate of another endpoint address. Amazon Pinpoint won't attempt to send the message again.
OPT_OUT - The user who's associated with the endpoint address has opted out of receiving messages from you. Amazon Pinpoint won't attempt to send the message again.
PERMANENT_FAILURE - An error occurred when delivering the message to the endpoint address. Amazon Pinpoint won't attempt to send the message again.
SUCCESSFUL - The message was successfully delivered to the endpoint address.
TEMPORARY_FAILURE - A temporary error occurred. Amazon Pinpoint won't attempt to send the message again.
THROTTLED - Amazon Pinpoint throttled the operation to send the message to the endpoint address.
TIMEOUT - The message couldn't be sent within the timeout period.
UNKNOWN_FAILURE - An unknown error occurred.
The unique identifier for the message that was sent.
*/ @property (nonatomic, strong) NSString * _Nullable messageId; /**The downstream service status code for delivering the message.
*/ @property (nonatomic, strong) NSNumber * _Nullable statusCode; /**The status message for delivering the message.
*/ @property (nonatomic, strong) NSString * _Nullable statusMessage; /**For push notifications that are sent through the GCM channel, specifies whether the endpoint's device registration token was updated as part of delivering the message.
*/ @property (nonatomic, strong) NSString * _Nullable updatedToken; @end /**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] */ @interface AWSPinpointTargetingMetricDimension : AWSModel /**The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.
*/ @property (nonatomic, strong) NSString * _Nullable comparisonOperator; /**The value to compare.
*/ @property (nonatomic, strong) NSNumber * _Nullable value; @end /**Specifies a condition to evaluate for an activity path in a journey.
*/ @interface AWSPinpointTargetingMultiConditionalBranch : AWSModel /**The condition to evaluate for the activity path.
*/ @property (nonatomic, strong) AWSPinpointTargetingSimpleCondition * _Nullable condition; /**The unique identifier for the next activity to perform, after completing the activity for the path.
*/ @property (nonatomic, strong) NSString * _Nullable nextActivity; @end /**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.
To create multivariate split activities that send participants down different paths based on push notification events (such as Open or Received events), your mobile app has to specify the User ID and Endpoint ID values. For more information, see Integrating Amazon Pinpoint with your application in the Amazon Pinpoint Developer Guide.
The paths for the activity, including the conditions for entering each path and the activity to perform for each path.
*/ @property (nonatomic, strong) NSArrayThe unique identifier for the activity to perform for participants who don't meet any of the conditions specified for other paths in the activity.
*/ @property (nonatomic, strong) NSString * _Nullable defaultActivity; /**The amount of time to wait or the date and time when Amazon Pinpoint determines whether the conditions are met.
*/ @property (nonatomic, strong) AWSPinpointTargetingWaitTime * _Nullable evaluationWaitTime; @end /**Specifies a phone number to validate and retrieve information about.
*/ @interface AWSPinpointTargetingNumberValidateRequest : AWSModel /**The two-character code, in ISO 3166-1 alpha-2 format, for the country or region where the phone number was originally registered.
*/ @property (nonatomic, strong) NSString * _Nullable isoCountryCode; /**The phone number to retrieve information about. The phone number that you provide should include a valid numeric country code. Otherwise, the operation might result in an error.
*/ @property (nonatomic, strong) NSString * _Nullable phoneNumber; @end /**Provides information about a phone number.
*/ @interface AWSPinpointTargetingNumberValidateResponse : AWSModel /**The carrier or service provider that the phone number is currently registered with. In some countries and regions, this value may be the carrier or service provider that the phone number was originally registered with.
*/ @property (nonatomic, strong) NSString * _Nullable carrier; /**The name of the city where the phone number was originally registered.
*/ @property (nonatomic, strong) NSString * _Nullable city; /**The cleansed phone number, in E.164 format, for the location where the phone number was originally registered.
*/ @property (nonatomic, strong) NSString * _Nullable cleansedPhoneNumberE164; /**The cleansed phone number, in the format for the location where the phone number was originally registered.
*/ @property (nonatomic, strong) NSString * _Nullable cleansedPhoneNumberNational; /**The name of the country or region where the phone number was originally registered.
*/ @property (nonatomic, strong) NSString * _Nullable country; /**The two-character code, in ISO 3166-1 alpha-2 format, for the country or region where the phone number was originally registered.
*/ @property (nonatomic, strong) NSString * _Nullable countryCodeIso2; /**The numeric code for the country or region where the phone number was originally registered.
*/ @property (nonatomic, strong) NSString * _Nullable countryCodeNumeric; /**The name of the county where the phone number was originally registered.
*/ @property (nonatomic, strong) NSString * _Nullable county; /**The two-character code, in ISO 3166-1 alpha-2 format, that was sent in the request body.
*/ @property (nonatomic, strong) NSString * _Nullable originalCountryCodeIso2; /**The phone number that was sent in the request body.
*/ @property (nonatomic, strong) NSString * _Nullable originalPhoneNumber; /**The description of the phone type. Valid values are: MOBILE, LANDLINE, VOIP, INVALID, PREPAID, and OTHER.
*/ @property (nonatomic, strong) NSString * _Nullable phoneType; /**The phone type, represented by an integer. Valid values are: 0 (mobile), 1 (landline), 2 (VoIP), 3 (invalid), 4 (other), and 5 (prepaid).
*/ @property (nonatomic, strong) NSNumber * _Nullable phoneTypeCode; /**The time zone for the location where the phone number was originally registered.
*/ @property (nonatomic, strong) NSString * _Nullable timezone; /**The postal or ZIP code for the location where the phone number was originally registered.
*/ @property (nonatomic, strong) NSString * _Nullable zipCode; @end /**Override button configuration.
Required parameters: [ButtonAction] */ @interface AWSPinpointTargetingOverrideButtonConfiguration : AWSModel /**Action triggered by the button.
*/ @property (nonatomic, assign) AWSPinpointTargetingButtonAction buttonAction; /**Button destination.
*/ @property (nonatomic, strong) NSString * _Nullable link; @end /** */ @interface AWSPinpointTargetingPhoneNumberValidateRequest : AWSRequest /**Specifies a phone number to validate and retrieve information about.
*/ @property (nonatomic, strong) AWSPinpointTargetingNumberValidateRequest * _Nullable numberValidateRequest; @end /** */ @interface AWSPinpointTargetingPhoneNumberValidateResponse : AWSModel /**Provides information about a phone number.
*/ @property (nonatomic, strong) AWSPinpointTargetingNumberValidateResponse * _Nullable numberValidateResponse; @end /**Specifies the properties and attributes of an endpoint that's associated with an event.
*/ @interface AWSPinpointTargetingPublicEndpoint : AWSModel /**The unique identifier for the recipient, such as a device token, email address, or mobile phone number.
*/ @property (nonatomic, strong) NSString * _Nullable address; /**One or more custom attributes that describe the endpoint by associating a name with an array of values. You can use these attributes as filter criteria when you create segments.
*/ @property (nonatomic, strong) NSDictionaryThe channel that's used when sending messages or push notifications to the endpoint.
*/ @property (nonatomic, assign) AWSPinpointTargetingChannelType channelType; /**The demographic information for the endpoint, such as the time zone and platform.
*/ @property (nonatomic, strong) AWSPinpointTargetingEndpointDemographic * _Nullable demographic; /**The date and time, in ISO 8601 format, when the endpoint was last updated.
*/ @property (nonatomic, strong) NSString * _Nullable effectiveDate; /**Specifies whether to send messages or push notifications to the endpoint. Valid values are: ACTIVE, messages are sent to the endpoint; and, INACTIVE, messages aren’t sent to the endpoint.
Amazon Pinpoint automatically sets this value to ACTIVE when you create an endpoint or update an existing endpoint. Amazon Pinpoint automatically sets this value to INACTIVE if you update another endpoint that has the same address specified by the Address property.
*/ @property (nonatomic, strong) NSString * _Nullable endpointStatus; /**The geographic information for the endpoint.
*/ @property (nonatomic, strong) AWSPinpointTargetingEndpointLocation * _Nullable location; /**One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint.
*/ @property (nonatomic, strong) NSDictionarySpecifies whether the user who's associated with the endpoint has opted out of receiving messages and push notifications from you. Possible values are: ALL, the user has opted out and doesn't want to receive any messages or push notifications; and, NONE, the user hasn't opted out and wants to receive all messages and push notifications.
*/ @property (nonatomic, strong) NSString * _Nullable optOut; /**A unique identifier that's generated each time the endpoint is updated.
*/ @property (nonatomic, strong) NSString * _Nullable requestId; /**One or more custom user attributes that your app reports to Amazon Pinpoint for the user who's associated with the endpoint.
*/ @property (nonatomic, strong) AWSPinpointTargetingEndpointUser * _Nullable user; @end /**Specifies the settings for a push notification activity in a journey. This type of activity sends a push notification to participants.
*/ @interface AWSPinpointTargetingPushMessageActivity : AWSModel /**Specifies the time to live (TTL) value for push notifications that are sent to participants in a journey.
*/ @property (nonatomic, strong) AWSPinpointTargetingJourneyPushMessage * _Nullable messageConfig; /**The unique identifier for the next activity to perform, after the message is sent.
*/ @property (nonatomic, strong) NSString * _Nullable nextActivity; /**The name of the push notification template to use for the message. If specified, this value must match the name of an existing message template.
*/ @property (nonatomic, strong) NSString * _Nullable templateName; /**The unique identifier for the version of the push notification template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
*/ @property (nonatomic, strong) NSString * _Nullable templateVersion; @end /**Specifies the content and settings for a message template that can be used in messages that are sent through a push notification channel.
*/ @interface AWSPinpointTargetingPushNotificationTemplateRequest : AWSModel /**The message template to use for the ADM (Amazon Device Messaging) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).
*/ @property (nonatomic, strong) AWSPinpointTargetingAndroidPushNotificationTemplate * _Nullable ADM; /**The message template to use for the APNs (Apple Push Notification service) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).
*/ @property (nonatomic, strong) AWSPinpointTargetingAPNSPushNotificationTemplate * _Nullable APNS; /**The message template to use for the Baidu (Baidu Cloud Push) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).
*/ @property (nonatomic, strong) AWSPinpointTargetingAndroidPushNotificationTemplate * _Nullable baidu; /**The default message template to use for push notification channels.
*/ @property (nonatomic, strong) AWSPinpointTargetingDefaultPushNotificationTemplate * _Nullable defaultValue; /**A JSON object that specifies the default values to use for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable. When you create a message that's based on the template, you can override these defaults with message-specific and address-specific variables and values.
*/ @property (nonatomic, strong) NSString * _Nullable defaultSubstitutions; /**The message template to use for the GCM channel, which is used to send notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).
*/ @property (nonatomic, strong) AWSPinpointTargetingAndroidPushNotificationTemplate * _Nullable GCM; /**The unique identifier for the recommender model to use for the message template. Amazon Pinpoint uses this value to determine how to retrieve and process data from a recommender model when it sends messages that use the template, if the template contains message variables for recommendation data.
*/ @property (nonatomic, strong) NSString * _Nullable recommenderId; /**A custom description of the message template.
*/ @property (nonatomic, strong) NSString * _Nullable templateDescription; /**As of 22-05-2023 tags has been deprecated for update operations. After this date any value in tags is not processed and an error code is not returned. To manage tags we recommend using either Tags in the API Reference for Amazon Pinpoint, resourcegroupstaggingapi commands in the AWS Command Line Interface Documentation or resourcegroupstaggingapi in the AWS SDK.
(Deprecated) A string-to-string map of key-value pairs that defines the tags to associate with the message template. Each tag consists of a required tag key and an associated tag value.
*/ @property (nonatomic, strong) NSDictionaryProvides 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] */ @interface AWSPinpointTargetingPushNotificationTemplateResponse : AWSModel /**The message template that's used for the ADM (Amazon Device Messaging) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).
*/ @property (nonatomic, strong) AWSPinpointTargetingAndroidPushNotificationTemplate * _Nullable ADM; /**The message template that's used for the APNs (Apple Push Notification service) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).
*/ @property (nonatomic, strong) AWSPinpointTargetingAPNSPushNotificationTemplate * _Nullable APNS; /**The Amazon Resource Name (ARN) of the message template.
*/ @property (nonatomic, strong) NSString * _Nullable arn; /**The message template that's used for the Baidu (Baidu Cloud Push) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).
*/ @property (nonatomic, strong) AWSPinpointTargetingAndroidPushNotificationTemplate * _Nullable baidu; /**The date, in ISO 8601 format, when the message template was created.
*/ @property (nonatomic, strong) NSString * _Nullable creationDate; /**The default message template that's used for push notification channels.
*/ @property (nonatomic, strong) AWSPinpointTargetingDefaultPushNotificationTemplate * _Nullable defaultValue; /**The JSON object that specifies the default values that are used for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable.
*/ @property (nonatomic, strong) NSString * _Nullable defaultSubstitutions; /**The message template that's used for the GCM channel, which is used to send notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).
*/ @property (nonatomic, strong) AWSPinpointTargetingAndroidPushNotificationTemplate * _Nullable GCM; /**The date, in ISO 8601 format, when the message template was last modified.
*/ @property (nonatomic, strong) NSString * _Nullable lastModifiedDate; /**The unique identifier for the recommender model that's used by the message template.
*/ @property (nonatomic, strong) NSString * _Nullable recommenderId; /**The custom description of the message template.
*/ @property (nonatomic, strong) NSString * _Nullable templateDescription; /**The name of the message template.
*/ @property (nonatomic, strong) NSString * _Nullable templateName; /**The type of channel that the message template is designed for. For a push notification template, this value is PUSH.
*/ @property (nonatomic, assign) AWSPinpointTargetingTemplateType templateType; /**The unique identifier, as an integer, for the active version of the message template, or the version of the template that you specified by using the version parameter in your request.
*/ @property (nonatomic, strong) NSString * _Nullable version; /**A string-to-string map of key-value pairs that identifies the tags that are associated with the message template. Each tag consists of a required tag key and an associated tag value.
*/ @property (nonatomic, strong) NSDictionaryThe unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/ @property (nonatomic, strong) NSString * _Nullable applicationId; /**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.
*/ @property (nonatomic, strong) AWSPinpointTargetingWriteEventStream * _Nullable writeEventStream; @end /** */ @interface AWSPinpointTargetingPutEventStreamResponse : AWSModel /**Specifies settings for publishing event data to an Amazon Kinesis data stream or an Amazon Kinesis Data Firehose delivery stream.
*/ @property (nonatomic, strong) AWSPinpointTargetingEventStream * _Nullable eventStream; @end /** */ @interface AWSPinpointTargetingPutEventsRequest : AWSRequest /**The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/ @property (nonatomic, strong) NSString * _Nullable applicationId; /**Specifies a batch of events to process.
*/ @property (nonatomic, strong) AWSPinpointTargetingEventsRequest * _Nullable eventsRequest; @end /** */ @interface AWSPinpointTargetingPutEventsResponse : AWSModel /**Provides information about endpoints and the events that they're associated with.
*/ @property (nonatomic, strong) AWSPinpointTargetingEventsResponse * _Nullable eventsResponse; @end /**Specifies the start and end times that define a time range when messages aren't sent to endpoints.
*/ @interface AWSPinpointTargetingQuietTime : AWSModel /**The specific time when quiet time ends. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
*/ @property (nonatomic, strong) NSString * _Nullable end; /**The specific time when quiet time begins. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
*/ @property (nonatomic, strong) NSString * _Nullable start; @end /**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.
*/ @interface AWSPinpointTargetingRandomSplitActivity : AWSModel /**The paths for the activity, including the percentage of participants to enter each path and the activity to perform for each path.
*/ @property (nonatomic, strong) NSArraySpecifies the settings for a path in a random split activity in a journey.
*/ @interface AWSPinpointTargetingRandomSplitEntry : AWSModel /**The unique identifier for the next activity to perform, after completing the activity for the path.
*/ @property (nonatomic, strong) NSString * _Nullable nextActivity; /**The percentage of participants to send down the activity path.
To determine which participants are sent down each path, Amazon Pinpoint applies a probability-based algorithm to the percentages that you specify for the paths. Therefore, the actual percentage of participants who are sent down a path may not be equal to the percentage that you specify.
*/ @property (nonatomic, strong) NSNumber * _Nullable percentage; @end /**Specifies the contents of an email message, represented as a raw MIME message.
*/ @interface AWSPinpointTargetingRawEmail : AWSModel /**The email message, represented as a raw MIME message. The entire message must be base64 encoded.
*/ @property (nonatomic, strong) NSData * _Nullable data; @end /**Specifies criteria for including or excluding endpoints from a segment based on how recently an endpoint was active.
Required parameters: [Duration, RecencyType] */ @interface AWSPinpointTargetingRecencyDimension : AWSModel /**The duration to use when determining whether an endpoint is active or inactive.
*/ @property (nonatomic, assign) AWSPinpointTargetingDuration duration; /**The type of recency dimension to use for the segment. Valid values are: ACTIVE, endpoints that were active within the specified duration are included in the segment; and, INACTIVE, endpoints that weren't active within the specified duration are included in the segment.
*/ @property (nonatomic, assign) AWSPinpointTargetingRecencyType recencyType; @end /**Provides information about Amazon Pinpoint configuration settings for retrieving and processing data from a recommender model.
Required parameters: [RecommendationProviderUri, LastModifiedDate, CreationDate, RecommendationProviderRoleArn, Id] */ @interface AWSPinpointTargetingRecommenderConfigurationResponse : AWSModel /**A map that defines 1-10 custom endpoint or user attributes, depending on the value for the RecommendationProviderIdType property. Each of these attributes temporarily stores a recommended item that's retrieved from the recommender model and sent to an AWS Lambda function for additional processing. Each attribute can be used as a message variable in a message template.
This value is null if the configuration doesn't invoke an AWS Lambda function (RecommendationTransformerUri) to perform additional processing of recommendation data.
*/ @property (nonatomic, strong) NSDictionaryThe date, in extended ISO 8601 format, when the configuration was created for the recommender model.
*/ @property (nonatomic, strong) NSString * _Nullable creationDate; /**The custom description of the configuration for the recommender model.
*/ @property (nonatomic, strong) NSString * _Nullable detail; /**The unique identifier for the recommender model configuration.
*/ @property (nonatomic, strong) NSString * _Nullable identifier; /**The date, in extended ISO 8601 format, when the configuration for the recommender model was last modified.
*/ @property (nonatomic, strong) NSString * _Nullable lastModifiedDate; /**The custom name of the configuration for the recommender model.
*/ @property (nonatomic, strong) NSString * _Nullable name; /**The type of Amazon Pinpoint ID that's associated with unique user IDs in the recommender model. This value enables the model to use attribute and event data that’s specific to a particular endpoint or user in an Amazon Pinpoint application. Possible values are:
PINPOINT_ENDPOINT_ID - Each user in the model is associated with a particular endpoint in Amazon Pinpoint. The data is correlated based on endpoint IDs in Amazon Pinpoint. This is the default value.
PINPOINT_USER_ID - Each user in the model is associated with a particular user and endpoint in Amazon Pinpoint. The data is correlated based on user IDs in Amazon Pinpoint. If this value is specified, an endpoint definition in Amazon Pinpoint has to specify both a user ID (UserId) and an endpoint ID. Otherwise, messages won’t be sent to the user's endpoint.
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to retrieve recommendation data from the recommender model.
*/ @property (nonatomic, strong) NSString * _Nullable recommendationProviderRoleArn; /**The Amazon Resource Name (ARN) of the recommender model that Amazon Pinpoint retrieves the recommendation data from. This value is the ARN of an Amazon Personalize campaign.
*/ @property (nonatomic, strong) NSString * _Nullable recommendationProviderUri; /**The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon Pinpoint invokes to perform additional processing of recommendation data that it retrieves from the recommender model.
*/ @property (nonatomic, strong) NSString * _Nullable recommendationTransformerUri; /**The custom display name for the standard endpoint or user attribute (RecommendationItems) that temporarily stores recommended items for each endpoint or user, depending on the value for the RecommendationProviderIdType property. This name appears in the Attribute finder of the template editor on the Amazon Pinpoint console.
This value is null if the configuration doesn't invoke an AWS Lambda function (RecommendationTransformerUri) to perform additional processing of recommendation data.
*/ @property (nonatomic, strong) NSString * _Nullable recommendationsDisplayName; /**The number of recommended items that are retrieved from the model for each endpoint or user, depending on the value for the RecommendationProviderIdType property. This number determines how many recommended items are available for use in message variables.
*/ @property (nonatomic, strong) NSNumber * _Nullable recommendationsPerMessage; @end /** */ @interface AWSPinpointTargetingRemoveAttributesRequest : AWSRequest /**The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/ @property (nonatomic, strong) NSString * _Nullable applicationId; /**The type of attribute or attributes to remove. Valid values are:
endpoint-custom-attributes - Custom attributes that describe endpoints, such as the date when an associated user opted in or out of receiving communications from you through a specific type of channel.
endpoint-metric-attributes - Custom metrics that your app reports to Amazon Pinpoint for endpoints, such as the number of app sessions or the number of items left in a cart.
endpoint-user-attributes - Custom attributes that describe users, such as first name, last name, and age.
Specifies one or more attributes to remove from all the endpoints that are associated with an application.
*/ @property (nonatomic, strong) AWSPinpointTargetingUpdateAttributesRequest * _Nullable updateAttributesRequest; @end /** */ @interface AWSPinpointTargetingRemoveAttributesResponse : AWSModel /**Provides information about the type and the names of attributes that were removed from all the endpoints that are associated with an application.
*/ @property (nonatomic, strong) AWSPinpointTargetingAttributesResource * _Nullable attributesResource; @end /**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] */ @interface AWSPinpointTargetingResultRow : AWSModel /**An array of objects that defines the field and field values that were used to group data in a result set that contains multiple results. This value is null if the data in a result set isn’t grouped.
*/ @property (nonatomic, strong) NSArrayAn array of objects that provides pre-aggregated values for a standard metric that applies to an application, campaign, or journey.
*/ @property (nonatomic, strong) NSArrayProvides 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] */ @interface AWSPinpointTargetingResultRowValue : AWSModel /**The friendly name of the metric whose value is specified by the Value property.
*/ @property (nonatomic, strong) NSString * _Nullable key; /**The data type of the value specified by the Value property.
*/ @property (nonatomic, strong) NSString * _Nullable types; /**In a Values object, the value for the metric that the query retrieved data for. In a GroupedBys object, the value for the field that was used to group data in a result set that contains multiple results (Values objects).
*/ @property (nonatomic, strong) NSString * _Nullable value; @end /**Specifies the status and settings of the SMS channel for an application.
*/ @interface AWSPinpointTargetingSMSChannelRequest : AWSModel /**Specifies whether to enable the SMS channel for the application.
*/ @property (nonatomic, strong) NSNumber * _Nullable enabled; /**The identity that you want to display on recipients' devices when they receive messages from the SMS channel.
*/ @property (nonatomic, strong) NSString * _Nullable senderId; /**The registered short code that you want to use when you send messages through the SMS channel.
*/ @property (nonatomic, strong) NSString * _Nullable shortCode; @end /**Provides information about the status and settings of the SMS channel for an application.
Required parameters: [Platform] */ @interface AWSPinpointTargetingSMSChannelResponse : AWSModel /**The unique identifier for the application that the SMS channel applies to.
*/ @property (nonatomic, strong) NSString * _Nullable applicationId; /**The date and time, in ISO 8601 format, when the SMS channel was enabled.
*/ @property (nonatomic, strong) NSString * _Nullable creationDate; /**Specifies whether the SMS channel is enabled for the application.
*/ @property (nonatomic, strong) NSNumber * _Nullable enabled; /**(Not used) This property is retained only for backward compatibility.
*/ @property (nonatomic, strong) NSNumber * _Nullable hasCredential; /**(Deprecated) An identifier for the SMS channel. This property is retained only for backward compatibility.
*/ @property (nonatomic, strong) NSString * _Nullable identifier; /**Specifies whether the SMS channel is archived.
*/ @property (nonatomic, strong) NSNumber * _Nullable isArchived; /**The user who last modified the SMS channel.
*/ @property (nonatomic, strong) NSString * _Nullable lastModifiedBy; /**The date and time, in ISO 8601 format, when the SMS channel was last modified.
*/ @property (nonatomic, strong) NSString * _Nullable lastModifiedDate; /**The type of messaging or notification platform for the channel. For the SMS channel, this value is SMS.
*/ @property (nonatomic, strong) NSString * _Nullable platform; /**The maximum number of promotional messages that you can send through the SMS channel each second.
*/ @property (nonatomic, strong) NSNumber * _Nullable promotionalMessagesPerSecond; /**The identity that displays on recipients' devices when they receive messages from the SMS channel.
*/ @property (nonatomic, strong) NSString * _Nullable senderId; /**The registered short code to use when you send messages through the SMS channel.
*/ @property (nonatomic, strong) NSString * _Nullable shortCode; /**The maximum number of transactional messages that you can send through the SMS channel each second.
*/ @property (nonatomic, strong) NSNumber * _Nullable transactionalMessagesPerSecond; /**The current version of the SMS channel.
*/ @property (nonatomic, strong) NSNumber * _Nullable version; @end /**Specifies the default settings for a one-time SMS message that's sent directly to an endpoint.
*/ @interface AWSPinpointTargetingSMSMessage : AWSModel /**The body of the SMS message.
*/ @property (nonatomic, strong) NSString * _Nullable body; /**The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.
*/ @property (nonatomic, strong) NSString * _Nullable entityId; /**The SMS program name that you provided to AWS Support when you requested your dedicated number.
*/ @property (nonatomic, strong) NSString * _Nullable keyword; /**This field is reserved for future use.
*/ @property (nonatomic, strong) NSString * _Nullable mediaUrl; /**The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages).
*/ @property (nonatomic, assign) AWSPinpointTargetingMessageType messageType; /**The number to send the SMS message from. This value should be one of the dedicated long or short codes that's assigned to your AWS account. If you don't specify a long or short code, Amazon Pinpoint assigns a random long code to the SMS message and sends the message from that code.
*/ @property (nonatomic, strong) NSString * _Nullable originationNumber; /**The sender ID to display as the sender of the message on a recipient's device. Support for sender IDs varies by country or region.
*/ @property (nonatomic, strong) NSString * _Nullable senderId; /**The message variables to use in the SMS message. You can override the default variables with individual address variables.
*/ @property (nonatomic, strong) NSDictionaryThe template ID received from the regulatory body for sending SMS in your country.
*/ @property (nonatomic, strong) NSString * _Nullable templateId; @end /**Specifies the settings for an SMS activity in a journey. This type of activity sends a text message to participants.
*/ @interface AWSPinpointTargetingSMSMessageActivity : AWSModel /**Specifies the sender ID and message type for an SMS message that's sent to participants in a journey.
*/ @property (nonatomic, strong) AWSPinpointTargetingJourneySMSMessage * _Nullable messageConfig; /**The unique identifier for the next activity to perform, after the message is sent.
*/ @property (nonatomic, strong) NSString * _Nullable nextActivity; /**The name of the SMS message template to use for the message. If specified, this value must match the name of an existing message template.
*/ @property (nonatomic, strong) NSString * _Nullable templateName; /**The unique identifier for the version of the SMS template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
*/ @property (nonatomic, strong) NSString * _Nullable templateVersion; @end /**Specifies the content and settings for a message template that can be used in text messages that are sent through the SMS channel.
*/ @interface AWSPinpointTargetingSMSTemplateRequest : AWSModel /**The message body to use in text messages that are based on the message template.
*/ @property (nonatomic, strong) NSString * _Nullable body; /**A JSON object that specifies the default values to use for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable. When you create a message that's based on the template, you can override these defaults with message-specific and address-specific variables and values.
*/ @property (nonatomic, strong) NSString * _Nullable defaultSubstitutions; /**The unique identifier for the recommender model to use for the message template. Amazon Pinpoint uses this value to determine how to retrieve and process data from a recommender model when it sends messages that use the template, if the template contains message variables for recommendation data.
*/ @property (nonatomic, strong) NSString * _Nullable recommenderId; /**A custom description of the message template.
*/ @property (nonatomic, strong) NSString * _Nullable templateDescription; /**As of 22-05-2023 tags has been deprecated for update operations. After this date any value in tags is not processed and an error code is not returned. To manage tags we recommend using either Tags in the API Reference for Amazon Pinpoint, resourcegroupstaggingapi commands in the AWS Command Line Interface Documentation or resourcegroupstaggingapi in the AWS SDK.
(Deprecated) A string-to-string map of key-value pairs that defines the tags to associate with the message template. Each tag consists of a required tag key and an associated tag value.
*/ @property (nonatomic, strong) NSDictionaryProvides 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] */ @interface AWSPinpointTargetingSMSTemplateResponse : AWSModel /**The Amazon Resource Name (ARN) of the message template.
*/ @property (nonatomic, strong) NSString * _Nullable arn; /**The message body that's used in text messages that are based on the message template.
*/ @property (nonatomic, strong) NSString * _Nullable body; /**The date, in ISO 8601 format, when the message template was created.
*/ @property (nonatomic, strong) NSString * _Nullable creationDate; /**The JSON object that specifies the default values that are used for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable.
*/ @property (nonatomic, strong) NSString * _Nullable defaultSubstitutions; /**The date, in ISO 8601 format, when the message template was last modified.
*/ @property (nonatomic, strong) NSString * _Nullable lastModifiedDate; /**The unique identifier for the recommender model that's used by the message template.
*/ @property (nonatomic, strong) NSString * _Nullable recommenderId; /**The custom description of the message template.
*/ @property (nonatomic, strong) NSString * _Nullable templateDescription; /**The name of the message template.
*/ @property (nonatomic, strong) NSString * _Nullable templateName; /**The type of channel that the message template is designed for. For an SMS template, this value is SMS.
*/ @property (nonatomic, assign) AWSPinpointTargetingTemplateType templateType; /**The unique identifier, as an integer, for the active version of the message template, or the version of the template that you specified by using the version parameter in your request.
*/ @property (nonatomic, strong) NSString * _Nullable version; /**A string-to-string map of key-value pairs that identifies the tags that are associated with the message template. Each tag consists of a required tag key and an associated tag value.
*/ @property (nonatomic, strong) NSDictionarySpecifies the schedule settings for a campaign.
Required parameters: [StartTime] */ @interface AWSPinpointTargetingSchedule : AWSModel /**The scheduled time, in ISO 8601 format, when the campaign ended or will end.
*/ @property (nonatomic, strong) NSString * _Nullable endTime; /**The type of event that causes the campaign to be sent, if the value of the Frequency property is EVENT.
*/ @property (nonatomic, strong) AWSPinpointTargetingCampaignEventFilter * _Nullable eventFilter; /**Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.
*/ @property (nonatomic, assign) AWSPinpointTargetingFrequency frequency; /**Specifies whether the start and end times for the campaign schedule use each recipient's local time. To base the schedule on each recipient's local time, set this value to true.
*/ @property (nonatomic, strong) NSNumber * _Nullable isLocalTime; /**The default quiet time for the campaign. Quiet time is a specific time range when a campaign doesn't send messages to endpoints, if all the following conditions are met:
The EndpointDemographic.Timezone property of the endpoint is set to a valid value.
The current time in the endpoint's time zone is later than or equal to the time specified by the QuietTime.Start property for the campaign.
The current time in the endpoint's time zone is earlier than or equal to the time specified by the QuietTime.End property for the campaign.
If any of the preceding conditions isn't met, the endpoint will receive messages from the campaign, even if quiet time is enabled.
*/ @property (nonatomic, strong) AWSPinpointTargetingQuietTime * _Nullable quietTime; /**The scheduled time when the campaign began or will begin. Valid values are: IMMEDIATE, to start the campaign immediately; or, a specific time in ISO 8601 format.
*/ @property (nonatomic, strong) NSString * _Nullable startTime; /**The starting UTC offset for the campaign schedule, if the value of the IsLocalTime property is true. Valid values are: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, UTC+05:30, UTC+05:45, UTC+06, UTC+06:30, UTC+07, UTC+08, UTC+09, UTC+09:30, UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+13, UTC-02, UTC-03, UTC-04, UTC-05, UTC-06, UTC-07, UTC-08, UTC-09, UTC-10, and UTC-11.
*/ @property (nonatomic, strong) NSString * _Nullable timezone; @end /**Specifies dimension settings for including or excluding endpoints from a segment based on how recently an endpoint was active.
*/ @interface AWSPinpointTargetingSegmentBehaviors : AWSModel /**The dimension settings that are based on how recently an endpoint was active.
*/ @property (nonatomic, strong) AWSPinpointTargetingRecencyDimension * _Nullable recency; @end /**Specifies a segment to associate with an activity in a journey.
Required parameters: [SegmentId] */ @interface AWSPinpointTargetingSegmentCondition : AWSModel /**The unique identifier for the segment to associate with the activity.
*/ @property (nonatomic, strong) NSString * _Nullable segmentId; @end /**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.
*/ @interface AWSPinpointTargetingSegmentDemographics : AWSModel /**The app version criteria for the segment.
*/ @property (nonatomic, strong) AWSPinpointTargetingSetDimension * _Nullable appVersion; /**The channel criteria for the segment.
*/ @property (nonatomic, strong) AWSPinpointTargetingSetDimension * _Nullable channel; /**The device type criteria for the segment.
*/ @property (nonatomic, strong) AWSPinpointTargetingSetDimension * _Nullable deviceType; /**The device make criteria for the segment.
*/ @property (nonatomic, strong) AWSPinpointTargetingSetDimension * _Nullable make; /**The device model criteria for the segment.
*/ @property (nonatomic, strong) AWSPinpointTargetingSetDimension * _Nullable model; /**The device platform criteria for the segment.
*/ @property (nonatomic, strong) AWSPinpointTargetingSetDimension * _Nullable platform; @end /**Specifies the dimension settings for a segment.
*/ @interface AWSPinpointTargetingSegmentDimensions : AWSModel /**One or more custom attributes to use as criteria for the segment.
*/ @property (nonatomic, strong) NSDictionaryThe behavior-based criteria, such as how recently users have used your app, for the segment.
*/ @property (nonatomic, strong) AWSPinpointTargetingSegmentBehaviors * _Nullable behavior; /**The demographic-based criteria, such as device platform, for the segment.
*/ @property (nonatomic, strong) AWSPinpointTargetingSegmentDemographics * _Nullable demographic; /**The location-based criteria, such as region or GPS coordinates, for the segment.
*/ @property (nonatomic, strong) AWSPinpointTargetingSegmentLocation * _Nullable location; /**One or more custom metrics to use as criteria for the segment.
*/ @property (nonatomic, strong) NSDictionaryOne or more custom user attributes to use as criteria for the segment.
*/ @property (nonatomic, strong) NSDictionarySpecifies the base segments and dimensions for a segment, and the relationships between these base segments and dimensions.
*/ @interface AWSPinpointTargetingSegmentGroup : AWSModel /**An array that defines the dimensions for the segment.
*/ @property (nonatomic, strong) NSArrayThe base segment to build the segment on. A base segment, also referred to as a source segment, defines the initial population of endpoints for a segment. When you add dimensions to a segment, Amazon Pinpoint filters the base segment by using the dimensions that you specify.
You can specify more than one dimensional segment or only one imported segment. If you specify an imported segment, the Amazon Pinpoint console displays a segment size estimate that indicates the size of the imported segment without any filters applied to it.
*/ @property (nonatomic, strong) NSArraySpecifies how to handle multiple base segments for the segment. For example, if you specify three base segments for the segment, whether the resulting segment is based on all, any, or none of the base segments.
*/ @property (nonatomic, assign) AWSPinpointTargetingSourceType sourceType; /**Specifies how to handle multiple dimensions for the segment. For example, if you specify three dimensions for the segment, whether the resulting segment includes endpoints that match all, any, or none of the dimensions.
*/ @property (nonatomic, assign) AWSPinpointTargetingTypes types; @end /**Specifies the settings that define the relationships between segment groups for a segment.
*/ @interface AWSPinpointTargetingSegmentGroupList : AWSModel /**An array that defines the set of segment criteria to evaluate when handling segment groups for the segment.
*/ @property (nonatomic, strong) NSArraySpecifies how to handle multiple segment groups for the segment. For example, if the segment includes three segment groups, whether the resulting segment includes endpoints that match all, any, or none of the segment groups.
*/ @property (nonatomic, assign) AWSPinpointTargetingInclude include; @end /**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] */ @interface AWSPinpointTargetingSegmentImportResource : AWSModel /**The number of channel types in the endpoint definitions that were imported to create the segment.
*/ @property (nonatomic, strong) NSDictionary(Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy. Amazon Pinpoint previously used this value to assume an IAM role when importing endpoint definitions, but we removed this requirement. We don't recommend use of external IDs for IAM roles that are assumed by Amazon Pinpoint.
*/ @property (nonatomic, strong) NSString * _Nullable externalId; /**The format of the files that were imported to create the segment. Valid values are: CSV, for comma-separated values format; and, JSON, for newline-delimited JSON format.
*/ @property (nonatomic, assign) AWSPinpointTargetingFormat format; /**The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorized Amazon Pinpoint to access the Amazon S3 location to import endpoint definitions from.
*/ @property (nonatomic, strong) NSString * _Nullable roleArn; /**The URL of the Amazon Simple Storage Service (Amazon S3) bucket that the endpoint definitions were imported from to create the segment.
*/ @property (nonatomic, strong) NSString * _Nullable s3Url; /**The number of endpoint definitions that were imported successfully to create the segment.
*/ @property (nonatomic, strong) NSNumber * _Nullable size; @end /**Specifies geographical dimension settings for a segment.
*/ @interface AWSPinpointTargetingSegmentLocation : AWSModel /**The country or region code, in ISO 3166-1 alpha-2 format, for the segment.
*/ @property (nonatomic, strong) AWSPinpointTargetingSetDimension * _Nullable country; /**The GPS location and range for the segment.
*/ @property (nonatomic, strong) AWSPinpointTargetingGPSPointDimension * _Nullable GPSPoint; @end /**Specifies the segment identifier and version of a segment.
Required parameters: [Id] */ @interface AWSPinpointTargetingSegmentReference : AWSModel /**The unique identifier for the segment.
*/ @property (nonatomic, strong) NSString * _Nullable identifier; /**The version number of the segment.
*/ @property (nonatomic, strong) NSNumber * _Nullable version; @end /**Provides information about the configuration, dimension, and other settings for a segment.
Required parameters: [SegmentType, CreationDate, Id, Arn, ApplicationId] */ @interface AWSPinpointTargetingSegmentResponse : AWSModel /**The unique identifier for the application that the segment is associated with.
*/ @property (nonatomic, strong) NSString * _Nullable applicationId; /**The Amazon Resource Name (ARN) of the segment.
*/ @property (nonatomic, strong) NSString * _Nullable arn; /**The date and time when the segment was created.
*/ @property (nonatomic, strong) NSString * _Nullable creationDate; /**The dimension settings for the segment.
*/ @property (nonatomic, strong) AWSPinpointTargetingSegmentDimensions * _Nullable dimensions; /**The unique identifier for the segment.
*/ @property (nonatomic, strong) NSString * _Nullable identifier; /**The settings for the import job that's associated with the segment.
*/ @property (nonatomic, strong) AWSPinpointTargetingSegmentImportResource * _Nullable importDefinition; /**The date and time when the segment was last modified.
*/ @property (nonatomic, strong) NSString * _Nullable lastModifiedDate; /**The name of the segment.
*/ @property (nonatomic, strong) NSString * _Nullable name; /**A list of one or more segment groups that apply to the segment. Each segment group consists of zero or more base segments and the dimensions that are applied to those base segments.
*/ @property (nonatomic, strong) AWSPinpointTargetingSegmentGroupList * _Nullable segmentGroups; /**The segment type. Valid values are:
DIMENSIONAL - A dynamic segment, which is a segment that uses selection criteria that you specify and is based on endpoint data that's reported by your app. Dynamic segments can change over time.
IMPORT - A static segment, which is a segment that uses selection criteria that you specify and is based on endpoint definitions that you import from a file. Imported segments are static; they don't change over time.
The version number of the segment.
*/ @property (nonatomic, strong) NSNumber * _Nullable version; /**A string-to-string map of key-value pairs that identifies the tags that are associated with the segment. Each tag consists of a required tag key and an associated tag value.
*/ @property (nonatomic, strong) NSDictionaryProvides information about all the segments that are associated with an application.
Required parameters: [Item] */ @interface AWSPinpointTargetingSegmentsResponse : AWSModel /**An array of responses, one for each segment that's associated with the application (Segments resource) or each version of a segment that's associated with the application (Segment Versions resource).
*/ @property (nonatomic, strong) NSArrayThe string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.
*/ @property (nonatomic, strong) NSString * _Nullable nextToken; @end /** */ @interface AWSPinpointTargetingSendMessagesRequest : AWSRequest /**The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/ @property (nonatomic, strong) NSString * _Nullable applicationId; /**Specifies the configuration and other settings for a message.
*/ @property (nonatomic, strong) AWSPinpointTargetingMessageRequest * _Nullable messageRequest; @end /** */ @interface AWSPinpointTargetingSendMessagesResponse : AWSModel /**Provides information about the results of a request to send a message to an endpoint address.
*/ @property (nonatomic, strong) AWSPinpointTargetingMessageResponse * _Nullable messageResponse; @end /** */ @interface AWSPinpointTargetingSendOTPMessageRequest : AWSRequest /**The unique ID of your Amazon Pinpoint application.
*/ @property (nonatomic, strong) NSString * _Nullable applicationId; /**Send OTP message request parameters.
*/ @property (nonatomic, strong) AWSPinpointTargetingSendOTPMessageRequestParameters * _Nullable sendOTPMessageRequestParameters; @end /**Send OTP message request parameters.
Required parameters: [BrandName, ReferenceId, Channel, DestinationIdentity, OriginationIdentity] */ @interface AWSPinpointTargetingSendOTPMessageRequestParameters : AWSModel /**The attempts allowed to validate an OTP.
*/ @property (nonatomic, strong) NSNumber * _Nullable allowedAttempts; /**The brand name that will be substituted into the OTP message body. Should be owned by calling AWS account.
*/ @property (nonatomic, strong) NSString * _Nullable brandName; /**Channel type for the OTP message. Supported values: [SMS].
*/ @property (nonatomic, strong) NSString * _Nullable channel; /**The number of characters in the generated OTP.
*/ @property (nonatomic, strong) NSNumber * _Nullable codeLength; /**The destination identity to send OTP to.
*/ @property (nonatomic, strong) NSString * _Nullable destinationIdentity; /**A unique Entity ID received from DLT after entity registration is approved.
*/ @property (nonatomic, strong) NSString * _Nullable entityId; /**The language to be used for the outgoing message body containing the OTP.
*/ @property (nonatomic, strong) NSString * _Nullable language; /**The origination identity used to send OTP from.
*/ @property (nonatomic, strong) NSString * _Nullable originationIdentity; /**Developer-specified reference identifier. Required to match during OTP verification.
*/ @property (nonatomic, strong) NSString * _Nullable referenceId; /**A unique Template ID received from DLT after entity registration is approved.
*/ @property (nonatomic, strong) NSString * _Nullable templateId; /**The time in minutes before the OTP is no longer valid.
*/ @property (nonatomic, strong) NSNumber * _Nullable validityPeriod; @end /** */ @interface AWSPinpointTargetingSendOTPMessageResponse : AWSModel /**Provides information about the results of a request to send a message to an endpoint address.
*/ @property (nonatomic, strong) AWSPinpointTargetingMessageResponse * _Nullable messageResponse; @end /**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] */ @interface AWSPinpointTargetingSendUsersMessageRequest : AWSModel /**A map of custom attribute-value pairs. For a push notification, Amazon Pinpoint adds these attributes to the data.pinpoint object in the body of the notification payload. Amazon Pinpoint also provides these attributes in the events that it generates for users-messages deliveries.
*/ @property (nonatomic, strong) NSDictionaryThe settings and content for the default message and any default messages that you defined for specific channels.
*/ @property (nonatomic, strong) AWSPinpointTargetingDirectMessageConfiguration * _Nullable messageConfiguration; /**The message template to use for the message.
*/ @property (nonatomic, strong) AWSPinpointTargetingTemplateConfiguration * _Nullable templateConfiguration; /**The unique identifier for tracing the message. This identifier is visible to message recipients.
*/ @property (nonatomic, strong) NSString * _Nullable traceId; /**A map that associates user IDs with EndpointSendConfiguration objects. You can use an EndpointSendConfiguration object to tailor the message for a user by specifying settings such as content overrides and message variables.
*/ @property (nonatomic, strong) NSDictionaryProvides information about which users and endpoints a message was sent to.
Required parameters: [ApplicationId] */ @interface AWSPinpointTargetingSendUsersMessageResponse : AWSModel /**The unique identifier for the application that was used to send the message.
*/ @property (nonatomic, strong) NSString * _Nullable applicationId; /**The unique identifier that was assigned to the message request.
*/ @property (nonatomic, strong) NSString * _Nullable requestId; /**An object that indicates which endpoints the message was sent to, for each user. The object lists user IDs and, for each user ID, provides the endpoint IDs that the message was sent to. For each endpoint ID, it provides an EndpointMessageResult object.
*/ @property (nonatomic, strong) NSDictionaryThe unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/ @property (nonatomic, strong) NSString * _Nullable applicationId; /**Specifies the configuration and other settings for a message to send to all the endpoints that are associated with a list of users.
*/ @property (nonatomic, strong) AWSPinpointTargetingSendUsersMessageRequest * _Nullable sendUsersMessageRequest; @end /** */ @interface AWSPinpointTargetingSendUsersMessagesResponse : AWSModel /**Provides information about which users and endpoints a message was sent to.
*/ @property (nonatomic, strong) AWSPinpointTargetingSendUsersMessageResponse * _Nullable sendUsersMessageResponse; @end /**Provides information about a session.
Required parameters: [StartTimestamp, Id] */ @interface AWSPinpointTargetingSession : AWSModel /**The duration of the session, in milliseconds.
*/ @property (nonatomic, strong) NSNumber * _Nullable duration; /**The unique identifier for the session.
*/ @property (nonatomic, strong) NSString * _Nullable identifier; /**The date and time when the session began.
*/ @property (nonatomic, strong) NSString * _Nullable startTimestamp; /**The date and time when the session ended.
*/ @property (nonatomic, strong) NSString * _Nullable stopTimestamp; @end /**Specifies the dimension type and values for a segment dimension.
Required parameters: [Values] */ @interface AWSPinpointTargetingSetDimension : AWSModel /**The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
*/ @property (nonatomic, assign) AWSPinpointTargetingDimensionType dimensionType; /**The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
*/ @property (nonatomic, strong) NSArraySpecifies a condition to evaluate for an activity in a journey.
*/ @interface AWSPinpointTargetingSimpleCondition : AWSModel /**The dimension settings for the event that's associated with the activity.
*/ @property (nonatomic, strong) AWSPinpointTargetingEventCondition * _Nullable eventCondition; /**The segment that's associated with the activity.
*/ @property (nonatomic, strong) AWSPinpointTargetingSegmentCondition * _Nullable segmentCondition; /**The dimension settings for the segment that's associated with the activity.
*/ @property (nonatomic, strong) AWSPinpointTargetingSegmentDimensions * _Nullable segmentDimensions; @end /**Specifies the contents of an email message, composed of a subject, a text part, and an HTML part.
*/ @interface AWSPinpointTargetingSimpleEmail : AWSModel /**The body of the email message, in HTML format. We recommend using HTML format for email clients that render HTML content. You can include links, formatted text, and more in an HTML message.
*/ @property (nonatomic, strong) AWSPinpointTargetingSimpleEmailPart * _Nullable htmlPart; /**The subject line, or title, of the email.
*/ @property (nonatomic, strong) AWSPinpointTargetingSimpleEmailPart * _Nullable subject; /**The body of the email message, in plain text format. We recommend using plain text format for email clients that don't render HTML content and clients that are connected to high-latency networks, such as mobile devices.
*/ @property (nonatomic, strong) AWSPinpointTargetingSimpleEmailPart * _Nullable textPart; @end /**Specifies the subject or body of an email message, represented as textual email data and the applicable character set.
*/ @interface AWSPinpointTargetingSimpleEmailPart : AWSModel /**The applicable character set for the message content.
*/ @property (nonatomic, strong) NSString * _Nullable charset; /**The textual data of the message content.
*/ @property (nonatomic, strong) NSString * _Nullable data; @end /**Specifies the conditions for the first activity in a journey. This activity and its conditions determine which users are participants in a journey.
*/ @interface AWSPinpointTargetingStartCondition : AWSModel /**The custom description of the condition.
*/ @property (nonatomic, strong) NSString * _Nullable detail; /**Specifies the settings for an event that causes a journey activity to start.
*/ @property (nonatomic, strong) AWSPinpointTargetingEventStartCondition * _Nullable eventStartCondition; /**The segment that's associated with the first activity in the journey. This segment determines which users are participants in the journey.
*/ @property (nonatomic, strong) AWSPinpointTargetingSegmentCondition * _Nullable segmentStartCondition; @end /** */ @interface AWSPinpointTargetingTagResourceRequest : AWSRequest /**The Amazon Resource Name (ARN) of the resource.
*/ @property (nonatomic, strong) NSString * _Nullable resourceArn; /**Specifies the tags (keys and values) for an application, campaign, message template, or segment.
*/ @property (nonatomic, strong) AWSPinpointTargetingTagsModel * _Nullable tagsModel; @end /**Specifies the tags (keys and values) for an application, campaign, message template, or segment.
Required parameters: [tags] */ @interface AWSPinpointTargetingTagsModel : AWSModel /**A string-to-string map of key-value pairs that defines the tags for an application, campaign, message template, or segment. Each of these resources can have a maximum of 50 tags.
Each tag consists of a required tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.
*/ @property (nonatomic, strong) NSDictionarySpecifies the name and version of the message template to use for the message.
*/ @interface AWSPinpointTargetingTemplate : AWSModel /**The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
*/ @property (nonatomic, strong) NSString * _Nullable name; /**The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
*/ @property (nonatomic, strong) NSString * _Nullable version; @end /**Specifies which version of a message template to use as the active version of the template.
*/ @interface AWSPinpointTargetingTemplateActiveVersionRequest : AWSModel /**The version of the message template to use as the active version of the template. Valid values are: latest, for the most recent version of the template; or, the unique identifier for any existing version of the template. If you specify an identifier, the value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the
Specifies the message template to use for the message, for each type of channel.
*/ @interface AWSPinpointTargetingTemplateConfiguration : AWSModel /**The email template to use for the message.
*/ @property (nonatomic, strong) AWSPinpointTargetingTemplate * _Nullable emailTemplate; /**The push notification template to use for the message.
*/ @property (nonatomic, strong) AWSPinpointTargetingTemplate * _Nullable pushTemplate; /**The SMS template to use for the message.
*/ @property (nonatomic, strong) AWSPinpointTargetingTemplate * _Nullable SMSTemplate; /**The voice template to use for the message. This object isn't supported for campaigns.
*/ @property (nonatomic, strong) AWSPinpointTargetingTemplate * _Nullable voiceTemplate; @end /**Provides information about a request to create a message template.
*/ @interface AWSPinpointTargetingTemplateCreateMessageBody : AWSModel /**The Amazon Resource Name (ARN) of the message template that was created.
*/ @property (nonatomic, strong) NSString * _Nullable arn; /**The message that's returned from the API for the request to create the message template.
*/ @property (nonatomic, strong) NSString * _Nullable message; /**The unique identifier for the request to create the message template.
*/ @property (nonatomic, strong) NSString * _Nullable requestID; @end /**Provides information about a message template that's associated with your Amazon Pinpoint account.
Required parameters: [LastModifiedDate, CreationDate, TemplateName, TemplateType] */ @interface AWSPinpointTargetingTemplateResponse : AWSModel /**The Amazon Resource Name (ARN) of the message template. This value isn't included in a TemplateResponse object. To retrieve the ARN of a template, use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the type of template that you want to retrieve the ARN for.
*/ @property (nonatomic, strong) NSString * _Nullable arn; /**The date, in ISO 8601 format, when the message template was created.
*/ @property (nonatomic, strong) NSString * _Nullable creationDate; /**The JSON object that specifies the default values that are used for message variables in the message template. This object isn't included in a TemplateResponse object. To retrieve this object for a template, use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the type of template that you want to retrieve the object for.
*/ @property (nonatomic, strong) NSString * _Nullable defaultSubstitutions; /**The date, in ISO 8601 format, when the message template was last modified.
*/ @property (nonatomic, strong) NSString * _Nullable lastModifiedDate; /**The custom description of the message template. This value isn't included in a TemplateResponse object. To retrieve the description of a template, use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the type of template that you want to retrieve the description for.
*/ @property (nonatomic, strong) NSString * _Nullable templateDescription; /**The name of the message template.
*/ @property (nonatomic, strong) NSString * _Nullable templateName; /**The type of channel that the message template is designed for. Possible values are: EMAIL, PUSH, SMS, and VOICE.
*/ @property (nonatomic, assign) AWSPinpointTargetingTemplateType templateType; /**The unique identifier, as an integer, for the active version of the message template.
*/ @property (nonatomic, strong) NSString * _Nullable version; /**A map of key-value pairs that identifies the tags that are associated with the message template. This object isn't included in a TemplateResponse object. To retrieve this object for a template, use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the type of template that you want to retrieve the object for.
*/ @property (nonatomic, strong) NSDictionaryProvides information about a specific version of a message template.
Required parameters: [LastModifiedDate, CreationDate, TemplateName, TemplateType] */ @interface AWSPinpointTargetingTemplateVersionResponse : AWSModel /**The date, in ISO 8601 format, when the version of the message template was created.
*/ @property (nonatomic, strong) NSString * _Nullable creationDate; /**A JSON object that specifies the default values that are used for message variables in the version of the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable.
*/ @property (nonatomic, strong) NSString * _Nullable defaultSubstitutions; /**The date, in ISO 8601 format, when the version of the message template was last modified.
*/ @property (nonatomic, strong) NSString * _Nullable lastModifiedDate; /**The custom description of the version of the message template.
*/ @property (nonatomic, strong) NSString * _Nullable templateDescription; /**The name of the message template.
*/ @property (nonatomic, strong) NSString * _Nullable templateName; /**The type of channel that the message template is designed for. Possible values are: EMAIL, PUSH, SMS, and VOICE.
*/ @property (nonatomic, strong) NSString * _Nullable templateType; /**The unique identifier for the version of the message template. This value is an integer that Amazon Pinpoint automatically increments and assigns to each new version of a template.
*/ @property (nonatomic, strong) NSString * _Nullable version; @end /**Provides information about all the versions of a specific message template.
Required parameters: [Item] */ @interface AWSPinpointTargetingTemplateVersionsResponse : AWSModel /**An array of responses, one for each version of the message template.
*/ @property (nonatomic, strong) NSArrayThe message that's returned from the API for the request to retrieve information about all the versions of the message template.
*/ @property (nonatomic, strong) NSString * _Nullable message; /**The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.
*/ @property (nonatomic, strong) NSString * _Nullable nextToken; /**The unique identifier for the request to retrieve information about all the versions of the message template.
*/ @property (nonatomic, strong) NSString * _Nullable requestID; @end /**Provides information about all the message templates that are associated with your Amazon Pinpoint account.
Required parameters: [Item] */ @interface AWSPinpointTargetingTemplatesResponse : AWSModel /**An array of responses, one for each message template that's associated with your Amazon Pinpoint account and meets any filter criteria that you specified in the request.
*/ @property (nonatomic, strong) NSArrayThe string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.
*/ @property (nonatomic, strong) NSString * _Nullable nextToken; @end /**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] */ @interface AWSPinpointTargetingTreatmentResource : AWSModel /**The delivery configuration settings for sending the treatment through a custom channel. This object is required if the MessageConfiguration object for the treatment specifies a CustomMessage object.
*/ @property (nonatomic, strong) AWSPinpointTargetingCustomDeliveryConfiguration * _Nullable customDeliveryConfiguration; /**The unique identifier for the treatment.
*/ @property (nonatomic, strong) NSString * _Nullable identifier; /**The message configuration settings for the treatment.
*/ @property (nonatomic, strong) AWSPinpointTargetingMessageConfiguration * _Nullable messageConfiguration; /**The schedule settings for the treatment.
*/ @property (nonatomic, strong) AWSPinpointTargetingSchedule * _Nullable schedule; /**The allocated percentage of users (segment members) that the treatment is sent to.
*/ @property (nonatomic, strong) NSNumber * _Nullable sizePercent; /**The current status of the treatment.
*/ @property (nonatomic, strong) AWSPinpointTargetingCampaignState * _Nullable state; /**The message template to use for the treatment.
*/ @property (nonatomic, strong) AWSPinpointTargetingTemplateConfiguration * _Nullable templateConfiguration; /**The custom description of the treatment.
*/ @property (nonatomic, strong) NSString * _Nullable treatmentDescription; /**The custom name of the treatment.
*/ @property (nonatomic, strong) NSString * _Nullable treatmentName; @end /** */ @interface AWSPinpointTargetingUntagResourceRequest : AWSRequest /**The Amazon Resource Name (ARN) of the resource.
*/ @property (nonatomic, strong) NSString * _Nullable resourceArn; /**The key of the tag to remove from the resource. To remove multiple tags, append the tagKeys parameter and argument for each additional tag to remove, separated by an ampersand (&).
*/ @property (nonatomic, strong) NSArraySpecifies the status and settings of the ADM (Amazon Device Messaging) channel for an application.
*/ @property (nonatomic, strong) AWSPinpointTargetingADMChannelRequest * _Nullable ADMChannelRequest; /**The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/ @property (nonatomic, strong) NSString * _Nullable applicationId; @end /** */ @interface AWSPinpointTargetingUpdateAdmChannelResponse : AWSModel /**Provides information about the status and settings of the ADM (Amazon Device Messaging) channel for an application.
*/ @property (nonatomic, strong) AWSPinpointTargetingADMChannelResponse * _Nullable ADMChannelResponse; @end /** */ @interface AWSPinpointTargetingUpdateApnsChannelRequest : AWSRequest /**Specifies the status and settings of the APNs (Apple Push Notification service) channel for an application.
*/ @property (nonatomic, strong) AWSPinpointTargetingAPNSChannelRequest * _Nullable APNSChannelRequest; /**The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/ @property (nonatomic, strong) NSString * _Nullable applicationId; @end /** */ @interface AWSPinpointTargetingUpdateApnsChannelResponse : AWSModel /**Provides information about the status and settings of the APNs (Apple Push Notification service) channel for an application.
*/ @property (nonatomic, strong) AWSPinpointTargetingAPNSChannelResponse * _Nullable APNSChannelResponse; @end /** */ @interface AWSPinpointTargetingUpdateApnsSandboxChannelRequest : AWSRequest /**Specifies the status and settings of the APNs (Apple Push Notification service) sandbox channel for an application.
*/ @property (nonatomic, strong) AWSPinpointTargetingAPNSSandboxChannelRequest * _Nullable APNSSandboxChannelRequest; /**The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/ @property (nonatomic, strong) NSString * _Nullable applicationId; @end /** */ @interface AWSPinpointTargetingUpdateApnsSandboxChannelResponse : AWSModel /**Provides information about the status and settings of the APNs (Apple Push Notification service) sandbox channel for an application.
*/ @property (nonatomic, strong) AWSPinpointTargetingAPNSSandboxChannelResponse * _Nullable APNSSandboxChannelResponse; @end /** */ @interface AWSPinpointTargetingUpdateApnsVoipChannelRequest : AWSRequest /**Specifies the status and settings of the APNs (Apple Push Notification service) VoIP channel for an application.
*/ @property (nonatomic, strong) AWSPinpointTargetingAPNSVoipChannelRequest * _Nullable APNSVoipChannelRequest; /**The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/ @property (nonatomic, strong) NSString * _Nullable applicationId; @end /** */ @interface AWSPinpointTargetingUpdateApnsVoipChannelResponse : AWSModel /**Provides information about the status and settings of the APNs (Apple Push Notification service) VoIP channel for an application.
*/ @property (nonatomic, strong) AWSPinpointTargetingAPNSVoipChannelResponse * _Nullable APNSVoipChannelResponse; @end /** */ @interface AWSPinpointTargetingUpdateApnsVoipSandboxChannelRequest : AWSRequest /**Specifies the status and settings of the APNs (Apple Push Notification service) VoIP sandbox channel for an application.
*/ @property (nonatomic, strong) AWSPinpointTargetingAPNSVoipSandboxChannelRequest * _Nullable APNSVoipSandboxChannelRequest; /**The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/ @property (nonatomic, strong) NSString * _Nullable applicationId; @end /** */ @interface AWSPinpointTargetingUpdateApnsVoipSandboxChannelResponse : AWSModel /**Provides information about the status and settings of the APNs (Apple Push Notification service) VoIP sandbox channel for an application.
*/ @property (nonatomic, strong) AWSPinpointTargetingAPNSVoipSandboxChannelResponse * _Nullable APNSVoipSandboxChannelResponse; @end /** */ @interface AWSPinpointTargetingUpdateApplicationSettingsRequest : AWSRequest /**The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/ @property (nonatomic, strong) NSString * _Nullable applicationId; /**Specifies the default settings for an application.
*/ @property (nonatomic, strong) AWSPinpointTargetingWriteApplicationSettingsRequest * _Nullable writeApplicationSettingsRequest; @end /** */ @interface AWSPinpointTargetingUpdateApplicationSettingsResponse : AWSModel /**Provides information about an application, including the default settings for an application.
*/ @property (nonatomic, strong) AWSPinpointTargetingApplicationSettingsResource * _Nullable applicationSettingsResource; @end /**Specifies one or more attributes to remove from all the endpoints that are associated with an application.
*/ @interface AWSPinpointTargetingUpdateAttributesRequest : AWSModel /**An array of the attributes to remove from all the endpoints that are associated with the application. The array can specify the complete, exact name of each attribute to remove or it can specify a glob pattern that an attribute name must match in order for the attribute to be removed.
*/ @property (nonatomic, strong) NSArrayThe unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/ @property (nonatomic, strong) NSString * _Nullable applicationId; /**Specifies the status and settings of the Baidu (Baidu Cloud Push) channel for an application.
*/ @property (nonatomic, strong) AWSPinpointTargetingBaiduChannelRequest * _Nullable baiduChannelRequest; @end /** */ @interface AWSPinpointTargetingUpdateBaiduChannelResponse : AWSModel /**Provides information about the status and settings of the Baidu (Baidu Cloud Push) channel for an application.
*/ @property (nonatomic, strong) AWSPinpointTargetingBaiduChannelResponse * _Nullable baiduChannelResponse; @end /** */ @interface AWSPinpointTargetingUpdateCampaignRequest : AWSRequest /**The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/ @property (nonatomic, strong) NSString * _Nullable applicationId; /**The unique identifier for the campaign.
*/ @property (nonatomic, strong) NSString * _Nullable campaignId; /**Specifies the configuration and other settings for a campaign.
*/ @property (nonatomic, strong) AWSPinpointTargetingWriteCampaignRequest * _Nullable writeCampaignRequest; @end /** */ @interface AWSPinpointTargetingUpdateCampaignResponse : AWSModel /**Provides information about the status, configuration, and other settings for a campaign.
*/ @property (nonatomic, strong) AWSPinpointTargetingCampaignResponse * _Nullable campaignResponse; @end /** */ @interface AWSPinpointTargetingUpdateEmailChannelRequest : AWSRequest /**The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/ @property (nonatomic, strong) NSString * _Nullable applicationId; /**Specifies the status and settings of the email channel for an application.
*/ @property (nonatomic, strong) AWSPinpointTargetingEmailChannelRequest * _Nullable emailChannelRequest; @end /** */ @interface AWSPinpointTargetingUpdateEmailChannelResponse : AWSModel /**Provides information about the status and settings of the email channel for an application.
*/ @property (nonatomic, strong) AWSPinpointTargetingEmailChannelResponse * _Nullable emailChannelResponse; @end /** */ @interface AWSPinpointTargetingUpdateEmailTemplateRequest : AWSRequest /**Specifies whether to save the updates as a new version of the message template. Valid values are: true, save the updates as a new version; and, false, save the updates to (overwrite) the latest existing version of the template.
If you don't specify a value for this parameter, Amazon Pinpoint saves the updates to (overwrites) the latest existing version of the template. If you specify a value of true for this parameter, don't specify a value for the version parameter. Otherwise, an error will occur.
*/ @property (nonatomic, strong) NSNumber * _Nullable createNewVersion; /**Specifies the content and settings for a message template that can be used in messages that are sent through the email channel.
*/ @property (nonatomic, strong) AWSPinpointTargetingEmailTemplateRequest * _Nullable emailTemplateRequest; /**The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
*/ @property (nonatomic, strong) NSString * _Nullable templateName; /**The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the
If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.
If you don't specify a value for this parameter, Amazon Pinpoint does the following:
For a get operation, retrieves information about the active version of the template.
For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.
For a delete operation, deletes the template, including all versions of the template.
Provides information about an API request or response.
*/ @property (nonatomic, strong) AWSPinpointTargetingMessageBody * _Nullable messageBody; @end /** */ @interface AWSPinpointTargetingUpdateEndpointRequest : AWSRequest /**The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/ @property (nonatomic, strong) NSString * _Nullable applicationId; /**The unique identifier for the endpoint.
*/ @property (nonatomic, strong) NSString * _Nullable endpointId; /**Specifies the channel type and other settings for an endpoint.
*/ @property (nonatomic, strong) AWSPinpointTargetingEndpointRequest * _Nullable endpointRequest; @end /** */ @interface AWSPinpointTargetingUpdateEndpointResponse : AWSModel /**Provides information about an API request or response.
*/ @property (nonatomic, strong) AWSPinpointTargetingMessageBody * _Nullable messageBody; @end /** */ @interface AWSPinpointTargetingUpdateEndpointsBatchRequest : AWSRequest /**The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/ @property (nonatomic, strong) NSString * _Nullable applicationId; /**Specifies a batch of endpoints to create or update and the settings and attributes to set or change for each endpoint.
*/ @property (nonatomic, strong) AWSPinpointTargetingEndpointBatchRequest * _Nullable endpointBatchRequest; @end /** */ @interface AWSPinpointTargetingUpdateEndpointsBatchResponse : AWSModel /**Provides information about an API request or response.
*/ @property (nonatomic, strong) AWSPinpointTargetingMessageBody * _Nullable messageBody; @end /** */ @interface AWSPinpointTargetingUpdateGcmChannelRequest : AWSRequest /**The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/ @property (nonatomic, strong) NSString * _Nullable applicationId; /**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.
*/ @property (nonatomic, strong) AWSPinpointTargetingGCMChannelRequest * _Nullable GCMChannelRequest; @end /** */ @interface AWSPinpointTargetingUpdateGcmChannelResponse : AWSModel /**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.
*/ @property (nonatomic, strong) AWSPinpointTargetingGCMChannelResponse * _Nullable GCMChannelResponse; @end /** */ @interface AWSPinpointTargetingUpdateInAppTemplateRequest : AWSRequest /**Specifies whether to save the updates as a new version of the message template. Valid values are: true, save the updates as a new version; and, false, save the updates to (overwrite) the latest existing version of the template.
If you don't specify a value for this parameter, Amazon Pinpoint saves the updates to (overwrites) the latest existing version of the template. If you specify a value of true for this parameter, don't specify a value for the version parameter. Otherwise, an error will occur.
*/ @property (nonatomic, strong) NSNumber * _Nullable createNewVersion; /**InApp Template Request.
*/ @property (nonatomic, strong) AWSPinpointTargetingInAppTemplateRequest * _Nullable inAppTemplateRequest; /**The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
*/ @property (nonatomic, strong) NSString * _Nullable templateName; /**The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the
If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.
If you don't specify a value for this parameter, Amazon Pinpoint does the following:
For a get operation, retrieves information about the active version of the template.
For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.
For a delete operation, deletes the template, including all versions of the template.
Provides information about an API request or response.
*/ @property (nonatomic, strong) AWSPinpointTargetingMessageBody * _Nullable messageBody; @end /** */ @interface AWSPinpointTargetingUpdateJourneyRequest : AWSRequest /**The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/ @property (nonatomic, strong) NSString * _Nullable applicationId; /**The unique identifier for the journey.
*/ @property (nonatomic, strong) NSString * _Nullable journeyId; /**Specifies the configuration and other settings for a journey.
*/ @property (nonatomic, strong) AWSPinpointTargetingWriteJourneyRequest * _Nullable writeJourneyRequest; @end /** */ @interface AWSPinpointTargetingUpdateJourneyResponse : AWSModel /**Provides information about the status, configuration, and other settings for a journey.
*/ @property (nonatomic, strong) AWSPinpointTargetingJourneyResponse * _Nullable journeyResponse; @end /** */ @interface AWSPinpointTargetingUpdateJourneyStateRequest : AWSRequest /**The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/ @property (nonatomic, strong) NSString * _Nullable applicationId; /**The unique identifier for the journey.
*/ @property (nonatomic, strong) NSString * _Nullable journeyId; /**Changes the status of a journey.
*/ @property (nonatomic, strong) AWSPinpointTargetingJourneyStateRequest * _Nullable journeyStateRequest; @end /** */ @interface AWSPinpointTargetingUpdateJourneyStateResponse : AWSModel /**Provides information about the status, configuration, and other settings for a journey.
*/ @property (nonatomic, strong) AWSPinpointTargetingJourneyResponse * _Nullable journeyResponse; @end /** */ @interface AWSPinpointTargetingUpdatePushTemplateRequest : AWSRequest /**Specifies whether to save the updates as a new version of the message template. Valid values are: true, save the updates as a new version; and, false, save the updates to (overwrite) the latest existing version of the template.
If you don't specify a value for this parameter, Amazon Pinpoint saves the updates to (overwrites) the latest existing version of the template. If you specify a value of true for this parameter, don't specify a value for the version parameter. Otherwise, an error will occur.
*/ @property (nonatomic, strong) NSNumber * _Nullable createNewVersion; /**Specifies the content and settings for a message template that can be used in messages that are sent through a push notification channel.
*/ @property (nonatomic, strong) AWSPinpointTargetingPushNotificationTemplateRequest * _Nullable pushNotificationTemplateRequest; /**The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
*/ @property (nonatomic, strong) NSString * _Nullable templateName; /**The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the
If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.
If you don't specify a value for this parameter, Amazon Pinpoint does the following:
For a get operation, retrieves information about the active version of the template.
For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.
For a delete operation, deletes the template, including all versions of the template.
Provides information about an API request or response.
*/ @property (nonatomic, strong) AWSPinpointTargetingMessageBody * _Nullable messageBody; @end /**Specifies Amazon Pinpoint configuration settings for retrieving and processing recommendation data from a recommender model.
Required parameters: [RecommendationProviderUri, RecommendationProviderRoleArn] */ @interface AWSPinpointTargetingUpdateRecommenderConfiguration : AWSModel /**A map of key-value pairs that defines 1-10 custom endpoint or user attributes, depending on the value for the RecommendationProviderIdType property. Each of these attributes temporarily stores a recommended item that's retrieved from the recommender model and sent to an AWS Lambda function for additional processing. Each attribute can be used as a message variable in a message template.
In the map, the key is the name of a custom attribute and the value is a custom display name for that attribute. The display name appears in the Attribute finder of the template editor on the Amazon Pinpoint console. The following restrictions apply to these names:
An attribute name must start with a letter or number and it can contain up to 50 characters. The characters can be letters, numbers, underscores (_), or hyphens (-). Attribute names are case sensitive and must be unique.
An attribute display name must start with a letter or number and it can contain up to 25 characters. The characters can be letters, numbers, spaces, underscores (_), or hyphens (-).
This object is required if the configuration invokes an AWS Lambda function (RecommendationTransformerUri) to process recommendation data. Otherwise, don't include this object in your request.
*/ @property (nonatomic, strong) NSDictionaryA custom description of the configuration for the recommender model. The description can contain up to 128 characters. The characters can be letters, numbers, spaces, or the following symbols: _ ; () , ‐.
*/ @property (nonatomic, strong) NSString * _Nullable detail; /**A custom name of the configuration for the recommender model. The name must start with a letter or number and it can contain up to 128 characters. The characters can be letters, numbers, spaces, underscores (_), or hyphens (-).
*/ @property (nonatomic, strong) NSString * _Nullable name; /**The type of Amazon Pinpoint ID to associate with unique user IDs in the recommender model. This value enables the model to use attribute and event data that’s specific to a particular endpoint or user in an Amazon Pinpoint application. Valid values are:
PINPOINT_ENDPOINT_ID - Associate each user in the model with a particular endpoint in Amazon Pinpoint. The data is correlated based on endpoint IDs in Amazon Pinpoint. This is the default value.
PINPOINT_USER_ID - Associate each user in the model with a particular user and endpoint in Amazon Pinpoint. The data is correlated based on user IDs in Amazon Pinpoint. If you specify this value, an endpoint definition in Amazon Pinpoint has to specify both a user ID (UserId) and an endpoint ID. Otherwise, messages won’t be sent to the user's endpoint.
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to retrieve recommendation data from the recommender model.
*/ @property (nonatomic, strong) NSString * _Nullable recommendationProviderRoleArn; /**The Amazon Resource Name (ARN) of the recommender model to retrieve recommendation data from. This value must match the ARN of an Amazon Personalize campaign.
*/ @property (nonatomic, strong) NSString * _Nullable recommendationProviderUri; /**The name or Amazon Resource Name (ARN) of the AWS Lambda function to invoke for additional processing of recommendation data that's retrieved from the recommender model.
*/ @property (nonatomic, strong) NSString * _Nullable recommendationTransformerUri; /**A custom display name for the standard endpoint or user attribute (RecommendationItems) that temporarily stores recommended items for each endpoint or user, depending on the value for the RecommendationProviderIdType property. This value is required if the configuration doesn't invoke an AWS Lambda function (RecommendationTransformerUri) to perform additional processing of recommendation data.
This name appears in the Attribute finder of the template editor on the Amazon Pinpoint console. The name can contain up to 25 characters. The characters can be letters, numbers, spaces, underscores (_), or hyphens (-). These restrictions don't apply to attribute values.
*/ @property (nonatomic, strong) NSString * _Nullable recommendationsDisplayName; /**The number of recommended items to retrieve from the model for each endpoint or user, depending on the value for the RecommendationProviderIdType property. This number determines how many recommended items are available for use in message variables. The minimum value is 1. The maximum value is 5. The default value is 5.
To use multiple recommended items and custom attributes with message variables, you have to use an AWS Lambda function (RecommendationTransformerUri) to perform additional processing of recommendation data.
*/ @property (nonatomic, strong) NSNumber * _Nullable recommendationsPerMessage; @end /** */ @interface AWSPinpointTargetingUpdateRecommenderConfigurationRequest : AWSRequest /**The unique identifier for the recommender model configuration. This identifier is displayed as the Recommender ID on the Amazon Pinpoint console.
*/ @property (nonatomic, strong) NSString * _Nullable recommenderId; /**Specifies Amazon Pinpoint configuration settings for retrieving and processing recommendation data from a recommender model.
*/ @property (nonatomic, strong) AWSPinpointTargetingUpdateRecommenderConfiguration * _Nullable updateRecommenderConfiguration; @end /** */ @interface AWSPinpointTargetingUpdateRecommenderConfigurationResponse : AWSModel /**Provides information about Amazon Pinpoint configuration settings for retrieving and processing data from a recommender model.
*/ @property (nonatomic, strong) AWSPinpointTargetingRecommenderConfigurationResponse * _Nullable recommenderConfigurationResponse; @end /** */ @interface AWSPinpointTargetingUpdateSegmentRequest : AWSRequest /**The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/ @property (nonatomic, strong) NSString * _Nullable applicationId; /**The unique identifier for the segment.
*/ @property (nonatomic, strong) NSString * _Nullable segmentId; /**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.
*/ @property (nonatomic, strong) AWSPinpointTargetingWriteSegmentRequest * _Nullable writeSegmentRequest; @end /** */ @interface AWSPinpointTargetingUpdateSegmentResponse : AWSModel /**Provides information about the configuration, dimension, and other settings for a segment.
*/ @property (nonatomic, strong) AWSPinpointTargetingSegmentResponse * _Nullable segmentResponse; @end /** */ @interface AWSPinpointTargetingUpdateSmsChannelRequest : AWSRequest /**The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/ @property (nonatomic, strong) NSString * _Nullable applicationId; /**Specifies the status and settings of the SMS channel for an application.
*/ @property (nonatomic, strong) AWSPinpointTargetingSMSChannelRequest * _Nullable SMSChannelRequest; @end /** */ @interface AWSPinpointTargetingUpdateSmsChannelResponse : AWSModel /**Provides information about the status and settings of the SMS channel for an application.
*/ @property (nonatomic, strong) AWSPinpointTargetingSMSChannelResponse * _Nullable SMSChannelResponse; @end /** */ @interface AWSPinpointTargetingUpdateSmsTemplateRequest : AWSRequest /**Specifies whether to save the updates as a new version of the message template. Valid values are: true, save the updates as a new version; and, false, save the updates to (overwrite) the latest existing version of the template.
If you don't specify a value for this parameter, Amazon Pinpoint saves the updates to (overwrites) the latest existing version of the template. If you specify a value of true for this parameter, don't specify a value for the version parameter. Otherwise, an error will occur.
*/ @property (nonatomic, strong) NSNumber * _Nullable createNewVersion; /**Specifies the content and settings for a message template that can be used in text messages that are sent through the SMS channel.
*/ @property (nonatomic, strong) AWSPinpointTargetingSMSTemplateRequest * _Nullable SMSTemplateRequest; /**The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
*/ @property (nonatomic, strong) NSString * _Nullable templateName; /**The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the
If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.
If you don't specify a value for this parameter, Amazon Pinpoint does the following:
For a get operation, retrieves information about the active version of the template.
For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.
For a delete operation, deletes the template, including all versions of the template.
Provides information about an API request or response.
*/ @property (nonatomic, strong) AWSPinpointTargetingMessageBody * _Nullable messageBody; @end /** */ @interface AWSPinpointTargetingUpdateTemplateActiveVersionRequest : AWSRequest /**Specifies which version of a message template to use as the active version of the template.
*/ @property (nonatomic, strong) AWSPinpointTargetingTemplateActiveVersionRequest * _Nullable templateActiveVersionRequest; /**The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
*/ @property (nonatomic, strong) NSString * _Nullable templateName; /**The type of channel that the message template is designed for. Valid values are: EMAIL, PUSH, SMS, and VOICE.
*/ @property (nonatomic, strong) NSString * _Nullable templateType; @end /** */ @interface AWSPinpointTargetingUpdateTemplateActiveVersionResponse : AWSModel /**Provides information about an API request or response.
*/ @property (nonatomic, strong) AWSPinpointTargetingMessageBody * _Nullable messageBody; @end /** */ @interface AWSPinpointTargetingUpdateVoiceChannelRequest : AWSRequest /**The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/ @property (nonatomic, strong) NSString * _Nullable applicationId; /**Specifies the status and settings of the voice channel for an application.
*/ @property (nonatomic, strong) AWSPinpointTargetingVoiceChannelRequest * _Nullable voiceChannelRequest; @end /** */ @interface AWSPinpointTargetingUpdateVoiceChannelResponse : AWSModel /**Provides information about the status and settings of the voice channel for an application.
*/ @property (nonatomic, strong) AWSPinpointTargetingVoiceChannelResponse * _Nullable voiceChannelResponse; @end /** */ @interface AWSPinpointTargetingUpdateVoiceTemplateRequest : AWSRequest /**Specifies whether to save the updates as a new version of the message template. Valid values are: true, save the updates as a new version; and, false, save the updates to (overwrite) the latest existing version of the template.
If you don't specify a value for this parameter, Amazon Pinpoint saves the updates to (overwrites) the latest existing version of the template. If you specify a value of true for this parameter, don't specify a value for the version parameter. Otherwise, an error will occur.
*/ @property (nonatomic, strong) NSNumber * _Nullable createNewVersion; /**The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
*/ @property (nonatomic, strong) NSString * _Nullable templateName; /**The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the
If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.
If you don't specify a value for this parameter, Amazon Pinpoint does the following:
For a get operation, retrieves information about the active version of the template.
For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.
For a delete operation, deletes the template, including all versions of the template.
Specifies the content and settings for a message template that can be used in messages that are sent through the voice channel.
*/ @property (nonatomic, strong) AWSPinpointTargetingVoiceTemplateRequest * _Nullable voiceTemplateRequest; @end /** */ @interface AWSPinpointTargetingUpdateVoiceTemplateResponse : AWSModel /**Provides information about an API request or response.
*/ @property (nonatomic, strong) AWSPinpointTargetingMessageBody * _Nullable messageBody; @end /**Verify OTP Message Response.
*/ @interface AWSPinpointTargetingVerificationResponse : AWSModel /**Specifies whether the OTP is valid or not.
*/ @property (nonatomic, strong) NSNumber * _Nullable valid; @end /** */ @interface AWSPinpointTargetingVerifyOTPMessageRequest : AWSRequest /**The unique ID of your Amazon Pinpoint application.
*/ @property (nonatomic, strong) NSString * _Nullable applicationId; /**Verify OTP message request.
*/ @property (nonatomic, strong) AWSPinpointTargetingVerifyOTPMessageRequestParameters * _Nullable verifyOTPMessageRequestParameters; @end /**Verify OTP message request.
Required parameters: [ReferenceId, Otp, DestinationIdentity] */ @interface AWSPinpointTargetingVerifyOTPMessageRequestParameters : AWSModel /**The destination identity to send OTP to.
*/ @property (nonatomic, strong) NSString * _Nullable destinationIdentity; /**The OTP the end user provided for verification.
*/ @property (nonatomic, strong) NSString * _Nullable otp; /**The reference identifier provided when the OTP was previously sent.
*/ @property (nonatomic, strong) NSString * _Nullable referenceId; @end /** */ @interface AWSPinpointTargetingVerifyOTPMessageResponse : AWSModel /**Verify OTP Message Response.
*/ @property (nonatomic, strong) AWSPinpointTargetingVerificationResponse * _Nullable verificationResponse; @end /**Specifies the status and settings of the voice channel for an application.
*/ @interface AWSPinpointTargetingVoiceChannelRequest : AWSModel /**Specifies whether to enable the voice channel for the application.
*/ @property (nonatomic, strong) NSNumber * _Nullable enabled; @end /**Provides information about the status and settings of the voice channel for an application.
Required parameters: [Platform] */ @interface AWSPinpointTargetingVoiceChannelResponse : AWSModel /**The unique identifier for the application that the voice channel applies to.
*/ @property (nonatomic, strong) NSString * _Nullable applicationId; /**The date and time, in ISO 8601 format, when the voice channel was enabled.
*/ @property (nonatomic, strong) NSString * _Nullable creationDate; /**Specifies whether the voice channel is enabled for the application.
*/ @property (nonatomic, strong) NSNumber * _Nullable enabled; /**(Not used) This property is retained only for backward compatibility.
*/ @property (nonatomic, strong) NSNumber * _Nullable hasCredential; /**(Deprecated) An identifier for the voice channel. This property is retained only for backward compatibility.
*/ @property (nonatomic, strong) NSString * _Nullable identifier; /**Specifies whether the voice channel is archived.
*/ @property (nonatomic, strong) NSNumber * _Nullable isArchived; /**The user who last modified the voice channel.
*/ @property (nonatomic, strong) NSString * _Nullable lastModifiedBy; /**The date and time, in ISO 8601 format, when the voice channel was last modified.
*/ @property (nonatomic, strong) NSString * _Nullable lastModifiedDate; /**The type of messaging or notification platform for the channel. For the voice channel, this value is VOICE.
*/ @property (nonatomic, strong) NSString * _Nullable platform; /**The current version of the voice channel.
*/ @property (nonatomic, strong) NSNumber * _Nullable version; @end /**Specifies the settings for a one-time voice message that's sent directly to an endpoint through the voice channel.
*/ @interface AWSPinpointTargetingVoiceMessage : AWSModel /**The text of the script to use for the voice message.
*/ @property (nonatomic, strong) NSString * _Nullable body; /**The code for the language to use when synthesizing the text of the message script. For a list of supported languages and the code for each one, see the Amazon Polly Developer Guide.
*/ @property (nonatomic, strong) NSString * _Nullable languageCode; /**The long code to send the voice message from. This value should be one of the dedicated long codes that's assigned to your AWS account. Although it isn't required, we recommend that you specify the long code in E.164 format, for example +12065550100, to ensure prompt and accurate delivery of the message.
*/ @property (nonatomic, strong) NSString * _Nullable originationNumber; /**The default message variables to use in the voice message. You can override the default variables with individual address variables.
*/ @property (nonatomic, strong) NSDictionaryThe name of the voice to use when delivering the message. For a list of supported voices, see the Amazon Polly Developer Guide.
*/ @property (nonatomic, strong) NSString * _Nullable voiceId; @end /**Specifies the content and settings for a message template that can be used in messages that are sent through the voice channel.
*/ @interface AWSPinpointTargetingVoiceTemplateRequest : AWSModel /**The text of the script to use in messages that are based on the message template, in plain text format.
*/ @property (nonatomic, strong) NSString * _Nullable body; /**A JSON object that specifies the default values to use for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable. When you create a message that's based on the template, you can override these defaults with message-specific and address-specific variables and values.
*/ @property (nonatomic, strong) NSString * _Nullable defaultSubstitutions; /**The code for the language to use when synthesizing the text of the script in messages that are based on the message template. For a list of supported languages and the code for each one, see the Amazon Polly Developer Guide.
*/ @property (nonatomic, strong) NSString * _Nullable languageCode; /**A custom description of the message template.
*/ @property (nonatomic, strong) NSString * _Nullable templateDescription; /**The name of the voice to use when delivering messages that are based on the message template. For a list of supported voices, see the Amazon Polly Developer Guide.
*/ @property (nonatomic, strong) NSString * _Nullable voiceId; /**As of 22-05-2023 tags has been deprecated for update operations. After this date any value in tags is not processed and an error code is not returned. To manage tags we recommend using either Tags in the API Reference for Amazon Pinpoint, resourcegroupstaggingapi commands in the AWS Command Line Interface Documentation or resourcegroupstaggingapi in the AWS SDK.
(Deprecated) A string-to-string map of key-value pairs that defines the tags to associate with the message template. Each tag consists of a required tag key and an associated tag value.
*/ @property (nonatomic, strong) NSDictionaryProvides 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] */ @interface AWSPinpointTargetingVoiceTemplateResponse : AWSModel /**The Amazon Resource Name (ARN) of the message template.
*/ @property (nonatomic, strong) NSString * _Nullable arn; /**The text of the script that's used in messages that are based on the message template, in plain text format.
*/ @property (nonatomic, strong) NSString * _Nullable body; /**The date, in ISO 8601 format, when the message template was created.
*/ @property (nonatomic, strong) NSString * _Nullable creationDate; /**The JSON object that specifies the default values that are used for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable.
*/ @property (nonatomic, strong) NSString * _Nullable defaultSubstitutions; /**The code for the language that's used when synthesizing the text of the script in messages that are based on the message template. For a list of supported languages and the code for each one, see the Amazon Polly Developer Guide.
*/ @property (nonatomic, strong) NSString * _Nullable languageCode; /**The date, in ISO 8601 format, when the message template was last modified.
*/ @property (nonatomic, strong) NSString * _Nullable lastModifiedDate; /**The custom description of the message template.
*/ @property (nonatomic, strong) NSString * _Nullable templateDescription; /**The name of the message template.
*/ @property (nonatomic, strong) NSString * _Nullable templateName; /**The type of channel that the message template is designed for. For a voice template, this value is VOICE.
*/ @property (nonatomic, assign) AWSPinpointTargetingTemplateType templateType; /**The unique identifier, as an integer, for the active version of the message template, or the version of the template that you specified by using the version parameter in your request.
*/ @property (nonatomic, strong) NSString * _Nullable version; /**The name of the voice that's used when delivering messages that are based on the message template. For a list of supported voices, see the Amazon Polly Developer Guide.
*/ @property (nonatomic, strong) NSString * _Nullable voiceId; /**A string-to-string map of key-value pairs that identifies the tags that are associated with the message template. Each tag consists of a required tag key and an associated tag value.
*/ @property (nonatomic, strong) NSDictionarySpecifies 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.
*/ @interface AWSPinpointTargetingWaitActivity : AWSModel /**The unique identifier for the next activity to perform, after performing the wait activity.
*/ @property (nonatomic, strong) NSString * _Nullable nextActivity; /**The amount of time to wait or the date and time when the activity moves participants to the next activity in the journey.
*/ @property (nonatomic, strong) AWSPinpointTargetingWaitTime * _Nullable waitTime; @end /**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.
*/ @interface AWSPinpointTargetingWaitTime : AWSModel /**The amount of time to wait, as a duration in ISO 8601 format, before determining whether the activity's conditions have been met or moving participants to the next activity in the journey.
*/ @property (nonatomic, strong) NSString * _Nullable waitFor; /**The date and time, in ISO 8601 format, when Amazon Pinpoint determines whether the activity's conditions have been met or the activity moves participants to the next activity in the journey.
*/ @property (nonatomic, strong) NSString * _Nullable waitUntil; @end /**Specifies the default settings for an application.
*/ @interface AWSPinpointTargetingWriteApplicationSettingsRequest : AWSModel /**The settings for the AWS Lambda function to invoke by default as a code hook for campaigns in the application. You can use this hook to customize segments that are used by campaigns in the application.
To override these settings and define custom settings for a specific campaign, use the CampaignHook object of the
Specifies whether to enable application-related alarms in Amazon CloudWatch.
*/ @property (nonatomic, strong) NSNumber * _Nullable cloudWatchMetricsEnabled; /** */ @property (nonatomic, strong) NSNumber * _Nullable eventTaggingEnabled; /**The default sending limits for campaigns in the application. To override these limits and define custom limits for a specific campaign or journey, use the
The default quiet time for campaigns in the application. Quiet time is a specific time range when messages aren't sent to endpoints, if all the following conditions are met:
The EndpointDemographic.Timezone property of the endpoint is set to a valid value.
The current time in the endpoint's time zone is later than or equal to the time specified by the QuietTime.Start property for the application (or a campaign or journey that has custom quiet time settings).
The current time in the endpoint's time zone is earlier than or equal to the time specified by the QuietTime.End property for the application (or a campaign or journey that has custom quiet time settings).
If any of the preceding conditions isn't met, the endpoint will receive messages from a campaign or journey, even if quiet time is enabled.
To override the default quiet time settings for a specific campaign or journey, use the
Specifies the configuration and other settings for a campaign.
*/ @interface AWSPinpointTargetingWriteCampaignRequest : AWSModel /**An array of requests that defines additional treatments for the campaign, in addition to the default treatment for the campaign.
*/ @property (nonatomic, strong) NSArrayThe delivery configuration settings for sending the campaign through a custom channel. This object is required if the MessageConfiguration object for the campaign specifies a CustomMessage object.
*/ @property (nonatomic, strong) AWSPinpointTargetingCustomDeliveryConfiguration * _Nullable customDeliveryConfiguration; /**A custom description of the campaign.
*/ @property (nonatomic, strong) NSString * _Nullable detail; /**The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.
*/ @property (nonatomic, strong) NSNumber * _Nullable holdoutPercent; /**The settings for the AWS Lambda function to invoke as a code hook for the campaign. You can use this hook to customize the segment that's used by the campaign.
*/ @property (nonatomic, strong) AWSPinpointTargetingCampaignHook * _Nullable hook; /**Specifies whether to pause the campaign. A paused campaign doesn't run unless you resume it by changing this value to false.
*/ @property (nonatomic, strong) NSNumber * _Nullable isPaused; /**The messaging limits for the campaign.
*/ @property (nonatomic, strong) AWSPinpointTargetingCampaignLimits * _Nullable limits; /**The message configuration settings for the campaign.
*/ @property (nonatomic, strong) AWSPinpointTargetingMessageConfiguration * _Nullable messageConfiguration; /**A custom name for the campaign.
*/ @property (nonatomic, strong) NSString * _Nullable name; /**Defines the priority of the campaign, used to decide the order of messages displayed to user if there are multiple messages scheduled to be displayed at the same moment.
*/ @property (nonatomic, strong) NSNumber * _Nullable priority; /**The schedule settings for the campaign.
*/ @property (nonatomic, strong) AWSPinpointTargetingSchedule * _Nullable schedule; /**The unique identifier for the segment to associate with the campaign.
*/ @property (nonatomic, strong) NSString * _Nullable segmentId; /**The version of the segment to associate with the campaign.
*/ @property (nonatomic, strong) NSNumber * _Nullable segmentVersion; /**The message template to use for the campaign.
*/ @property (nonatomic, strong) AWSPinpointTargetingTemplateConfiguration * _Nullable templateConfiguration; /**A custom description of the default treatment for the campaign.
*/ @property (nonatomic, strong) NSString * _Nullable treatmentDescription; /**A custom name of the default treatment for the campaign, if the campaign has multiple treatments. A treatment is a variation of a campaign that's used for A/B testing.
*/ @property (nonatomic, strong) NSString * _Nullable treatmentName; /**As of 22-05-2023 tags has been deprecated for update operations. After this date any value in tags is not processed and an error code is not returned. To manage tags we recommend using either Tags in the API Reference for Amazon Pinpoint, resourcegroupstaggingapi commands in the AWS Command Line Interface Documentation or resourcegroupstaggingapi in the AWS SDK.
(Deprecated) A string-to-string map of key-value pairs that defines the tags to associate with the campaign. Each tag consists of a required tag key and an associated tag value.
*/ @property (nonatomic, strong) NSDictionarySpecifies 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] */ @interface AWSPinpointTargetingWriteEventStream : AWSModel /**The Amazon Resource Name (ARN) of the Amazon Kinesis data stream or Amazon Kinesis Data Firehose delivery stream that you want to publish event data to.
For a Kinesis data stream, the ARN format is: arn:aws:kinesis:
For a Kinesis Data Firehose delivery stream, the ARN format is: arn:aws:firehose:
The AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to publish event data to the stream in your AWS account.
*/ @property (nonatomic, strong) NSString * _Nullable roleArn; @end /**Specifies the configuration and other settings for a journey.
Required parameters: [Name] */ @interface AWSPinpointTargetingWriteJourneyRequest : AWSModel /**A map that contains a set of Activity objects, one object for each activity in the journey. For each Activity object, the key is the unique identifier (string) for an activity and the value is the settings for the activity. An activity identifier can contain a maximum of 100 characters. The characters must be alphanumeric characters.
*/ @property (nonatomic, strong) NSDictionaryThe time when journey will stop sending messages. QuietTime should be configured first and SendingSchedule should be set to true.
*/ @property (nonatomic, strong) AWSPinpointTargetingClosedDays * _Nullable closedDays; /**The date, in ISO 8601 format, when the journey was created.
*/ @property (nonatomic, strong) NSString * _Nullable creationDate; /**The channel-specific configurations for the journey.
*/ @property (nonatomic, strong) AWSPinpointTargetingJourneyChannelSettings * _Nullable journeyChannelSettings; /**The date, in ISO 8601 format, when the journey was last modified.
*/ @property (nonatomic, strong) NSString * _Nullable lastModifiedDate; /**The messaging and entry limits for the journey.
*/ @property (nonatomic, strong) AWSPinpointTargetingJourneyLimits * _Nullable limits; /**Specifies whether the journey's scheduled start and end times use each participant's local time. To base the schedule on each participant's local time, set this value to true.
*/ @property (nonatomic, strong) NSNumber * _Nullable localTime; /**The name of the journey. A journey name can contain a maximum of 150 characters. The characters can be alphanumeric characters or symbols, such as underscores (_) or hyphens (-). A journey name can't contain any spaces.
*/ @property (nonatomic, strong) NSString * _Nullable name; /**The time when journey allow to send messages. QuietTime should be configured first and SendingSchedule should be set to true.
*/ @property (nonatomic, strong) AWSPinpointTargetingOpenHours * _Nullable openHours; /**The quiet time settings for the journey. Quiet time is a specific time range when a journey doesn't send messages to participants, if all the following conditions are met:
The EndpointDemographic.Timezone property of the endpoint for the participant is set to a valid value.
The current time in the participant's time zone is later than or equal to the time specified by the QuietTime.Start property for the journey.
The current time in the participant's time zone is earlier than or equal to the time specified by the QuietTime.End property for the journey.
If any of the preceding conditions isn't met, the participant will receive messages from the journey, even if quiet time is enabled.
*/ @property (nonatomic, strong) AWSPinpointTargetingQuietTime * _Nullable quietTime; /**The frequency with which Amazon Pinpoint evaluates segment and event data for the journey, as a duration in ISO 8601 format.
*/ @property (nonatomic, strong) NSString * _Nullable refreshFrequency; /**Indicates whether the journey participants should be refreshed when a segment is updated.
*/ @property (nonatomic, strong) NSNumber * _Nullable refreshOnSegmentUpdate; /**The schedule settings for the journey.
*/ @property (nonatomic, strong) AWSPinpointTargetingJourneySchedule * _Nullable schedule; /**Indicates if journey has Advance Quiet Time enabled. This flag should be set to true in order to allow using OpenHours and ClosedDays.
*/ @property (nonatomic, strong) NSNumber * _Nullable sendingSchedule; /**The unique identifier for the first activity in the journey. The identifier for this activity can contain a maximum of 128 characters. The characters must be alphanumeric characters.
*/ @property (nonatomic, strong) NSString * _Nullable startActivity; /**The segment that defines which users are participants in the journey.
*/ @property (nonatomic, strong) AWSPinpointTargetingStartCondition * _Nullable startCondition; /**The status of the journey. Valid values are:
DRAFT - Saves the journey and doesn't publish it.
ACTIVE - Saves and publishes the journey. Depending on the journey's schedule, the journey starts running immediately or at the scheduled start time. If a journey's status is ACTIVE, you can't add, change, or remove activities from it.
PAUSED, CANCELLED, COMPLETED, and CLOSED states are not supported in requests to create or update a journey. To cancel, pause, or resume a journey, use the
An array of time zone estimation methods, if any, to use for determining an Endpoints time zone if the Endpoint does not have a value for the Demographic.Timezone attribute.
PHONE_NUMBER - A time zone is determined based on the Endpoint.Address and Endpoint.Location.Country.
POSTAL_CODE - A time zone is determined based on the Endpoint.Location.PostalCode and Endpoint.Location.Country.
POSTAL_CODE detection is only supported in the United States, United Kingdom, Australia, New Zealand, Canada, France, Italy, Spain, Germany and in regions where Amazon Pinpoint is available.
Specifies whether endpoints in quiet hours should enter a wait till the end of their quiet hours.
*/ @property (nonatomic, strong) NSNumber * _Nullable waitForQuietTime; @end /**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.
*/ @interface AWSPinpointTargetingWriteSegmentRequest : AWSModel /**The criteria that define the dimensions for the segment.
*/ @property (nonatomic, strong) AWSPinpointTargetingSegmentDimensions * _Nullable dimensions; /**The name of the segment.
*/ @property (nonatomic, strong) NSString * _Nullable name; /**The segment group to use and the dimensions to apply to the group's base segments in order to build the segment. A segment group can consist of zero or more base segments. Your request can include only one segment group.
*/ @property (nonatomic, strong) AWSPinpointTargetingSegmentGroupList * _Nullable segmentGroups; /**As of 22-05-2023 tags has been deprecated for update operations. After this date any value in tags is not processed and an error code is not returned. To manage tags we recommend using either Tags in the API Reference for Amazon Pinpoint, resourcegroupstaggingapi commands in the AWS Command Line Interface Documentation or resourcegroupstaggingapi in the AWS SDK.
(Deprecated) A string-to-string map of key-value pairs that defines the tags to associate with the segment. Each tag consists of a required tag key and an associated tag value.
*/ @property (nonatomic, strong) NSDictionarySpecifies 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] */ @interface AWSPinpointTargetingWriteTreatmentResource : AWSModel /**The delivery configuration settings for sending the treatment through a custom channel. This object is required if the MessageConfiguration object for the treatment specifies a CustomMessage object.
*/ @property (nonatomic, strong) AWSPinpointTargetingCustomDeliveryConfiguration * _Nullable customDeliveryConfiguration; /**The message configuration settings for the treatment.
*/ @property (nonatomic, strong) AWSPinpointTargetingMessageConfiguration * _Nullable messageConfiguration; /**The schedule settings for the treatment.
*/ @property (nonatomic, strong) AWSPinpointTargetingSchedule * _Nullable schedule; /**The allocated percentage of users (segment members) to send the treatment to.
*/ @property (nonatomic, strong) NSNumber * _Nullable sizePercent; /**The message template to use for the treatment.
*/ @property (nonatomic, strong) AWSPinpointTargetingTemplateConfiguration * _Nullable templateConfiguration; /**A custom description of the treatment.
*/ @property (nonatomic, strong) NSString * _Nullable treatmentDescription; /**A custom name for the treatment.
*/ @property (nonatomic, strong) NSString * _Nullable treatmentName; @end /**Specifies the start and end time for OpenHours.
*/ @interface AWSPinpointTargetingOpenHoursRule : AWSModel /**The end of the scheduled time, in ISO 8601 format, when the channel can't send messages.
*/ @property (nonatomic, strong) NSString * _Nullable endTime; /**The start of the scheduled time, in ISO 8601 format, when the channel can send messages.
*/ @property (nonatomic, strong) NSString * _Nullable startTime; @end /**Specifies the times when message are allowed to be sent to endpoints.
*/ @interface AWSPinpointTargetingOpenHours : AWSModel /**Specifies the schedule settings for the custom channel.
*/ @property (nonatomic, strong) NSDictionarySpecifies the schedule settings for the email channel.
*/ @property (nonatomic, strong) NSDictionarySpecifies the schedule settings for the push channel.
*/ @property (nonatomic, strong) NSDictionarySpecifies the schedule settings for the SMS channel.
*/ @property (nonatomic, strong) NSDictionarySpecifies the schedule settings for the voice channel.
*/ @property (nonatomic, strong) NSDictionarySpecifies the rule settings for when messages can't be sent.
*/ @interface AWSPinpointTargetingClosedDaysRule : AWSModel /**End DateTime ISO 8601 format
*/ @property (nonatomic, strong) NSString * _Nullable endDateTime; /**The name of the closed day rule.
*/ @property (nonatomic, strong) NSString * _Nullable name; /**Start DateTime ISO 8601 format
*/ @property (nonatomic, strong) NSString * _Nullable startDateTime; @end /**The time when a journey will not send messages. QuietTime should be configured first and SendingSchedule should be set to true.
*/ @interface AWSPinpointTargetingClosedDays : AWSModel /**Rules for the Custom channel.
*/ @property (nonatomic, strong) NSArrayRules for the Email channel.
*/ @property (nonatomic, strong) NSArrayRules for the Push channel.
*/ @property (nonatomic, strong) NSArrayRules for the SMS channel.
*/ @property (nonatomic, strong) NSArrayRules for the Voice channel.
*/ @property (nonatomic, strong) NSArray