Amazon Ground Station

Amazon Ground Station Ground Station Operations API

The Ground Station Operations API from Amazon Ground Station — 5 operation(s) for ground station operations.

GitHub OpenAPI

Operations 4

GET /agentResponseUrl/{agentId}/{taskId} Get Agent Task Response Url #
POST /dataflowEndpointGroupV2 Create Dataflow Endpoint Group V2 #
GET /groundstation/{groundStationId}/antenna List Antennas #
GET /groundstation/{groundStationId}/reservation List Ground Station Reservations #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/amazon-ground-station/openapi/amazon-ground-station-operations-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/amazon-ground-station:amazon-ground-station-operations-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

amazon-ground-station-operations-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: AWS Ground Station Operations API
  version: '2019-05-23'
  description: Generated from AWS's published Smithy model for AWS Ground Station. 5 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://groundstation.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Operations
paths:
  /agentResponseUrl/{agentId}/{taskId}:
    get:
      operationId: GetAgentTaskResponseUrl
      summary: Get Agent Task Response Url
      description: For use by AWS Ground Station Agent and shouldn't be called directly. Gets a presigned URL for uploading agent task response logs.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAgentTaskResponseUrlResponse'
        '531':
          description: DependencyException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DependencyException'
        '431':
          description: InvalidParameterException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterException'
        '434':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetAgentTaskResponseUrlRequest'
      tags:
      - Operations
  /dataflowEndpointGroupV2:
    post:
      operationId: CreateDataflowEndpointGroupV2
      summary: Create Dataflow Endpoint Group V2
      description: Creates a DataflowEndpoint group containing the specified list of Ground Station Agent based endpoints. The name field in each endpoint is used in your mission profile DataflowEndpointConfig to specify which endpoints to use during a contact. When a contact uses multiple DataflowEndpointConfig objects, each Config must match a DataflowEndpoint in the same group.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateDataflowEndpointGroupV2Response'
        '531':
          description: DependencyException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DependencyException'
        '431':
          description: InvalidParameterException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterException'
        '434':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '402':
          description: ServiceQuotaExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceQuotaExceededException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateDataflowEndpointGroupV2Request'
      tags:
      - Operations
  /groundstation/{groundStationId}/antenna:
    get:
      operationId: ListAntennas
      summary: List Antennas
      description: Returns a list of antennas at a specified ground station.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListAntennasResponse'
        '531':
          description: DependencyException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DependencyException'
        '431':
          description: InvalidParameterException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListAntennasRequest'
      tags:
      - Operations
  /groundstation/{groundStationId}/reservation:
    get:
      operationId: ListGroundStationReservations
      summary: List Ground Station Reservations
      description: Returns a list of reservations for a specified ground station.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListGroundStationReservationsResponse'
        '531':
          description: DependencyException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DependencyException'
        '431':
          description: InvalidParameterException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListGroundStationReservationsRequest'
      tags:
      - Operations
components:
  schemas:
    ListGroundStationReservationsResponse:
      type: object
      properties:
        reservationList:
          type: array
          items:
            $ref: '#/components/schemas/GroundStationReservationListItem'
          description: List of ground station reservations.
        nextToken:
          type: string
          description: Next token to be used in a subsequent ListGroundStationReservations call to retrieve the next page of results.
      required:
      - reservationList
    ListGroundStationReservationsRequest:
      type: object
      properties:
        groundStationId:
          type: string
          description: ID of a ground station.
        startTime:
          type: string
          description: Start time of the reservation window in UTC.
        endTime:
          type: string
          description: End time of the reservation window in UTC.
        reservationTypes:
          type: array
          items:
            type: string
            enum:
            - MAINTENANCE
            - CONTACT
          description: Types of reservations to filter by.
        maxResults:
          type: integer
          description: Maximum number of ground station reservations returned.
        nextToken:
          type: string
          description: Next token returned in the request of a previous ListGroundStationReservations call. Used to get the next page of results.
      required:
      - groundStationId
      - startTime
      - endTime
    ListAntennasRequest:
      type: object
      properties:
        groundStationId:
          type: string
          description: ID of a ground station.
        maxResults:
          type: integer
          description: Maximum number of antennas returned.
        nextToken:
          type: string
          description: Next token returned in the request of a previous ListAntennas call. Used to get the next page of results.
      required:
      - groundStationId
    MaintenanceReservationDetails:
      type: object
      properties:
        maintenanceType:
          type: string
          enum:
          - PLANNED
          - UNPLANNED
          description: Type of maintenance.
      required:
      - maintenanceType
    CreateEndpointDetails:
      type: object
      properties:
        uplinkAwsGroundStationAgentEndpoint:
          $ref: '#/components/schemas/UplinkAwsGroundStationAgentEndpoint'
        downlinkAwsGroundStationAgentEndpoint:
          $ref: '#/components/schemas/DownlinkAwsGroundStationAgentEndpoint'
      description: Exactly one member is set.
    ResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
    InvalidParameterException:
      type: object
      properties:
        message:
          type: string
        parameterName:
          type: string
          description: Name of the invalid parameter.
    ConnectionDetails:
      type: object
      properties:
        socketAddress:
          $ref: '#/components/schemas/SocketAddress'
        mtu:
          type: integer
          description: Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.
      required:
      - socketAddress
    DependencyException:
      type: object
      properties:
        message:
          type: string
        parameterName:
          type: string
          description: Name of the parameter that caused the exception.
    DownlinkAwsGroundStationAgentEndpoint:
      type: object
      properties:
        name:
          type: string
          description: Downlink dataflow endpoint name
        dataflowDetails:
          $ref: '#/components/schemas/DownlinkDataflowDetails'
      required:
      - name
      - dataflowDetails
    ReservationDetails:
      type: object
      properties:
        maintenance:
          $ref: '#/components/schemas/MaintenanceReservationDetails'
        contact:
          $ref: '#/components/schemas/ContactReservationDetails'
      description: Exactly one member is set.
    UplinkDataflowDetails:
      type: object
      properties:
        agentConnectionDetails:
          $ref: '#/components/schemas/UplinkConnectionDetails'
      description: Exactly one member is set.
    GetAgentTaskResponseUrlResponse:
      type: object
      properties:
        agentId:
          type: string
          description: UUID of the agent.
        taskId:
          type: string
          description: GUID of the agent task.
        presignedLogUrl:
          type: string
          description: Presigned URL for uploading agent task response logs.
      required:
      - agentId
      - taskId
      - presignedLogUrl
    SocketAddress:
      type: object
      properties:
        name:
          type: string
          description: Name of a socket address.
        port:
          type: integer
          description: Port of a socket address.
      required:
      - name
      - port
    CreateDataflowEndpointGroupV2Request:
      type: object
      properties:
        endpoints:
          type: array
          items:
            $ref: '#/components/schemas/CreateEndpointDetails'
          description: Dataflow endpoint group's endpoint definitions
        contactPrePassDurationSeconds:
          type: integer
          description: Amount of time, in seconds, before a contact starts that the Ground Station Dataflow Endpoint Group will be in a PREPASS state. A Ground Station Dataflow Endpoint Group State Change event will be emitted when the Dataflow Endpoint Group enters and exits the PREPASS state.
        contactPostPassDurationSeconds:
          type: integer
          description: Amount of time, in seconds, after a contact ends that the Ground Station Dataflow Endpoint Group will be in a POSTPASS state. A Ground Station Dataflow Endpoint Group State Change event will be emitted when the Dataflow Endpoint Group enters and exits the POSTPASS state.
        tags:
          type: object
          additionalProperties:
            type: string
          description: Tags of a V2 dataflow endpoint group.
      required:
      - endpoints
    UplinkConnectionDetails:
      type: object
      properties:
        ingressAddressAndPort:
          $ref: '#/components/schemas/ConnectionDetails'
        agentIpAndPortAddress:
          $ref: '#/components/schemas/RangedConnectionDetails'
      required:
      - ingressAddressAndPort
      - agentIpAndPortAddress
    UplinkAwsGroundStationAgentEndpoint:
      type: object
      properties:
        name:
          type: string
          description: Uplink dataflow endpoint name
        dataflowDetails:
          $ref: '#/components/schemas/UplinkDataflowDetails'
      required:
      - name
      - dataflowDetails
    ServiceQuotaExceededException:
      type: object
      properties:
        message:
          type: string
        parameterName:
          type: string
          description: Parameter name that caused the exception
    DownlinkDataflowDetails:
      type: object
      properties:
        agentConnectionDetails:
          $ref: '#/components/schemas/DownlinkConnectionDetails'
      description: Exactly one member is set.
    DownlinkConnectionDetails:
      type: object
      properties:
        agentIpAndPortAddress:
          $ref: '#/components/schemas/RangedConnectionDetails'
        egressAddressAndPort:
          $ref: '#/components/schemas/ConnectionDetails'
      required:
      - agentIpAndPortAddress
      - egressAddressAndPort
    CreateDataflowEndpointGroupV2Response:
      type: object
      properties:
        dataflowEndpointGroupId:
          type: string
          description: Dataflow endpoint group ID
    ContactReservationDetails:
      type: object
      properties:
        contactId:
          type: string
          description: UUID of a contact.
    GroundStationReservationListItem:
      type: object
      properties:
        reservationType:
          type: string
          enum:
          - MAINTENANCE
          - CONTACT
          description: Type of a ground station reservation.
        groundStationId:
          type: string
          description: ID of a ground station.
        antennaName:
          type: string
          description: Name of an antenna.
        startTime:
          type: string
          description: Start time of a ground station reservation in UTC.
        endTime:
          type: string
          description: End time of a ground station reservation in UTC.
        reservationDetails:
          $ref: '#/components/schemas/ReservationDetails'
      required:
      - reservationType
      - groundStationId
      - antennaName
      - startTime
      - endTime
      - reservationDetails
    AntennaListItem:
      type: object
      properties:
        groundStationName:
          type: string
          description: Name of the ground station the antenna is associated with.
        antennaName:
          type: string
          description: Name of the antenna.
        region:
          type: string
          description: Region of the antenna.
      required:
      - groundStationName
      - antennaName
      - region
    RangedSocketAddress:
      type: object
      properties:
        name:
          type: string
          description: IPv4 socket address.
        portRange:
          $ref: '#/components/schemas/IntegerRange'
      required:
      - name
      - portRange
    ListAntennasResponse:
      type: object
      properties:
        antennaList:
          type: array
          items:
            $ref: '#/components/schemas/AntennaListItem'
          description: List of antennas.
        nextToken:
          type: string
          description: Next token to be used in a subsequent ListAntennas call to retrieve the next page of results.
      required:
      - antennaList
    GetAgentTaskResponseUrlRequest:
      type: object
      properties:
        agentId:
          type: string
          description: UUID of agent requesting the response URL.
        taskId:
          type: string
          description: GUID of the agent task for which the response URL is being requested.
      required:
      - agentId
      - taskId
    IntegerRange:
      type: object
      properties:
        minimum:
          type: integer
          description: A minimum value.
        maximum:
          type: integer
          description: A maximum value.
      required:
      - minimum
      - maximum
    RangedConnectionDetails:
      type: object
      properties:
        socketAddress:
          $ref: '#/components/schemas/RangedSocketAddress'
        mtu:
          type: integer
          description: Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.
      required:
      - socketAddress
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: groundstation
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/groundstation/service/2019-05-23/groundstation-2019-05-23.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)