AWS Ground Station
Welcome to the AWS Ground Station API Reference. AWS Ground Station is a fully managed service that enables you to control satellite communications, downlink…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Welcome to the AWS Ground Station API Reference. AWS Ground Station is a fully managed service that enables you to control satellite communications, downlink and process satellite data, and scale your satellite operations efficiently and cost-effectively without having to build or manage your own ground station infrastructure.
Endpoints 40
Contact
- GETDescribe contact
/contact/:contactIdDescribes an existing contact. - DELETECancel contact
/contact/:contactIdCancels or stops a contact with a specified contact ID based on its position in the contact lifecycle . For contacts that: Have yet to start, the contact will… - GETDescribe contact version
/contact/:contactId/versions/:versionIdDescribes a specific version of a contact. - GETList contact versions
/contact/:contactId/versions?maxResults=0&nextToken=stringReturns a list of versions for a specified contact. - POSTUpdate contact
/contact/:contactId/versionsUpdates a specific contact. - POSTList contacts
/contactsReturns a list of contacts. If statusList contains AVAILABLE, the request must include groundStation , missionprofileArn , and satelliteArn . - POSTReserve contact
/contactReserves a contact using specified parameters.
Config
- GETList configs
/config?maxResults=0&nextToken=stringReturns a list of Config objects. - POSTCreate config
/configCreates a Config with the specified configData parameters. Only one type of configData can be specified. - GETGet config
/config/:configType/:configIdReturns Config information. Only one Config response can be returned. - PUTUpdate config
/config/:configType/:configIdUpdates the Config used when scheduling contacts. Updating a Config will not update the execution parameters for existing future contacts scheduled with this… - DELETEDelete config
/config/:configType/:configIdDeletes a Config .
Dataflow endpoint group
- GETList dataflow endpoint groups
/dataflowEndpointGroup?maxResults=0&nextToken=stringReturns a list of DataflowEndpoint groups. - POSTCreate dataflow endpoint group
/dataflowEndpointGroupCreates a DataflowEndpoint group containing the specified list of DataflowEndpoint objects. The name field in each endpoint is used in your mission profile… - GETGet dataflow endpoint group
/dataflowEndpointGroup/:dataflowEndpointGroupIdReturns the dataflow endpoint group. - DELETEDelete dataflow endpoint group
/dataflowEndpointGroup/:dataflowEndpointGroupIdDeletes a dataflow endpoint group.
Dataflow endpoint group v2
- POSTCreate dataflow endpoint group v2
/dataflowEndpointGroupV2Creates a DataflowEndpoint group containing the specified list of Ground Station Agent based endpoints. The name field in each endpoint is used in your…
Ephemeris
- POSTCreate ephemeris
/ephemerisCreate an ephemeris with your specified EphemerisData . - GETDescribe ephemeris
/ephemeris/:ephemerisIdRetrieve information about an existing ephemeris. - PUTUpdate ephemeris
/ephemeris/:ephemerisIdUpdate an existing ephemeris. - DELETEDelete ephemeris
/ephemeris/:ephemerisIdDelete an ephemeris. - POSTList ephemerides
/ephemerides?maxResults=0&nextToken=stringList your existing ephemerides.
Mission profile
- GETList mission profiles
/missionprofile?maxResults=0&nextToken=stringReturns a list of mission profiles. - POSTCreate mission profile
/missionprofileCreates a mission profile. dataflowEdges is a list of lists of strings. Each lower level list of strings has two elements: a from ARN and a to ARN. - GETGet mission profile
/missionprofile/:missionProfileIdReturns a mission profile. - PUTUpdate mission profile
/missionprofile/:missionProfileIdUpdates a mission profile. Updating a mission profile will not update the execution parameters for existing future contacts. - DELETEDelete mission profile
/missionprofile/:missionProfileIdDeletes a mission profile.
Agent
- GETGet agent configuration
/agent/:agentId/configurationFor use by AWS Ground Station Agent and shouldn't be called directly. Gets the latest configuration information for a registered agent. - POSTRegister agent
/agentFor use by AWS Ground Station Agent and shouldn't be called directly. Registers a new agent with AWS Ground Station. - PUTUpdate agent status
/agent/:agentIdFor use by AWS Ground Station Agent and shouldn't be called directly. Update the status of the agent.
Satellite
- GETGet satellite
/satellite/:satelliteIdReturns a satellite. - GETList satellites
/satellite?maxResults=0&nextToken=stringReturns a list of satellites.
Ground station
- GETList antennas
/groundstation/:groundStationId/antenna?maxResults=0&nextToken=stringReturns a list of antennas at a specified ground station. - GETList ground station reservations
/groundstation/:groundStationId/reservation?startTime=string&endTime=string&reservationTypes=&maxResults=0&nextToken=stringReturns a list of reservations for a specified ground station. - GETList ground stations
/groundstation?satelliteId=string&maxResults=0&nextToken=stringReturns a list of ground stations.
- GETGet agent task response url
/agentResponseUrl/:agentId/:taskIdFor use by AWS Ground Station Agent and shouldn't be called directly. Gets a presigned URL for uploading agent task response logs. - POSTGet minute usage
/minute-usageReturns the number of reserved minutes used by account. - GETList tags for resource
/tags/:resourceArnReturns a list of tags for a specified resource. - POSTTag resource
/tags/:resourceArnAssigns a tag to a resource. - DELETEUntag resource
/tags/:resourceArn?tagKeys=Deassigns a resource tag.
API details
- Base URL
https://groundstation.{region}.amazonaws.com- Authentication
- AWS Signature Version 4 (requests signed with your AWS access key)
- Operations
- 40 operations on 26 pathsGET 18POST 12DELETE 6PUT 4
- Main resources
- Contact 7Config 5Ephemeris 5Mission profile 5Dataflow endpoint group 4Agent 3Ground station 3Satellite 2Dataflow endpoint group v2 1
- Description format
- AWS Smithy model, API version
2019-05-23 - Links
- Documentation · OpenAPI document
- Listed from
- AWS Smithy API model (aws/api-models-aws) (Apache-2.0)
How to test the AWS Ground Station in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the AWS Ground Station collection, without the publisher's secrets.
- Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Describe contact” (GET /contact/:contactId), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the AWS Ground Station?
Welcome to the AWS Ground Station API Reference. AWS Ground Station is a fully managed service that enables you to control satellite communications, downlink… It is listed under Developer tools and has 40 endpoints.
Who publishes the AWS Ground Station?
It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.
What is the base URL of the AWS Ground Station?
Requests go to https://groundstation.{region}.amazonaws.com. Endpoint paths are added to this base URL.
How do I authenticate with the AWS Ground Station?
With AWS Signature Version 4 (requests signed with your AWS access key).
How many endpoints does the AWS Ground Station have?
40 operations on 26 paths (18 GET, 12 POST, 6 DELETE, 4 PUT). The largest groups are Contact, Config, Ephemeris, Mission profile.
Is forking the AWS Ground Station free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.