{ "smithy": "1.0", "shapes": { "com.amazonaws.groundstation#AngleUnits": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "DEGREE_ANGLE", "name": "DEGREE_ANGLE" }, { "value": "RADIAN", "name": "RADIAN" } ] } }, "com.amazonaws.groundstation#AntennaDemodDecodeDetails": { "type": "structure", "members": { "outputNode": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "
Name of an antenna demod decode output node used in a contact.
" } } }, "traits": { "smithy.api#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\n antenna for downlink during a contact.
" } }, "com.amazonaws.groundstation#AntennaDownlinkDemodDecodeConfig": { "type": "structure", "members": { "spectrumConfig": { "target": "com.amazonaws.groundstation#SpectrumConfig", "traits": { "smithy.api#documentation": "Information about the spectral Config
.
Information about the demodulation Config
.
Information about the decode Config
.
Information about how AWS Ground Station should configure an antenna for downlink demod decode during a contact.
" } }, "com.amazonaws.groundstation#AntennaUplinkConfig": { "type": "structure", "members": { "transmitDisabled": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "Whether or not uplink transmit is disabled.
" } }, "spectrumConfig": { "target": "com.amazonaws.groundstation#UplinkSpectrumConfig", "traits": { "smithy.api#documentation": "Information about the uplink spectral Config
.
EIRP of the target.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Information about the uplink Config
of an antenna.
Cancels a contact with a specified contact ID.
", "smithy.api#http": { "method": "DELETE", "uri": "/contact/{contactId}", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazonaws.groundstation#CancelContactRequest": { "type": "structure", "members": { "contactId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "UUID of a contact.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "" } }, "com.amazonaws.groundstation#Config": { "type": "resource", "identifiers": { "configId": { "target": "smithy.api#String" }, "configType": { "target": "com.amazonaws.groundstation#ConfigCapabilityType" } }, "create": { "target": "com.amazonaws.groundstation#CreateConfig" }, "read": { "target": "com.amazonaws.groundstation#GetConfig" }, "update": { "target": "com.amazonaws.groundstation#UpdateConfig" }, "delete": { "target": "com.amazonaws.groundstation#DeleteConfig" }, "list": { "target": "com.amazonaws.groundstation#ListConfigs" }, "traits": { "aws.api#arn": { "template": "config/{configType}/{configId}", "absolute": false, "noAccount": false, "noRegion": false } } }, "com.amazonaws.groundstation#ConfigArn": { "type": "string", "traits": { "aws.api#arnReference": { "type": "AWS::GroundStation::Config", "service": "com.amazonaws.groundstation#GroundStation", "resource": "com.amazonaws.groundstation#Config" } } }, "com.amazonaws.groundstation#ConfigCapabilityType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "antenna-downlink", "name": "ANTENNA_DOWNLINK" }, { "value": "antenna-downlink-demod-decode", "name": "ANTENNA_DOWNLINK_DEMOD_DECODE" }, { "value": "antenna-uplink", "name": "ANTENNA_UPLINK" }, { "value": "dataflow-endpoint", "name": "DATAFLOW_ENDPOINT" }, { "value": "tracking", "name": "TRACKING" }, { "value": "uplink-echo", "name": "UPLINK_ECHO" }, { "value": "s3-recording", "name": "S3_RECORDING" } ] } }, "com.amazonaws.groundstation#ConfigDetails": { "type": "union", "members": { "endpointDetails": { "target": "com.amazonaws.groundstation#EndpointDetails" }, "antennaDemodDecodeDetails": { "target": "com.amazonaws.groundstation#AntennaDemodDecodeDetails", "traits": { "smithy.api#documentation": "Details for antenna demod decode Config
in a contact.
Details for an S3 recording Config
in a contact.
Details for certain Config
object types in a contact.
UUID of a Config
.
Type of a Config
.
ARN of a Config
.
UUID of a Config
.
Type of a Config
.
ARN 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.
" } }, "trackingConfig": { "target": "com.amazonaws.groundstation#TrackingConfig", "traits": { "smithy.api#documentation": "Object that determines whether tracking should be used during a contact executed with this Config
in the mission profile.
Information about the dataflow endpoint Config
.
Information about how AWS Ground Station should configure an antenna for downlink demod decode during a contact.
" } }, "antennaUplinkConfig": { "target": "com.amazonaws.groundstation#AntennaUplinkConfig", "traits": { "smithy.api#documentation": "Information about how AWS Ground Station should configure an antenna for uplink during a contact.
" } }, "uplinkEchoConfig": { "target": "com.amazonaws.groundstation#UplinkEchoConfig", "traits": { "smithy.api#documentation": "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.
Information about an S3 recording Config
.
Object containing the parameters of a Config
.
See the subtype definitions for what each type of Config
contains.
UUID of a contact.
" } }, "missionProfileArn": { "target": "com.amazonaws.groundstation#MissionProfileArn", "traits": { "smithy.api#documentation": "ARN of a mission profile.
" } }, "satelliteArn": { "target": "com.amazonaws.groundstation#satelliteArn", "traits": { "smithy.api#documentation": "ARN of a satellite.
" } }, "startTime": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "Start time of a contact.
" } }, "endTime": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "End time of a contact.
" } }, "prePassStartTime": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "Amount of time prior to contact start you’d like to receive a CloudWatch event indicating an upcoming pass.
" } }, "postPassEndTime": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "Amount of time after a contact ends that you’d like to receive a CloudWatch event indicating the pass has finished.
" } }, "groundStation": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Name of a ground station.
" } }, "contactStatus": { "target": "com.amazonaws.groundstation#ContactStatus", "traits": { "smithy.api#documentation": "Status of a contact.
" } }, "errorMessage": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Error message of a contact.
" } }, "maximumElevation": { "target": "com.amazonaws.groundstation#Elevation", "traits": { "smithy.api#documentation": "Maximum elevation angle of a contact.
" } }, "region": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Region of a contact.
" } }, "tags": { "target": "com.amazonaws.groundstation#TagsMap", "traits": { "smithy.api#documentation": "Tags assigned to a contact.
" } } }, "traits": { "smithy.api#documentation": "Data describing a contact.
", "smithy.api#references": [ { "resource": "com.amazonaws.groundstation#Contact" } ] } }, "com.amazonaws.groundstation#ContactIdResponse": { "type": "structure", "members": { "contactId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "UUID of a contact.
" } } }, "traits": { "smithy.api#documentation": "" } }, "com.amazonaws.groundstation#ContactList": { "type": "list", "member": { "target": "com.amazonaws.groundstation#ContactData" } }, "com.amazonaws.groundstation#ContactStatus": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "AVAILABLE", "name": "AVAILABLE" }, { "value": "AWS_CANCELLED", "name": "AWS_CANCELLED" }, { "value": "AWS_FAILED", "name": "AWS_FAILED" }, { "value": "CANCELLED", "name": "CANCELLED" }, { "value": "CANCELLING", "name": "CANCELLING" }, { "value": "COMPLETED", "name": "COMPLETED" }, { "value": "FAILED", "name": "FAILED" }, { "value": "FAILED_TO_SCHEDULE", "name": "FAILED_TO_SCHEDULE" }, { "value": "PASS", "name": "PASS" }, { "value": "POSTPASS", "name": "POSTPASS" }, { "value": "PREPASS", "name": "PREPASS" }, { "value": "SCHEDULED", "name": "SCHEDULED" }, { "value": "SCHEDULING", "name": "SCHEDULING" } ] } }, "com.amazonaws.groundstation#CreateConfig": { "type": "operation", "input": { "target": "com.amazonaws.groundstation#CreateConfigRequest" }, "output": { "target": "com.amazonaws.groundstation#ConfigIdResponse" }, "errors": [ { "target": "com.amazonaws.groundstation#DependencyException" }, { "target": "com.amazonaws.groundstation#InvalidParameterException" }, { "target": "com.amazonaws.groundstation#ResourceLimitExceededException" }, { "target": "com.amazonaws.groundstation#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "Creates a Config
with the specified configData
parameters.
Only one type of configData
can be specified.
Name of a Config
.
Parameters of a Config
.
Tags assigned to a Config
.
Creates a DataflowEndpoint
group containing the specified list of DataflowEndpoint
objects.
The name
field in each endpoint is used in your mission profile DataflowEndpointConfig
\n to specify which endpoints to use during a contact.
When a contact uses multiple DataflowEndpointConfig
objects, each Config
\n must match a DataflowEndpoint
in the same group.
Endpoint details of each endpoint in the dataflow endpoint group.
", "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.groundstation#TagsMap", "traits": { "smithy.api#documentation": "Tags of a dataflow endpoint group.
" } } }, "traits": { "smithy.api#documentation": "" } }, "com.amazonaws.groundstation#CreateMissionProfile": { "type": "operation", "input": { "target": "com.amazonaws.groundstation#CreateMissionProfileRequest" }, "output": { "target": "com.amazonaws.groundstation#MissionProfileIdResponse" }, "errors": [ { "target": "com.amazonaws.groundstation#DependencyException" }, { "target": "com.amazonaws.groundstation#InvalidParameterException" }, { "target": "com.amazonaws.groundstation#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "Creates a mission profile.
\n\n dataflowEdges
is a list of lists of strings. Each lower level list of strings\n has two elements: a from ARN and a to ARN.
Name of a mission profile.
", "smithy.api#required": {} } }, "contactPrePassDurationSeconds": { "target": "com.amazonaws.groundstation#DurationInSeconds", "traits": { "smithy.api#documentation": "Amount of time prior to contact start you’d like to receive a CloudWatch event indicating an upcoming pass.
" } }, "contactPostPassDurationSeconds": { "target": "com.amazonaws.groundstation#DurationInSeconds", "traits": { "smithy.api#documentation": "Amount of time after a contact ends that you’d like to receive a CloudWatch event indicating the pass has finished.
" } }, "minimumViableContactDurationSeconds": { "target": "com.amazonaws.groundstation#DurationInSeconds", "traits": { "smithy.api#documentation": "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.
", "smithy.api#required": {} } }, "dataflowEdges": { "target": "com.amazonaws.groundstation#DataflowEdgeList", "traits": { "smithy.api#documentation": "A list of lists of ARNs. Each list of ARNs is an edge, with a from \n Config
and a to\n Config
.
ARN of a tracking Config
.
Tags assigned to a mission profile.
" } } }, "traits": { "smithy.api#documentation": "" } }, "com.amazonaws.groundstation#Criticality": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "PREFERRED", "name": "PREFERRED" }, { "value": "REMOVED", "name": "REMOVED" }, { "value": "REQUIRED", "name": "REQUIRED" } ] } }, "com.amazonaws.groundstation#DataflowDetail": { "type": "structure", "members": { "source": { "target": "com.amazonaws.groundstation#Source" }, "destination": { "target": "com.amazonaws.groundstation#Destination" }, "errorMessage": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Error message for a dataflow.
" } } }, "traits": { "smithy.api#documentation": "Information about a dataflow edge used in a contact.
" } }, "com.amazonaws.groundstation#DataflowEdge": { "type": "list", "member": { "target": "com.amazonaws.groundstation#ConfigArn" }, "traits": { "smithy.api#length": { "min": 2, "max": 2 } } }, "com.amazonaws.groundstation#DataflowEdgeList": { "type": "list", "member": { "target": "com.amazonaws.groundstation#DataflowEdge" } }, "com.amazonaws.groundstation#DataflowEndpoint": { "type": "structure", "members": { "name": { "target": "com.amazonaws.groundstation#SafeName", "traits": { "smithy.api#documentation": "Name of a dataflow endpoint.
" } }, "address": { "target": "com.amazonaws.groundstation#SocketAddress", "traits": { "smithy.api#documentation": "Socket address of a dataflow endpoint.
" } }, "status": { "target": "com.amazonaws.groundstation#EndpointStatus", "traits": { "smithy.api#documentation": "Status of a dataflow endpoint.
" } }, "mtu": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.
", "smithy.api#range": { "min": 1400, "max": 1500 } } } }, "traits": { "smithy.api#documentation": "Information about a dataflow endpoint.
" } }, "com.amazonaws.groundstation#DataflowEndpointConfig": { "type": "structure", "members": { "dataflowEndpointName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Name of a dataflow endpoint.
", "smithy.api#required": {} } }, "dataflowEndpointRegion": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Region of a dataflow endpoint.
" } } }, "traits": { "smithy.api#documentation": "Information about the dataflow endpoint Config
.
UUID of a dataflow endpoint group.
" } } }, "traits": { "smithy.api#documentation": "" } }, "com.amazonaws.groundstation#DataflowEndpointGroupList": { "type": "list", "member": { "target": "com.amazonaws.groundstation#DataflowEndpointListItem" } }, "com.amazonaws.groundstation#DataflowEndpointListItem": { "type": "structure", "members": { "dataflowEndpointGroupId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "UUID of a dataflow endpoint group.
" } }, "dataflowEndpointGroupArn": { "target": "com.amazonaws.groundstation#DataflowEndpointGroupArn", "traits": { "smithy.api#documentation": "ARN of a dataflow endpoint group.
" } } }, "traits": { "smithy.api#documentation": "Item in a list of DataflowEndpoint
groups.
Unvalidated JSON of a decode Config
.
Information about the decode Config
.
Deletes a Config
.
UUID of a Config
.
Type of a Config
.
Deletes a dataflow endpoint group.
", "smithy.api#http": { "method": "DELETE", "uri": "/dataflowEndpointGroup/{dataflowEndpointGroupId}", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazonaws.groundstation#DeleteDataflowEndpointGroupRequest": { "type": "structure", "members": { "dataflowEndpointGroupId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "UUID of a dataflow endpoint group.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "" } }, "com.amazonaws.groundstation#DeleteMissionProfile": { "type": "operation", "input": { "target": "com.amazonaws.groundstation#DeleteMissionProfileRequest" }, "output": { "target": "com.amazonaws.groundstation#MissionProfileIdResponse" }, "errors": [ { "target": "com.amazonaws.groundstation#DependencyException" }, { "target": "com.amazonaws.groundstation#InvalidParameterException" }, { "target": "com.amazonaws.groundstation#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "Deletes a mission profile.
", "smithy.api#http": { "method": "DELETE", "uri": "/missionprofile/{missionProfileId}", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazonaws.groundstation#DeleteMissionProfileRequest": { "type": "structure", "members": { "missionProfileId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "UUID of a mission profile.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "" } }, "com.amazonaws.groundstation#DemodulationConfig": { "type": "structure", "members": { "unvalidatedJSON": { "target": "com.amazonaws.groundstation#JsonString", "traits": { "smithy.api#documentation": "Unvalidated JSON of a demodulation Config
.
Information about the demodulation Config
.
Dependency encountered an error.
", "smithy.api#error": "server", "smithy.api#httpError": 531 } }, "com.amazonaws.groundstation#DescribeContact": { "type": "operation", "input": { "target": "com.amazonaws.groundstation#DescribeContactRequest" }, "output": { "target": "com.amazonaws.groundstation#DescribeContactResponse" }, "errors": [ { "target": "com.amazonaws.groundstation#DependencyException" }, { "target": "com.amazonaws.groundstation#InvalidParameterException" }, { "target": "com.amazonaws.groundstation#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "Describes an existing contact.
", "smithy.api#http": { "method": "GET", "uri": "/contact/{contactId}", "code": 200 }, "smithy.api#readonly": {} } }, "com.amazonaws.groundstation#DescribeContactRequest": { "type": "structure", "members": { "contactId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "UUID of a contact.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "" } }, "com.amazonaws.groundstation#DescribeContactResponse": { "type": "structure", "members": { "contactId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "UUID of a contact.
" } }, "missionProfileArn": { "target": "com.amazonaws.groundstation#MissionProfileArn", "traits": { "smithy.api#documentation": "ARN of a mission profile.
" } }, "satelliteArn": { "target": "com.amazonaws.groundstation#satelliteArn", "traits": { "smithy.api#documentation": "ARN of a satellite.
" } }, "startTime": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "Start time of a contact.
" } }, "endTime": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "End time of a contact.
" } }, "prePassStartTime": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "Amount of time prior to contact start you’d like to receive a CloudWatch event indicating an upcoming pass.
" } }, "postPassEndTime": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "Amount of time after a contact ends that you’d like to receive a CloudWatch event indicating the pass has finished.
" } }, "groundStation": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Ground station for a contact.
" } }, "contactStatus": { "target": "com.amazonaws.groundstation#ContactStatus", "traits": { "smithy.api#documentation": "Status of a contact.
" } }, "errorMessage": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Error message for a contact.
" } }, "maximumElevation": { "target": "com.amazonaws.groundstation#Elevation", "traits": { "smithy.api#documentation": "Maximum elevation angle of a contact.
" } }, "tags": { "target": "com.amazonaws.groundstation#TagsMap", "traits": { "smithy.api#documentation": "Tags assigned to a contact.
" } }, "region": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Region of a contact.
" } }, "dataflowList": { "target": "com.amazonaws.groundstation#DataflowList", "traits": { "smithy.api#documentation": "List describing source and destination details for each dataflow edge.
" } } }, "traits": { "smithy.api#documentation": "", "smithy.api#references": [ { "resource": "com.amazonaws.groundstation#Contact" } ] } }, "com.amazonaws.groundstation#Destination": { "type": "structure", "members": { "configType": { "target": "com.amazonaws.groundstation#ConfigCapabilityType", "traits": { "smithy.api#documentation": "Type of a Config
.
UUID of a Config
.
Additional details for a Config
, if type is dataflow endpoint or antenna demod decode.
Region of a dataflow destination.
" } } }, "traits": { "smithy.api#documentation": "Dataflow details for the destination side.
" } }, "com.amazonaws.groundstation#DurationInSeconds": { "type": "integer", "traits": { "smithy.api#box": {}, "smithy.api#range": { "min": 1, "max": 21600 } } }, "com.amazonaws.groundstation#Eirp": { "type": "structure", "members": { "value": { "target": "smithy.api#Double", "traits": { "smithy.api#documentation": "Value of an EIRP. Valid values are between 20.0 to 50.0 dBW.
", "smithy.api#required": {} } }, "units": { "target": "com.amazonaws.groundstation#EirpUnits", "traits": { "smithy.api#documentation": "Units of an EIRP.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Object that represents EIRP.
" } }, "com.amazonaws.groundstation#EirpUnits": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "dBW", "name": "DBW" } ] } }, "com.amazonaws.groundstation#Elevation": { "type": "structure", "members": { "value": { "target": "smithy.api#Double", "traits": { "smithy.api#documentation": "Elevation angle value.
", "smithy.api#required": {} } }, "unit": { "target": "com.amazonaws.groundstation#AngleUnits", "traits": { "smithy.api#documentation": "Elevation angle units.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Elevation angle of the satellite in the sky during a contact.
" } }, "com.amazonaws.groundstation#EndpointDetails": { "type": "structure", "members": { "securityDetails": { "target": "com.amazonaws.groundstation#SecurityDetails", "traits": { "smithy.api#documentation": "Endpoint security details.
" } }, "endpoint": { "target": "com.amazonaws.groundstation#DataflowEndpoint", "traits": { "smithy.api#documentation": "A dataflow endpoint.
" } } }, "traits": { "smithy.api#documentation": "Information about the endpoint details.
" } }, "com.amazonaws.groundstation#EndpointDetailsList": { "type": "list", "member": { "target": "com.amazonaws.groundstation#EndpointDetails" } }, "com.amazonaws.groundstation#EndpointStatus": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "created", "name": "created" }, { "value": "creating", "name": "creating" }, { "value": "deleted", "name": "deleted" }, { "value": "deleting", "name": "deleting" }, { "value": "failed", "name": "failed" } ] } }, "com.amazonaws.groundstation#Frequency": { "type": "structure", "members": { "value": { "target": "smithy.api#Double", "traits": { "smithy.api#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.
", "smithy.api#required": {} } }, "units": { "target": "com.amazonaws.groundstation#FrequencyUnits", "traits": { "smithy.api#documentation": "Frequency units.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Object that describes the frequency.
" } }, "com.amazonaws.groundstation#FrequencyBandwidth": { "type": "structure", "members": { "value": { "target": "smithy.api#Double", "traits": { "smithy.api#documentation": "Frequency bandwidth value. AWS Ground Station currently has the following bandwidth limitations:
\nFor 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.
Frequency bandwidth units.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Object that describes the frequency bandwidth.
" } }, "com.amazonaws.groundstation#FrequencyUnits": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "GHz", "name": "GHZ" }, { "value": "MHz", "name": "MHZ" }, { "value": "kHz", "name": "KHZ" } ] } }, "com.amazonaws.groundstation#GetConfig": { "type": "operation", "input": { "target": "com.amazonaws.groundstation#GetConfigRequest" }, "output": { "target": "com.amazonaws.groundstation#GetConfigResponse" }, "errors": [ { "target": "com.amazonaws.groundstation#DependencyException" }, { "target": "com.amazonaws.groundstation#InvalidParameterException" }, { "target": "com.amazonaws.groundstation#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "Returns Config
information.
Only one Config
response can be returned.
UUID of a Config
.
Type of a Config
.
UUID of a Config
.
ARN of a Config
\n
Name of a Config
.
Type of a Config
.
Data elements in a Config
.
Tags assigned to a Config
.
Returns the dataflow endpoint group.
", "smithy.api#http": { "method": "GET", "uri": "/dataflowEndpointGroup/{dataflowEndpointGroupId}", "code": 200 }, "smithy.api#readonly": {} } }, "com.amazonaws.groundstation#GetDataflowEndpointGroupRequest": { "type": "structure", "members": { "dataflowEndpointGroupId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "UUID of a dataflow endpoint group.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "" } }, "com.amazonaws.groundstation#GetDataflowEndpointGroupResponse": { "type": "structure", "members": { "dataflowEndpointGroupId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "UUID of a dataflow endpoint group.
" } }, "dataflowEndpointGroupArn": { "target": "com.amazonaws.groundstation#DataflowEndpointGroupArn", "traits": { "smithy.api#documentation": "ARN of a dataflow endpoint group.
" } }, "endpointsDetails": { "target": "com.amazonaws.groundstation#EndpointDetailsList", "traits": { "smithy.api#documentation": "Details of a dataflow endpoint.
" } }, "tags": { "target": "com.amazonaws.groundstation#TagsMap", "traits": { "smithy.api#documentation": "Tags assigned to a dataflow endpoint group.
" } } }, "traits": { "smithy.api#documentation": "" } }, "com.amazonaws.groundstation#GetMinuteUsage": { "type": "operation", "input": { "target": "com.amazonaws.groundstation#GetMinuteUsageRequest" }, "output": { "target": "com.amazonaws.groundstation#GetMinuteUsageResponse" }, "errors": [ { "target": "com.amazonaws.groundstation#DependencyException" }, { "target": "com.amazonaws.groundstation#InvalidParameterException" }, { "target": "com.amazonaws.groundstation#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "Returns the number of minutes used by account.
", "smithy.api#http": { "method": "POST", "uri": "/minute-usage", "code": 200 }, "smithy.api#readonly": {} } }, "com.amazonaws.groundstation#GetMinuteUsageRequest": { "type": "structure", "members": { "month": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "The month being requested, with a value of 1-12.
", "smithy.api#required": {} } }, "year": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "The year being requested, in the format of YYYY.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "" } }, "com.amazonaws.groundstation#GetMinuteUsageResponse": { "type": "structure", "members": { "isReservedMinutesCustomer": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "Returns whether or not an account has signed up for the reserved minutes pricing plan, specific to the month being requested.
" } }, "totalReservedMinuteAllocation": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "Total number of reserved minutes allocated, specific to the month being requested.
" } }, "upcomingMinutesScheduled": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "Upcoming minutes scheduled for an account, specific to the month being requested.
" } }, "totalScheduledMinutes": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "Total scheduled minutes for an account, specific to the month being requested.
" } }, "estimatedMinutesRemaining": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "Estimated number of minutes remaining for an account, specific to the month being requested.
" } } }, "traits": { "smithy.api#documentation": "" } }, "com.amazonaws.groundstation#GetMissionProfile": { "type": "operation", "input": { "target": "com.amazonaws.groundstation#GetMissionProfileRequest" }, "output": { "target": "com.amazonaws.groundstation#GetMissionProfileResponse" }, "errors": [ { "target": "com.amazonaws.groundstation#DependencyException" }, { "target": "com.amazonaws.groundstation#InvalidParameterException" }, { "target": "com.amazonaws.groundstation#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "Returns a mission profile.
", "smithy.api#http": { "method": "GET", "uri": "/missionprofile/{missionProfileId}", "code": 200 }, "smithy.api#readonly": {} } }, "com.amazonaws.groundstation#GetMissionProfileRequest": { "type": "structure", "members": { "missionProfileId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "UUID of a mission profile.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "" } }, "com.amazonaws.groundstation#GetMissionProfileResponse": { "type": "structure", "members": { "missionProfileId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "UUID of a mission profile.
" } }, "missionProfileArn": { "target": "com.amazonaws.groundstation#MissionProfileArn", "traits": { "smithy.api#documentation": "ARN of a mission profile.
" } }, "name": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Name of a mission profile.
" } }, "region": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Region of a mission profile.
" } }, "contactPrePassDurationSeconds": { "target": "com.amazonaws.groundstation#DurationInSeconds", "traits": { "smithy.api#documentation": "Amount of time prior to contact start you’d like to receive a CloudWatch event indicating an upcoming pass.
" } }, "contactPostPassDurationSeconds": { "target": "com.amazonaws.groundstation#DurationInSeconds", "traits": { "smithy.api#documentation": "Amount of time after a contact ends that you’d like to receive a CloudWatch event indicating the pass has finished.
" } }, "minimumViableContactDurationSeconds": { "target": "com.amazonaws.groundstation#DurationInSeconds", "traits": { "smithy.api#documentation": "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.
" } }, "dataflowEdges": { "target": "com.amazonaws.groundstation#DataflowEdgeList", "traits": { "smithy.api#documentation": "A list of lists of ARNs. Each list of ARNs is an edge, with a from \n Config
and a to \n Config
.
ARN of a tracking Config
.
Tags assigned to a mission profile.
" } } }, "traits": { "smithy.api#documentation": "", "smithy.api#references": [ { "resource": "com.amazonaws.groundstation#MissionProfile" } ] } }, "com.amazonaws.groundstation#GetSatellite": { "type": "operation", "input": { "target": "com.amazonaws.groundstation#GetSatelliteRequest" }, "output": { "target": "com.amazonaws.groundstation#GetSatelliteResponse" }, "errors": [ { "target": "com.amazonaws.groundstation#DependencyException" }, { "target": "com.amazonaws.groundstation#InvalidParameterException" }, { "target": "com.amazonaws.groundstation#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "Returns a satellite.
", "smithy.api#http": { "method": "GET", "uri": "/satellite/{satelliteId}", "code": 200 }, "smithy.api#readonly": {} } }, "com.amazonaws.groundstation#GetSatelliteRequest": { "type": "structure", "members": { "satelliteId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "UUID of a satellite.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "" } }, "com.amazonaws.groundstation#GetSatelliteResponse": { "type": "structure", "members": { "satelliteId": { "target": "com.amazonaws.groundstation#Uuid", "traits": { "smithy.api#documentation": "UUID of a satellite.
" } }, "satelliteArn": { "target": "com.amazonaws.groundstation#satelliteArn", "traits": { "smithy.api#documentation": "ARN of a satellite.
" } }, "noradSatelliteID": { "target": "com.amazonaws.groundstation#noradSatelliteID", "traits": { "smithy.api#documentation": "NORAD satellite ID number.
" } }, "groundStations": { "target": "com.amazonaws.groundstation#GroundStationIdList", "traits": { "smithy.api#documentation": "A list of ground stations to which the satellite is on-boarded.
" } } }, "traits": { "smithy.api#documentation": "", "smithy.api#references": [ { "resource": "com.amazon.awsgsaascontrolplanelambda.r20190311#Satellite" } ] } }, "com.amazonaws.groundstation#GroundStation": { "type": "service", "version": "2019-05-23", "operations": [ { "target": "com.amazonaws.groundstation#GetMinuteUsage" }, { "target": "com.amazonaws.groundstation#ListTagsForResource" }, { "target": "com.amazonaws.groundstation#TagResource" }, { "target": "com.amazonaws.groundstation#UntagResource" } ], "resources": [ { "target": "com.amazonaws.groundstation#Config" }, { "target": "com.amazonaws.groundstation#Contact" }, { "target": "com.amazonaws.groundstation#DataflowEndpointGroup" }, { "target": "com.amazonaws.groundstation#GroundStationResource" }, { "target": "com.amazonaws.groundstation#MissionProfile" }, { "target": "com.amazonaws.groundstation#Satellite" } ], "traits": { "aws.api#service": { "sdkId": "GroundStation", "arnNamespace": "groundstation", "cloudFormationName": "AWSGroundStation", "cloudTrailEventSource": "REPLACE_WITH_EVENT_SOURCE", "endpointPrefix": "groundstation" }, "aws.auth#sigv4": { "name": "groundstation" }, "aws.protocols#restJson1": {}, "smithy.api#documentation": "Welcome to the AWS Ground Station API Reference. AWS Ground Station is a fully managed service that\n enables you to control satellite communications, downlink and process satellite data, and\n scale your satellite operations efficiently and cost-effectively without having\n to build or manage your own ground station infrastructure.
", "smithy.api#title": "AWS Ground Station" } }, "com.amazonaws.groundstation#GroundStationData": { "type": "structure", "members": { "groundStationId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "UUID of a ground station.
" } }, "groundStationName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Name of a ground station.
" } }, "region": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Ground station Region.
" } } }, "traits": { "smithy.api#documentation": "Information about the ground station data.
" } }, "com.amazonaws.groundstation#GroundStationIdList": { "type": "list", "member": { "target": "smithy.api#String" } }, "com.amazonaws.groundstation#GroundStationList": { "type": "list", "member": { "target": "com.amazonaws.groundstation#GroundStationData" } }, "com.amazonaws.groundstation#GroundStationResource": { "type": "resource", "identifiers": { "groundStationId": { "target": "smithy.api#String" } }, "list": { "target": "com.amazonaws.groundstation#ListGroundStations" }, "traits": { "aws.api#arn": { "template": "groundstation:{groundStationId}", "absolute": false, "noAccount": false, "noRegion": false } } }, "com.amazonaws.groundstation#InvalidParameterException": { "type": "structure", "members": { "message": { "target": "smithy.api#String" }, "parameterName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "" } } }, "traits": { "smithy.api#documentation": "One or more parameters are not valid.
", "smithy.api#error": "client", "smithy.api#httpError": 431 } }, "com.amazonaws.groundstation#JsonString": { "type": "string", "traits": { "smithy.api#length": { "min": 2, "max": 8192 }, "smithy.api#pattern": "^[{}\\[\\]:.,\"0-9A-z\\-_\\s]{2,8192}$" } }, "com.amazonaws.groundstation#ListConfigs": { "type": "operation", "input": { "target": "com.amazonaws.groundstation#ListConfigsRequest" }, "output": { "target": "com.amazonaws.groundstation#ListConfigsResponse" }, "errors": [ { "target": "com.amazonaws.groundstation#DependencyException" }, { "target": "com.amazonaws.groundstation#InvalidParameterException" }, { "target": "com.amazonaws.groundstation#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "Returns a list of Config
objects.
Maximum number of Configs
returned.
Next token returned in the request of a previous ListConfigs
call. Used to get the next page of results.
Next token returned in the response of a previous ListConfigs
call. Used to get the next page of results.
List of Config
items.
Returns a list of contacts.
\nIf statusList
contains AVAILABLE, the request must include\n groundStation
, missionprofileArn
, and satelliteArn
.\n
Maximum number of contacts returned.
" } }, "nextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Next token returned in the request of a previous ListContacts
call. Used to get the next page of results.
Status of a contact reservation.
", "smithy.api#required": {} } }, "startTime": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "Start time of a contact.
", "smithy.api#required": {} } }, "endTime": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "End time of a contact.
", "smithy.api#required": {} } }, "groundStation": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Name of a ground station.
" } }, "satelliteArn": { "target": "com.amazonaws.groundstation#satelliteArn", "traits": { "smithy.api#documentation": "ARN of a satellite.
" } }, "missionProfileArn": { "target": "com.amazonaws.groundstation#MissionProfileArn", "traits": { "smithy.api#documentation": "ARN of a mission profile.
" } } }, "traits": { "smithy.api#documentation": "" } }, "com.amazonaws.groundstation#ListContactsResponse": { "type": "structure", "members": { "nextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Next token returned in the response of a previous ListContacts
call. Used to get the next page of results.
List of contacts.
" } } }, "traits": { "smithy.api#documentation": "" } }, "com.amazonaws.groundstation#ListDataflowEndpointGroups": { "type": "operation", "input": { "target": "com.amazonaws.groundstation#ListDataflowEndpointGroupsRequest" }, "output": { "target": "com.amazonaws.groundstation#ListDataflowEndpointGroupsResponse" }, "errors": [ { "target": "com.amazonaws.groundstation#DependencyException" }, { "target": "com.amazonaws.groundstation#InvalidParameterException" }, { "target": "com.amazonaws.groundstation#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "Returns a list of DataflowEndpoint
groups.
Maximum number of dataflow endpoint groups returned.
", "smithy.api#httpQuery": "maxResults" } }, "nextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Next token returned in the request of a previous ListDataflowEndpointGroups
call. Used to get the next page of results.
Next token returned in the response of a previous ListDataflowEndpointGroups
call. Used to get the next page of results.
A list of dataflow endpoint groups.
" } } }, "traits": { "smithy.api#documentation": "" } }, "com.amazonaws.groundstation#ListGroundStations": { "type": "operation", "input": { "target": "com.amazonaws.groundstation#ListGroundStationsRequest" }, "output": { "target": "com.amazonaws.groundstation#ListGroundStationsResponse" }, "errors": [ { "target": "com.amazonaws.groundstation#DependencyException" }, { "target": "com.amazonaws.groundstation#InvalidParameterException" }, { "target": "com.amazonaws.groundstation#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "Returns a list of ground stations.
", "smithy.api#http": { "method": "GET", "uri": "/groundstation", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "items": "groundStationList", "pageSize": "maxResults" }, "smithy.api#readonly": {} } }, "com.amazonaws.groundstation#ListGroundStationsRequest": { "type": "structure", "members": { "satelliteId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Satellite ID to retrieve on-boarded ground stations.
", "smithy.api#httpQuery": "satelliteId" } }, "maxResults": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "Maximum number of ground stations returned.
", "smithy.api#httpQuery": "maxResults" } }, "nextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Next token that can be supplied in the next call to get the next page of ground stations.
", "smithy.api#httpQuery": "nextToken" } } }, "traits": { "smithy.api#documentation": "" } }, "com.amazonaws.groundstation#ListGroundStationsResponse": { "type": "structure", "members": { "nextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Next token that can be supplied in the next call to get the next page of ground stations.
" } }, "groundStationList": { "target": "com.amazonaws.groundstation#GroundStationList", "traits": { "smithy.api#documentation": "List of ground stations.
" } } }, "traits": { "smithy.api#documentation": "" } }, "com.amazonaws.groundstation#ListMissionProfiles": { "type": "operation", "input": { "target": "com.amazonaws.groundstation#ListMissionProfilesRequest" }, "output": { "target": "com.amazonaws.groundstation#ListMissionProfilesResponse" }, "errors": [ { "target": "com.amazonaws.groundstation#DependencyException" }, { "target": "com.amazonaws.groundstation#InvalidParameterException" }, { "target": "com.amazonaws.groundstation#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "Returns a list of mission profiles.
", "smithy.api#http": { "method": "GET", "uri": "/missionprofile", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "items": "missionProfileList", "pageSize": "maxResults" }, "smithy.api#readonly": {} } }, "com.amazonaws.groundstation#ListMissionProfilesRequest": { "type": "structure", "members": { "maxResults": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "Maximum number of mission profiles returned.
", "smithy.api#httpQuery": "maxResults" } }, "nextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Next token returned in the request of a previous ListMissionProfiles
call. Used to get the next page of results.
Next token returned in the response of a previous ListMissionProfiles
call. Used to get the next page of results.
List of mission profiles.
" } } }, "traits": { "smithy.api#documentation": "" } }, "com.amazonaws.groundstation#ListSatellites": { "type": "operation", "input": { "target": "com.amazonaws.groundstation#ListSatellitesRequest" }, "output": { "target": "com.amazonaws.groundstation#ListSatellitesResponse" }, "errors": [ { "target": "com.amazonaws.groundstation#DependencyException" }, { "target": "com.amazonaws.groundstation#InvalidParameterException" }, { "target": "com.amazonaws.groundstation#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "Returns a list of satellites.
", "smithy.api#http": { "method": "GET", "uri": "/satellite", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "items": "satellites", "pageSize": "maxResults" }, "smithy.api#readonly": {} } }, "com.amazonaws.groundstation#ListSatellitesRequest": { "type": "structure", "members": { "maxResults": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "Maximum number of satellites returned.
", "smithy.api#httpQuery": "maxResults" } }, "nextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Next token that can be supplied in the next call to get the next page of satellites.
", "smithy.api#httpQuery": "nextToken" } } }, "traits": { "smithy.api#documentation": "" } }, "com.amazonaws.groundstation#ListSatellitesResponse": { "type": "structure", "members": { "nextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Next token that can be supplied in the next call to get the next page of satellites.
" } }, "satellites": { "target": "com.amazonaws.groundstation#SatelliteList", "traits": { "smithy.api#documentation": "List of satellites.
" } } }, "traits": { "smithy.api#documentation": "" } }, "com.amazonaws.groundstation#ListTagsForResource": { "type": "operation", "input": { "target": "com.amazonaws.groundstation#ListTagsForResourceRequest" }, "output": { "target": "com.amazonaws.groundstation#ListTagsForResourceResponse" }, "errors": [ { "target": "com.amazonaws.groundstation#DependencyException" }, { "target": "com.amazonaws.groundstation#InvalidParameterException" }, { "target": "com.amazonaws.groundstation#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "Returns a list of tags for a specified resource.
", "smithy.api#http": { "method": "GET", "uri": "/tags/{resourceArn}", "code": 200 }, "smithy.api#readonly": {} } }, "com.amazonaws.groundstation#ListTagsForResourceRequest": { "type": "structure", "members": { "resourceArn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "ARN of a resource.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "" } }, "com.amazonaws.groundstation#ListTagsForResourceResponse": { "type": "structure", "members": { "tags": { "target": "com.amazonaws.groundstation#TagsMap", "traits": { "smithy.api#documentation": "Tags assigned to a resource.
" } } }, "traits": { "smithy.api#documentation": "" } }, "com.amazonaws.groundstation#MissionProfile": { "type": "resource", "identifiers": { "missionProfileId": { "target": "smithy.api#String" } }, "create": { "target": "com.amazonaws.groundstation#CreateMissionProfile" }, "read": { "target": "com.amazonaws.groundstation#GetMissionProfile" }, "update": { "target": "com.amazonaws.groundstation#UpdateMissionProfile" }, "delete": { "target": "com.amazonaws.groundstation#DeleteMissionProfile" }, "list": { "target": "com.amazonaws.groundstation#ListMissionProfiles" }, "traits": { "aws.api#arn": { "template": "mission-profile/{missionProfileId}", "absolute": false, "noAccount": false, "noRegion": false } } }, "com.amazonaws.groundstation#MissionProfileArn": { "type": "string", "traits": { "aws.api#arnReference": { "type": "AWS::GroundStation::MissionProfile", "service": "com.amazonaws.groundstation#GroundStation", "resource": "com.amazonaws.groundstation#MissionProfile" } } }, "com.amazonaws.groundstation#MissionProfileIdResponse": { "type": "structure", "members": { "missionProfileId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "UUID of a mission profile.
" } } }, "traits": { "smithy.api#documentation": "" } }, "com.amazonaws.groundstation#MissionProfileList": { "type": "list", "member": { "target": "com.amazonaws.groundstation#MissionProfileListItem" } }, "com.amazonaws.groundstation#MissionProfileListItem": { "type": "structure", "members": { "missionProfileId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "UUID of a mission profile.
" } }, "missionProfileArn": { "target": "com.amazonaws.groundstation#MissionProfileArn", "traits": { "smithy.api#documentation": "ARN of a mission profile.
" } }, "region": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Region of a mission profile.
" } }, "name": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Name of a mission profile.
" } } }, "traits": { "smithy.api#documentation": "Item in a list of mission profiles.
" } }, "com.amazonaws.groundstation#Polarization": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "LEFT_HAND", "name": "LEFT_HAND" }, { "value": "NONE", "name": "NONE" }, { "value": "RIGHT_HAND", "name": "RIGHT_HAND" } ] } }, "com.amazonaws.groundstation#ReserveContact": { "type": "operation", "input": { "target": "com.amazonaws.groundstation#ReserveContactRequest" }, "output": { "target": "com.amazonaws.groundstation#ContactIdResponse" }, "errors": [ { "target": "com.amazonaws.groundstation#DependencyException" }, { "target": "com.amazonaws.groundstation#InvalidParameterException" }, { "target": "com.amazonaws.groundstation#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "Reserves a contact using specified parameters.
", "smithy.api#http": { "method": "POST", "uri": "/contact", "code": 200 } } }, "com.amazonaws.groundstation#ReserveContactRequest": { "type": "structure", "members": { "missionProfileArn": { "target": "com.amazonaws.groundstation#MissionProfileArn", "traits": { "smithy.api#documentation": "ARN of a mission profile.
", "smithy.api#required": {} } }, "satelliteArn": { "target": "com.amazonaws.groundstation#satelliteArn", "traits": { "smithy.api#documentation": "ARN of a satellite
", "smithy.api#required": {} } }, "startTime": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "Start time of a contact.
", "smithy.api#required": {} } }, "endTime": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "End time of a contact.
", "smithy.api#required": {} } }, "groundStation": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Name of a ground station.
", "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.groundstation#TagsMap", "traits": { "smithy.api#documentation": "Tags assigned to a contact.
" } } }, "traits": { "smithy.api#documentation": "" } }, "com.amazonaws.groundstation#ResourceLimitExceededException": { "type": "structure", "members": { "message": { "target": "smithy.api#String" }, "parameterName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "" } } }, "traits": { "smithy.api#documentation": "Account limits for this resource have been exceeded.
", "smithy.api#error": "client", "smithy.api#httpError": 429 } }, "com.amazonaws.groundstation#ResourceNotFoundException": { "type": "structure", "members": { "message": { "target": "smithy.api#String" } }, "traits": { "smithy.api#documentation": "Resource was not found.
", "smithy.api#error": "client", "smithy.api#httpError": 434 } }, "com.amazonaws.groundstation#RoleArn": { "type": "string" }, "com.amazonaws.groundstation#S3KeyPrefix": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 900 }, "smithy.api#pattern": "^([a-zA-Z0-9_\\-=/]|\\{satellite_id\\}|\\{config\\-name}|\\{s3\\-config-id}|\\{year\\}|\\{month\\}|\\{day\\}){1,900}$" } }, "com.amazonaws.groundstation#S3RecordingConfig": { "type": "structure", "members": { "bucketArn": { "target": "com.amazonaws.groundstation#BucketArn", "traits": { "smithy.api#documentation": "ARN of the bucket to record to.
", "smithy.api#required": {} } }, "roleArn": { "target": "com.amazonaws.groundstation#RoleArn", "traits": { "smithy.api#documentation": "ARN of the role Ground Station assumes to write data to the bucket.
", "smithy.api#required": {} } }, "prefix": { "target": "com.amazonaws.groundstation#S3KeyPrefix", "traits": { "smithy.api#documentation": "S3 Key prefix to prefice data files.
" } } }, "traits": { "smithy.api#documentation": "Information about an S3 recording Config
.
ARN of the bucket used.
" } }, "keyTemplate": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Template of the S3 key used.
" } } }, "traits": { "smithy.api#documentation": "Details about an S3 recording Config
used in a contact.
UUID of a satellite.
" } }, "satelliteArn": { "target": "com.amazonaws.groundstation#satelliteArn", "traits": { "smithy.api#documentation": "ARN of a satellite.
" } }, "noradSatelliteID": { "target": "com.amazonaws.groundstation#noradSatelliteID", "traits": { "smithy.api#documentation": "NORAD satellite ID number.
" } }, "groundStations": { "target": "com.amazonaws.groundstation#GroundStationIdList", "traits": { "smithy.api#documentation": "A list of ground stations to which the satellite is on-boarded.
" } } }, "traits": { "smithy.api#documentation": "Item in a list of satellites.
" } }, "com.amazonaws.groundstation#SecurityDetails": { "type": "structure", "members": { "subnetIds": { "target": "com.amazonaws.groundstation#SubnetList", "traits": { "smithy.api#documentation": "A list of subnets where AWS Ground Station places elastic network interfaces to send streams to your instances.
", "smithy.api#required": {} } }, "securityGroupIds": { "target": "com.amazonaws.groundstation#SecurityGroupIdList", "traits": { "smithy.api#documentation": "The security groups to attach to the elastic network interfaces.
", "smithy.api#required": {} } }, "roleArn": { "target": "com.amazonaws.groundstation#RoleArn", "traits": { "smithy.api#documentation": "ARN to a role needed for connecting streams to your instances.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Information about endpoints.
" } }, "com.amazonaws.groundstation#SecurityGroupIdList": { "type": "list", "member": { "target": "smithy.api#String" } }, "com.amazonaws.groundstation#SocketAddress": { "type": "structure", "members": { "name": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Name of a socket address.
", "smithy.api#required": {} } }, "port": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "Port of a socket address.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Information about the socket address.
" } }, "com.amazonaws.groundstation#Source": { "type": "structure", "members": { "configType": { "target": "com.amazonaws.groundstation#ConfigCapabilityType", "traits": { "smithy.api#documentation": "Type of a Config
.
UUID of a Config
.
Additional details for a Config
, if type is dataflow endpoint or antenna demod decode.
Region of a dataflow source.
" } } }, "traits": { "smithy.api#documentation": "Dataflow details for the source side.
" } }, "com.amazonaws.groundstation#SpectrumConfig": { "type": "structure", "members": { "centerFrequency": { "target": "com.amazonaws.groundstation#Frequency", "traits": { "smithy.api#documentation": "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.
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.
Polarization of a spectral Config
. Capturing both \"RIGHT_HAND\"
and \"LEFT_HAND\"
polarization requires two separate configs.
Object that describes a spectral Config
.
Assigns a tag to a resource.
", "smithy.api#http": { "method": "POST", "uri": "/tags/{resourceArn}", "code": 200 } } }, "com.amazonaws.groundstation#TagResourceRequest": { "type": "structure", "members": { "resourceArn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "ARN of a resource tag.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.groundstation#TagsMap", "traits": { "smithy.api#documentation": "Tags assigned to a resource.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "" } }, "com.amazonaws.groundstation#TagResourceResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#documentation": "" } }, "com.amazonaws.groundstation#TagsMap": { "type": "map", "key": { "target": "smithy.api#String" }, "value": { "target": "smithy.api#String" } }, "com.amazonaws.groundstation#TrackingConfig": { "type": "structure", "members": { "autotrack": { "target": "com.amazonaws.groundstation#Criticality", "traits": { "smithy.api#documentation": "Current setting for autotrack.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Object that determines whether tracking should be used during a contact\n executed with this Config
in the mission profile.
Deassigns a resource tag.
", "smithy.api#http": { "method": "DELETE", "uri": "/tags/{resourceArn}", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazonaws.groundstation#UntagResourceRequest": { "type": "structure", "members": { "resourceArn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "ARN of a resource.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "tagKeys": { "target": "com.amazonaws.groundstation#TagKeys", "traits": { "smithy.api#documentation": "Keys of a resource tag.
", "smithy.api#httpQuery": "tagKeys", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "" } }, "com.amazonaws.groundstation#UntagResourceResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#documentation": "" } }, "com.amazonaws.groundstation#UpdateConfig": { "type": "operation", "input": { "target": "com.amazonaws.groundstation#UpdateConfigRequest" }, "output": { "target": "com.amazonaws.groundstation#ConfigIdResponse" }, "errors": [ { "target": "com.amazonaws.groundstation#DependencyException" }, { "target": "com.amazonaws.groundstation#InvalidParameterException" }, { "target": "com.amazonaws.groundstation#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "Updates the Config
used when scheduling contacts.
Updating a Config
will not update the execution parameters\n for existing future contacts scheduled with this Config
.
UUID of a Config
.
Name of a Config
.
Type of a Config
.
Parameters of a Config
.
Updates a mission profile.
\nUpdating a mission profile will not update the execution parameters\n for existing future contacts.
", "smithy.api#http": { "method": "PUT", "uri": "/missionprofile/{missionProfileId}", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazonaws.groundstation#UpdateMissionProfileRequest": { "type": "structure", "members": { "missionProfileId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "UUID of a mission profile.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.groundstation#SafeName", "traits": { "smithy.api#documentation": "Name of a mission profile.
" } }, "contactPrePassDurationSeconds": { "target": "com.amazonaws.groundstation#DurationInSeconds", "traits": { "smithy.api#documentation": "Amount of time after a contact ends that you’d like to receive a CloudWatch event indicating the pass has finished.
" } }, "contactPostPassDurationSeconds": { "target": "com.amazonaws.groundstation#DurationInSeconds", "traits": { "smithy.api#documentation": "Amount of time after a contact ends that you’d like to receive a CloudWatch event indicating the pass has finished.
" } }, "minimumViableContactDurationSeconds": { "target": "com.amazonaws.groundstation#DurationInSeconds", "traits": { "smithy.api#documentation": "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.
" } }, "dataflowEdges": { "target": "com.amazonaws.groundstation#DataflowEdgeList", "traits": { "smithy.api#documentation": "A list of lists of ARNs. Each list of ARNs is an edge, with a from \n Config
and a to \n Config
.
ARN of a tracking Config
.
Whether or not an uplink Config
is enabled.
ARN of an uplink Config
.
Information about an uplink echo Config
.
Parameters from the AntennaUplinkConfig
, corresponding to the \n specified AntennaUplinkConfigArn
, are used when this UplinkEchoConfig
\n 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
.