GetSatellite - AWS Ground Station

GetSatellite

Returns a satellite.

Request Syntax

GET /satellite/satelliteId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

satelliteId

UUID of a satellite.

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}$

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "currentEphemeris": { "ephemerisId": "string", "epoch": number, "name": "string", "source": "string" }, "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.

currentEphemeris

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

Type: EphemerisMetaData object

groundStations

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

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 500 items.

Length Constraints: Minimum length of 4. Maximum length of 500.

Pattern: ^[ a-zA-Z0-9-._:=]{4,256}$

noradSatelliteID

NORAD satellite ID number.

Type: Integer

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

satelliteArn

ARN of a satellite.

Type: String

satelliteId

UUID of a satellite.

Type: String

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}$

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: