ListSatellites - AWS Ground Station

ListSatellites

Returns a list of satellites.

Request Syntax

GET /satellite?maxResults=maxResults&nextToken=nextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

maxResults

Maximum number of satellites returned.

nextToken

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

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "nextToken": "string", "satellites": [ { "groundStations": [ "string" ], "noradSatelliteID": number, "satelliteArn": "string", "satelliteId": "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.

nextToken

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

Type: String

satellites

List of satellites.

Type: Array of SatelliteListItem objects

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

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: