You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::Pinpoint::Types::Activity

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing Activity as input to an Aws::Client method, you can use a vanilla Hash:

{
  custom: {
    delivery_uri: "__string",
    endpoint_types: ["PUSH"], # accepts PUSH, GCM, APNS, APNS_SANDBOX, APNS_VOIP, APNS_VOIP_SANDBOX, ADM, SMS, VOICE, EMAIL, BAIDU, CUSTOM
    message_config: {
      data: "__string",
    },
    next_activity: "__string",
    template_name: "__string",
    template_version: "__string",
  },
  conditional_split: {
    condition: {
      conditions: [
        {
          event_condition: {
            dimensions: {
              attributes: {
                "__string" => {
                  attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
                  values: ["__string"], # required
                },
              },
              event_type: {
                dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
                values: ["__string"], # required
              },
              metrics: {
                "__string" => {
                  comparison_operator: "__string", # required
                  value: 1.0, # required
                },
              },
            },
            message_activity: "__string",
          },
          segment_condition: {
            segment_id: "__string", # required
          },
          segment_dimensions: {
            attributes: {
              "__string" => {
                attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
                values: ["__string"], # required
              },
            },
            behavior: {
              recency: {
                duration: "HR_24", # required, accepts HR_24, DAY_7, DAY_14, DAY_30
                recency_type: "ACTIVE", # required, accepts ACTIVE, INACTIVE
              },
            },
            demographic: {
              app_version: {
                dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
                values: ["__string"], # required
              },
              channel: {
                dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
                values: ["__string"], # required
              },
              device_type: {
                dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
                values: ["__string"], # required
              },
              make: {
                dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
                values: ["__string"], # required
              },
              model: {
                dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
                values: ["__string"], # required
              },
              platform: {
                dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
                values: ["__string"], # required
              },
            },
            location: {
              country: {
                dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
                values: ["__string"], # required
              },
              gps_point: {
                coordinates: { # required
                  latitude: 1.0, # required
                  longitude: 1.0, # required
                },
                range_in_kilometers: 1.0,
              },
            },
            metrics: {
              "__string" => {
                comparison_operator: "__string", # required
                value: 1.0, # required
              },
            },
            user_attributes: {
              "__string" => {
                attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
                values: ["__string"], # required
              },
            },
          },
        },
      ],
      operator: "ALL", # accepts ALL, ANY
    },
    evaluation_wait_time: {
      wait_for: "__string",
      wait_until: "__string",
    },
    false_activity: "__string",
    true_activity: "__string",
  },
  description: "__string",
  email: {
    message_config: {
      from_address: "__string",
    },
    next_activity: "__string",
    template_name: "__string",
    template_version: "__string",
  },
  holdout: {
    next_activity: "__string",
    percentage: 1, # required
  },
  multi_condition: {
    branches: [
      {
        condition: {
          event_condition: {
            dimensions: {
              attributes: {
                "__string" => {
                  attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
                  values: ["__string"], # required
                },
              },
              event_type: {
                dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
                values: ["__string"], # required
              },
              metrics: {
                "__string" => {
                  comparison_operator: "__string", # required
                  value: 1.0, # required
                },
              },
            },
            message_activity: "__string",
          },
          segment_condition: {
            segment_id: "__string", # required
          },
          segment_dimensions: {
            attributes: {
              "__string" => {
                attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
                values: ["__string"], # required
              },
            },
            behavior: {
              recency: {
                duration: "HR_24", # required, accepts HR_24, DAY_7, DAY_14, DAY_30
                recency_type: "ACTIVE", # required, accepts ACTIVE, INACTIVE
              },
            },
            demographic: {
              app_version: {
                dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
                values: ["__string"], # required
              },
              channel: {
                dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
                values: ["__string"], # required
              },
              device_type: {
                dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
                values: ["__string"], # required
              },
              make: {
                dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
                values: ["__string"], # required
              },
              model: {
                dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
                values: ["__string"], # required
              },
              platform: {
                dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
                values: ["__string"], # required
              },
            },
            location: {
              country: {
                dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
                values: ["__string"], # required
              },
              gps_point: {
                coordinates: { # required
                  latitude: 1.0, # required
                  longitude: 1.0, # required
                },
                range_in_kilometers: 1.0,
              },
            },
            metrics: {
              "__string" => {
                comparison_operator: "__string", # required
                value: 1.0, # required
              },
            },
            user_attributes: {
              "__string" => {
                attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
                values: ["__string"], # required
              },
            },
          },
        },
        next_activity: "__string",
      },
    ],
    default_activity: "__string",
    evaluation_wait_time: {
      wait_for: "__string",
      wait_until: "__string",
    },
  },
  push: {
    message_config: {
      time_to_live: "__string",
    },
    next_activity: "__string",
    template_name: "__string",
    template_version: "__string",
  },
  random_split: {
    branches: [
      {
        next_activity: "__string",
        percentage: 1,
      },
    ],
  },
  sms: {
    message_config: {
      message_type: "TRANSACTIONAL", # accepts TRANSACTIONAL, PROMOTIONAL
      sender_id: "__string",
    },
    next_activity: "__string",
    template_name: "__string",
    template_version: "__string",
  },
  wait: {
    next_activity: "__string",
    wait_time: {
      wait_for: "__string",
      wait_until: "__string",
    },
  },
}

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

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#conditional_split ⇒ Types::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.

Returns:

#custom ⇒ Types::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.

Returns:

#description ⇒ String

The custom description of the activity.

Returns:

  • (String) —

    The custom description of the activity.

#email ⇒ Types::EmailMessageActivity

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

Returns:

#holdout ⇒ Types::HoldoutActivity

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

Returns:

#multi_condition ⇒ Types::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.

Returns:

#push ⇒ Types::PushMessageActivity

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

Returns:

#random_split ⇒ Types::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.

Returns:

#sms ⇒ Types::SMSMessageActivity

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

Returns:

#wait ⇒ Types::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.

Returns: