AWSPinpointTargetingWriteJourneyRequest

Objective-C

@interface AWSPinpointTargetingWriteJourneyRequest

Swift

class AWSPinpointTargetingWriteJourneyRequest

Specifies the configuration and other settings for a journey.

Required parameters: [Name]

  • 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSDictionary<NSString *, AWSPinpointTargetingActivity *> *_Nullable activities;

    Swift

    var activities: [String : AWSPinpointTargetingActivity]? { get set }

  • The time when journey will stop sending messages. QuietTime should be configured first and SendingSchedule should be set to true.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSPinpointTargetingClosedDays *_Nullable closedDays;

    Swift

    var closedDays: AWSPinpointTargetingClosedDays? { get set }

  • The date, in ISO 8601 format, when the journey was created.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable creationDate;

    Swift

    var creationDate: String? { get set }

  • The channel-specific configurations for the journey.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSPinpointTargetingJourneyChannelSettings *_Nullable journeyChannelSettings;

    Swift

    var journeyChannelSettings: AWSPinpointTargetingJourneyChannelSettings? { get set }

  • The date, in ISO 8601 format, when the journey was last modified.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable lastModifiedDate;

    Swift

    var lastModifiedDate: String? { get set }

  • The messaging and entry limits for the journey.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSPinpointTargetingJourneyLimits *_Nullable limits;

    Swift

    var limits: AWSPinpointTargetingJourneyLimits? { get set }

  • 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable localTime;

    Swift

    var localTime: NSNumber? { get set }

  • 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable name;

    Swift

    var name: String? { get set }

  • The time when journey allow to send messages. QuietTime should be configured first and SendingSchedule should be set to true.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSPinpointTargetingOpenHours *_Nullable openHours;

    Swift

    var openHours: AWSPinpointTargetingOpenHours? { get set }

  • 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSPinpointTargetingQuietTime *_Nullable quietTime;

    Swift

    var quietTime: AWSPinpointTargetingQuietTime? { get set }

  • The frequency with which Amazon Pinpoint evaluates segment and event data for the journey, as a duration in ISO 8601 format.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable refreshFrequency;

    Swift

    var refreshFrequency: String? { get set }

  • Indicates whether the journey participants should be refreshed when a segment is updated.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable refreshOnSegmentUpdate;

    Swift

    var refreshOnSegmentUpdate: NSNumber? { get set }

  • The schedule settings for the journey.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSPinpointTargetingJourneySchedule *_Nullable schedule;

    Swift

    var schedule: AWSPinpointTargetingJourneySchedule? { get set }

  • Indicates if journey has Advance Quiet Time enabled. This flag should be set to true in order to allow using OpenHours and ClosedDays.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable sendingSchedule;

    Swift

    var sendingSchedule: NSNumber? { get set }

  • 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable startActivity;

    Swift

    var startActivity: String? { get set }

  • The segment that defines which users are participants in the journey.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSPinpointTargetingStartCondition *_Nullable startCondition;

    Swift

    var startCondition: AWSPinpointTargetingStartCondition? { get set }

  • 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 Journey State resource.

    Declaration

    Objective-C

    @property (nonatomic) AWSPinpointTargetingState state;

    Swift

    var state: AWSPinpointTargetingState { get set }

  • 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSArray<NSString *> *_Nullable timezoneEstimationMethods;

    Swift

    var timezoneEstimationMethods: [String]? { get set }

  • Specifies whether endpoints in quiet hours should enter a wait till the end of their quiet hours.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable waitForQuietTime;

    Swift

    var waitForQuietTime: NSNumber? { get set }