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

Class: Aws::Pinpoint::Types::SegmentGroupList

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

Overview

Note:

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

{
  groups: [
    {
      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
            },
          },
        },
      ],
      source_segments: [
        {
          id: "__string", # required
          version: 1,
        },
      ],
      source_type: "ALL", # accepts ALL, ANY, NONE
      type: "ALL", # accepts ALL, ANY, NONE
    },
  ],
  include: "ALL", # accepts ALL, ANY, NONE
}

Specifies the settings that define the relationships between segment groups for a segment.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#groups ⇒ Array<Types::SegmentGroup>

An array that defines the set of segment criteria to evaluate when handling segment groups for the segment.

Returns:

  • (Array<Types::SegmentGroup>) —

    An array that defines the set of segment criteria to evaluate when handling segment groups for the segment.

#include ⇒ String

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

Possible values:

  • ALL
  • ANY
  • NONE

Returns:

  • (String) —

    Specifies how to handle multiple segment groups for the segment.