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

Inherits:

Struct

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

Includes:

Structure

Defined in:

lib/aws-sdk-pinpoint/types.rb

Overview

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

See Also:

• AWS API Documentation

Instance Attribute Summary

• #application_id ⇒ String

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

• #arn ⇒ String

  The Amazon Resource Name (ARN) of the segment.

• #creation_date ⇒ String

  The date and time when the segment was created.

• #dimensions ⇒ Types::SegmentDimensions

  The dimension settings for the segment.

• #id ⇒ String

  The unique identifier for the segment.

• #import_definition ⇒ Types::SegmentImportResource

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

• #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 list of one or more segment groups that apply to the segment.

• #segment_type ⇒ String

  The segment type.

• #tags ⇒ Hash<String,String>

  A string-to-string map of key-value pairs that identifies the tags that are associated with the segment.

• #version ⇒ Integer

  The version number of the segment.

Instance Attribute Details

#application_id ⇒ String

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

Returns:

• (String)

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

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

#arn ⇒ String

The Amazon Resource Name (ARN) of the segment.

Returns:

• (String)

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

class SegmentResponse < Struct.new(
  :application_id,
  :arn,
  :creation_date,
  :dimensions,
  :id,
  :import_definition,
  :last_modified_date,
  :name,
  :segment_groups,
  :segment_type,
  :tags,
  :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 13533

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

#dimensions ⇒ Types::SegmentDimensions

The dimension settings for the segment.

Returns:

• (Types::SegmentDimensions)

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

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

#id ⇒ String

The unique identifier for the segment.

Returns:

• (String)

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

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

#import_definition ⇒ Types::SegmentImportResource

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

Returns:

• (Types::SegmentImportResource)

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

class SegmentResponse < Struct.new(
  :application_id,
  :arn,
  :creation_date,
  :dimensions,
  :id,
  :import_definition,
  :last_modified_date,
  :name,
  :segment_groups,
  :segment_type,
  :tags,
  :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 13533

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

#name ⇒ String

The name of the segment.

Returns:

• (String)

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

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

#segment_groups ⇒ Types::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.

Returns:

• (Types::SegmentGroupList)

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

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

#segment_type ⇒ String

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)

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

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

#tags ⇒ Hash<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>)

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

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

#version ⇒ Integer

The version number of the segment.

Returns:

• (Integer)

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

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