CloudWatchEvidently / Client / list_segment_references

list_segment_references#

CloudWatchEvidently.Client.list_segment_references(**kwargs)#

Use this operation to find which experiments or launches are using a specified segment.

See also: AWS API Documentation

Request Syntax

response = client.list_segment_references(
    maxResults=123,
    nextToken='string',
    segment='string',
    type='EXPERIMENT'|'LAUNCH'
)
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 ListSegmentReferences operation.

  • segment (string) –

    [REQUIRED]

    The ARN of the segment that you want to view information for.

  • type (string) –

    [REQUIRED]

    Specifies whether to return information about launches or experiments that use this segment.

Return type:

dict

Returns:

Response Syntax

{
    'nextToken': 'string',
    'referencedBy': [
        {
            'arn': 'string',
            'endTime': 'string',
            'lastUpdatedOn': 'string',
            'name': 'string',
            'startTime': 'string',
            'status': 'string',
            'type': 'string'
        },
    ]
}

Response Structure

  • (dict) –

    • nextToken (string) –

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

    • referencedBy (list) –

      An array of structures, where each structure contains information about one experiment or launch that uses this segment.

      • (dict) –

        A structure that contains information about one experiment or launch that uses the specified segment.

        • arn (string) –

          The ARN of the experiment or launch.

        • endTime (string) –

          The day and time that this experiment or launch ended.

        • lastUpdatedOn (string) –

          The day and time that this experiment or launch was most recently updated.

        • name (string) –

          The name of the experiment or launch.

        • startTime (string) –

          The day and time that this experiment or launch started.

        • status (string) –

          The status of the experiment or launch.

        • type (string) –

          Specifies whether the resource that this structure contains information about is an experiment or a launch.

Exceptions

  • CloudWatchEvidently.Client.exceptions.ThrottlingException

  • CloudWatchEvidently.Client.exceptions.ValidationException

  • CloudWatchEvidently.Client.exceptions.ResourceNotFoundException

  • CloudWatchEvidently.Client.exceptions.AccessDeniedException