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.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#application_id ⇒ String

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

Returns:

  • (String) 


11371
11372
11373
11374
11375
11376
11377
11378
11379
11380
11381
11382
11383
11384
11385
11386
 
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 11371

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

#arn ⇒ String

The Amazon Resource Name (ARN) of the segment.

Returns:

  • (String) 


11371
11372
11373
11374
11375
11376
11377
11378
11379
11380
11381
11382
11383
11384
11385
11386
 
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 11371

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

The date and time when the segment was created.

Returns:

  • (String) 


11371
11372
11373
11374
11375
11376
11377
11378
11379
11380
11381
11382
11383
11384
11385
11386
 
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 11371

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

#dimensions ⇒ Types::SegmentDimensions

The dimension settings for the segment.

Returns:



11371
11372
11373
11374
11375
11376
11377
11378
11379
11380
11381
11382
11383
11384
11385
11386
 
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 11371

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

#id ⇒ String

The unique identifier for the segment.

Returns:

  • (String) 


11371
11372
11373
11374
11375
11376
11377
11378
11379
11380
11381
11382
11383
11384
11385
11386
 
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 11371

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

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

Returns:



11371
11372
11373
11374
11375
11376
11377
11378
11379
11380
11381
11382
11383
11384
11385
11386
 
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 11371

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

The date and time when the segment was last modified.

Returns:

  • (String) 


11371
11372
11373
11374
11375
11376
11377
11378
11379
11380
11381
11382
11383
11384
11385
11386
 
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 11371

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

#name ⇒ String

The name of the segment.

Returns:

  • (String) 


11371
11372
11373
11374
11375
11376
11377
11378
11379
11380
11381
11382
11383
11384
11385
11386
 
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 11371

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_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:



11371
11372
11373
11374
11375
11376
11377
11378
11379
11380
11381
11382
11383
11384
11385
11386
 
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 11371

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_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) 


11371
11372
11373
11374
11375
11376
11377
11378
11379
11380
11381
11382
11383
11384
11385
11386
 
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 11371

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

#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>) 


11371
11372
11373
11374
11375
11376
11377
11378
11379
11380
11381
11382
11383
11384
11385
11386
 
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 11371

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

#version ⇒ Integer

The version number of the segment.

Returns:

  • (Integer) 


11371
11372
11373
11374
11375
11376
11377
11378
11379
11380
11381
11382
11383
11384
11385
11386
 
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 11371

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