Struct aws_sdk_pinpoint::model::JourneyResponse

#[non_exhaustive]
pub struct JourneyResponse {

    pub activities: Option<HashMap<String, Activity>>,
    pub application_id: Option<String>,
    pub creation_date: Option<String>,
    pub id: Option<String>,
    pub last_modified_date: Option<String>,
    pub limits: Option<JourneyLimits>,
    pub local_time: bool,
    pub name: Option<String>,
    pub quiet_time: Option<QuietTime>,
    pub refresh_frequency: Option<String>,
    pub schedule: Option<JourneySchedule>,
    pub start_activity: Option<String>,
    pub start_condition: Option<StartCondition>,
    pub state: Option<State>,
    pub tags: Option<HashMap<String, String>>,
    pub wait_for_quiet_time: bool,
    pub refresh_on_segment_update: bool,
    pub journey_channel_settings: Option<JourneyChannelSettings>,
}

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

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

activities: Option<HashMap<String, Activity>>

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.

application_id: Option<String>

The unique identifier for the application that the journey applies to.

creation_date: Option<String>

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

id: Option<String>

The unique identifier for the journey.

last_modified_date: Option<String>

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

limits: Option<JourneyLimits>

The messaging and entry limits for the journey.

local_time: bool

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.

name: Option<String>

The name of the journey.

quiet_time: Option<QuietTime>

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.

refresh_frequency: Option<String>

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

schedule: Option<JourneySchedule>

The schedule settings for the journey.

start_activity: Option<String>

The unique identifier for the first activity in the journey.

start_condition: Option<StartCondition>

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

state: Option<State>

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.

tags: Option<HashMap<String, String>>

This object is not used or supported.

wait_for_quiet_time: bool

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

refresh_on_segment_update: bool

Specifies whether a journey should be refreshed on segment update.

journey_channel_settings: Option<JourneyChannelSettings>

The channel-specific configurations for the journey.

Implementations

impl JourneyResponse

pub fn activities(&self) -> Option<&HashMap<String, Activity>>

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.

pub fn application_id(&self) -> Option<&str>

The unique identifier for the application that the journey applies to.

pub fn creation_date(&self) -> Option<&str>

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

pub fn id(&self) -> Option<&str>

The unique identifier for the journey.

pub fn last_modified_date(&self) -> Option<&str>

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

pub fn limits(&self) -> Option<&JourneyLimits>

The messaging and entry limits for the journey.

pub fn local_time(&self) -> bool

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.

pub fn name(&self) -> Option<&str>

The name of the journey.

pub fn quiet_time(&self) -> Option<&QuietTime>

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.

pub fn refresh_frequency(&self) -> Option<&str>

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

pub fn schedule(&self) -> Option<&JourneySchedule>

The schedule settings for the journey.

pub fn start_activity(&self) -> Option<&str>

The unique identifier for the first activity in the journey.

pub fn start_condition(&self) -> Option<&StartCondition>

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

pub fn state(&self) -> Option<&State>

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.

pub fn tags(&self) -> Option<&HashMap<String, String>>

This object is not used or supported.

pub fn wait_for_quiet_time(&self) -> bool

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

pub fn refresh_on_segment_update(&self) -> bool

Specifies whether a journey should be refreshed on segment update.

pub fn journey_channel_settings(&self) -> Option<&JourneyChannelSettings>

The channel-specific configurations for the journey.

impl JourneyResponse

pub fn builder() -> Builder

Creates a new builder-style object to manufacture JourneyResponse

Trait Implementations

impl Clone for JourneyResponse

fn clone(&self) -> JourneyResponse

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for JourneyResponse

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq<JourneyResponse> for JourneyResponse

fn eq(&self, other: &JourneyResponse) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &JourneyResponse) -> bool

This method tests for !=.

impl StructuralPartialEq for JourneyResponse