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

***************
list_satellites
***************



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

  

  Returns a list of satellites.

  

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


  **Request Syntax**
  ::

    response = client.list_satellites(
        maxResults=123,
        nextToken='string'
    )
    
  :type maxResults: integer
  :param maxResults: 

    Maximum number of satellites returned.

    

  
  :type nextToken: string
  :param nextToken: 

    Next token that can be supplied in the next call to get the next page of satellites.

    

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

    
    ::

      {
          'nextToken': 'string',
          'satellites': [
              {
                  'satelliteId': 'string',
                  'satelliteArn': 'string',
                  'noradSatelliteID': 123,
                  'groundStations': [
                      'string',
                  ],
                  'currentEphemeris': {
                      'source': 'CUSTOMER_PROVIDED'|'SPACE_TRACK',
                      'ephemerisId': 'string',
                      'epoch': datetime(2015, 1, 1),
                      'name': 'string'
                  }
              },
          ]
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

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

        Next token that can be supplied in the next call to get the next page of satellites.

        
      

      - **satellites** *(list) --* 

        List of satellites.

        
        

        - *(dict) --* 

          Item in a list of satellites.

          
          

          - **satelliteId** *(string) --* 

            UUID of a satellite.

            
          

          - **satelliteArn** *(string) --* 

            ARN of a satellite.

            
          

          - **noradSatelliteID** *(integer) --* 

            NORAD satellite ID number.

            
          

          - **groundStations** *(list) --* 

            A list of ground stations to which the satellite is on-boarded.

            
            

            - *(string) --* 
        
          

          - **currentEphemeris** *(dict) --* 

            The current ephemeris being used to compute the trajectory of the satellite.

            
            

            - **source** *(string) --* 

              The ``EphemerisSource`` that generated a given ephemeris.

              
            

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

              UUID of a customer-provided ephemeris.

               

              This field is not populated for default ephemerides from Space Track.

              
            

            - **epoch** *(datetime) --* 

              The epoch of a default, ephemeris from Space Track in UTC.

               

              This field is not populated for customer-provided ephemerides.

              
            

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

              A name string associated with the ephemeris. Used as a human-readable identifier for the ephemeris.

               

              A name is only returned for customer-provider ephemerides that have a name associated.

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

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

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

  