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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
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:



14068
14069
14070
14071
14072
14073
14074
14075
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 14068

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

#name ⇒ String

The name of the segment.

Returns:

  • (String) 


14068
14069
14070
14071
14072
14073
14074
14075
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 14068

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:



14068
14069
14070
14071
14072
14073
14074
14075
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 14068

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

#tags ⇒ Hash<String,String>

<note markdown=“1”>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][2

commands in the *AWS Command Line

Interface Documentation* or [resourcegroupstaggingapi] in the *AWS SDK*.

</note>

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

[1]: docs.aws.amazon.com/pinpoint/latest/apireference/tags-resource-arn.html [2]: docs.aws.amazon.com/cli/latest/reference/resourcegroupstaggingapi/index.html [3]: sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/resourcegroupstaggingapi/package-summary.html

Returns:

  • (Hash<String,String>) 


14068
14069
14070
14071
14072
14073
14074
14075
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 14068

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