{ "version":"2.0", "metadata":{ "apiVersion":"2019-05-23", "endpointPrefix":"groundstation", "jsonVersion":"1.1", "protocol":"rest-json", "serviceFullName":"AWS Ground Station", "serviceId":"GroundStation", "signatureVersion":"v4", "signingName":"groundstation", "uid":"groundstation-2019-05-23" }, "operations":{ "CancelContact":{ "name":"CancelContact", "http":{ "method":"DELETE", "requestUri":"/contact/{contactId}", "responseCode":200 }, "input":{"shape":"CancelContactRequest"}, "output":{"shape":"ContactIdResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"DependencyException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"
Cancels a contact with a specified contact ID.
", "idempotent":true }, "CreateConfig":{ "name":"CreateConfig", "http":{ "method":"POST", "requestUri":"/config", "responseCode":200 }, "input":{"shape":"CreateConfigRequest"}, "output":{"shape":"ConfigIdResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"DependencyException"}, {"shape":"ResourceLimitExceededException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"Creates a Config with the specified configData parameters.
Only one type of configData can be specified.
Creates a DataflowEndpoint group containing the specified list of DataflowEndpoint objects.
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.
Creates 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.
Deletes a Config.
Deletes a dataflow endpoint group.
", "idempotent":true }, "DeleteMissionProfile":{ "name":"DeleteMissionProfile", "http":{ "method":"DELETE", "requestUri":"/missionprofile/{missionProfileId}", "responseCode":200 }, "input":{"shape":"DeleteMissionProfileRequest"}, "output":{"shape":"MissionProfileIdResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"DependencyException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"Deletes a mission profile.
", "idempotent":true }, "DescribeContact":{ "name":"DescribeContact", "http":{ "method":"GET", "requestUri":"/contact/{contactId}", "responseCode":200 }, "input":{"shape":"DescribeContactRequest"}, "output":{"shape":"DescribeContactResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"DependencyException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"Describes an existing contact.
" }, "GetConfig":{ "name":"GetConfig", "http":{ "method":"GET", "requestUri":"/config/{configType}/{configId}", "responseCode":200 }, "input":{"shape":"GetConfigRequest"}, "output":{"shape":"GetConfigResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"DependencyException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"Returns Config information.
Only one Config response can be returned.
Returns the dataflow endpoint group.
" }, "GetMinuteUsage":{ "name":"GetMinuteUsage", "http":{ "method":"POST", "requestUri":"/minute-usage", "responseCode":200 }, "input":{"shape":"GetMinuteUsageRequest"}, "output":{"shape":"GetMinuteUsageResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"DependencyException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"Returns the number of minutes used by account.
" }, "GetMissionProfile":{ "name":"GetMissionProfile", "http":{ "method":"GET", "requestUri":"/missionprofile/{missionProfileId}", "responseCode":200 }, "input":{"shape":"GetMissionProfileRequest"}, "output":{"shape":"GetMissionProfileResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"DependencyException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"Returns a mission profile.
" }, "GetSatellite":{ "name":"GetSatellite", "http":{ "method":"GET", "requestUri":"/satellite/{satelliteId}", "responseCode":200 }, "input":{"shape":"GetSatelliteRequest"}, "output":{"shape":"GetSatelliteResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"DependencyException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"Returns a satellite.
" }, "ListConfigs":{ "name":"ListConfigs", "http":{ "method":"GET", "requestUri":"/config", "responseCode":200 }, "input":{"shape":"ListConfigsRequest"}, "output":{"shape":"ListConfigsResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"DependencyException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"Returns a list of Config objects.
Returns a list of contacts.
If statusList contains AVAILABLE, the request must include groundStation, missionprofileArn, and satelliteArn.
Returns a list of DataflowEndpoint groups.
Returns a list of ground stations.
" }, "ListMissionProfiles":{ "name":"ListMissionProfiles", "http":{ "method":"GET", "requestUri":"/missionprofile", "responseCode":200 }, "input":{"shape":"ListMissionProfilesRequest"}, "output":{"shape":"ListMissionProfilesResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"DependencyException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"Returns a list of mission profiles.
" }, "ListSatellites":{ "name":"ListSatellites", "http":{ "method":"GET", "requestUri":"/satellite", "responseCode":200 }, "input":{"shape":"ListSatellitesRequest"}, "output":{"shape":"ListSatellitesResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"DependencyException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"Returns a list of satellites.
" }, "ListTagsForResource":{ "name":"ListTagsForResource", "http":{ "method":"GET", "requestUri":"/tags/{resourceArn}", "responseCode":200 }, "input":{"shape":"ListTagsForResourceRequest"}, "output":{"shape":"ListTagsForResourceResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"DependencyException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"Returns a list of tags for a specified resource.
" }, "ReserveContact":{ "name":"ReserveContact", "http":{ "method":"POST", "requestUri":"/contact", "responseCode":200 }, "input":{"shape":"ReserveContactRequest"}, "output":{"shape":"ContactIdResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"DependencyException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"Reserves a contact using specified parameters.
" }, "TagResource":{ "name":"TagResource", "http":{ "method":"POST", "requestUri":"/tags/{resourceArn}", "responseCode":200 }, "input":{"shape":"TagResourceRequest"}, "output":{"shape":"TagResourceResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"DependencyException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"Assigns a tag to a resource.
" }, "UntagResource":{ "name":"UntagResource", "http":{ "method":"DELETE", "requestUri":"/tags/{resourceArn}", "responseCode":200 }, "input":{"shape":"UntagResourceRequest"}, "output":{"shape":"UntagResourceResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"DependencyException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"Deassigns a resource tag.
", "idempotent":true }, "UpdateConfig":{ "name":"UpdateConfig", "http":{ "method":"PUT", "requestUri":"/config/{configType}/{configId}", "responseCode":200 }, "input":{"shape":"UpdateConfigRequest"}, "output":{"shape":"ConfigIdResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"DependencyException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"Updates the Config used when scheduling contacts.
Updating a Config will not update the execution parameters for existing future contacts scheduled with this Config.
Updates a mission profile.
Updating a mission profile will not update the execution parameters for existing future contacts.
", "idempotent":true } }, "shapes":{ "AngleUnits":{ "type":"string", "enum":[ "DEGREE_ANGLE", "RADIAN" ] }, "AntennaDemodDecodeDetails":{ "type":"structure", "members":{ "outputNode":{ "shape":"String", "documentation":"Name of an antenna demod decode output node used in a contact.
" } }, "documentation":"Details about an antenna demod decode Config used in a contact.
Object that describes a spectral Config.
Information about how AWS Ground Station should configure an antenna for downlink during a contact.
" }, "AntennaDownlinkDemodDecodeConfig":{ "type":"structure", "required":[ "decodeConfig", "demodulationConfig", "spectrumConfig" ], "members":{ "decodeConfig":{ "shape":"DecodeConfig", "documentation":"Information about the decode Config.
Information about the demodulation Config.
Information about the spectral Config.
Information about how AWS Ground Station should configure an antenna for downlink demod decode during a contact.
" }, "AntennaUplinkConfig":{ "type":"structure", "required":[ "spectrumConfig", "targetEirp" ], "members":{ "spectrumConfig":{ "shape":"UplinkSpectrumConfig", "documentation":"Information about the uplink spectral Config.
EIRP of the target.
" }, "transmitDisabled":{ "shape":"Boolean", "documentation":"Whether or not uplink transmit is disabled.
" } }, "documentation":"Information about the uplink Config of an antenna.
UUID of a contact.
", "location":"uri", "locationName":"contactId" } }, "documentation":"" }, "ConfigArn":{"type":"string"}, "ConfigCapabilityType":{ "type":"string", "enum":[ "antenna-downlink", "antenna-downlink-demod-decode", "antenna-uplink", "dataflow-endpoint", "tracking", "uplink-echo" ] }, "ConfigDetails":{ "type":"structure", "members":{ "antennaDemodDecodeDetails":{ "shape":"AntennaDemodDecodeDetails", "documentation":"Details for antenna demod decode Config in a contact.
Details for certain Config object types in a contact.
ARN of a Config.
UUID of a Config.
Type of a Config.
ARN of a Config.
UUID of a Config.
Type of a Config.
Name of a Config.
An item in a list of Config objects.
Information about how AWS Ground Station should configure an antenna for downlink during a contact.
" }, "antennaDownlinkDemodDecodeConfig":{ "shape":"AntennaDownlinkDemodDecodeConfig", "documentation":"Information about how AWS Ground Station should configure an antenna for downlink demod decode during a contact.
" }, "antennaUplinkConfig":{ "shape":"AntennaUplinkConfig", "documentation":"Information about how AWS Ground Station should configure an antenna for uplink during a contact.
" }, "dataflowEndpointConfig":{ "shape":"DataflowEndpointConfig", "documentation":"Information about the dataflow endpoint Config.
Object that determines whether tracking should be used during a contact executed with this Config in the mission profile.
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.
Object containing the parameters of a Config.
See the subtype definitions for what each type of Config contains.
UUID of a contact.
" }, "contactStatus":{ "shape":"ContactStatus", "documentation":"Status of a contact.
" }, "endTime":{ "shape":"Timestamp", "documentation":"End time of a contact.
" }, "errorMessage":{ "shape":"String", "documentation":"Error message of a contact.
" }, "groundStation":{ "shape":"String", "documentation":"Name of a ground station.
" }, "maximumElevation":{ "shape":"Elevation", "documentation":"Maximum elevation angle of a contact.
" }, "missionProfileArn":{ "shape":"MissionProfileArn", "documentation":"ARN of a mission profile.
" }, "postPassEndTime":{ "shape":"Timestamp", "documentation":"Amount of time after a contact ends that you’d like to receive a CloudWatch event indicating the pass has finished.
" }, "prePassStartTime":{ "shape":"Timestamp", "documentation":"Amount of time prior to contact start you’d like to receive a CloudWatch event indicating an upcoming pass.
" }, "region":{ "shape":"String", "documentation":"Region of a contact.
" }, "satelliteArn":{ "shape":"satelliteArn", "documentation":"ARN of a satellite.
" }, "startTime":{ "shape":"Timestamp", "documentation":"Start time of a contact.
" }, "tags":{ "shape":"TagsMap", "documentation":"Tags assigned to a contact.
" } }, "documentation":"Data describing a contact.
" }, "ContactIdResponse":{ "type":"structure", "members":{ "contactId":{ "shape":"String", "documentation":"UUID of a contact.
" } }, "documentation":"" }, "ContactList":{ "type":"list", "member":{"shape":"ContactData"} }, "ContactStatus":{ "type":"string", "enum":[ "AVAILABLE", "AWS_CANCELLED", "CANCELLED", "CANCELLING", "COMPLETED", "FAILED", "FAILED_TO_SCHEDULE", "PASS", "POSTPASS", "PREPASS", "SCHEDULED", "SCHEDULING" ] }, "CreateConfigRequest":{ "type":"structure", "required":[ "configData", "name" ], "members":{ "configData":{ "shape":"ConfigTypeData", "documentation":"Parameters of a Config.
Name of a Config.
Tags assigned to a Config.
Endpoint details of each endpoint in the dataflow endpoint group.
" }, "tags":{ "shape":"TagsMap", "documentation":"Tags of a dataflow endpoint group.
" } }, "documentation":"" }, "CreateMissionProfileRequest":{ "type":"structure", "required":[ "dataflowEdges", "minimumViableContactDurationSeconds", "name", "trackingConfigArn" ], "members":{ "contactPostPassDurationSeconds":{ "shape":"DurationInSeconds", "documentation":"Amount of time after a contact ends that you’d like to receive a CloudWatch event indicating the pass has finished.
" }, "contactPrePassDurationSeconds":{ "shape":"DurationInSeconds", "documentation":"Amount of time prior to contact start you’d like to receive a CloudWatch event indicating an upcoming pass.
" }, "dataflowEdges":{ "shape":"DataflowEdgeList", "documentation":"A list of lists of ARNs. Each list of ARNs is an edge, with a from Config and a to Config.
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":{ "shape":"SafeName", "documentation":"Name of a mission profile.
" }, "tags":{ "shape":"TagsMap", "documentation":"Tags assigned to a mission profile.
" }, "trackingConfigArn":{ "shape":"ConfigArn", "documentation":"ARN of a tracking Config.
Information about a dataflow edge used in a contact.
" }, "DataflowEdge":{ "type":"list", "member":{"shape":"ConfigArn"}, "max":2, "min":2 }, "DataflowEdgeList":{ "type":"list", "member":{"shape":"DataflowEdge"} }, "DataflowEndpoint":{ "type":"structure", "members":{ "address":{ "shape":"SocketAddress", "documentation":"Socket address of a dataflow endpoint.
" }, "mtu":{ "shape":"DataflowEndpointmtuInteger", "documentation":"Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.
" }, "name":{ "shape":"SafeName", "documentation":"Name of a dataflow endpoint.
" }, "status":{ "shape":"EndpointStatus", "documentation":"Status of a dataflow endpoint.
" } }, "documentation":"Information about a dataflow endpoint.
" }, "DataflowEndpointConfig":{ "type":"structure", "required":["dataflowEndpointName"], "members":{ "dataflowEndpointName":{ "shape":"String", "documentation":"Name of a dataflow endpoint.
" }, "dataflowEndpointRegion":{ "shape":"String", "documentation":"Region of a dataflow endpoint.
" } }, "documentation":"Information about the dataflow endpoint Config.
UUID of a dataflow endpoint group.
" } }, "documentation":"" }, "DataflowEndpointGroupList":{ "type":"list", "member":{"shape":"DataflowEndpointListItem"} }, "DataflowEndpointListItem":{ "type":"structure", "members":{ "dataflowEndpointGroupArn":{ "shape":"DataflowEndpointGroupArn", "documentation":"ARN of a dataflow endpoint group.
" }, "dataflowEndpointGroupId":{ "shape":"String", "documentation":"UUID of a dataflow endpoint group.
" } }, "documentation":"Item in a list of DataflowEndpoint groups.
Unvalidated JSON of a decode Config.
Information about the decode Config.
UUID of a Config.
Type of a Config.
UUID of a dataflow endpoint group.
", "location":"uri", "locationName":"dataflowEndpointGroupId" } }, "documentation":"" }, "DeleteMissionProfileRequest":{ "type":"structure", "required":["missionProfileId"], "members":{ "missionProfileId":{ "shape":"String", "documentation":"UUID of a mission profile.
", "location":"uri", "locationName":"missionProfileId" } }, "documentation":"" }, "DemodulationConfig":{ "type":"structure", "required":["unvalidatedJSON"], "members":{ "unvalidatedJSON":{ "shape":"JsonString", "documentation":"Unvalidated JSON of a demodulation Config.
Information about the demodulation Config.
Dependency encountered an error.
", "error":{"httpStatusCode":531}, "exception":true, "fault":true }, "DescribeContactRequest":{ "type":"structure", "required":["contactId"], "members":{ "contactId":{ "shape":"String", "documentation":"UUID of a contact.
", "location":"uri", "locationName":"contactId" } }, "documentation":"" }, "DescribeContactResponse":{ "type":"structure", "members":{ "contactId":{ "shape":"String", "documentation":"UUID of a contact.
" }, "contactStatus":{ "shape":"ContactStatus", "documentation":"Status of a contact.
" }, "dataflowList":{ "shape":"DataflowList", "documentation":"List describing source and destination details for each dataflow edge.
" }, "endTime":{ "shape":"Timestamp", "documentation":"End time of a contact.
" }, "errorMessage":{ "shape":"String", "documentation":"Error message for a contact.
" }, "groundStation":{ "shape":"String", "documentation":"Ground station for a contact.
" }, "maximumElevation":{ "shape":"Elevation", "documentation":"Maximum elevation angle of a contact.
" }, "missionProfileArn":{ "shape":"MissionProfileArn", "documentation":"ARN of a mission profile.
" }, "postPassEndTime":{ "shape":"Timestamp", "documentation":"Amount of time after a contact ends that you’d like to receive a CloudWatch event indicating the pass has finished.
" }, "prePassStartTime":{ "shape":"Timestamp", "documentation":"Amount of time prior to contact start you’d like to receive a CloudWatch event indicating an upcoming pass.
" }, "region":{ "shape":"String", "documentation":"Region of a contact.
" }, "satelliteArn":{ "shape":"satelliteArn", "documentation":"ARN of a satellite.
" }, "startTime":{ "shape":"Timestamp", "documentation":"Start time of a contact.
" }, "tags":{ "shape":"TagsMap", "documentation":"Tags assigned to a contact.
" } }, "documentation":"" }, "Destination":{ "type":"structure", "members":{ "configDetails":{ "shape":"ConfigDetails", "documentation":"Additional details for a Config, if type is dataflow endpoint or antenna demod decode.
UUID of a Config.
Type of a Config.
Region of a dataflow destination.
" } }, "documentation":"Dataflow details for the destination side.
" }, "Double":{ "type":"double", "box":true }, "DurationInSeconds":{ "type":"integer", "box":true, "max":21600, "min":1 }, "Eirp":{ "type":"structure", "required":[ "units", "value" ], "members":{ "units":{ "shape":"EirpUnits", "documentation":"Units of an EIRP.
" }, "value":{ "shape":"Double", "documentation":"Value of an EIRP. Valid values are between 20.0 to 50.0 dBW.
" } }, "documentation":"Object that represents EIRP.
" }, "EirpUnits":{ "type":"string", "enum":["dBW"] }, "Elevation":{ "type":"structure", "required":[ "unit", "value" ], "members":{ "unit":{ "shape":"AngleUnits", "documentation":"Elevation angle units.
" }, "value":{ "shape":"Double", "documentation":"Elevation angle value.
" } }, "documentation":"Elevation angle of the satellite in the sky during a contact.
" }, "EndpointDetails":{ "type":"structure", "members":{ "endpoint":{ "shape":"DataflowEndpoint", "documentation":"A dataflow endpoint.
" }, "securityDetails":{ "shape":"SecurityDetails", "documentation":"Endpoint security details.
" } }, "documentation":"Information about the endpoint details.
" }, "EndpointDetailsList":{ "type":"list", "member":{"shape":"EndpointDetails"} }, "EndpointStatus":{ "type":"string", "enum":[ "created", "creating", "deleted", "deleting", "failed" ] }, "Frequency":{ "type":"structure", "required":[ "units", "value" ], "members":{ "units":{ "shape":"FrequencyUnits", "documentation":"Frequency units.
" }, "value":{ "shape":"Double", "documentation":"Frequency value. Valid values are between 2200 to 2300 MHz and 7750 to 8400 MHz for downlink and 2025 to 2120 MHz for uplink.
" } }, "documentation":"Object that describes the frequency.
" }, "FrequencyBandwidth":{ "type":"structure", "required":[ "units", "value" ], "members":{ "units":{ "shape":"BandwidthUnits", "documentation":"Frequency bandwidth units.
" }, "value":{ "shape":"Double", "documentation":"Frequency bandwidth value. AWS Ground Station currently has the following bandwidth limitations:
For AntennaDownlinkDemodDecodeconfig, valid values are between 125 kHz to 650 MHz.
For AntennaDownlinkconfig, valid values are between 10 kHz to 54 MHz.
For AntennaUplinkConfig, valid values are between 10 kHz to 54 MHz.
Object that describes the frequency bandwidth.
" }, "FrequencyUnits":{ "type":"string", "enum":[ "GHz", "MHz", "kHz" ] }, "GetConfigRequest":{ "type":"structure", "required":[ "configId", "configType" ], "members":{ "configId":{ "shape":"String", "documentation":"UUID of a Config.
Type of a Config.
ARN of a Config
Data elements in a Config.
UUID of a Config.
Type of a Config.
Name of a Config.
Tags assigned to a Config.
UUID of a dataflow endpoint group.
", "location":"uri", "locationName":"dataflowEndpointGroupId" } }, "documentation":"" }, "GetDataflowEndpointGroupResponse":{ "type":"structure", "members":{ "dataflowEndpointGroupArn":{ "shape":"DataflowEndpointGroupArn", "documentation":"ARN of a dataflow endpoint group.
" }, "dataflowEndpointGroupId":{ "shape":"String", "documentation":"UUID of a dataflow endpoint group.
" }, "endpointsDetails":{ "shape":"EndpointDetailsList", "documentation":"Details of a dataflow endpoint.
" }, "tags":{ "shape":"TagsMap", "documentation":"Tags assigned to a dataflow endpoint group.
" } }, "documentation":"" }, "GetMinuteUsageRequest":{ "type":"structure", "required":[ "month", "year" ], "members":{ "month":{ "shape":"Integer", "documentation":"The month being requested, with a value of 1-12.
" }, "year":{ "shape":"Integer", "documentation":"The year being requested, in the format of YYYY.
" } }, "documentation":"" }, "GetMinuteUsageResponse":{ "type":"structure", "members":{ "estimatedMinutesRemaining":{ "shape":"Integer", "documentation":"Estimated number of minutes remaining for an account, specific to the month being requested.
" }, "isReservedMinutesCustomer":{ "shape":"Boolean", "documentation":"Returns whether or not an account has signed up for the reserved minutes pricing plan, specific to the month being requested.
" }, "totalReservedMinuteAllocation":{ "shape":"Integer", "documentation":"Total number of reserved minutes allocated, specific to the month being requested.
" }, "totalScheduledMinutes":{ "shape":"Integer", "documentation":"Total scheduled minutes for an account, specific to the month being requested.
" }, "upcomingMinutesScheduled":{ "shape":"Integer", "documentation":"Upcoming minutes scheduled for an account, specific to the month being requested.
" } }, "documentation":"" }, "GetMissionProfileRequest":{ "type":"structure", "required":["missionProfileId"], "members":{ "missionProfileId":{ "shape":"String", "documentation":"UUID of a mission profile.
", "location":"uri", "locationName":"missionProfileId" } }, "documentation":"" }, "GetMissionProfileResponse":{ "type":"structure", "members":{ "contactPostPassDurationSeconds":{ "shape":"DurationInSeconds", "documentation":"Amount of time after a contact ends that you’d like to receive a CloudWatch event indicating the pass has finished.
" }, "contactPrePassDurationSeconds":{ "shape":"DurationInSeconds", "documentation":"Amount of time prior to contact start you’d like to receive a CloudWatch event indicating an upcoming pass.
" }, "dataflowEdges":{ "shape":"DataflowEdgeList", "documentation":"A list of lists of ARNs. Each list of ARNs is an edge, with a from Config and a to Config.
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.
" }, "missionProfileArn":{ "shape":"MissionProfileArn", "documentation":"ARN of a mission profile.
" }, "missionProfileId":{ "shape":"String", "documentation":"UUID of a mission profile.
" }, "name":{ "shape":"String", "documentation":"Name of a mission profile.
" }, "region":{ "shape":"String", "documentation":"Region of a mission profile.
" }, "tags":{ "shape":"TagsMap", "documentation":"Tags assigned to a mission profile.
" }, "trackingConfigArn":{ "shape":"ConfigArn", "documentation":"ARN of a tracking Config.
UUID of a satellite.
", "location":"uri", "locationName":"satelliteId" } }, "documentation":"" }, "GetSatelliteResponse":{ "type":"structure", "members":{ "groundStations":{ "shape":"GroundStationIdList", "documentation":"A list of ground stations to which the satellite is on-boarded.
" }, "noradSatelliteID":{ "shape":"noradSatelliteID", "documentation":"NORAD satellite ID number.
" }, "satelliteArn":{ "shape":"satelliteArn", "documentation":"ARN of a satellite.
" }, "satelliteId":{ "shape":"Uuid", "documentation":"UUID of a satellite.
" } }, "documentation":"" }, "GroundStationData":{ "type":"structure", "members":{ "groundStationId":{ "shape":"String", "documentation":"UUID of a ground station.
" }, "groundStationName":{ "shape":"String", "documentation":"Name of a ground station.
" }, "region":{ "shape":"String", "documentation":"Ground station Region.
" } }, "documentation":"Information about the ground station data.
" }, "GroundStationIdList":{ "type":"list", "member":{"shape":"String"} }, "GroundStationList":{ "type":"list", "member":{"shape":"GroundStationData"} }, "Integer":{ "type":"integer", "box":true }, "InvalidParameterException":{ "type":"structure", "members":{ "message":{"shape":"String"}, "parameterName":{ "shape":"String", "documentation":"" } }, "documentation":"One or more parameters are not valid.
", "error":{ "httpStatusCode":431, "senderFault":true }, "exception":true }, "JsonString":{ "type":"string", "max":8192, "min":2, "pattern":"^[{}\\[\\]:.,\"0-9A-z\\-_\\s]{2,8192}$" }, "ListConfigsRequest":{ "type":"structure", "members":{ "maxResults":{ "shape":"Integer", "documentation":"Maximum number of Configs returned.
Next token returned in the request of a previous ListConfigs call. Used to get the next page of results.
List of Config items.
Next token returned in the response of a previous ListConfigs call. Used to get the next page of results.
End time of a contact.
" }, "groundStation":{ "shape":"String", "documentation":"Name of a ground station.
" }, "maxResults":{ "shape":"Integer", "documentation":"Maximum number of contacts returned.
" }, "missionProfileArn":{ "shape":"MissionProfileArn", "documentation":"ARN of a mission profile.
" }, "nextToken":{ "shape":"String", "documentation":"Next token returned in the request of a previous ListContacts call. Used to get the next page of results.
ARN of a satellite.
" }, "startTime":{ "shape":"Timestamp", "documentation":"Start time of a contact.
" }, "statusList":{ "shape":"StatusList", "documentation":"Status of a contact reservation.
" } }, "documentation":"" }, "ListContactsResponse":{ "type":"structure", "members":{ "contactList":{ "shape":"ContactList", "documentation":"List of contacts.
" }, "nextToken":{ "shape":"String", "documentation":"Next token returned in the response of a previous ListContacts call. Used to get the next page of results.
Maximum number of dataflow endpoint groups returned.
", "location":"querystring", "locationName":"maxResults" }, "nextToken":{ "shape":"String", "documentation":"Next token returned in the request of a previous ListDataflowEndpointGroups call. Used to get the next page of results.
A list of dataflow endpoint groups.
" }, "nextToken":{ "shape":"String", "documentation":"Next token returned in the response of a previous ListDataflowEndpointGroups call. Used to get the next page of results.
Maximum number of ground stations returned.
", "location":"querystring", "locationName":"maxResults" }, "nextToken":{ "shape":"String", "documentation":"Next token that can be supplied in the next call to get the next page of ground stations.
", "location":"querystring", "locationName":"nextToken" }, "satelliteId":{ "shape":"String", "documentation":"Satellite ID to retrieve on-boarded ground stations.
", "location":"querystring", "locationName":"satelliteId" } }, "documentation":"" }, "ListGroundStationsResponse":{ "type":"structure", "members":{ "groundStationList":{ "shape":"GroundStationList", "documentation":"List of ground stations.
" }, "nextToken":{ "shape":"String", "documentation":"Next token that can be supplied in the next call to get the next page of ground stations.
" } }, "documentation":"" }, "ListMissionProfilesRequest":{ "type":"structure", "members":{ "maxResults":{ "shape":"Integer", "documentation":"Maximum number of mission profiles returned.
", "location":"querystring", "locationName":"maxResults" }, "nextToken":{ "shape":"String", "documentation":"Next token returned in the request of a previous ListMissionProfiles call. Used to get the next page of results.
List of mission profiles.
" }, "nextToken":{ "shape":"String", "documentation":"Next token returned in the response of a previous ListMissionProfiles call. Used to get the next page of results.
Maximum number of satellites returned.
", "location":"querystring", "locationName":"maxResults" }, "nextToken":{ "shape":"String", "documentation":"Next token that can be supplied in the next call to get the next page of satellites.
", "location":"querystring", "locationName":"nextToken" } }, "documentation":"" }, "ListSatellitesResponse":{ "type":"structure", "members":{ "nextToken":{ "shape":"String", "documentation":"Next token that can be supplied in the next call to get the next page of satellites.
" }, "satellites":{ "shape":"SatelliteList", "documentation":"List of satellites.
" } }, "documentation":"" }, "ListTagsForResourceRequest":{ "type":"structure", "required":["resourceArn"], "members":{ "resourceArn":{ "shape":"String", "documentation":"ARN of a resource.
", "location":"uri", "locationName":"resourceArn" } }, "documentation":"" }, "ListTagsForResourceResponse":{ "type":"structure", "members":{ "tags":{ "shape":"TagsMap", "documentation":"Tags assigned to a resource.
" } }, "documentation":"" }, "MissionProfileArn":{"type":"string"}, "MissionProfileIdResponse":{ "type":"structure", "members":{ "missionProfileId":{ "shape":"String", "documentation":"UUID of a mission profile.
" } }, "documentation":"" }, "MissionProfileList":{ "type":"list", "member":{"shape":"MissionProfileListItem"} }, "MissionProfileListItem":{ "type":"structure", "members":{ "missionProfileArn":{ "shape":"MissionProfileArn", "documentation":"ARN of a mission profile.
" }, "missionProfileId":{ "shape":"String", "documentation":"UUID of a mission profile.
" }, "name":{ "shape":"String", "documentation":"Name of a mission profile.
" }, "region":{ "shape":"String", "documentation":"Region of a mission profile.
" } }, "documentation":"Item in a list of mission profiles.
" }, "Polarization":{ "type":"string", "enum":[ "LEFT_HAND", "NONE", "RIGHT_HAND" ] }, "ReserveContactRequest":{ "type":"structure", "required":[ "endTime", "groundStation", "missionProfileArn", "satelliteArn", "startTime" ], "members":{ "endTime":{ "shape":"Timestamp", "documentation":"End time of a contact.
" }, "groundStation":{ "shape":"String", "documentation":"Name of a ground station.
" }, "missionProfileArn":{ "shape":"MissionProfileArn", "documentation":"ARN of a mission profile.
" }, "satelliteArn":{ "shape":"satelliteArn", "documentation":"ARN of a satellite
" }, "startTime":{ "shape":"Timestamp", "documentation":"Start time of a contact.
" }, "tags":{ "shape":"TagsMap", "documentation":"Tags assigned to a contact.
" } }, "documentation":"" }, "ResourceLimitExceededException":{ "type":"structure", "members":{ "message":{"shape":"String"}, "parameterName":{ "shape":"String", "documentation":"" } }, "documentation":"Account limits for this resource have been exceeded.
", "error":{ "httpStatusCode":429, "senderFault":true }, "exception":true }, "ResourceNotFoundException":{ "type":"structure", "members":{ "message":{"shape":"String"} }, "documentation":"Resource was not found.
", "error":{ "httpStatusCode":434, "senderFault":true }, "exception":true }, "RoleArn":{"type":"string"}, "SafeName":{ "type":"string", "max":256, "min":1, "pattern":"^[ a-zA-Z0-9_:-]{1,256}$" }, "SatelliteList":{ "type":"list", "member":{"shape":"SatelliteListItem"} }, "SatelliteListItem":{ "type":"structure", "members":{ "groundStations":{ "shape":"GroundStationIdList", "documentation":"A list of ground stations to which the satellite is on-boarded.
" }, "noradSatelliteID":{ "shape":"noradSatelliteID", "documentation":"NORAD satellite ID number.
" }, "satelliteArn":{ "shape":"satelliteArn", "documentation":"ARN of a satellite.
" }, "satelliteId":{ "shape":"Uuid", "documentation":"UUID of a satellite.
" } }, "documentation":"Item in a list of satellites.
" }, "SecurityDetails":{ "type":"structure", "required":[ "roleArn", "securityGroupIds", "subnetIds" ], "members":{ "roleArn":{ "shape":"RoleArn", "documentation":"ARN to a role needed for connecting streams to your instances.
" }, "securityGroupIds":{ "shape":"SecurityGroupIdList", "documentation":"The security groups to attach to the elastic network interfaces.
" }, "subnetIds":{ "shape":"SubnetList", "documentation":"A list of subnets where AWS Ground Station places elastic network interfaces to send streams to your instances.
" } }, "documentation":"Information about endpoints.
" }, "SecurityGroupIdList":{ "type":"list", "member":{"shape":"String"} }, "SocketAddress":{ "type":"structure", "required":[ "name", "port" ], "members":{ "name":{ "shape":"String", "documentation":"Name of a socket address.
" }, "port":{ "shape":"Integer", "documentation":"Port of a socket address.
" } }, "documentation":"Information about the socket address.
" }, "Source":{ "type":"structure", "members":{ "configDetails":{ "shape":"ConfigDetails", "documentation":"Additional details for a Config, if type is dataflow endpoint or antenna demod decode.
UUID of a Config.
Type of a Config.
Region of a dataflow source.
" } }, "documentation":"Dataflow details for the source side.
" }, "SpectrumConfig":{ "type":"structure", "required":[ "bandwidth", "centerFrequency" ], "members":{ "bandwidth":{ "shape":"FrequencyBandwidth", "documentation":"Bandwidth of a spectral Config. AWS Ground Station currently has the following bandwidth limitations:
For AntennaDownlinkDemodDecodeconfig, valid values are between 125 kHz to 650 MHz.
For AntennaDownlinkconfig valid values are between 10 kHz to 54 MHz.
For AntennaUplinkConfig, valid values are between 10 kHz to 54 MHz.
Center frequency of a spectral Config. Valid values are between 2200 to 2300 MHz and 7750 to 8400 MHz for downlink and 2025 to 2120 MHz for uplink.
Polarization of a spectral Config. Capturing both \"RIGHT_HAND\" and \"LEFT_HAND\" polarization requires two separate configs.
Object that describes a spectral Config.
ARN of a resource tag.
", "location":"uri", "locationName":"resourceArn" }, "tags":{ "shape":"TagsMap", "documentation":"Tags assigned to a resource.
" } }, "documentation":"" }, "TagResourceResponse":{ "type":"structure", "members":{ }, "documentation":"" }, "TagsMap":{ "type":"map", "key":{"shape":"String"}, "value":{"shape":"String"} }, "Timestamp":{"type":"timestamp"}, "TrackingConfig":{ "type":"structure", "required":["autotrack"], "members":{ "autotrack":{ "shape":"Criticality", "documentation":"Current setting for autotrack.
" } }, "documentation":"Object that determines whether tracking should be used during a contact executed with this Config in the mission profile.
ARN of a resource.
", "location":"uri", "locationName":"resourceArn" }, "tagKeys":{ "shape":"TagKeys", "documentation":"Keys of a resource tag.
", "location":"querystring", "locationName":"tagKeys" } }, "documentation":"" }, "UntagResourceResponse":{ "type":"structure", "members":{ }, "documentation":"" }, "UpdateConfigRequest":{ "type":"structure", "required":[ "configData", "configId", "configType", "name" ], "members":{ "configData":{ "shape":"ConfigTypeData", "documentation":"Parameters of a Config.
UUID of a Config.
Type of a Config.
Name of a Config.
Amount of time after a contact ends that you’d like to receive a CloudWatch event indicating the pass has finished.
" }, "contactPrePassDurationSeconds":{ "shape":"DurationInSeconds", "documentation":"Amount of time after a contact ends that you’d like to receive a CloudWatch event indicating the pass has finished.
" }, "dataflowEdges":{ "shape":"DataflowEdgeList", "documentation":"A list of lists of ARNs. Each list of ARNs is an edge, with a from Config and a to Config.
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.
" }, "missionProfileId":{ "shape":"String", "documentation":"UUID of a mission profile.
", "location":"uri", "locationName":"missionProfileId" }, "name":{ "shape":"SafeName", "documentation":"Name of a mission profile.
" }, "trackingConfigArn":{ "shape":"ConfigArn", "documentation":"ARN of a tracking Config.
ARN of an uplink Config.
Whether or not an uplink Config is enabled.
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.
Center frequency of an uplink spectral Config. Valid values are between 2025 to 2120 MHz.
Polarization of an uplink spectral Config. Capturing both \"RIGHT_HAND\" and \"LEFT_HAND\" polarization requires two separate configs.
Information about the uplink spectral Config.
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.
" }