You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::Pinpoint::Types::WriteSegmentRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::Pinpoint::Types::WriteSegmentRequest
- Defined in:
- (unknown)
Overview
When passing WriteSegmentRequest as input to an Aws::Client method, you can use a vanilla Hash:
{
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
},
},
},
name: "__string",
segment_groups: {
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
},
tags: {
"__string" => "__string",
},
}
Specifies the configuration, dimension, and other settings for a segment. A WriteSegmentRequest object can include a Dimensions object or a SegmentGroups object, but not both.
Returned by:
Instance Attribute Summary collapse
-
#dimensions ⇒ Types::SegmentDimensions
The criteria that define the dimensions for the segment.
-
#name ⇒ String
The name of the segment.
-
#segment_groups ⇒ Types::SegmentGroupList
The segment group to use and the dimensions to apply to the group\'s base segments in order to build the segment.
-
#tags ⇒ Hash<String,String>
A string-to-string map of key-value pairs that defines the tags to associate with the segment.
Instance Attribute Details
#dimensions ⇒ Types::SegmentDimensions
The criteria that define the dimensions for the segment.
#name ⇒ String
The name of the segment.
#segment_groups ⇒ Types::SegmentGroupList
The segment group to use and the dimensions to apply to the group\'s base segments in order to build the segment. A segment group can consist of zero or more base segments. Your request can include only one segment group.
#tags ⇒ Hash<String,String>
A string-to-string map of key-value pairs that defines the tags to associate with the segment. Each tag consists of a required tag key and an associated tag value.