Amazon Ground Station Ground Station Versions API

openapi: 3.2.0
info:
  title: AWS Ground Station Versions API
  version: '2019-05-23'
  description: Generated from AWS's published Smithy model for AWS Ground Station. 3 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: Versions
paths:
  /contact/{contactId}/versions/{versionId}:
    get:
      operationId: DescribeContactVersion
      summary: Describe Contact Version
      description: Describes a specific version of a contact.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeContactVersionResponse'
        '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/DescribeContactVersionRequest'
      tags:
      - Versions
  /contact/{contactId}/versions:
    get:
      operationId: ListContactVersions
      summary: List Contact Versions
      description: Returns a list of versions for a specified contact.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListContactVersionsResponse'
        '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/ListContactVersionsRequest'
      tags:
      - Versions
    post:
      operationId: UpdateContact
      summary: Update Contact
      description: Updates a specific contact.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateContactResponse'
        '531':
          description: DependencyException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DependencyException'
        '431':
          description: InvalidParameterException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterException'
        '429':
          description: ResourceLimitExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceLimitExceededException'
        '434':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateContactRequest'
      tags:
      - Versions
components:
  schemas:
    EphemerisResponseData:
      type: object
      properties:
        ephemerisId:
          type: string
          description: Unique identifier of the ephemeris. Appears only for custom ephemerides.
        ephemerisType:
          type: string
          enum:
          - TLE
          - OEM
          - AZ_EL
          - SERVICE_MANAGED
          description: Type of ephemeris.
      required:
      - ephemerisType
    Elevation:
      type: object
      properties:
        value:
          type: number
          description: Elevation angle value.
        unit:
          type: string
          enum:
          - DEGREE_ANGLE
          - RADIAN
          description: Elevation angle units.
      required:
      - value
      - unit
    ContactVersion:
      type: object
      properties:
        versionId:
          type: integer
          description: Version ID of a contact.
        created:
          type: string
          description: Time the contact version was created in UTC.
        activated:
          type: string
          description: Time the contact version was activated in UTC. A version is activated when it becomes the current active version of the contact.
        superseded:
          type: string
          description: Time the contact version was superseded in UTC. A version is superseded when a newer version becomes active.
        lastUpdated:
          type: string
          description: Time the contact version was last updated in UTC.
        status:
          type: string
          enum:
          - UPDATING
          - ACTIVE
          - SUPERSEDED
          - FAILED_TO_UPDATE
          description: Status of the contact version.
        failureCodes:
          type: array
          items:
            type: string
            enum:
            - INTERNAL_ERROR
            - INVALID_SATELLITE_ARN
            - INVALID_UPDATE_CONTACT_REQUEST
            - EPHEMERIS_NOT_FOUND
            - EPHEMERIS_TIME_RANGE_INVALID
            - EPHEMERIS_NOT_ENABLED
            - SATELLITE_DOES_NOT_MATCH_EPHEMERIS
            - NOT_ONBOARDED_TO_AZEL_EPHEMERIS
            - AZEL_EPHEMERIS_NOT_FOUND
            - AZEL_EPHEMERIS_WRONG_GROUND_STATION
            - AZEL_EPHEMERIS_INVALID_STATUS
            - AZEL_EPHEMERIS_TIME_RANGE_INVALID
          description: List of failure codes for the contact version.
        failureMessage:
          type: string
          description: Failure message for the contact version.
    ListContactVersionsResponse:
      type: object
      properties:
        nextToken:
          type: string
          description: Next token to be used in a subsequent ListContactVersions call to retrieve the next page of results.
        contactVersionsList:
          type: array
          items:
            $ref: '#/components/schemas/ContactVersion'
          description: List of contact versions.
    UpdateContactRequest:
      type: object
      properties:
        contactId:
          type: string
          description: UUID of a contact.
        clientToken:
          type: string
          description: A client token is a unique, case-sensitive string of up to 64 ASCII characters. It is generated by the client to ensure idempotent operations, allowing safe retries without unintended side effects.
        trackingOverrides:
          $ref: '#/components/schemas/TrackingOverrides'
        satelliteArn:
          type: string
          description: ARN of a satellite.
      required:
      - contactId
    ResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
    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
    InvalidParameterException:
      type: object
      properties:
        message:
          type: string
        parameterName:
          type: string
          description: Name of the invalid parameter.
    DependencyException:
      type: object
      properties:
        message:
          type: string
        parameterName:
          type: string
          description: Name of the parameter that caused the exception.
    Destination:
      type: object
      properties:
        configType:
          type: string
          enum:
          - antenna-downlink
          - antenna-downlink-demod-decode
          - tracking
          - dataflow-endpoint
          - antenna-uplink
          - uplink-echo
          - s3-recording
          - telemetry-sink
          description: Type of a Config.
        configId:
          type: string
          description: UUID of a Config.
        configDetails:
          $ref: '#/components/schemas/ConfigDetails'
        dataflowDestinationRegion:
          type: string
          description: Region of a dataflow destination.
    Source:
      type: object
      properties:
        configType:
          type: string
          enum:
          - antenna-downlink
          - antenna-downlink-demod-decode
          - tracking
          - dataflow-endpoint
          - antenna-uplink
          - uplink-echo
          - s3-recording
          - telemetry-sink
          description: Type of a Config.
        configId:
          type: string
          description: UUID of a Config.
        configDetails:
          $ref: '#/components/schemas/ConfigDetails'
        dataflowSourceRegion:
          type: string
          description: Region of a dataflow source.
    UplinkDataflowDetails:
      type: object
      properties:
        agentConnectionDetails:
          $ref: '#/components/schemas/UplinkConnectionDetails'
      description: Exactly one member is set.
    S3RecordingDetails:
      type: object
      properties:
        bucketArn:
          type: string
          description: ARN of the bucket used.
        keyTemplate:
          type: string
          description: Key template used for the S3 Recording Configuration
    UpdateContactResponse:
      type: object
      properties:
        contactId:
          type: string
          description: UUID of a contact.
        versionId:
          type: integer
          description: Version ID of a contact.
    EndpointDetails:
      type: object
      properties:
        securityDetails:
          $ref: '#/components/schemas/SecurityDetails'
        endpoint:
          $ref: '#/components/schemas/DataflowEndpoint'
        awsGroundStationAgentEndpoint:
          $ref: '#/components/schemas/AwsGroundStationAgentEndpoint'
        uplinkAwsGroundStationAgentEndpoint:
          $ref: '#/components/schemas/UplinkAwsGroundStationAgentEndpointDetails'
        downlinkAwsGroundStationAgentEndpoint:
          $ref: '#/components/schemas/DownlinkAwsGroundStationAgentEndpointDetails'
        healthStatus:
          type: string
          enum:
          - HEALTHY
          - UNHEALTHY
          description: A dataflow endpoint health status. This field is ignored when calling CreateDataflowEndpointGroup.
        healthReasons:
          type: array
          items:
            type: string
            enum:
            - NO_REGISTERED_AGENT
            - INVALID_IP_OWNERSHIP
            - NOT_AUTHORIZED_TO_CREATE_SLR
            - UNVERIFIED_IP_OWNERSHIP
            - INITIALIZING_DATAPLANE
            - DATAPLANE_FAILURE
            - HEALTHY
          description: Health reasons for a dataflow endpoint. This field is ignored when calling CreateDataflowEndpointGroup.
    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
    SecurityDetails:
      type: object
      properties:
        subnetIds:
          type: array
          items:
            type: string
          description: A list of subnets where AWS Ground Station places elastic network interfaces to send streams to your instances.
        securityGroupIds:
          type: array
          items:
            type: string
          description: The security groups to attach to the elastic network interfaces.
        roleArn:
          type: string
          description: ARN to a role needed for connecting streams to your instances.
      required:
      - subnetIds
      - securityGroupIds
      - roleArn
    AzElProgramTrackSettings:
      type: object
      properties:
        ephemerisId:
          type: string
          description: Unique identifier of the azimuth elevation ephemeris.
      required:
      - ephemerisId
    ListContactVersionsRequest:
      type: object
      properties:
        contactId:
          type: string
          description: UUID of a contact.
        maxResults:
          type: integer
          description: Maximum number of contact versions returned.
        nextToken:
          type: string
          description: Next token returned in the request of a previous ListContactVersions call. Used to get the next page of results.
      required:
      - contactId
    UplinkConnectionDetails:
      type: object
      properties:
        ingressAddressAndPort:
          $ref: '#/components/schemas/ConnectionDetails'
        agentIpAndPortAddress:
          $ref: '#/components/schemas/RangedConnectionDetails'
      required:
      - ingressAddressAndPort
      - agentIpAndPortAddress
    ProgramTrackSettings:
      type: object
      properties:
        azEl:
          $ref: '#/components/schemas/AzElProgramTrackSettings'
        oem:
          $ref: '#/components/schemas/OemProgramTrackSettings'
        tle:
          $ref: '#/components/schemas/TleProgramTrackSettings'
      description: Exactly one member is set.
    TrackingOverrides:
      type: object
      properties:
        programTrackSettings:
          $ref: '#/components/schemas/ProgramTrackSettings'
    DataflowEndpoint:
      type: object
      properties:
        name:
          type: string
          description: Name of a dataflow endpoint.
        address:
          $ref: '#/components/schemas/SocketAddress'
        status:
          type: string
          enum:
          - created
          - creating
          - deleted
          - deleting
          - failed
          description: Status of a dataflow endpoint.
        mtu:
          type: integer
          description: Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.
    OemProgramTrackSettings:
      type: object
      properties:
        ephemerisId:
          type: string
          description: Unique identifier of the OEM ephemeris.
      required:
      - ephemerisId
    DescribeContactVersionRequest:
      type: object
      properties:
        contactId:
          type: string
          description: UUID of a contact.
        versionId:
          type: integer
          description: Version ID of a contact.
      required:
      - contactId
      - versionId
    AntennaDemodDecodeDetails:
      type: object
      properties:
        outputNode:
          type: string
          description: Name of an antenna demod decode output node used in a contact.
    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
    DataflowDetail:
      type: object
      properties:
        source:
          $ref: '#/components/schemas/Source'
        destination:
          $ref: '#/components/schemas/Destination'
        errorMessage:
          type: string
          description: Error message for a dataflow.
    DownlinkAwsGroundStationAgentEndpointDetails:
      type: object
      properties:
        name:
          type: string
          description: Downlink dataflow endpoint name
        dataflowDetails:
          $ref: '#/components/schemas/DownlinkDataflowDetails'
        agentStatus:
          type: string
          enum:
          - SUCCESS
          - FAILED
          - ACTIVE
          - INACTIVE
          description: Status of the agent associated with the downlink dataflow endpoint
        auditResults:
          type: string
          enum:
          - HEALTHY
          - UNHEALTHY
          description: Health audit results for the downlink dataflow endpoint
      required:
      - name
      - dataflowDetails
    ConfigDetails:
      type: object
      properties:
        endpointDetails:
          $ref: '#/components/schemas/EndpointDetails'
        antennaDemodDecodeDetails:
          $ref: '#/components/schemas/AntennaDemodDecodeDetails'
        s3RecordingDetails:
          $ref: '#/components/schemas/S3RecordingDetails'
      description: Exactly one member is set.
    DescribeContactVersionResponse:
      type: object
      properties:
        contactId:
          type: string
          description: UUID of a contact.
        missionProfileArn:
          type: string
          description: ARN of the contact's mission profile.
        satelliteArn:
          type: string
          description: ARN of a satellite.
        startTime:
          type: string
          description: Start time of a contact in UTC.
        endTime:
          type: string
          description: End time of a contact in UTC.
        prePassStartTime:
          type: string
          description: Start time in UTC of the pre-pass period, at which you receive a CloudWatch event indicating an upcoming pass.
        postPassEndTime:
          type: string
          description: End time in UTC of the post-pass period, at which you receive a CloudWatch event indicating the pass has finished.
        groundStation:
          type: string
          description: Ground station for a contact.
        contactStatus:
          type: string
          enum:
          - SCHEDULING
          - FAILED_TO_SCHEDULE
          - SCHEDULED
          - CANCELLED
          - AWS_CANCELLED
          - PREPASS
          - PASS
          - POSTPASS
          - COMPLETED
          - FAILED
          - AVAILABLE
          - CANCELLING
          - AWS_FAILED
          description: Status of a contact.
        errorMessage:
          type: string
          description: Error message for a contact.
        maximumElevation:
          $ref: '#/components/schemas/Elevation'
        tags:
          type: object
          additionalProperties:
            type: string
          description: Tags assigned to a contact.
        region:
          type: string
          description: Region where the ReserveContact API was called to schedule this contact.
        dataflowList:
          type: array
          items:
            $ref: '#/components/schemas/DataflowDetail'
          description: List describing source and destination details for each dataflow edge.
        visibilityStartTime:
          type: string
          description: Projected time in UTC your satellite will rise above the receive mask. This time is based on the satellite's current active ephemeris for future contacts and the ephemeris that was active during contact execution for completed contacts.
        visibilityEndTime:
          type: string
          description: Projected time in UTC your satellite will set below the receive mask. This time is based on the satellite's current active ephemeris for future contacts and the ephemeris that was active during contact execution for completed contacts.
        trackingOverrides:
          $ref: '#/components/schemas/TrackingOverrides'
        ephemeris:
          $ref: '#/components/schemas/EphemerisResponseData'
        version:
          $ref: '#/components/schemas/ContactVersion'
    RangedSocketAddress:
      type: object
      properties:
        name:
          type: string
          description: IPv4 socket address.
        portRange:
          $ref: '#/components/schemas/IntegerRange'
      required:
      - name
      - portRange
    AwsGroundStationAgentEndpoint:
      type: object
      properties:
        name:
          type: string
          description: Name string associated with AgentEndpoint. Used as a human-readable identifier for AgentEndpoint.
        egressAddress:
          $ref: '#/components/schemas/ConnectionDetails'
        ingressAddress:
          $ref: '#/components/schemas/RangedConnectionDetails'
        agentStatus:
          type: string
          enum:
          - SUCCESS
          - FAILED
          - ACTIVE
          - INACTIVE
          description: The status of AgentEndpoint.
        auditResults:
          type: string
          enum:
          - HEALTHY
          - UNHEALTHY
          description: The results of the audit.
      required:
      - name
      - egressAddress
      - ingressAddress
    TleProgramTrackSettings:
      type: object
      properties:
        ephemerisId:
          type: string
          description: Unique identifier of the TLE ephemeris.
      required:
      - ephemerisId
    UplinkAwsGroundStationAgentEndpointDetails:
      type: object
      properties:
        name:
          type: string
          description: Uplink dataflow endpoint name
        dataflowDetails:
          $ref: '#/components/schemas/UplinkDataflowDetails'
        agentStatus:
          type: string
          enum:
          - SUCCESS
          - FAILED
          - ACTIVE
          - INACTIVE
          description: Status of the agent associated with the uplink dataflow endpoint
        auditResults:
          type: string
          enum:
          - HEALTHY
          - UNHEALTHY
          description: Health audit results for the uplink dataflow endpoint
      required:
      - name
      - dataflowDetails
    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
    ResourceLimitExceededException:
      type: object
      properties:
        message:
          type: string
        parameterName:
          type: string
          description: Name of the parameter that exceeded the resource limit.
  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)