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

************
ListSegments
************



.. py:class:: CloudWatchEvidently.Paginator.ListSegments

  ::

    
    paginator = client.get_paginator('list_segments')

  
  

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

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

    .. 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/ListSegments>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :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**

      
      ::

        {
            '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'
                    }
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **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 <https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Evidently-segments.html>`__.

              
            

            - **tags** *(dict) --* 

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

              
              

              - *(string) --* 
                

                - *(string) --* 
          
        
        
      
        

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

          A token to resume pagination.

          
    