list_segments

CloudWatchEvidently.Client.list_segments(**kwargs)

Returns a list of audience segments that you have created in your account in this Region.

See also: AWS API Documentation

Request Syntax

response = client.list_segments(
    maxResults=123,
    nextToken='string'
)

Parameters

• maxResults (integer) -- The maximum number of results to include in the response. If you omit this, the default of 50 is used.
• nextToken (string) -- The token to use when requesting the next set of results. You received this token from a previous ListSegments operation.

Return type

dict

Returns

Response Syntax

{
    'nextToken': 'string',
    'segments': [
        {
            'arn': 'string',
            'createdTime': datetime(2015, 1, 1),
            'description': 'string',
            'experimentCount': 123,
            'lastUpdatedTime': datetime(2015, 1, 1),
            'launchCount': 123,
            'name': 'string',
            'pattern': 'string',
            'tags': {
                'string': 'string'
            }
        },
    ]
}

Response Structure

• (dict) --

  • nextToken (string) --

    The token to use in a subsequent ListSegments operation to return the next set of results.

  • segments (list) --

    An array of structures that contain information about the segments in this Region.

    • (dict) --

      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.

      • arn (string) --

        The ARN of the segment.

      • createdTime (datetime) --

        The date and time that this segment was created.

      • description (string) --

        The customer-created description for this segment.

      • experimentCount (integer) --

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

      • lastUpdatedTime (datetime) --

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

      • launchCount (integer) --

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

      • 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. For more information about the pattern syntax, see Segment rule pattern syntax.

      • tags (dict) --

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

        • (string) --
          • (string) --

Exceptions

• CloudWatchEvidently.Client.exceptions.ThrottlingException
• CloudWatchEvidently.Client.exceptions.ValidationException
• CloudWatchEvidently.Client.exceptions.AccessDeniedException