:doc:`GroundStation <../../groundstation>` / Paginator / ListEphemerides

***************
ListEphemerides
***************



.. py:class:: GroundStation.Paginator.ListEphemerides

  ::

    
    paginator = client.get_paginator('list_ephemerides')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`GroundStation.Client.list_ephemerides`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/ListEphemerides>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          satelliteId='string',
          ephemerisType='TLE'|'OEM'|'AZ_EL'|'SERVICE_MANAGED',
          startTime=datetime(2015, 1, 1),
          endTime=datetime(2015, 1, 1),
          statusList=[
              'VALIDATING'|'INVALID'|'ERROR'|'ENABLED'|'DISABLED'|'EXPIRED',
          ],
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type satelliteId: string
    :param satelliteId: 

      The AWS Ground Station satellite ID to list ephemeris for.

      

    
    :type ephemerisType: string
    :param ephemerisType: 

      Filter ephemerides by type. If not specified, all ephemeris types will be returned.

      

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

      The start time for the list operation in UTC. Returns ephemerides with expiration times within your specified time range.

      

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

      The end time for the list operation in UTC. Returns ephemerides with expiration times within your specified time range.

      

    
    :type statusList: list
    :param statusList: 

      The list of ephemeris status to return.

      

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

      
      ::

        {
            'ephemerides': [
                {
                    'ephemerisId': 'string',
                    'ephemerisType': 'TLE'|'OEM'|'AZ_EL'|'SERVICE_MANAGED',
                    'status': 'VALIDATING'|'INVALID'|'ERROR'|'ENABLED'|'DISABLED'|'EXPIRED',
                    'priority': 123,
                    'enabled': True|False,
                    'creationTime': datetime(2015, 1, 1),
                    'name': 'string',
                    'sourceS3Object': {
                        'bucket': 'string',
                        'key': 'string',
                        'version': 'string'
                    }
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **ephemerides** *(list) --* 

          List of ephemerides.

          
          

          - *(dict) --* 

            Ephemeris item.

            
            

            - **ephemerisId** *(string) --* 

              The AWS Ground Station ephemeris ID.

              
            

            - **ephemerisType** *(string) --* 

              The type of ephemeris.

              
            

            - **status** *(string) --* 

              The status of the ephemeris.

              
            

            - **priority** *(integer) --* 

              A priority score that determines which ephemeris to use when multiple ephemerides overlap.

               

              Higher numbers take precedence. The default is 1. Must be 1 or greater.

              
            

            - **enabled** *(boolean) --* 

              Whether or not the ephemeris is enabled.

              
            

            - **creationTime** *(datetime) --* 

              The time the ephemeris was uploaded in UTC.

              
            

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

              A name that you can use to identify the ephemeris.

              
            

            - **sourceS3Object** *(dict) --* 

              Source Amazon S3 object used for the ephemeris.

              
              

              - **bucket** *(string) --* 

                An Amazon S3 Bucket name.

                
              

              - **key** *(string) --* 

                An Amazon S3 key for the ephemeris.

                
              

              - **version** *(string) --* 

                For versioned Amazon S3 objects, the version to use for the ephemeris.

                
          
        
      
        

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

          A token to resume pagination.

          
    