:doc:`GroundStation <../../groundstation>` / Client / list_ephemerides

****************
list_ephemerides
****************



.. py:method:: GroundStation.Client.list_ephemerides(**kwargs)

  

  List your existing ephemerides.

  

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


  **Request Syntax**
  ::

    response = client.list_ephemerides(
        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',
        ],
        maxResults=123,
        nextToken='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 maxResults: integer
  :param maxResults: 

    Maximum number of ephemerides to return.

    

  
  :type nextToken: string
  :param nextToken: 

    Pagination token.

    

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

    
    ::

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

    

    - *(dict) --* 
      

      - **nextToken** *(string) --* 

        Pagination token.

        
      

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

              
        
      
    
  
  **Exceptions**
  
  *   :py:class:`GroundStation.Client.exceptions.InvalidParameterException`

  
  *   :py:class:`GroundStation.Client.exceptions.DependencyException`

  
  *   :py:class:`GroundStation.Client.exceptions.ResourceNotFoundException`

  