Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListGroundStations

Returns a list of ground stations.

Request Syntax


GET /groundstation?maxResults=maxResults&nextToken=nextToken&satelliteId=satelliteId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

maxResults

Maximum number of ground stations returned.

Valid Range: Minimum value of 0. Maximum value of 100.

nextToken

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

Length Constraints: Minimum length of 3. Maximum length of 1000.

Pattern: ^[A-Za-z0-9-/+_.=]+$

satelliteId

Satellite ID to retrieve on-boarded ground stations.

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "groundStationList": [ 
      { 
         "groundStationId": "string",
         "groundStationName": "string",
         "region": "string"
      }
   ],
   "nextToken": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

groundStationList

List of ground stations.

Type: Array of GroundStationData objects

nextToken

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

Type: String

Length Constraints: Minimum length of 3. Maximum length of 1000.

Pattern: ^[A-Za-z0-9-/+_.=]+$

Errors

For information about the errors that are common to all actions, see Common Errors.

DependencyException

Dependency encountered an error.

HTTP Status Code: 531

InvalidParameterException

One or more parameters are not valid.

HTTP Status Code: 431

ResourceNotFoundException

Resource was not found.

HTTP Status Code: 434