Client library for AWS Ground Station

npm install --save @datafire/amazonaws_groundstation

let amazonaws_groundstation = require('@datafire/amazonaws_groundstation').create({
  accessKeyId: "",
  secretAccessKey: "",
  region: ""
});

.then(data => {
  console.log(data);
});

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.

amazonaws_groundstation.ListConfigs({}, context)

• input object
  • maxResults integer
  • nextToken string

• output ListConfigsResponse

amazonaws_groundstation.CreateConfig({
  "configData": {},
  "name": ""
}, context)

• input object
  • tags object: Tags assigned to a Config.
  • configData required object:

    Object containing the parameters of a Config.

    See the subtype definitions for what each type of Config contains.

    • antennaDownlinkConfig
      • spectrumConfig required
        • bandwidth required
          • units required
          • value required
        • centerFrequency required
          • units required
          • value required
        • polarization
    • antennaDownlinkDemodDecodeConfig
      • decodeConfig required
        • unvalidatedJSON required
      • demodulationConfig required
        • unvalidatedJSON required
      • spectrumConfig required
        • bandwidth required
          • units required
          • value required
        • centerFrequency required
          • units required
          • value required
        • polarization
    • antennaUplinkConfig
      • spectrumConfig required
        • centerFrequency required
          • units required
          • value required
        • polarization
      • targetEirp required
        • units required
        • value required
      • transmitDisabled
    • dataflowEndpointConfig
      • dataflowEndpointName required
      • dataflowEndpointRegion
    • trackingConfig
      • autotrack required
    • uplinkEchoConfig
      • antennaUplinkConfigArn required
      • enabled required
  • name required string: Name of a Config.

• output ConfigIdResponse

amazonaws_groundstation.DeleteConfig({
  "configId": "",
  "configType": ""
}, context)

• input object
  • configId required string
  • configType required string

• output ConfigIdResponse

amazonaws_groundstation.GetConfig({
  "configId": "",
  "configType": ""
}, context)

• input object
  • configId required string
  • configType required string

• output GetConfigResponse

amazonaws_groundstation.UpdateConfig({
  "configId": "",
  "configType": "",
  "configData": {},
  "name": ""
}, context)

• input object
  • configId required string
  • configType required string
  • configData required object:

    Object containing the parameters of a Config.

    See the subtype definitions for what each type of Config contains.

    • antennaDownlinkConfig
      • spectrumConfig required
        • bandwidth required
          • units required
          • value required
        • centerFrequency required
          • units required
          • value required
        • polarization
    • antennaDownlinkDemodDecodeConfig
      • decodeConfig required
        • unvalidatedJSON required
      • demodulationConfig required
        • unvalidatedJSON required
      • spectrumConfig required
        • bandwidth required
          • units required
          • value required
        • centerFrequency required
          • units required
          • value required
        • polarization
    • antennaUplinkConfig
      • spectrumConfig required
        • centerFrequency required
          • units required
          • value required
        • polarization
      • targetEirp required
        • units required
        • value required
      • transmitDisabled
    • dataflowEndpointConfig
      • dataflowEndpointName required
      • dataflowEndpointRegion
    • trackingConfig
      • autotrack required
    • uplinkEchoConfig
      • antennaUplinkConfigArn required
      • enabled required
  • name required string: Name of a Config.

• output ConfigIdResponse

amazonaws_groundstation.ReserveContact({
  "endTime": "",
  "groundStation": "",
  "missionProfileArn": "",
  "satelliteArn": "",
  "startTime": ""
}, context)

• input object
  • tags object: Tags assigned to a contact.
  • endTime required string: End time of a contact.
  • groundStation required string: Name of a ground station.
  • missionProfileArn required string: ARN of a mission profile.
  • satelliteArn required string: ARN of a satellite
  • startTime required string: Start time of a contact.

• output ContactIdResponse

amazonaws_groundstation.CancelContact({
  "contactId": ""
}, context)

• input object
  • contactId required string

• output ContactIdResponse

amazonaws_groundstation.DescribeContact({
  "contactId": ""
}, context)

• input object
  • contactId required string

• output DescribeContactResponse

amazonaws_groundstation.ListContacts({
  "endTime": "",
  "startTime": "",
  "statusList": []
}, context)

• input object
  • maxResults string
  • nextToken string
  • endTime required string: End time of a contact.
  • groundStation string: Name of a ground station.
  • maxResults integer: Maximum number of contacts returned.
  • missionProfileArn string: ARN of a mission profile.
  • nextToken string: Next token returned in the request of a previous ListContacts call. Used to get the next page of results.
  • satelliteArn string: ARN of a satellite.
  • startTime required string: Start time of a contact.
  • statusList required array: Status of a contact reservation.
    • items ContactStatus

• output ListContactsResponse

amazonaws_groundstation.ListDataflowEndpointGroups({}, context)

• input object
  • maxResults integer
  • nextToken string

• output ListDataflowEndpointGroupsResponse

amazonaws_groundstation.CreateDataflowEndpointGroup({
  "endpointDetails": []
}, context)

• input object
  • tags object: Tags of a dataflow endpoint group.
  • endpointDetails required array: Endpoint details of each endpoint in the dataflow endpoint group.
    • items EndpointDetails

• output DataflowEndpointGroupIdResponse

amazonaws_groundstation.DeleteDataflowEndpointGroup({
  "dataflowEndpointGroupId": ""
}, context)

• input object
  • dataflowEndpointGroupId required string

• output DataflowEndpointGroupIdResponse

amazonaws_groundstation.GetDataflowEndpointGroup({
  "dataflowEndpointGroupId": ""
}, context)

• input object
  • dataflowEndpointGroupId required string

• output GetDataflowEndpointGroupResponse

amazonaws_groundstation.ListGroundStations({}, context)

• input object
  • maxResults integer
  • nextToken string
  • satelliteId string

• output ListGroundStationsResponse

amazonaws_groundstation.GetMinuteUsage({
  "month": 0,
  "year": 0
}, context)

• input object
  • month required integer: The month being requested, with a value of 1-12.
  • year required integer: The year being requested, in the format of YYYY.

• output GetMinuteUsageResponse

amazonaws_groundstation.ListMissionProfiles({}, context)

• input object
  • maxResults integer
  • nextToken string

• output ListMissionProfilesResponse

amazonaws_groundstation.CreateMissionProfile({
  "dataflowEdges": [],
  "minimumViableContactDurationSeconds": 0,
  "name": "",
  "trackingConfigArn": ""
}, context)

• input object
  • tags object: Tags assigned to a mission profile.
  • contactPostPassDurationSeconds integer: Amount of time after a contact ends that you’d like to receive a CloudWatch event indicating the pass has finished.
  • contactPrePassDurationSeconds integer: Amount of time prior to contact start you’d like to receive a CloudWatch event indicating an upcoming pass.
  • dataflowEdges required array: A list of lists of ARNs. Each list of ARNs is an edge, with a from Config and a to Config.
    • items DataflowEdge
  • minimumViableContactDurationSeconds required integer: Smallest amount of time in seconds that you’d like to see for an available contact. AWS Ground Station will not present you with contacts shorter than this duration.
  • name required string: Name of a mission profile.
  • trackingConfigArn required string: ARN of a tracking Config.

• output MissionProfileIdResponse

amazonaws_groundstation.DeleteMissionProfile({
  "missionProfileId": ""
}, context)

• input object
  • missionProfileId required string

• output MissionProfileIdResponse

amazonaws_groundstation.GetMissionProfile({
  "missionProfileId": ""
}, context)

• input object
  • missionProfileId required string

• output GetMissionProfileResponse

amazonaws_groundstation.UpdateMissionProfile({
  "missionProfileId": ""
}, context)

• input object
  • missionProfileId required string
  • contactPostPassDurationSeconds integer: Amount of time after a contact ends that you’d like to receive a CloudWatch event indicating the pass has finished.
  • contactPrePassDurationSeconds integer: Amount of time after a contact ends that you’d like to receive a CloudWatch event indicating the pass has finished.
  • dataflowEdges array: A list of lists of ARNs. Each list of ARNs is an edge, with a from Config and a to Config.
    • items DataflowEdge
  • minimumViableContactDurationSeconds integer: Smallest amount of time in seconds that you’d like to see for an available contact. AWS Ground Station will not present you with contacts shorter than this duration.
  • name string: Name of a mission profile.
  • trackingConfigArn string: ARN of a tracking Config.

• output MissionProfileIdResponse

amazonaws_groundstation.ListSatellites({}, context)

• input object
  • maxResults integer
  • nextToken string

• output ListSatellitesResponse

amazonaws_groundstation.GetSatellite({
  "satelliteId": ""
}, context)

• input object
  • satelliteId required string

• output GetSatelliteResponse

amazonaws_groundstation.ListTagsForResource({
  "resourceArn": ""
}, context)

• input object
  • resourceArn required string

• output ListTagsForResourceResponse

amazonaws_groundstation.TagResource({
  "resourceArn": "",
  "tags": {}
}, context)

• input object
  • resourceArn required string
  • tags required object: Tags assigned to a resource.

• output TagResourceResponse

amazonaws_groundstation.UntagResource({
  "resourceArn": "",
  "tagKeys": []
}, context)

• input object
  • resourceArn required string
  • tagKeys required array

• output UntagResourceResponse

• AngleUnits string (values: DEGREE_ANGLE, RADIAN)

• AntennaDemodDecodeDetails object: Details about an antenna demod decode Config used in a contact.
  • outputNode

• AntennaDownlinkConfig object: Information about how AWS Ground Station should configure an antenna for downlink during a contact.
  • spectrumConfig required
    • bandwidth required
      • units required
      • value required
    • centerFrequency required
      • units required
      • value required
    • polarization

• AntennaDownlinkDemodDecodeConfig object: Information about how AWS Ground Station should configure an antenna for downlink demod decode during a contact.
  • decodeConfig required
    • unvalidatedJSON required
  • demodulationConfig required
    • unvalidatedJSON required
  • spectrumConfig required
    • bandwidth required
      • units required
      • value required
    • centerFrequency required
      • units required
      • value required
    • polarization

• AntennaUplinkConfig object: Information about the uplink Config of an antenna.
  • spectrumConfig required
    • centerFrequency required
      • units required
      • value required
    • polarization
  • targetEirp required
    • units required
    • value required
  • transmitDisabled

• BandwidthUnits string (values: GHz, MHz, kHz)

• Boolean boolean

• CancelContactRequest object:

• ConfigArn string

• ConfigCapabilityType string (values: antenna-downlink, antenna-downlink-demod-decode, antenna-uplink, dataflow-endpoint, tracking, uplink-echo)

• ConfigDetails object: Details for certain Config object types in a contact.
  • antennaDemodDecodeDetails
    • outputNode
  • endpointDetails EndpointDetails

• ConfigIdResponse object:
  • configArn
  • configId
  • configType

• ConfigList array
  • items ConfigListItem

• ConfigListItem object: An item in a list of Config objects.
  • configArn
  • configId
  • configType
  • name

• ConfigTypeData object:

  Object containing the parameters of a Config.

  See the subtype definitions for what each type of Config contains.

  • antennaDownlinkConfig
    • spectrumConfig required
      • bandwidth required
        • units required
        • value required
      • centerFrequency required
        • units required
        • value required
      • polarization
  • antennaDownlinkDemodDecodeConfig
    • decodeConfig required
      • unvalidatedJSON required
    • demodulationConfig required
      • unvalidatedJSON required
    • spectrumConfig required
      • bandwidth required
        • units required
        • value required
      • centerFrequency required
        • units required
        • value required
      • polarization
  • antennaUplinkConfig
    • spectrumConfig required
      • centerFrequency required
        • units required
        • value required
      • polarization
    • targetEirp required
      • units required
      • value required
    • transmitDisabled
  • dataflowEndpointConfig
    • dataflowEndpointName required
    • dataflowEndpointRegion
  • trackingConfig
    • autotrack required
  • uplinkEchoConfig
    • antennaUplinkConfigArn required
    • enabled required

• ContactData object: Data describing a contact.
  • tags
  • contactId
  • contactStatus
  • endTime
  • errorMessage
  • groundStation
  • maximumElevation
    • unit required
    • value required
  • missionProfileArn
  • postPassEndTime
  • prePassStartTime
  • region
  • satelliteArn
  • startTime

• ContactIdResponse object:
  • contactId

• ContactList array
  • items ContactData

• ContactStatus string (values: AVAILABLE, AWS_CANCELLED, AWS_FAILED, CANCELLED, CANCELLING, COMPLETED, FAILED, FAILED_TO_SCHEDULE, PASS, POSTPASS, PREPASS, SCHEDULED, SCHEDULING)

• CreateConfigRequest object:
  • tags
  • configData required
    • antennaDownlinkConfig
      • spectrumConfig required
        • bandwidth required
          • units required
          • value required
        • centerFrequency required
          • units required
          • value required
        • polarization
    • antennaDownlinkDemodDecodeConfig
      • decodeConfig required
        • unvalidatedJSON required
      • demodulationConfig required
        • unvalidatedJSON required
      • spectrumConfig required
        • bandwidth required
          • units required
          • value required
        • centerFrequency required
          • units required
          • value required
        • polarization
    • antennaUplinkConfig
      • spectrumConfig required
        • centerFrequency required
          • units required
          • value required
        • polarization
      • targetEirp required
        • units required
        • value required
      • transmitDisabled
    • dataflowEndpointConfig
      • dataflowEndpointName required
      • dataflowEndpointRegion
    • trackingConfig
      • autotrack required
    • uplinkEchoConfig
      • antennaUplinkConfigArn required
      • enabled required
  • name required

• CreateDataflowEndpointGroupRequest object:
  • tags
  • endpointDetails required
    • items EndpointDetails

• CreateMissionProfileRequest object:
  • tags
  • contactPostPassDurationSeconds
  • contactPrePassDurationSeconds
  • dataflowEdges required
    • items DataflowEdge
  • minimumViableContactDurationSeconds required
  • name required
  • trackingConfigArn required

• Criticality string (values: PREFERRED, REMOVED, REQUIRED)

• DataflowDetail object: Information about a dataflow edge used in a contact.
  • destination Destination
  • errorMessage
  • source Source

• DataflowEdge array
  • items ConfigArn

• DataflowEdgeList array
  • items DataflowEdge

• DataflowEndpoint object: Information about a dataflow endpoint.
  • address
    • name required
    • port required
  • mtu
  • name
  • status

• DataflowEndpointConfig object: Information about the dataflow endpoint Config.
  • dataflowEndpointName required
  • dataflowEndpointRegion

• DataflowEndpointGroupArn string

• DataflowEndpointGroupIdResponse object:
  • dataflowEndpointGroupId

• DataflowEndpointGroupList array
  • items DataflowEndpointListItem

• DataflowEndpointListItem object: Item in a list of DataflowEndpoint groups.
  • dataflowEndpointGroupArn
  • dataflowEndpointGroupId

• DataflowEndpointmtuInteger integer

• DataflowList array
  • items DataflowDetail

• DecodeConfig object: Information about the decode Config.
  • unvalidatedJSON required

• DeleteConfigRequest object:

• DeleteDataflowEndpointGroupRequest object:

• DeleteMissionProfileRequest object:

• DemodulationConfig object: Information about the demodulation Config.
  • unvalidatedJSON required

• DescribeContactRequest object:

• DescribeContactResponse object:
  • tags
  • contactId
  • contactStatus
  • dataflowList
    • items DataflowDetail
  • endTime
  • errorMessage
  • groundStation
  • maximumElevation
    • unit required
    • value required
  • missionProfileArn
  • postPassEndTime
  • prePassStartTime
  • region
  • satelliteArn
  • startTime

• Destination object: Dataflow details for the destination side.
  • configDetails
    • antennaDemodDecodeDetails
      • outputNode
    • endpointDetails EndpointDetails
  • configId
  • configType
  • dataflowDestinationRegion

• Double number

• DurationInSeconds integer

• Eirp object: Object that represents EIRP.
  • units required
  • value required

• EirpUnits string (values: dBW)

• Elevation object: Elevation angle of the satellite in the sky during a contact.
  • unit required
  • value required

• EndpointDetails object: Information about the endpoint details.
  • endpoint
    • address
      • name required
      • port required
    • mtu
    • name
    • status
  • securityDetails
    • roleArn required
    • securityGroupIds required
      • items String
    • subnetIds required
      • items String

• EndpointDetailsList array
  • items EndpointDetails

• EndpointStatus string (values: created, creating, deleted, deleting, failed)

• Frequency object: Object that describes the frequency.
  • units required
  • value required

• FrequencyBandwidth object: Object that describes the frequency bandwidth.
  • units required
  • value required

• FrequencyUnits string (values: GHz, MHz, kHz)

• GetConfigRequest object:

• GetConfigResponse object:
  • tags
  • configArn required
  • configData required
    • antennaDownlinkConfig
      • spectrumConfig required
        • bandwidth required
          • units required
          • value required
        • centerFrequency required
          • units required
          • value required
        • polarization
    • antennaDownlinkDemodDecodeConfig
      • decodeConfig required
        • unvalidatedJSON required
      • demodulationConfig required
        • unvalidatedJSON required
      • spectrumConfig required
        • bandwidth required
          • units required
          • value required
        • centerFrequency required
          • units required
          • value required
        • polarization
    • antennaUplinkConfig
      • spectrumConfig required
        • centerFrequency required
          • units required
          • value required
        • polarization
      • targetEirp required
        • units required
        • value required
      • transmitDisabled
    • dataflowEndpointConfig
      • dataflowEndpointName required
      • dataflowEndpointRegion
    • trackingConfig
      • autotrack required
    • uplinkEchoConfig
      • antennaUplinkConfigArn required
      • enabled required
  • configId required
  • configType
  • name required

• GetDataflowEndpointGroupRequest object:

• GetDataflowEndpointGroupResponse object:
  • tags
  • dataflowEndpointGroupArn
  • dataflowEndpointGroupId
  • endpointsDetails
    • items EndpointDetails

• GetMinuteUsageRequest object:
  • month required
  • year required

• GetMinuteUsageResponse object:
  • estimatedMinutesRemaining
  • isReservedMinutesCustomer
  • totalReservedMinuteAllocation
  • totalScheduledMinutes
  • upcomingMinutesScheduled

• GetMissionProfileRequest object:

• GetMissionProfileResponse object:
  • tags
  • contactPostPassDurationSeconds
  • contactPrePassDurationSeconds
  • dataflowEdges
    • items DataflowEdge
  • minimumViableContactDurationSeconds
  • missionProfileArn
  • missionProfileId
  • name
  • region
  • trackingConfigArn

• GetSatelliteRequest object:

• GetSatelliteResponse object:
  • groundStations
    • items String
  • noradSatelliteID
  • satelliteArn
  • satelliteId

• GroundStationData object: Information about the ground station data.
  • groundStationId
  • groundStationName
  • region

• GroundStationIdList array
  • items String

• GroundStationList array
  • items GroundStationData

• Integer integer

• JsonString string

• ListConfigsRequest object:

• ListConfigsResponse object:
  • configList
    • items ConfigListItem
  • nextToken

• ListContactsRequest object:
  • endTime required
  • groundStation
  • maxResults
  • missionProfileArn
  • nextToken
  • satelliteArn
  • startTime required
  • statusList required
    • items ContactStatus

• ListContactsResponse object:
  • contactList
    • items ContactData
  • nextToken

• ListDataflowEndpointGroupsRequest object:

• ListDataflowEndpointGroupsResponse object:
  • dataflowEndpointGroupList
    • items DataflowEndpointListItem
  • nextToken

• ListGroundStationsRequest object:

• ListGroundStationsResponse object:
  • groundStationList
    • items GroundStationData
  • nextToken

• ListMissionProfilesRequest object:

• ListMissionProfilesResponse object:
  • missionProfileList
    • items MissionProfileListItem
  • nextToken

• ListSatellitesRequest object:

• ListSatellitesResponse object:
  • nextToken
  • satellites
    • items SatelliteListItem

• ListTagsForResourceRequest object:

• ListTagsForResourceResponse object:
  • tags

• MissionProfileArn string

• MissionProfileIdResponse object:
  • missionProfileId

• MissionProfileList array
  • items MissionProfileListItem

• MissionProfileListItem object: Item in a list of mission profiles.
  • missionProfileArn
  • missionProfileId
  • name
  • region

• Polarization string (values: LEFT_HAND, NONE, RIGHT_HAND)

• ReserveContactRequest object:
  • tags
  • endTime required
  • groundStation required
  • missionProfileArn required
  • satelliteArn required
  • startTime required

• RoleArn string

• SafeName string

• SatelliteList array
  • items SatelliteListItem

• SatelliteListItem object: Item in a list of satellites.
  • groundStations
    • items String
  • noradSatelliteID
  • satelliteArn
  • satelliteId

• SecurityDetails object: Information about endpoints.
  • roleArn required
  • securityGroupIds required
    • items String
  • subnetIds required
    • items String

• SecurityGroupIdList array
  • items String

• SocketAddress object: Information about the socket address.
  • name required
  • port required

• Source object: Dataflow details for the source side.
  • configDetails
    • antennaDemodDecodeDetails
      • outputNode
    • endpointDetails EndpointDetails
  • configId
  • configType
  • dataflowSourceRegion

• SpectrumConfig object: Object that describes a spectral Config.
  • bandwidth required
    • units required
    • value required
  • centerFrequency required
    • units required
    • value required
  • polarization

• StatusList array
  • items ContactStatus

• String string

• SubnetList array
  • items String

• TagKeys array
  • items String

• TagResourceRequest object:
  • tags required

• TagResourceResponse object:

• TagsMap object

• Timestamp string

• TrackingConfig object: Object that determines whether tracking should be used during a contact executed with this Config in the mission profile.
  • autotrack required

• UntagResourceRequest object:

• UntagResourceResponse object:

• UpdateConfigRequest object:
  • configData required
    • antennaDownlinkConfig
      • spectrumConfig required
        • bandwidth required
          • units required
          • value required
        • centerFrequency required
          • units required
          • value required
        • polarization
    • antennaDownlinkDemodDecodeConfig
      • decodeConfig required
        • unvalidatedJSON required
      • demodulationConfig required
        • unvalidatedJSON required
      • spectrumConfig required
        • bandwidth required
          • units required
          • value required
        • centerFrequency required
          • units required
          • value required
        • polarization
    • antennaUplinkConfig
      • spectrumConfig required
        • centerFrequency required
          • units required
          • value required
        • polarization
      • targetEirp required
        • units required
        • value required
      • transmitDisabled
    • dataflowEndpointConfig
      • dataflowEndpointName required
      • dataflowEndpointRegion
    • trackingConfig
      • autotrack required
    • uplinkEchoConfig
      • antennaUplinkConfigArn required
      • enabled required
  • name required

• UpdateMissionProfileRequest object:
  • contactPostPassDurationSeconds
  • contactPrePassDurationSeconds
  • dataflowEdges
    • items DataflowEdge
  • minimumViableContactDurationSeconds
  • name
  • trackingConfigArn

• UplinkEchoConfig object:

  Information about an uplink echo Config.

  Parameters from the AntennaUplinkConfig, corresponding to the specified AntennaUplinkConfigArn, are used when this UplinkEchoConfig is used in a contact.

  • antennaUplinkConfigArn required
  • enabled required

• UplinkSpectrumConfig object: Information about the uplink spectral Config.
  • centerFrequency required
    • units required
    • value required
  • polarization

• Uuid string

• noradSatelliteID integer

• satelliteArn string