:doc:`CustomerProfiles <../../customer-profiles>` / Paginator / ListEventStreams

****************
ListEventStreams
****************



.. py:class:: CustomerProfiles.Paginator.ListEventStreams

  ::

    
    paginator = client.get_paginator('list_event_streams')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`CustomerProfiles.Client.list_event_streams`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ListEventStreams>`_    


    **Request Syntax**
    ::

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

      The unique name of the domain.

      

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

      
      ::

        {
            'Items': [
                {
                    'DomainName': 'string',
                    'EventStreamName': 'string',
                    'EventStreamArn': 'string',
                    'State': 'RUNNING'|'STOPPED',
                    'StoppedSince': datetime(2015, 1, 1),
                    'DestinationSummary': {
                        'Uri': 'string',
                        'Status': 'HEALTHY'|'UNHEALTHY',
                        'UnhealthySince': datetime(2015, 1, 1)
                    },
                    'Tags': {
                        'string': 'string'
                    }
                },
            ],
            
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **Items** *(list) --* 

          Contains summary information about an EventStream.

          
          

          - *(dict) --* 

            An instance of EventStream in a list of EventStreams.

            
            

            - **DomainName** *(string) --* 

              The unique name of the domain.

              
            

            - **EventStreamName** *(string) --* 

              The name of the event stream.

              
            

            - **EventStreamArn** *(string) --* 

              A unique identifier for the event stream.

              
            

            - **State** *(string) --* 

              The operational state of destination stream for export.

              
            

            - **StoppedSince** *(datetime) --* 

              The timestamp when the ``State`` changed to ``STOPPED``.

              
            

            - **DestinationSummary** *(dict) --* 

              Summary information about the Kinesis data stream.

              
              

              - **Uri** *(string) --* 

                The StreamARN of the destination to deliver profile events to. For example, arn:aws:kinesis:region:account-id:stream/stream-name.

                
              

              - **Status** *(string) --* 

                The status of enabling the Kinesis stream as a destination for export.

                
              

              - **UnhealthySince** *(datetime) --* 

                The timestamp when the status last changed to ``UNHEALHY``.

                
          
            

            - **Tags** *(dict) --* 

              The tags used to organize, track, or control access for this resource.

              
              

              - *(string) --* 
                

                - *(string) --* 
          
        
        
      
    