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 to which the segment applies.

Returns:

  • (String)


5383
5384
5385
5386
5387
5388
5389
5390
5391
5392
5393
5394
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 5383

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

#creation_dateString

The date the segment was created in ISO 8601 format.

Returns:

  • (String)


5383
5384
5385
5386
5387
5388
5389
5390
5391
5392
5393
5394
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 5383

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

#dimensionsTypes::SegmentDimensions

The segment dimensions attributes.



5383
5384
5385
5386
5387
5388
5389
5390
5391
5392
5393
5394
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 5383

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

#idString

The unique segment ID.

Returns:

  • (String)


5383
5384
5385
5386
5387
5388
5389
5390
5391
5392
5393
5394
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 5383

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

#import_definitionTypes::SegmentImportResource

The import job settings.



5383
5384
5385
5386
5387
5388
5389
5390
5391
5392
5393
5394
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 5383

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

#last_modified_dateString

The date the segment was last updated in ISO 8601 format.

Returns:

  • (String)


5383
5384
5385
5386
5387
5388
5389
5390
5391
5392
5393
5394
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 5383

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

#nameString

The name of segment

Returns:

  • (String)


5383
5384
5385
5386
5387
5388
5389
5390
5391
5392
5393
5394
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 5383

class SegmentResponse < Struct.new(
  :application_id,
  :creation_date,
  :dimensions,
  :id,
  :import_definition,
  :last_modified_date,
  :name,
  :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)


5383
5384
5385
5386
5387
5388
5389
5390
5391
5392
5393
5394
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 5383

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

#versionInteger

The segment version number.

Returns:

  • (Integer)


5383
5384
5385
5386
5387
5388
5389
5390
5391
5392
5393
5394
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 5383

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