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

Inherits:

Struct

• Object
• Struct
• Aws::Pinpoint::Types::SegmentResponse

Includes:

Structure

Defined in:

lib/aws-sdk-pinpoint/types.rb

Overview

Segment definition.

See Also:

• AWS API Documentation

Instance Attribute Summary

• #application_id ⇒ String

  The ID of the application that the segment applies to.

• #creation_date ⇒ String

  The date and time when the segment was created.

• #dimensions ⇒ Types::SegmentDimensions

  The segment dimensions attributes.

• #id ⇒ String

  The unique segment ID.

• #import_definition ⇒ Types::SegmentImportResource

  The import job settings.

• #last_modified_date ⇒ String

  The date and time when the segment was last modified.

• #name ⇒ String

  The name of the segment.

• #segment_groups ⇒ Types::SegmentGroupList

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

• #segment_type ⇒ String

  The segment type: DIMENSIONAL - A dynamic segment built from selection criteria based on endpoint data reported by your app.

• #version ⇒ Integer

  The segment version number.

Instance Attribute Details

#application_id ⇒ String

The ID of the application that the segment applies to.

Returns:

• (String)

# File 'lib/aws-sdk-pinpoint/types.rb', line 8310

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_date ⇒ String

The date and time when the segment was created.

Returns:

• (String)

# File 'lib/aws-sdk-pinpoint/types.rb', line 8310

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

#dimensions ⇒ Types::SegmentDimensions

The segment dimensions attributes.

Returns:

• (Types::SegmentDimensions)

# File 'lib/aws-sdk-pinpoint/types.rb', line 8310

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

#id ⇒ String

The unique segment ID.

Returns:

• (String)

# File 'lib/aws-sdk-pinpoint/types.rb', line 8310

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_definition ⇒ Types::SegmentImportResource

The import job settings.

Returns:

• (Types::SegmentImportResource)

# File 'lib/aws-sdk-pinpoint/types.rb', line 8310

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_date ⇒ String

The date and time when the segment was last modified.

Returns:

• (String)

# File 'lib/aws-sdk-pinpoint/types.rb', line 8310

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

#name ⇒ String

The name of the segment.

Returns:

• (String)

# File 'lib/aws-sdk-pinpoint/types.rb', line 8310

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_groups ⇒ Types::SegmentGroupList

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

Returns:

• (Types::SegmentGroupList)

# File 'lib/aws-sdk-pinpoint/types.rb', line 8310

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_type ⇒ String

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)

# File 'lib/aws-sdk-pinpoint/types.rb', line 8310

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

#version ⇒ Integer

The segment version number.

Returns:

• (Integer)

# File 'lib/aws-sdk-pinpoint/types.rb', line 8310

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