:doc:`CodeCatalyst <../../codecatalyst>` / Paginator / ListEventLogs

*************
ListEventLogs
*************



.. py:class:: CodeCatalyst.Paginator.ListEventLogs

  ::

    
    paginator = client.get_paginator('list_event_logs')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`CodeCatalyst.Client.list_event_logs`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/codecatalyst-2022-09-28/ListEventLogs>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          spaceName='string',
          startTime=datetime(2015, 1, 1),
          endTime=datetime(2015, 1, 1),
          eventName='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type spaceName: string
    :param spaceName: **[REQUIRED]** 

      The name of the space.

      

    
    :type startTime: datetime
    :param startTime: **[REQUIRED]** 

      The date and time when you want to start retrieving events, in coordinated universal time (UTC) timestamp format as specified in `RFC 3339 <https://www.rfc-editor.org/rfc/rfc3339#section-5.6>`__.

      

    
    :type endTime: datetime
    :param endTime: **[REQUIRED]** 

      The time after which you do not want any events retrieved, in coordinated universal time (UTC) timestamp format as specified in `RFC 3339 <https://www.rfc-editor.org/rfc/rfc3339#section-5.6>`__.

      

    
    :type eventName: string
    :param eventName: 

      The name of the event.

      

    
    :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': [
                {
                    'id': 'string',
                    'eventName': 'string',
                    'eventType': 'string',
                    'eventCategory': 'string',
                    'eventSource': 'string',
                    'eventTime': datetime(2015, 1, 1),
                    'operationType': 'READONLY'|'MUTATION',
                    'userIdentity': {
                        'userType': 'USER'|'AWS_ACCOUNT'|'UNKNOWN',
                        'principalId': 'string',
                        'userName': 'string',
                        'awsAccountId': 'string'
                    },
                    'projectInformation': {
                        'name': 'string',
                        'projectId': 'string'
                    },
                    'requestId': 'string',
                    'requestPayload': {
                        'contentType': 'string',
                        'data': 'string'
                    },
                    'responsePayload': {
                        'contentType': 'string',
                        'data': 'string'
                    },
                    'errorCode': 'string',
                    'sourceIpAddress': 'string',
                    'userAgent': 'string'
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **items** *(list) --* 

          Information about each event retrieved in the list.

          
          

          - *(dict) --* 

            Information about an entry in an event log of Amazon CodeCatalyst activity.

            
            

            - **id** *(string) --* 

              The system-generated unique ID of the event.

              
            

            - **eventName** *(string) --* 

              The name of the event.

              
            

            - **eventType** *(string) --* 

              The type of the event.

              
            

            - **eventCategory** *(string) --* 

              The category for the event.

              
            

            - **eventSource** *(string) --* 

              The source of the event.

              
            

            - **eventTime** *(datetime) --* 

              The time the event took place, in coordinated universal time (UTC) timestamp format as specified in `RFC 3339 <https://www.rfc-editor.org/rfc/rfc3339#section-5.6>`__.

              
            

            - **operationType** *(string) --* 

              The type of the event.

              
            

            - **userIdentity** *(dict) --* 

              The system-generated unique ID of the user whose actions are recorded in the event.

              
              

              - **userType** *(string) --* 

                The role assigned to the user in a Amazon CodeCatalyst space or project when the event occurred.

                
              

              - **principalId** *(string) --* 

                The ID of the Amazon CodeCatalyst service principal.

                
              

              - **userName** *(string) --* 

                The display name of the user in Amazon CodeCatalyst.

                
              

              - **awsAccountId** *(string) --* 

                The Amazon Web Services account number of the user in Amazon Web Services, if any.

                
          
            

            - **projectInformation** *(dict) --* 

              Information about the project where the event occurred.

              
              

              - **name** *(string) --* 

                The name of the project in the space.

                
              

              - **projectId** *(string) --* 

                The system-generated unique ID of the project.

                
          
            

            - **requestId** *(string) --* 

              The system-generated unique ID of the request.

              
            

            - **requestPayload** *(dict) --* 

              Information about the payload of the request.

              
              

              - **contentType** *(string) --* 

                The type of content in the event payload.

                
              

              - **data** *(string) --* 

                The data included in the event payload.

                
          
            

            - **responsePayload** *(dict) --* 

              Information about the payload of the response, if any.

              
              

              - **contentType** *(string) --* 

                The type of content in the event payload.

                
              

              - **data** *(string) --* 

                The data included in the event payload.

                
          
            

            - **errorCode** *(string) --* 

              The code of the error, if any.

              
            

            - **sourceIpAddress** *(string) --* 

              The IP address of the user whose actions are recorded in the event.

              
            

            - **userAgent** *(string) --* 

              The user agent whose actions are recorded in the event.

              
        
      
        

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

          A token to resume pagination.

          
    