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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb

Overview

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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#dimensionsTypes::SegmentDimensions

The criteria that define the dimensions for the segment.



13403
13404
13405
13406
13407
13408
13409
13410
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 13403

class WriteSegmentRequest < Struct.new(
  :dimensions,
  :name,
  :segment_groups,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

The name of the segment.

Returns:

  • (String)


13403
13404
13405
13406
13407
13408
13409
13410
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 13403

class WriteSegmentRequest < Struct.new(
  :dimensions,
  :name,
  :segment_groups,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#segment_groupsTypes::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.



13403
13404
13405
13406
13407
13408
13409
13410
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 13403

class WriteSegmentRequest < Struct.new(
  :dimensions,
  :name,
  :segment_groups,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tagsHash<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.

Returns:

  • (Hash<String,String>)


13403
13404
13405
13406
13407
13408
13409
13410
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 13403

class WriteSegmentRequest < Struct.new(
  :dimensions,
  :name,
  :segment_groups,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end