:doc:`CloudWatchEvidently <../../evidently>` / Paginator / ListSegmentReferences

*********************
ListSegmentReferences
*********************



.. py:class:: CloudWatchEvidently.Paginator.ListSegmentReferences

  ::

    
    paginator = client.get_paginator('list_segment_references')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`CloudWatchEvidently.Client.list_segment_references`.

    .. danger::

            This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity.


    

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/evidently-2021-02-01/ListSegmentReferences>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          segment='string',
          type='EXPERIMENT'|'LAUNCH',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type segment: string
    :param segment: **[REQUIRED]** 

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

      

    
    :type type: string
    :param type: **[REQUIRED]** 

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

      

    
    :type PaginationConfig: dict
    :param PaginationConfig: 

      A dictionary that provides parameters to control pagination.

      

    
      - **MaxItems** *(integer) --* 

        The total number of items to return. If the total number of items available is more than the value specified in max-items then a ``NextToken`` will be provided in the output that you can use to resume pagination.

        

      
      - **PageSize** *(integer) --* 

        The size of each page.

        

      
      - **StartingToken** *(string) --* 

        A token to specify where to start paginating. This is the ``NextToken`` from a previous response.

        

      
    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax**

      
      ::

        {
            'referencedBy': [
                {
                    'arn': 'string',
                    'endTime': 'string',
                    'lastUpdatedOn': 'string',
                    'name': 'string',
                    'startTime': 'string',
                    'status': 'string',
                    'type': 'string'
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **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.

              
        
      
        

        - **NextToken** *(string) --* 

          A token to resume pagination.

          
    