| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.Evidently.CreateSegment
Description
Use this operation to define a segment of your audience. A segment is a portion of your audience that share one or more characteristics. Examples could be Chrome browser users, users in Europe, or Firefox browser users in Europe who also fit other criteria that your application collects, such as age.
Using a segment in an experiment limits that experiment to evaluate only the users who match the segment criteria. Using one or more segments in a launch allows you to define different traffic splits for the different audience segments.
<p>For more information about segment pattern syntax, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Evidently-segments.html#CloudWatch-Evidently-segments-syntax.html"> Segment rule pattern syntax</a>.</p> <p>The pattern that you define for a segment is matched against the value of <code>evaluationContext</code>, which is passed into Evidently in the <a href="https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_EvaluateFeature.html">EvaluateFeature</a> operation, when Evidently assigns a feature variation to a user.</p>
Synopsis
- data CreateSegment = CreateSegment' {}
- newCreateSegment :: Text -> Text -> CreateSegment
- createSegment_description :: Lens' CreateSegment (Maybe Text)
- createSegment_tags :: Lens' CreateSegment (Maybe (HashMap Text Text))
- createSegment_name :: Lens' CreateSegment Text
- createSegment_pattern :: Lens' CreateSegment Text
- data CreateSegmentResponse = CreateSegmentResponse' {
- httpStatus :: Int
- segment :: Segment
- newCreateSegmentResponse :: Int -> Segment -> CreateSegmentResponse
- createSegmentResponse_httpStatus :: Lens' CreateSegmentResponse Int
- createSegmentResponse_segment :: Lens' CreateSegmentResponse Segment
Creating a Request
data CreateSegment Source #
See: newCreateSegment smart constructor.
Constructors
| CreateSegment' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> CreateSegment |
Create a value of CreateSegment with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateSegment, createSegment_description - An optional description for this segment.
CreateSegment, createSegment_tags - Assigns one or more tags (key-value pairs) to the segment.
Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.
Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.
<p>You can associate as many as 50 tags with a segment.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services resources</a>.</p>
CreateSegment, createSegment_name - A name for the segment.
CreateSegment, createSegment_pattern - The pattern to use for the segment. For more information about pattern
syntax, see
Segment rule pattern syntax.
Request Lenses
createSegment_description :: Lens' CreateSegment (Maybe Text) Source #
An optional description for this segment.
createSegment_tags :: Lens' CreateSegment (Maybe (HashMap Text Text)) Source #
Assigns one or more tags (key-value pairs) to the segment.
Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.
Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.
<p>You can associate as many as 50 tags with a segment.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services resources</a>.</p>
createSegment_name :: Lens' CreateSegment Text Source #
A name for the segment.
createSegment_pattern :: Lens' CreateSegment Text Source #
The pattern to use for the segment. For more information about pattern syntax, see Segment rule pattern syntax.
Destructuring the Response
data CreateSegmentResponse Source #
See: newCreateSegmentResponse smart constructor.
Constructors
| CreateSegmentResponse' | |
Fields
| |
Instances
newCreateSegmentResponse Source #
Arguments
| :: Int | |
| -> Segment | |
| -> CreateSegmentResponse |
Create a value of CreateSegmentResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:CreateSegmentResponse', createSegmentResponse_httpStatus - The response's http status code.
CreateSegmentResponse, createSegmentResponse_segment - A structure that contains the complete information about the segment
that was just created.
Response Lenses
createSegmentResponse_httpStatus :: Lens' CreateSegmentResponse Int Source #
The response's http status code.
createSegmentResponse_segment :: Lens' CreateSegmentResponse Segment Source #
A structure that contains the complete information about the segment that was just created.