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

Class: Aws::Pinpoint::Types::CreateSegmentRequest

Inherits:

Struct

• Object
• Struct
• Aws::Pinpoint::Types::CreateSegmentRequest

Defined in:

gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb

Overview

Note:

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

{
  application_id: "__string", # required
  write_segment_request: { # required
    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
          type: "ALL", # accepts ALL, ANY, NONE
        },
      ],
      include: "ALL", # accepts ALL, ANY, NONE
    },
  },
}

See Also:

• AWS API Documentation

Instance Attribute Summary

• #application_id ⇒ String
• #write_segment_request ⇒ Types::WriteSegmentRequest

  Segment definition.

Instance Attribute Details

#application_id ⇒ String

Returns:

• (String)

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

class CreateSegmentRequest < Struct.new(
  :application_id,
  :write_segment_request)
  include Aws::Structure
end

#write_segment_request ⇒ Types::WriteSegmentRequest

Segment definition.

Returns:

• (Types::WriteSegmentRequest)

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

class CreateSegmentRequest < Struct.new(
  :application_id,
  :write_segment_request)
  include Aws::Structure
end