get_segment

CloudWatchEvidently.Client.get_segment(**kwargs)

Returns information about the specified segment. Specify the segment you want to view by specifying its ARN.

See also: AWS API Documentation

Request Syntax

response = client.get_segment(
    segment='string'
)

Parameters

segment (string) --

[REQUIRED]

The ARN of the segment to return information for.

Return type

dict

Returns

Response Syntax

{
    'segment': {
        '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) --
  • segment (dict) --

    A structure that contains the complete information about the segment.

    • 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.ResourceNotFoundException
• CloudWatchEvidently.Client.exceptions.AccessDeniedException