You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

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

Overview

Segment definition.

Instance Attribute Summary collapse

Instance Attribute Details

#application_idString

The ID of the application that the segment applies to.

Returns:

  • (String)


7845
7846
7847
7848
7849
7850
7851
7852
7853
7854
7855
7856
7857
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 7845

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

#creation_dateString

The date and time when the segment was created.

Returns:

  • (String)


7845
7846
7847
7848
7849
7850
7851
7852
7853
7854
7855
7856
7857
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 7845

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

#dimensionsTypes::SegmentDimensions

The segment dimensions attributes.



7845
7846
7847
7848
7849
7850
7851
7852
7853
7854
7855
7856
7857
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 7845

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

#idString

The unique segment ID.

Returns:

  • (String)


7845
7846
7847
7848
7849
7850
7851
7852
7853
7854
7855
7856
7857
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 7845

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

#import_definitionTypes::SegmentImportResource

The import job settings.



7845
7846
7847
7848
7849
7850
7851
7852
7853
7854
7855
7856
7857
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 7845

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

#last_modified_dateString

The date and time when the segment was last modified.

Returns:

  • (String)


7845
7846
7847
7848
7849
7850
7851
7852
7853
7854
7855
7856
7857
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 7845

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

#nameString

The name of the segment.

Returns:

  • (String)


7845
7846
7847
7848
7849
7850
7851
7852
7853
7854
7855
7856
7857
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 7845

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

#segment_groupsTypes::SegmentGroupList

A segment group, which consists of zero or more source segments, plus dimensions that are applied to those source segments.



7845
7846
7847
7848
7849
7850
7851
7852
7853
7854
7855
7856
7857
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 7845

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

#segment_typeString

The segment type: DIMENSIONAL - A dynamic segment built from selection criteria based on endpoint data reported by your app. You create this type of segment by using the segment builder in the Amazon Pinpoint console or by making a POST request to the segments resource. IMPORT - A static segment built from an imported set of endpoint definitions. You create this type of segment by importing a segment in the Amazon Pinpoint console or by making a POST request to the jobs/import resource.

Returns:

  • (String)


7845
7846
7847
7848
7849
7850
7851
7852
7853
7854
7855
7856
7857
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 7845

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

#versionInteger

The segment version number.

Returns:

  • (Integer)


7845
7846
7847
7848
7849
7850
7851
7852
7853
7854
7855
7856
7857
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 7845

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