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

********************
list_ground_stations
********************



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

  

  Returns a list of ground stations.

  

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


  **Request Syntax**
  ::

    response = client.list_ground_stations(
        satelliteId='string',
        maxResults=123,
        nextToken='string'
    )
    
  :type satelliteId: string
  :param satelliteId: 

    Satellite ID to retrieve on-boarded ground stations.

    

  
  :type maxResults: integer
  :param maxResults: 

    Maximum number of ground stations returned.

    

  
  :type nextToken: string
  :param nextToken: 

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

    

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

    
    ::

      {
          'nextToken': 'string',
          'groundStationList': [
              {
                  'groundStationId': 'string',
                  'groundStationName': 'string',
                  'region': 'string'
              },
          ]
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

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

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

        
      

      - **groundStationList** *(list) --* 

        List of ground stations.

        
        

        - *(dict) --* 

          Information about the ground station data.

          
          

          - **groundStationId** *(string) --* 

            UUID of a ground station.

            
          

          - **groundStationName** *(string) --* 

            Name of a ground station.

            
          

          - **region** *(string) --* 

            Ground station Region.

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

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

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

  