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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

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

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#application_id ⇒ String

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

Returns:

  • (String) —

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

#arn ⇒ String

The Amazon Resource Name (ARN) of the segment.

Returns:

  • (String) —

    The Amazon Resource Name (ARN) of the segment.

#creation_date ⇒ String

The date and time when the segment was created.

Returns:

  • (String) —

    The date and time when the segment was created.

#dimensions ⇒ Types::SegmentDimensions

The dimension settings for the segment.

Returns:

#id ⇒ String

The unique identifier for the segment.

Returns:

  • (String) —

    The unique identifier for the segment.

#import_definition ⇒ Types::SegmentImportResource

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

Returns:

#last_modified_date ⇒ String

The date and time when the segment was last modified.

Returns:

  • (String) —

    The date and time when the segment was last modified.

#name ⇒ String

The name of the segment.

Returns:

  • (String) —

    The name of the segment.

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

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

    Possible values:

    • DIMENSIONAL
    • IMPORT

Returns:

  • (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. Each tag consists of a required tag key and an associated tag value.

Returns:

  • (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.

Returns:

  • (Integer) —

    The version number of the segment.