Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Pinpoint.Types.Activity

Description

Synopsis

data Activity = Activity' {
- conditionalSplit :: Maybe ConditionalSplitActivity
- email :: Maybe EmailMessageActivity
- multiCondition :: Maybe MultiConditionalSplitActivity
- contactCenter :: Maybe ContactCenterActivity
- custom :: Maybe CustomMessageActivity
- wait :: Maybe WaitActivity
- randomSplit :: Maybe RandomSplitActivity
- holdout :: Maybe HoldoutActivity
- sms :: Maybe SMSMessageActivity
- push :: Maybe PushMessageActivity
- description :: Maybe Text
}
newActivity :: Activity
activity_conditionalSplit :: Lens' Activity (Maybe ConditionalSplitActivity)
activity_email :: Lens' Activity (Maybe EmailMessageActivity)
activity_multiCondition :: Lens' Activity (Maybe MultiConditionalSplitActivity)
activity_contactCenter :: Lens' Activity (Maybe ContactCenterActivity)
activity_custom :: Lens' Activity (Maybe CustomMessageActivity)
activity_wait :: Lens' Activity (Maybe WaitActivity)
activity_randomSplit :: Lens' Activity (Maybe RandomSplitActivity)
activity_holdout :: Lens' Activity (Maybe HoldoutActivity)
activity_sms :: Lens' Activity (Maybe SMSMessageActivity)
activity_push :: Lens' Activity (Maybe PushMessageActivity)
activity_description :: Lens' Activity (Maybe Text)

Documentation

data Activity Source #

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

See: newActivity smart constructor.

Constructors

Activity'

Fields

conditionalSplit :: Maybe ConditionalSplitActivity
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.
email :: Maybe EmailMessageActivity
The settings for an email activity. This type of activity sends an email message to participants.
multiCondition :: Maybe MultiConditionalSplitActivity
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.
contactCenter :: Maybe ContactCenterActivity
The settings for a connect activity. This type of activity initiates a contact center call to participants.
custom :: Maybe CustomMessageActivity
The settings for a custom message activity. This type of activity calls an AWS Lambda function or web hook that sends messages to participants.
wait :: Maybe WaitActivity
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.
randomSplit :: Maybe RandomSplitActivity
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.
holdout :: Maybe HoldoutActivity
The settings for a holdout activity. This type of activity stops a journey for a specified percentage of participants.
sms :: Maybe SMSMessageActivity
The settings for an SMS activity. This type of activity sends a text message to participants.
push :: Maybe PushMessageActivity
The settings for a push notification activity. This type of activity sends a push notification to participants.
description :: Maybe Text
The custom description of the activity.

Instances

Instances details

Eq Activity Source #
Instance details Defined in Amazonka.Pinpoint.Types.Activity Methods (==) :: Activity -> Activity -> Bool # (/=) :: Activity -> Activity -> Bool #
Read Activity Source #
Instance details Defined in Amazonka.Pinpoint.Types.Activity Methods readsPrec :: Int -> ReadS Activity # readList :: ReadS [Activity] # readPrec :: ReadPrec Activity # readListPrec :: ReadPrec [Activity] #
Show Activity Source #
Instance details Defined in Amazonka.Pinpoint.Types.Activity Methods showsPrec :: Int -> Activity -> ShowS # show :: Activity -> String # showList :: [Activity] -> ShowS #
Generic Activity Source #
Instance details Defined in Amazonka.Pinpoint.Types.Activity Associated Types type Rep Activity :: Type -> Type # Methods from :: Activity -> Rep Activity x # to :: Rep Activity x -> Activity #
NFData Activity Source #
Instance details Defined in Amazonka.Pinpoint.Types.Activity Methods rnf :: Activity -> () #
Hashable Activity Source #
Instance details Defined in Amazonka.Pinpoint.Types.Activity Methods hashWithSalt :: Int -> Activity -> Int # hash :: Activity -> Int #
ToJSON Activity Source #
Instance details Defined in Amazonka.Pinpoint.Types.Activity Methods toJSON :: Activity -> Value # toEncoding :: Activity -> Encoding # toJSONList :: [Activity] -> Value # toEncodingList :: [Activity] -> Encoding #
FromJSON Activity Source #
Instance details Defined in Amazonka.Pinpoint.Types.Activity Methods parseJSON :: Value -> Parser Activity # parseJSONList :: Value -> Parser [Activity] #
type Rep Activity Source #
Instance details Defined in Amazonka.Pinpoint.Types.Activity type Rep Activity = D1 ('MetaData "Activity" "Amazonka.Pinpoint.Types.Activity" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "Activity'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "conditionalSplit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ConditionalSplitActivity)) :: S1 ('MetaSel ('Just "email") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EmailMessageActivity))) :: (S1 ('MetaSel ('Just "multiCondition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MultiConditionalSplitActivity)) :: (S1 ('MetaSel ('Just "contactCenter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ContactCenterActivity)) :: S1 ('MetaSel ('Just "custom") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CustomMessageActivity))))) :: ((S1 ('MetaSel ('Just "wait") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe WaitActivity)) :: (S1 ('MetaSel ('Just "randomSplit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RandomSplitActivity)) :: S1 ('MetaSel ('Just "holdout") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe HoldoutActivity)))) :: (S1 ('MetaSel ('Just "sms") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SMSMessageActivity)) :: (S1 ('MetaSel ('Just "push") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PushMessageActivity)) :: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))))

newActivity :: Activity Source #

Create a value of Activity with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:conditionalSplit:Activity', activity_conditionalSplit - 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.

$sel:email:Activity', activity_email - The settings for an email activity. This type of activity sends an email message to participants.

$sel:multiCondition:Activity', activity_multiCondition - 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.

$sel:contactCenter:Activity', activity_contactCenter - The settings for a connect activity. This type of activity initiates a contact center call to participants.

$sel:custom:Activity', activity_custom - The settings for a custom message activity. This type of activity calls an AWS Lambda function or web hook that sends messages to participants.

$sel:wait:Activity', activity_wait - 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.

$sel:randomSplit:Activity', activity_randomSplit - 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.

$sel:holdout:Activity', activity_holdout - The settings for a holdout activity. This type of activity stops a journey for a specified percentage of participants.

$sel:sms:Activity', activity_sms - The settings for an SMS activity. This type of activity sends a text message to participants.

$sel:push:Activity', activity_push - The settings for a push notification activity. This type of activity sends a push notification to participants.

$sel:description:Activity', activity_description - The custom description of the activity.

activity_conditionalSplit :: Lens' Activity (Maybe ConditionalSplitActivity) Source #

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.

activity_email :: Lens' Activity (Maybe EmailMessageActivity) Source #

The settings for an email activity. This type of activity sends an email message to participants.

activity_multiCondition :: Lens' Activity (Maybe MultiConditionalSplitActivity) Source #

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.

activity_contactCenter :: Lens' Activity (Maybe ContactCenterActivity) Source #

The settings for a connect activity. This type of activity initiates a contact center call to participants.

activity_custom :: Lens' Activity (Maybe CustomMessageActivity) Source #

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

activity_wait :: Lens' Activity (Maybe WaitActivity) Source #

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.

activity_randomSplit :: Lens' Activity (Maybe RandomSplitActivity) Source #

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.

activity_holdout :: Lens' Activity (Maybe HoldoutActivity) Source #

The settings for a holdout activity. This type of activity stops a journey for a specified percentage of participants.

activity_sms :: Lens' Activity (Maybe SMSMessageActivity) Source #

The settings for an SMS activity. This type of activity sends a text message to participants.

activity_push :: Lens' Activity (Maybe PushMessageActivity) Source #

The settings for a push notification activity. This type of activity sends a push notification to participants.

activity_description :: Lens' Activity (Maybe Text) Source #

The custom description of the activity.