Segment
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.
Contents
- arn
-
The ARN of the segment.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern:
arn:[^:]*:[^:]*:[^:]*:[^:]*:segment/[-a-zA-Z0-9._]*
Required: Yes
- createdTime
-
The date and time that this segment was created.
Type: Timestamp
Required: Yes
- lastUpdatedTime
-
The date and time that this segment was most recently updated.
Type: Timestamp
Required: Yes
- name
-
The name of the segment.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
^[-a-zA-Z0-9._]*$
Required: Yes
- pattern
-
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.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: Yes
- description
-
The customer-created description for this segment.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 160.
Pattern:
.*
Required: No
- experimentCount
-
The number of experiments that this segment is used in. This count includes all current experiments, not just those that are currently running.
Type: Long
Required: No
- launchCount
-
The number of launches that this segment is used in. This count includes all current launches, not just those that are currently running.
Type: Long
Required: No
-
The list of tag keys and values associated with this launch.
Type: String to string map
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Key Pattern:
^(?!aws:)[a-zA-Z+-=._:/]+$
Value Length Constraints: Minimum length of 0. Maximum length of 256.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: