Class: Aws::CloudWatchEvidently::Types::Segment

Inherits:

Struct

• Object
• Struct
• Aws::CloudWatchEvidently::Types::Segment

Includes:

Structure

Defined in:

lib/aws-sdk-cloudwatchevidently/types.rb

Overview

This structure contains information about one audience segment. You can use segments in your experiments and launches to narrow the user sessions used for experiment or launch to only the user sessions that match one or more criteria.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #arn ⇒ String

  The ARN of the segment.

• #created_time ⇒ Time

  The date and time that this segment was created.

• #description ⇒ String

  The customer-created description for this segment.

• #experiment_count ⇒ Integer

  The number of experiments that this segment is used in.

• #last_updated_time ⇒ Time

  The date and time that this segment was most recently updated.

• #launch_count ⇒ Integer

  The number of launches that this segment is used in.

• #name ⇒ String

  The name of the segment.

• #pattern ⇒ String

  The pattern that defines the attributes to use to evalute whether a user session will be in the segment.

• #tags ⇒ Hash<String,String>

  The list of tag keys and values associated with this launch.

Instance Attribute Details

#arn ⇒ String

The ARN of the segment.

Returns:

• (String)

# File 'lib/aws-sdk-cloudwatchevidently/types.rb', line 2805

class Segment < Struct.new(
  :arn,
  :created_time,
  :description,
  :experiment_count,
  :last_updated_time,
  :launch_count,
  :name,
  :pattern,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#created_time ⇒ Time

The date and time that this segment was created.

Returns:

• (Time)

# File 'lib/aws-sdk-cloudwatchevidently/types.rb', line 2805

class Segment < Struct.new(
  :arn,
  :created_time,
  :description,
  :experiment_count,
  :last_updated_time,
  :launch_count,
  :name,
  :pattern,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

The customer-created description for this segment.

Returns:

• (String)

# File 'lib/aws-sdk-cloudwatchevidently/types.rb', line 2805

class Segment < Struct.new(
  :arn,
  :created_time,
  :description,
  :experiment_count,
  :last_updated_time,
  :launch_count,
  :name,
  :pattern,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#experiment_count ⇒ Integer

The number of experiments that this segment is used in. This count includes all current experiments, not just those that are currently running.

Returns:

• (Integer)

# File 'lib/aws-sdk-cloudwatchevidently/types.rb', line 2805

class Segment < Struct.new(
  :arn,
  :created_time,
  :description,
  :experiment_count,
  :last_updated_time,
  :launch_count,
  :name,
  :pattern,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#last_updated_time ⇒ Time

The date and time that this segment was most recently updated.

Returns:

• (Time)

# File 'lib/aws-sdk-cloudwatchevidently/types.rb', line 2805

class Segment < Struct.new(
  :arn,
  :created_time,
  :description,
  :experiment_count,
  :last_updated_time,
  :launch_count,
  :name,
  :pattern,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#launch_count ⇒ Integer

The number of launches that this segment is used in. This count includes all current launches, not just those that are currently running.

Returns:

• (Integer)

# File 'lib/aws-sdk-cloudwatchevidently/types.rb', line 2805

class Segment < Struct.new(
  :arn,
  :created_time,
  :description,
  :experiment_count,
  :last_updated_time,
  :launch_count,
  :name,
  :pattern,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the segment.

Returns:

• (String)

# File 'lib/aws-sdk-cloudwatchevidently/types.rb', line 2805

class Segment < Struct.new(
  :arn,
  :created_time,
  :description,
  :experiment_count,
  :last_updated_time,
  :launch_count,
  :name,
  :pattern,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#pattern ⇒ String

The pattern that defines the attributes to use to evalute whether a user session will be in the segment. For more information about the pattern syntax, see [Segment rule pattern syntax].

[1]: docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Evidently-segments.html

Returns:

• (String)

# File 'lib/aws-sdk-cloudwatchevidently/types.rb', line 2805

class Segment < Struct.new(
  :arn,
  :created_time,
  :description,
  :experiment_count,
  :last_updated_time,
  :launch_count,
  :name,
  :pattern,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

The list of tag keys and values associated with this launch.

Returns:

• (Hash<String,String>)

# File 'lib/aws-sdk-cloudwatchevidently/types.rb', line 2805

class Segment < Struct.new(
  :arn,
  :created_time,
  :description,
  :experiment_count,
  :last_updated_time,
  :launch_count,
  :name,
  :pattern,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end