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.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#dimensions ⇒ Types::SegmentDimensions

The criteria that define the dimensions for the segment.

Returns:



13835
13836
13837
13838
13839
13840
13841
13842
 
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 13835

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

#name ⇒ String

The name of the segment.

Returns:

  • (String) 


13835
13836
13837
13838
13839
13840
13841
13842
 
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 13835

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

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

Returns:



13835
13836
13837
13838
13839
13840
13841
13842
 
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 13835

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

#tags ⇒ Hash<String,String>

As of 22-05-2023 tags has been deprecated for update operations. After this date any value in tags is not processed and an error code is not returned. To manage tags we recommend using either Tags in the API Reference for Amazon Pinpoint, resourcegroupstaggingapi commands in the AWS Command Line Interface Documentation or resourcegroupstaggingapi in the AWS SDK.

(Deprecated) 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>) 


13835
13836
13837
13838
13839
13840
13841
13842
 
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 13835

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