Class: Aws::Pinpoint::Types::SegmentResponse

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

Overview

Provides information about the configuration, dimension, and other settings for a segment.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#application_idString

The unique identifier for the application that the segment is associated with.

Returns:

  • (String)


14629
14630
14631
14632
14633
14634
14635
14636
14637
14638
14639
14640
14641
14642
14643
14644
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 14629

class SegmentResponse < Struct.new(
  :application_id,
  :arn,
  :creation_date,
  :dimensions,
  :id,
  :import_definition,
  :last_modified_date,
  :name,
  :segment_groups,
  :segment_type,
  :tags,
  :version)
  SENSITIVE = []
  include Aws::Structure
end

#arnString

The Amazon Resource Name (ARN) of the segment.

Returns:

  • (String)


14629
14630
14631
14632
14633
14634
14635
14636
14637
14638
14639
14640
14641
14642
14643
14644
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 14629

class SegmentResponse < Struct.new(
  :application_id,
  :arn,
  :creation_date,
  :dimensions,
  :id,
  :import_definition,
  :last_modified_date,
  :name,
  :segment_groups,
  :segment_type,
  :tags,
  :version)
  SENSITIVE = []
  include Aws::Structure
end

#creation_dateString

The date and time when the segment was created.

Returns:

  • (String)


14629
14630
14631
14632
14633
14634
14635
14636
14637
14638
14639
14640
14641
14642
14643
14644
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 14629

class SegmentResponse < Struct.new(
  :application_id,
  :arn,
  :creation_date,
  :dimensions,
  :id,
  :import_definition,
  :last_modified_date,
  :name,
  :segment_groups,
  :segment_type,
  :tags,
  :version)
  SENSITIVE = []
  include Aws::Structure
end

#dimensionsTypes::SegmentDimensions

The dimension settings for the segment.



14629
14630
14631
14632
14633
14634
14635
14636
14637
14638
14639
14640
14641
14642
14643
14644
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 14629

class SegmentResponse < Struct.new(
  :application_id,
  :arn,
  :creation_date,
  :dimensions,
  :id,
  :import_definition,
  :last_modified_date,
  :name,
  :segment_groups,
  :segment_type,
  :tags,
  :version)
  SENSITIVE = []
  include Aws::Structure
end

#idString

The unique identifier for the segment.

Returns:

  • (String)


14629
14630
14631
14632
14633
14634
14635
14636
14637
14638
14639
14640
14641
14642
14643
14644
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 14629

class SegmentResponse < Struct.new(
  :application_id,
  :arn,
  :creation_date,
  :dimensions,
  :id,
  :import_definition,
  :last_modified_date,
  :name,
  :segment_groups,
  :segment_type,
  :tags,
  :version)
  SENSITIVE = []
  include Aws::Structure
end

#import_definitionTypes::SegmentImportResource

The settings for the import job that's associated with the segment.



14629
14630
14631
14632
14633
14634
14635
14636
14637
14638
14639
14640
14641
14642
14643
14644
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 14629

class SegmentResponse < Struct.new(
  :application_id,
  :arn,
  :creation_date,
  :dimensions,
  :id,
  :import_definition,
  :last_modified_date,
  :name,
  :segment_groups,
  :segment_type,
  :tags,
  :version)
  SENSITIVE = []
  include Aws::Structure
end

#last_modified_dateString

The date and time when the segment was last modified.

Returns:

  • (String)


14629
14630
14631
14632
14633
14634
14635
14636
14637
14638
14639
14640
14641
14642
14643
14644
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 14629

class SegmentResponse < Struct.new(
  :application_id,
  :arn,
  :creation_date,
  :dimensions,
  :id,
  :import_definition,
  :last_modified_date,
  :name,
  :segment_groups,
  :segment_type,
  :tags,
  :version)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

The name of the segment.

Returns:

  • (String)


14629
14630
14631
14632
14633
14634
14635
14636
14637
14638
14639
14640
14641
14642
14643
14644
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 14629

class SegmentResponse < Struct.new(
  :application_id,
  :arn,
  :creation_date,
  :dimensions,
  :id,
  :import_definition,
  :last_modified_date,
  :name,
  :segment_groups,
  :segment_type,
  :tags,
  :version)
  SENSITIVE = []
  include Aws::Structure
end

#segment_groupsTypes::SegmentGroupList

A list of one or more segment groups that apply to the segment. Each segment group consists of zero or more base segments and the dimensions that are applied to those base segments.



14629
14630
14631
14632
14633
14634
14635
14636
14637
14638
14639
14640
14641
14642
14643
14644
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 14629

class SegmentResponse < Struct.new(
  :application_id,
  :arn,
  :creation_date,
  :dimensions,
  :id,
  :import_definition,
  :last_modified_date,
  :name,
  :segment_groups,
  :segment_type,
  :tags,
  :version)
  SENSITIVE = []
  include Aws::Structure
end

#segment_typeString

The segment type. Valid values are:

  • DIMENSIONAL - A dynamic segment, which is a segment that uses selection criteria that you specify and is based on endpoint data that's reported by your app. Dynamic segments can change over time.

  • IMPORT - A static segment, which is a segment that uses selection criteria that you specify and is based on endpoint definitions that you import from a file. Imported segments are static; they don't change over time.

Returns:

  • (String)


14629
14630
14631
14632
14633
14634
14635
14636
14637
14638
14639
14640
14641
14642
14643
14644
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 14629

class SegmentResponse < Struct.new(
  :application_id,
  :arn,
  :creation_date,
  :dimensions,
  :id,
  :import_definition,
  :last_modified_date,
  :name,
  :segment_groups,
  :segment_type,
  :tags,
  :version)
  SENSITIVE = []
  include Aws::Structure
end

#tagsHash<String,String>

A string-to-string map of key-value pairs that identifies the tags that are associated with the segment. Each tag consists of a required tag key and an associated tag value.

Returns:

  • (Hash<String,String>)


14629
14630
14631
14632
14633
14634
14635
14636
14637
14638
14639
14640
14641
14642
14643
14644
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 14629

class SegmentResponse < Struct.new(
  :application_id,
  :arn,
  :creation_date,
  :dimensions,
  :id,
  :import_definition,
  :last_modified_date,
  :name,
  :segment_groups,
  :segment_type,
  :tags,
  :version)
  SENSITIVE = []
  include Aws::Structure
end

#versionInteger

The version number of the segment.

Returns:

  • (Integer)


14629
14630
14631
14632
14633
14634
14635
14636
14637
14638
14639
14640
14641
14642
14643
14644
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 14629

class SegmentResponse < Struct.new(
  :application_id,
  :arn,
  :creation_date,
  :dimensions,
  :id,
  :import_definition,
  :last_modified_date,
  :name,
  :segment_groups,
  :segment_type,
  :tags,
  :version)
  SENSITIVE = []
  include Aws::Structure
end