Class: Aws::Pinpoint::Types::WriteSegmentRequest

Inherits:

Struct

• Object
• Struct
• Aws::Pinpoint::Types::WriteSegmentRequest

Includes:

Structure

Defined in:

lib/aws-sdk-pinpoint/types.rb

Overview

Note:

When making an API call, you may pass WriteSegmentRequest data as a hash:

{
  dimensions: {
    attributes: {
      "__string" => {
        attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
        values: ["__string"],
      },
    },
    behavior: {
      recency: {
        duration: "HR_24", # accepts HR_24, DAY_7, DAY_14, DAY_30
        recency_type: "ACTIVE", # accepts ACTIVE, INACTIVE
      },
    },
    demographic: {
      app_version: {
        dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
        values: ["__string"],
      },
      channel: {
        dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
        values: ["__string"],
      },
      device_type: {
        dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
        values: ["__string"],
      },
      make: {
        dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
        values: ["__string"],
      },
      model: {
        dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
        values: ["__string"],
      },
      platform: {
        dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
        values: ["__string"],
      },
    },
    location: {
      country: {
        dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
        values: ["__string"],
      },
      gps_point: {
        coordinates: {
          latitude: 1.0,
          longitude: 1.0,
        },
        range_in_kilometers: 1.0,
      },
    },
    metrics: {
      "__string" => {
        comparison_operator: "__string",
        value: 1.0,
      },
    },
    user_attributes: {
      "__string" => {
        attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
        values: ["__string"],
      },
    },
  },
  name: "__string",
  segment_groups: {
    groups: [
      {
        dimensions: [
          {
            attributes: {
              "__string" => {
                attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
                values: ["__string"],
              },
            },
            behavior: {
              recency: {
                duration: "HR_24", # accepts HR_24, DAY_7, DAY_14, DAY_30
                recency_type: "ACTIVE", # accepts ACTIVE, INACTIVE
              },
            },
            demographic: {
              app_version: {
                dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
                values: ["__string"],
              },
              channel: {
                dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
                values: ["__string"],
              },
              device_type: {
                dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
                values: ["__string"],
              },
              make: {
                dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
                values: ["__string"],
              },
              model: {
                dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
                values: ["__string"],
              },
              platform: {
                dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
                values: ["__string"],
              },
            },
            location: {
              country: {
                dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
                values: ["__string"],
              },
              gps_point: {
                coordinates: {
                  latitude: 1.0,
                  longitude: 1.0,
                },
                range_in_kilometers: 1.0,
              },
            },
            metrics: {
              "__string" => {
                comparison_operator: "__string",
                value: 1.0,
              },
            },
            user_attributes: {
              "__string" => {
                attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
                values: ["__string"],
              },
            },
          },
        ],
        source_segments: [
          {
            id: "__string",
            version: 1,
          },
        ],
        source_type: "ALL", # accepts ALL, ANY, NONE
        type: "ALL", # accepts ALL, ANY, NONE
      },
    ],
    include: "ALL", # accepts ALL, ANY, NONE
  },
}

Segment definition.

See Also:

• AWS API Documentation

Instance Attribute Summary

• #dimensions ⇒ Types::SegmentDimensions

  The segment dimensions attributes.

• #name ⇒ String

  The name of segment.

• #segment_groups ⇒ Types::SegmentGroupList

  A segment group, which consists of zero or more source segments, plus dimensions that are applied to those source segments.

Instance Attribute Details

#dimensions ⇒ Types::SegmentDimensions

The segment dimensions attributes.

Returns:

• (Types::SegmentDimensions)

# File 'lib/aws-sdk-pinpoint/types.rb', line 11031

class WriteSegmentRequest < Struct.new(
  :dimensions,
  :name,
  :segment_groups)
  include Aws::Structure
end

#name ⇒ String

The name of segment

Returns:

• (String)

# File 'lib/aws-sdk-pinpoint/types.rb', line 11031

class WriteSegmentRequest < Struct.new(
  :dimensions,
  :name,
  :segment_groups)
  include Aws::Structure
end

#segment_groups ⇒ Types::SegmentGroupList

A segment group, which consists of zero or more source segments, plus dimensions that are applied to those source segments. Your request can only include one segment group. Your request can include either a SegmentGroups object or a Dimensions object, but not both.

Returns:

• (Types::SegmentGroupList)

# File 'lib/aws-sdk-pinpoint/types.rb', line 11031

class WriteSegmentRequest < Struct.new(
  :dimensions,
  :name,
  :segment_groups)
  include Aws::Structure
end