Cancels or stops a contact with a specified contact ID based on its position in the contact lifecycle.
For contacts that:
Have yet to start, the contact will be cancelled.
Have started but have yet to finish, the contact will be stopped.
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 DataflowEndpoint group containing the specified list of Ground Station Agent based endpoints.
The name field in each endpoint is used in your mission profile DataflowEndpointConfig to specify which endpoints to use during a contact.
When a contact uses multiple DataflowEndpointConfig objects, each Config must match a DataflowEndpoint in the same group.
Create an ephemeris with your specified EphemerisData.
" }, "CreateMissionProfile":{ "name":"CreateMissionProfile", "http":{ "method":"POST", "requestUri":"/missionprofile", "responseCode":200 }, "input":{"shape":"CreateMissionProfileRequest"}, "output":{"shape":"MissionProfileIdResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"DependencyException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"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 }, "DeleteEphemeris":{ "name":"DeleteEphemeris", "http":{ "method":"DELETE", "requestUri":"/ephemeris/{ephemerisId}", "responseCode":200 }, "input":{"shape":"DeleteEphemerisRequest"}, "output":{"shape":"EphemerisIdResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"DependencyException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ResourceInUseException"} ], "documentation":"Delete an ephemeris.
", "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.
", "readonly":true }, "DescribeEphemeris":{ "name":"DescribeEphemeris", "http":{ "method":"GET", "requestUri":"/ephemeris/{ephemerisId}", "responseCode":200 }, "input":{"shape":"DescribeEphemerisRequest"}, "output":{"shape":"DescribeEphemerisResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"DependencyException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"Retrieve information about an existing ephemeris.
", "readonly":true }, "GetAgentConfiguration":{ "name":"GetAgentConfiguration", "http":{ "method":"GET", "requestUri":"/agent/{agentId}/configuration", "responseCode":200 }, "input":{"shape":"GetAgentConfigurationRequest"}, "output":{"shape":"GetAgentConfigurationResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"DependencyException"}, {"shape":"ResourceNotFoundException"} ], "documentation":" For use by AWS Ground Station Agent and shouldn't be called directly.
Gets the latest configuration information for a registered agent.
", "readonly":true }, "GetAgentTaskResponseUrl":{ "name":"GetAgentTaskResponseUrl", "http":{ "method":"GET", "requestUri":"/agentResponseUrl/{agentId}/{taskId}", "responseCode":200 }, "input":{"shape":"GetAgentTaskResponseUrlRequest"}, "output":{"shape":"GetAgentTaskResponseUrlResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"DependencyException"}, {"shape":"ResourceNotFoundException"} ], "documentation":" For use by AWS Ground Station Agent and shouldn't be called directly.
Gets a presigned URL for uploading agent task response logs.
", "readonly":true }, "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.
", "readonly":true }, "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 reserved minutes used by account.
", "readonly":true }, "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.
", "readonly":true }, "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.
", "readonly":true }, "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.
List your existing ephemerides.
", "readonly":true }, "ListGroundStations":{ "name":"ListGroundStations", "http":{ "method":"GET", "requestUri":"/groundstation", "responseCode":200 }, "input":{"shape":"ListGroundStationsRequest"}, "output":{"shape":"ListGroundStationsResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"DependencyException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"Returns a list of ground stations.
", "readonly":true }, "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.
", "readonly":true }, "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.
", "readonly":true }, "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.
", "readonly":true }, "RegisterAgent":{ "name":"RegisterAgent", "http":{ "method":"POST", "requestUri":"/agent", "responseCode":200 }, "input":{"shape":"RegisterAgentRequest"}, "output":{"shape":"RegisterAgentResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"DependencyException"}, {"shape":"ResourceNotFoundException"} ], "documentation":" For use by AWS Ground Station Agent and shouldn't be called directly.
Registers a new agent with AWS Ground Station.
" }, "ReserveContact":{ "name":"ReserveContact", "http":{ "method":"POST", "requestUri":"/contact", "responseCode":200 }, "input":{"shape":"ReserveContactRequest"}, "output":{"shape":"ContactIdResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"DependencyException"}, {"shape":"ResourceLimitExceededException"}, {"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 }, "UpdateAgentStatus":{ "name":"UpdateAgentStatus", "http":{ "method":"PUT", "requestUri":"/agent/{agentId}", "responseCode":200 }, "input":{"shape":"UpdateAgentStatusRequest"}, "output":{"shape":"UpdateAgentStatusResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"DependencyException"}, {"shape":"ResourceNotFoundException"} ], "documentation":" For use by AWS Ground Station Agent and shouldn't be called directly.
Update the status of the agent.
", "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.
Update an existing ephemeris.
", "idempotent":true }, "UpdateMissionProfile":{ "name":"UpdateMissionProfile", "http":{ "method":"PUT", "requestUri":"/missionprofile/{missionProfileId}", "responseCode":200 }, "input":{"shape":"UpdateMissionProfileRequest"}, "output":{"shape":"MissionProfileIdResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"DependencyException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"Updates a mission profile.
Updating a mission profile will not update the execution parameters for existing future contacts.
", "idempotent":true } }, "shapes":{ "AWSRegion":{ "type":"string", "max":128, "min":1, "pattern":"[\\w-]+" }, "AgentCpuCoresList":{ "type":"list", "member":{"shape":"Integer"}, "max":256, "min":0 }, "AgentDetails":{ "type":"structure", "required":[ "agentVersion", "instanceId", "instanceType", "componentVersions" ], "members":{ "agentVersion":{ "shape":"VersionString", "documentation":"Current agent version.
" }, "instanceId":{ "shape":"InstanceId", "documentation":"ID of EC2 instance agent is running on.
" }, "instanceType":{ "shape":"InstanceType", "documentation":"Type of EC2 instance agent is running on.
" }, "reservedCpuCores":{ "shape":"AgentCpuCoresList", "documentation":"This field should not be used. Use agentCpuCores instead.
List of CPU cores reserved for processes other than the agent running on the EC2 instance.
" }, "agentCpuCores":{ "shape":"AgentCpuCoresList", "documentation":"List of CPU cores reserved for the agent.
" }, "componentVersions":{ "shape":"ComponentVersionList", "documentation":"List of versions being used by agent components.
" } }, "documentation":"Detailed information about the agent.
" }, "AgentStatus":{ "type":"string", "enum":[ "SUCCESS", "FAILED", "ACTIVE", "INACTIVE" ] }, "AggregateStatus":{ "type":"structure", "required":["status"], "members":{ "status":{ "shape":"AgentStatus", "documentation":"Aggregate status.
" }, "signatureMap":{ "shape":"SignatureMap", "documentation":"Sparse map of failure signatures.
" } }, "documentation":"Aggregate status of Agent components.
" }, "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":[ "spectrumConfig", "demodulationConfig", "decodeConfig" ], "members":{ "spectrumConfig":{ "shape":"SpectrumConfig", "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.
" }, "AntennaUplinkConfig":{ "type":"structure", "required":[ "spectrumConfig", "targetEirp" ], "members":{ "transmitDisabled":{ "shape":"Boolean", "documentation":"Whether or not uplink transmit is disabled.
" }, "spectrumConfig":{ "shape":"UplinkSpectrumConfig", "documentation":"Information about the uplink spectral Config.
EIRP of the target.
" } }, "documentation":"Information about the uplink Config of an antenna.
Name string associated with AgentEndpoint. Used as a human-readable identifier for AgentEndpoint.
" }, "egressAddress":{ "shape":"ConnectionDetails", "documentation":"The egress address of AgentEndpoint.
" }, "ingressAddress":{ "shape":"RangedConnectionDetails", "documentation":"The ingress address of AgentEndpoint.
" }, "agentStatus":{ "shape":"AgentStatus", "documentation":"The status of AgentEndpoint.
" }, "auditResults":{ "shape":"AuditResults", "documentation":"The results of the audit.
" } }, "documentation":"Information about AwsGroundStationAgentEndpoint.
" }, "AzElEphemeris":{ "type":"structure", "required":[ "groundStation", "data" ], "members":{ "groundStation":{ "shape":"GroundStationName", "documentation":"The ground station name for which you're providing azimuth elevation data.
This ephemeris is specific to this ground station and can't be used at other locations.
" }, "data":{ "shape":"AzElSegmentsData", "documentation":"Azimuth elevation segment data.
You can provide data inline in the request or through an Amazon S3 object reference.
" } }, "documentation":"Azimuth elevation ephemeris data.
Use this ephemeris type to provide pointing angles directly, rather than satellite orbital elements. Use this when you need precise antenna pointing but have imprecise or unknown satellite trajectory information.
The azimuth elevation data specifies the antenna pointing direction at specific times relative to a ground station location. AWS Ground Station uses 4th order Lagrange interpolation to compute pointing angles between the provided data points.
AWS Ground Station automatically filters interpolated pointing angles, including only those that are above the site mask elevation of the specified ground station.
For more detail about providing azimuth elevation ephemerides to AWS Ground Station, see the azimuth elevation ephemeris section of the AWS Ground Station User Guide.
" }, "AzElEphemerisFilter":{ "type":"structure", "required":["id"], "members":{ "id":{ "shape":"Uuid", "documentation":"Unique identifier of the azimuth elevation ephemeris.
" } }, "documentation":"Filter for selecting contacts that use a specific AzElEphemeris.
" }, "AzElProgramTrackSettings":{ "type":"structure", "required":["ephemerisId"], "members":{ "ephemerisId":{ "shape":"Uuid", "documentation":"Unique identifier of the azimuth elevation ephemeris.
" } }, "documentation":"Program track settings for AzElEphemeris.
" }, "AzElSegment":{ "type":"structure", "required":[ "referenceEpoch", "validTimeRange", "azElList" ], "members":{ "referenceEpoch":{ "shape":"SyntheticTimestamp_date_time", "documentation":"The reference time for this segment in ISO 8601 format in Coordinated Universal Time (UTC).
All time values within the segment's AzElSegment$azElList are specified as offsets in atomic seconds from this reference epoch.
Example: 2024-01-15T12:00:00.000Z
The valid time range for this segment.
Specifies the start and end timestamps in ISO 8601 format in Coordinated Universal Time (UTC). The segment's pointing data must cover this entire time range.
" }, "azElList":{ "shape":"TimeAzElList", "documentation":"List of time-tagged azimuth elevation data points.
Must contain at least five points to support 4th order Lagrange interpolation. Points must be in chronological order with no duplicates.
" } }, "documentation":"A time segment containing azimuth elevation pointing data.
Each segment defines a continuous time period with pointing angle data points. AWS Ground Station uses 4th order Lagrange interpolation between the provided points, so each segment must contain at least five data points.
" }, "AzElSegmentList":{ "type":"list", "member":{"shape":"AzElSegment"}, "max":100, "min":1 }, "AzElSegments":{ "type":"structure", "required":[ "angleUnit", "azElSegmentList" ], "members":{ "angleUnit":{ "shape":"AngleUnits", "documentation":"The unit of measure for azimuth and elevation angles. All angles in all segments must use the same unit.
" }, "azElSegmentList":{ "shape":"AzElSegmentList", "documentation":"List of azimuth elevation segments.
Must contain between 1 and 100 segments. Segments must be in chronological order with no overlaps.
" } }, "documentation":"Azimuth elevation segment collection.
Contains five or more time-ordered segments that define antenna pointing angles over the ephemeris validity period.
" }, "AzElSegmentsData":{ "type":"structure", "members":{ "s3Object":{ "shape":"S3Object", "documentation":"The Amazon S3 object containing azimuth elevation segment data.
The Amazon S3 object must contain JSON-formatted azimuth elevation data matching the AzElSegments structure.
" }, "azElData":{ "shape":"AzElSegments", "documentation":"Azimuth elevation segment data provided directly in the request.
Use this option for smaller datasets or when Amazon S3 access is not available.
" } }, "documentation":"Container for azimuth elevation segment data.
Specify either AzElSegmentsData$s3Object to reference data in Amazon S3, or AzElSegmentsData$azElData to provide data inline.
", "union":true }, "BandwidthUnits":{ "type":"string", "enum":[ "GHz", "MHz", "kHz" ] }, "Boolean":{ "type":"boolean", "box":true }, "BucketArn":{"type":"string"}, "CancelContactRequest":{ "type":"structure", "required":["contactId"], "members":{ "contactId":{ "shape":"Uuid", "documentation":"UUID of a contact.
", "location":"uri", "locationName":"contactId" } }, "documentation":"" }, "CapabilityArn":{"type":"string"}, "CapabilityArnList":{ "type":"list", "member":{"shape":"CapabilityArn"}, "max":20, "min":1 }, "CapabilityHealth":{ "type":"string", "enum":[ "HEALTHY", "UNHEALTHY" ] }, "CapabilityHealthReason":{ "type":"string", "enum":[ "NO_REGISTERED_AGENT", "INVALID_IP_OWNERSHIP", "NOT_AUTHORIZED_TO_CREATE_SLR", "UNVERIFIED_IP_OWNERSHIP", "INITIALIZING_DATAPLANE", "DATAPLANE_FAILURE", "HEALTHY" ] }, "CapabilityHealthReasonList":{ "type":"list", "member":{"shape":"CapabilityHealthReason"}, "max":500, "min":0 }, "ComponentStatusData":{ "type":"structure", "required":[ "componentType", "capabilityArn", "status", "dataflowId" ], "members":{ "componentType":{ "shape":"ComponentTypeString", "documentation":"
The Component type.
" }, "capabilityArn":{ "shape":"CapabilityArn", "documentation":"Capability ARN of the component.
" }, "status":{ "shape":"AgentStatus", "documentation":"Component status.
" }, "bytesSent":{ "shape":"Long", "documentation":"Bytes sent by the component.
" }, "bytesReceived":{ "shape":"Long", "documentation":"Bytes received by the component.
" }, "packetsDropped":{ "shape":"Long", "documentation":"Packets dropped by component.
" }, "dataflowId":{ "shape":"Uuid", "documentation":"Dataflow UUID associated with the component.
" } }, "documentation":"Data on the status of agent components.
" }, "ComponentStatusList":{ "type":"list", "member":{"shape":"ComponentStatusData"}, "max":20, "min":0 }, "ComponentTypeString":{ "type":"string", "pattern":"[a-zA-Z0-9_]{1,64}" }, "ComponentVersion":{ "type":"structure", "required":[ "componentType", "versions" ], "members":{ "componentType":{ "shape":"ComponentTypeString", "documentation":"Component type.
" }, "versions":{ "shape":"VersionStringList", "documentation":"List of versions.
" } }, "documentation":"Version information for agent components.
" }, "ComponentVersionList":{ "type":"list", "member":{"shape":"ComponentVersion"}, "max":20, "min":1 }, "ConfigArn":{ "type":"string", "max":424, "min":82, "pattern":"arn:aws:groundstation:[-a-z0-9]{1,50}:[0-9]{12}:config/[a-z0-9]+(-[a-z0-9]+){0,4}/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(/.{1,256})?" }, "ConfigCapabilityType":{ "type":"string", "enum":[ "antenna-downlink", "antenna-downlink-demod-decode", "tracking", "dataflow-endpoint", "antenna-uplink", "uplink-echo", "s3-recording", "telemetry-sink" ] }, "ConfigDetails":{ "type":"structure", "members":{ "endpointDetails":{"shape":"EndpointDetails"}, "antennaDemodDecodeDetails":{ "shape":"AntennaDemodDecodeDetails", "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.
" }, "ConfigList":{ "type":"list", "member":{"shape":"ConfigListItem"} }, "ConfigListItem":{ "type":"structure", "members":{ "configId":{ "shape":"String", "documentation":"
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":{ "shape":"TrackingConfig", "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":{ "shape":"AntennaUplinkConfig", "documentation":"Information about how AWS Ground Station should configure an antenna for uplink during a contact.
" }, "uplinkEchoConfig":{ "shape":"UplinkEchoConfig", "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.
Information about a telemetry sink Config.
Object containing the parameters of a Config.
See the subtype definitions for what each type of Config contains.
A socket address.
" }, "mtu":{ "shape":"Integer", "documentation":"Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.
" } }, "documentation":"Egress address of AgentEndpoint with an optional mtu.
" }, "ContactData":{ "type":"structure", "members":{ "contactId":{ "shape":"Uuid", "documentation":"UUID of a contact.
" }, "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 in UTC.
" }, "endTime":{ "shape":"Timestamp", "documentation":"End time of a contact in UTC.
" }, "prePassStartTime":{ "shape":"Timestamp", "documentation":"Amount of time prior to contact start you’d like to receive a CloudWatch event indicating an upcoming pass.
" }, "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.
" }, "groundStation":{ "shape":"String", "documentation":"Name of a ground station.
" }, "contactStatus":{ "shape":"ContactStatus", "documentation":"Status of a contact.
" }, "errorMessage":{ "shape":"String", "documentation":"Error message of a contact.
" }, "maximumElevation":{ "shape":"Elevation", "documentation":"Maximum elevation angle of a contact.
" }, "region":{ "shape":"String", "documentation":"Region of a contact.
" }, "tags":{ "shape":"TagsMap", "documentation":"Tags assigned to a contact.
" }, "visibilityStartTime":{ "shape":"Timestamp", "documentation":" Projected time in UTC your satellite will rise above the receive mask. This time is based on the satellite's current active ephemeris for future contacts and the ephemeris that was active during contact execution for completed contacts. This field is not present for contacts with a SCHEDULING or SCHEDULED status.
Projected time in UTC your satellite will set below the receive mask. This time is based on the satellite's current active ephemeris for future contacts and the ephemeris that was active during contact execution for completed contacts. This field is not present for contacts with a SCHEDULING or SCHEDULED status.
The ephemeris that determines antenna pointing for the contact.
" } }, "documentation":"Data describing a contact.
" }, "ContactIdResponse":{ "type":"structure", "members":{ "contactId":{ "shape":"Uuid", "documentation":"UUID of a contact.
" } }, "documentation":"" }, "ContactList":{ "type":"list", "member":{"shape":"ContactData"} }, "ContactStatus":{ "type":"string", "enum":[ "SCHEDULING", "FAILED_TO_SCHEDULE", "SCHEDULED", "CANCELLED", "AWS_CANCELLED", "PREPASS", "PASS", "POSTPASS", "COMPLETED", "FAILED", "AVAILABLE", "CANCELLING", "AWS_FAILED" ] }, "CreateConfigRequest":{ "type":"structure", "required":[ "name", "configData" ], "members":{ "name":{ "shape":"SafeName", "documentation":"
Name of a Config.
Parameters of a Config.
Tags assigned to a Config.
" }, "CreateDataflowEndpointGroupRequest":{ "type":"structure", "required":["endpointDetails"], "members":{ "endpointDetails":{ "shape":"EndpointDetailsList", "documentation":"
Endpoint details of each endpoint in the dataflow endpoint group. All dataflow endpoints within a single dataflow endpoint group must be of the same type. You cannot mix AWS Ground Station Agent endpoints with Dataflow endpoints in the same group. If your use case requires both types of endpoints, you must create separate dataflow endpoint groups for each type.
" }, "tags":{ "shape":"TagsMap", "documentation":"Tags of a dataflow endpoint group.
" }, "contactPrePassDurationSeconds":{ "shape":"DataflowEndpointGroupDurationInSeconds", "documentation":" Amount of time, in seconds, before a contact starts that the Ground Station Dataflow Endpoint Group will be in a PREPASS state. A Ground Station Dataflow Endpoint Group State Change event will be emitted when the Dataflow Endpoint Group enters and exits the PREPASS state.
Amount of time, in seconds, after a contact ends that the Ground Station Dataflow Endpoint Group will be in a POSTPASS state. A Ground Station Dataflow Endpoint Group State Change event will be emitted when the Dataflow Endpoint Group enters and exits the POSTPASS state.
" }, "CreateDataflowEndpointGroupV2Request":{ "type":"structure", "required":["endpoints"], "members":{ "endpoints":{ "shape":"CreateEndpointDetailsList", "documentation":"
Dataflow endpoint group's endpoint definitions
" }, "contactPrePassDurationSeconds":{ "shape":"DataflowEndpointGroupDurationInSeconds", "documentation":" Amount of time, in seconds, before a contact starts that the Ground Station Dataflow Endpoint Group will be in a PREPASS state. A Ground Station Dataflow Endpoint Group State Change event will be emitted when the Dataflow Endpoint Group enters and exits the PREPASS state.
Amount of time, in seconds, after a contact ends that the Ground Station Dataflow Endpoint Group will be in a POSTPASS state. A Ground Station Dataflow Endpoint Group State Change event will be emitted when the Dataflow Endpoint Group enters and exits the POSTPASS state.
Tags of a V2 dataflow endpoint group.
" } } }, "CreateDataflowEndpointGroupV2Response":{ "type":"structure", "members":{ "dataflowEndpointGroupId":{ "shape":"Uuid", "documentation":"Dataflow endpoint group ID
" } } }, "CreateEndpointDetails":{ "type":"structure", "members":{ "uplinkAwsGroundStationAgentEndpoint":{ "shape":"UplinkAwsGroundStationAgentEndpoint", "documentation":"Definition for an uplink agent endpoint
" }, "downlinkAwsGroundStationAgentEndpoint":{ "shape":"DownlinkAwsGroundStationAgentEndpoint", "documentation":"Definition for a downlink agent endpoint
" } }, "documentation":"Endpoint definition used for creating a dataflow endpoint
", "union":true }, "CreateEndpointDetailsList":{ "type":"list", "member":{"shape":"CreateEndpointDetails"}, "max":12, "min":1 }, "CreateEphemerisRequest":{ "type":"structure", "required":["name"], "members":{ "satelliteId":{ "shape":"Uuid", "documentation":"The satellite ID that associates this ephemeris with a satellite in AWS Ground Station.
" }, "enabled":{ "shape":"Boolean", "documentation":"Set to true to enable the ephemeris after validation. Set to false to keep it disabled.
A priority score that determines which ephemeris to use when multiple ephemerides overlap.
Higher numbers take precedence. The default is 1. Must be 1 or greater.
" }, "expirationTime":{ "shape":"Timestamp", "documentation":"An overall expiration time for the ephemeris in UTC, after which it will become EXPIRED.
A name that you can use to identify the ephemeris.
" }, "kmsKeyArn":{ "shape":"KeyArn", "documentation":"The ARN of the KMS key to use for encrypting the ephemeris.
" }, "ephemeris":{ "shape":"EphemerisData", "documentation":"Ephemeris data.
" }, "tags":{ "shape":"TagsMap", "documentation":"Tags assigned to an ephemeris.
" } } }, "CreateMissionProfileRequest":{ "type":"structure", "required":[ "name", "minimumViableContactDurationSeconds", "dataflowEdges", "trackingConfigArn" ], "members":{ "name":{ "shape":"SafeName", "documentation":"Name of a mission profile.
" }, "contactPrePassDurationSeconds":{ "shape":"DurationInSeconds", "documentation":"Amount of time prior to contact start you’d like to receive a Ground Station Contact State Change event indicating an upcoming pass.
" }, "contactPostPassDurationSeconds":{ "shape":"DurationInSeconds", "documentation":"Amount of time after a contact ends that you’d like to receive a Ground Station Contact State Change event indicating the pass has finished.
" }, "minimumViableContactDurationSeconds":{ "shape":"PositiveDurationInSeconds", "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":{ "shape":"DataflowEdgeList", "documentation":"A list of lists of ARNs. Each list of ARNs is an edge, with a from Config and a to Config.
ARN of a tracking Config.
ARN of a telemetry sink Config.
Tags assigned to a mission profile.
" }, "streamsKmsKey":{ "shape":"KmsKey", "documentation":"KMS key to use for encrypting streams.
" }, "streamsKmsRole":{ "shape":"RoleArn", "documentation":"Role to use for encrypting streams with KMS key.
" } }, "documentation":"" }, "Criticality":{ "type":"string", "enum":[ "REQUIRED", "PREFERRED", "REMOVED" ] }, "CustomerEphemerisPriority":{ "type":"integer", "box":true, "max":99999, "min":1 }, "DataflowDetail":{ "type":"structure", "members":{ "source":{"shape":"Source"}, "destination":{"shape":"Destination"}, "errorMessage":{ "shape":"String", "documentation":"
Error message for a dataflow.
" } }, "documentation":"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"}, "max":500, "min":0 }, "DataflowEndpoint":{ "type":"structure", "members":{ "name":{ "shape":"SafeName", "documentation":"Name of a dataflow endpoint.
" }, "address":{ "shape":"SocketAddress", "documentation":"Socket address of a dataflow endpoint.
" }, "status":{ "shape":"EndpointStatus", "documentation":"Status of a dataflow endpoint.
" }, "mtu":{ "shape":"DataflowEndpointMtuInteger", "documentation":"Maximum transmission unit (MTU) size in bytes 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":{ "dataflowEndpointGroupId":{ "shape":"Uuid", "documentation":"
UUID of a dataflow endpoint group.
" }, "dataflowEndpointGroupArn":{ "shape":"DataflowEndpointGroupArn", "documentation":"ARN 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.
" }, "DeleteDataflowEndpointGroupRequest":{ "type":"structure", "required":["dataflowEndpointGroupId"], "members":{ "dataflowEndpointGroupId":{ "shape":"Uuid", "documentation":"
UUID of a dataflow endpoint group.
", "location":"uri", "locationName":"dataflowEndpointGroupId" } }, "documentation":"" }, "DeleteEphemerisRequest":{ "type":"structure", "required":["ephemerisId"], "members":{ "ephemerisId":{ "shape":"Uuid", "documentation":"
The AWS Ground Station ephemeris ID.
", "location":"uri", "locationName":"ephemerisId" } } }, "DeleteMissionProfileRequest":{ "type":"structure", "required":["missionProfileId"], "members":{ "missionProfileId":{ "shape":"Uuid", "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":"Uuid", "documentation":"UUID of a contact.
", "location":"uri", "locationName":"contactId" } }, "documentation":"" }, "DescribeContactResponse":{ "type":"structure", "members":{ "contactId":{ "shape":"Uuid", "documentation":"
UUID of a contact.
" }, "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 in UTC.
" }, "endTime":{ "shape":"Timestamp", "documentation":"End time of a contact in UTC.
" }, "prePassStartTime":{ "shape":"Timestamp", "documentation":"Amount of time prior to contact start you’d like to receive a CloudWatch event indicating an upcoming pass.
" }, "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.
" }, "groundStation":{ "shape":"String", "documentation":"Ground station for a contact.
" }, "contactStatus":{ "shape":"ContactStatus", "documentation":"Status of a contact.
" }, "errorMessage":{ "shape":"String", "documentation":"Error message for a contact.
" }, "maximumElevation":{ "shape":"Elevation", "documentation":"Maximum elevation angle of a contact.
" }, "tags":{ "shape":"TagsMap", "documentation":"Tags assigned to a contact.
" }, "region":{ "shape":"String", "documentation":"Region of a contact.
" }, "dataflowList":{ "shape":"DataflowList", "documentation":"List describing source and destination details for each dataflow edge.
" }, "visibilityStartTime":{ "shape":"Timestamp", "documentation":"Projected time in UTC your satellite will rise above the receive mask. This time is based on the satellite's current active ephemeris for future contacts and the ephemeris that was active during contact execution for completed contacts.
" }, "visibilityEndTime":{ "shape":"Timestamp", "documentation":"Projected time in UTC your satellite will set below the receive mask. This time is based on the satellite's current active ephemeris for future contacts and the ephemeris that was active during contact execution for completed contacts.
" }, "trackingOverrides":{ "shape":"TrackingOverrides", "documentation":"Tracking configuration overrides specified when the contact was reserved.
" }, "ephemeris":{ "shape":"EphemerisResponseData", "documentation":"The ephemeris that determines antenna pointing directions for the contact.
" } }, "documentation":"" }, "DescribeEphemerisRequest":{ "type":"structure", "required":["ephemerisId"], "members":{ "ephemerisId":{ "shape":"Uuid", "documentation":"
The AWS Ground Station ephemeris ID.
", "location":"uri", "locationName":"ephemerisId" } } }, "DescribeEphemerisResponse":{ "type":"structure", "members":{ "ephemerisId":{ "shape":"Uuid", "documentation":"The AWS Ground Station ephemeris ID.
" }, "satelliteId":{ "shape":"Uuid", "documentation":"The AWS Ground Station satellite ID associated with ephemeris.
" }, "status":{ "shape":"EphemerisStatus", "documentation":"The status of the ephemeris.
" }, "priority":{ "shape":"EphemerisPriority", "documentation":"A priority score that determines which ephemeris to use when multiple ephemerides overlap.
Higher numbers take precedence. The default is 1. Must be 1 or greater.
" }, "creationTime":{ "shape":"Timestamp", "documentation":"The time the ephemeris was uploaded in UTC.
" }, "enabled":{ "shape":"Boolean", "documentation":"Whether or not the ephemeris is enabled.
" }, "name":{ "shape":"SafeName", "documentation":"A name that you can use to identify the ephemeris.
" }, "tags":{ "shape":"TagsMap", "documentation":"Tags assigned to an ephemeris.
" }, "suppliedData":{ "shape":"EphemerisTypeDescription", "documentation":"Supplied ephemeris data.
" }, "invalidReason":{ "shape":"EphemerisInvalidReason", "documentation":"Reason that an ephemeris failed validation. Appears only when the status is INVALID.
Detailed error information for ephemerides with INVALID status.
Provides specific error codes and messages to help diagnose validation failures.
" } } }, "Destination":{ "type":"structure", "members":{ "configType":{ "shape":"ConfigCapabilityType", "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.
" } }, "documentation":"Dataflow details for the destination side.
" }, "DiscoveryData":{ "type":"structure", "required":[ "publicIpAddresses", "privateIpAddresses", "capabilityArns" ], "members":{ "publicIpAddresses":{ "shape":"IpAddressList", "documentation":"List of public IP addresses to associate with agent.
" }, "privateIpAddresses":{ "shape":"IpAddressList", "documentation":"List of private IP addresses to associate with agent.
" }, "capabilityArns":{ "shape":"CapabilityArnList", "documentation":"List of capabilities to associate with agent.
" } }, "documentation":"Data for agent discovery.
" }, "Double":{ "type":"double", "box":true }, "DownlinkAwsGroundStationAgentEndpoint":{ "type":"structure", "required":[ "name", "dataflowDetails" ], "members":{ "name":{ "shape":"SafeName", "documentation":"Downlink dataflow endpoint name
" }, "dataflowDetails":{ "shape":"DownlinkDataflowDetails", "documentation":"Dataflow details for the downlink endpoint
" } }, "documentation":"Definition for a downlink agent endpoint
" }, "DownlinkAwsGroundStationAgentEndpointDetails":{ "type":"structure", "required":[ "name", "dataflowDetails" ], "members":{ "name":{ "shape":"SafeName", "documentation":"Downlink dataflow endpoint name
" }, "dataflowDetails":{ "shape":"DownlinkDataflowDetails", "documentation":"Dataflow details for the downlink endpoint
" }, "agentStatus":{ "shape":"AgentStatus", "documentation":"Status of the agent associated with the downlink dataflow endpoint
" }, "auditResults":{ "shape":"AuditResults", "documentation":"Health audit results for the downlink dataflow endpoint
" } }, "documentation":"Details for a downlink agent endpoint
" }, "DownlinkConnectionDetails":{ "type":"structure", "required":[ "agentIpAndPortAddress", "egressAddressAndPort" ], "members":{ "agentIpAndPortAddress":{"shape":"RangedConnectionDetails"}, "egressAddressAndPort":{"shape":"ConnectionDetails"} }, "documentation":"Connection details for Ground Station to Agent and Agent to customer
" }, "DownlinkDataflowDetails":{ "type":"structure", "members":{ "agentConnectionDetails":{ "shape":"DownlinkConnectionDetails", "documentation":"Downlink connection details for customer to Agent and Agent to Ground Station
" } }, "documentation":"Dataflow details for a downlink endpoint
", "union":true }, "DurationInSeconds":{ "type":"integer", "box":true, "max":21600, "min":0 }, "Eirp":{ "type":"structure", "required":[ "value", "units" ], "members":{ "value":{ "shape":"Double", "documentation":"Value of an EIRP. Valid values are between 20.0 to 50.0 dBW.
" }, "units":{ "shape":"EirpUnits", "documentation":"Units of an EIRP.
" } }, "documentation":"Object that represents EIRP.
" }, "EirpUnits":{ "type":"string", "enum":["dBW"] }, "Elevation":{ "type":"structure", "required":[ "value", "unit" ], "members":{ "value":{ "shape":"Double", "documentation":"Elevation angle value.
" }, "unit":{ "shape":"AngleUnits", "documentation":"Elevation angle units.
" } }, "documentation":"Elevation angle of the satellite in the sky during a contact.
" }, "EndpointDetails":{ "type":"structure", "members":{ "securityDetails":{ "shape":"SecurityDetails", "documentation":"Endpoint security details including a list of subnets, a list of security groups and a role to connect streams to instances.
" }, "endpoint":{ "shape":"DataflowEndpoint", "documentation":"A dataflow endpoint.
" }, "awsGroundStationAgentEndpoint":{ "shape":"AwsGroundStationAgentEndpoint", "documentation":"An agent endpoint.
" }, "uplinkAwsGroundStationAgentEndpoint":{ "shape":"UplinkAwsGroundStationAgentEndpointDetails", "documentation":"Definition for an uplink agent endpoint
" }, "downlinkAwsGroundStationAgentEndpoint":{ "shape":"DownlinkAwsGroundStationAgentEndpointDetails", "documentation":"Definition for a downlink agent endpoint
" }, "healthStatus":{ "shape":"CapabilityHealth", "documentation":"A dataflow endpoint health status. This field is ignored when calling CreateDataflowEndpointGroup.
Health reasons for a dataflow endpoint. This field is ignored when calling CreateDataflowEndpointGroup.
Information about the endpoint details.
" }, "EndpointDetailsList":{ "type":"list", "member":{"shape":"EndpointDetails"}, "max":500, "min":0 }, "EndpointStatus":{ "type":"string", "enum":[ "created", "creating", "deleted", "deleting", "failed" ] }, "EphemeridesList":{ "type":"list", "member":{"shape":"EphemerisItem"}, "max":500, "min":1 }, "EphemerisData":{ "type":"structure", "members":{ "tle":{"shape":"TLEEphemeris"}, "oem":{"shape":"OEMEphemeris"}, "azEl":{"shape":"AzElEphemeris"} }, "documentation":"Ephemeris data.
", "union":true }, "EphemerisDescription":{ "type":"structure", "members":{ "sourceS3Object":{ "shape":"S3Object", "documentation":"Source Amazon S3 object used for the ephemeris.
" }, "ephemerisData":{ "shape":"UnboundedString", "documentation":"Supplied ephemeris data.
" } }, "documentation":"Description of ephemeris.
" }, "EphemerisErrorCode":{ "type":"string", "enum":[ "INTERNAL_ERROR", "MISMATCHED_SATCAT_ID", "OEM_VERSION_UNSUPPORTED", "ORIGINATOR_MISSING", "CREATION_DATE_MISSING", "OBJECT_NAME_MISSING", "OBJECT_ID_MISSING", "REF_FRAME_UNSUPPORTED", "REF_FRAME_EPOCH_UNSUPPORTED", "TIME_SYSTEM_UNSUPPORTED", "CENTER_BODY_UNSUPPORTED", "INTERPOLATION_MISSING", "INTERPOLATION_DEGREE_INVALID", "AZ_EL_SEGMENT_LIST_MISSING", "INSUFFICIENT_TIME_AZ_EL", "START_TIME_IN_FUTURE", "END_TIME_IN_PAST", "EXPIRATION_TIME_TOO_EARLY", "START_TIME_METADATA_TOO_EARLY", "STOP_TIME_METADATA_TOO_LATE", "AZ_EL_SEGMENT_END_TIME_BEFORE_START_TIME", "AZ_EL_SEGMENT_TIMES_OVERLAP", "AZ_EL_SEGMENTS_OUT_OF_ORDER", "TIME_AZ_EL_ITEMS_OUT_OF_ORDER", "MEAN_MOTION_INVALID", "TIME_AZ_EL_AZ_RADIAN_RANGE_INVALID", "TIME_AZ_EL_EL_RADIAN_RANGE_INVALID", "TIME_AZ_EL_AZ_DEGREE_RANGE_INVALID", "TIME_AZ_EL_EL_DEGREE_RANGE_INVALID", "TIME_AZ_EL_ANGLE_UNITS_INVALID", "INSUFFICIENT_KMS_PERMISSIONS", "FILE_FORMAT_INVALID", "AZ_EL_SEGMENT_REFERENCE_EPOCH_INVALID", "AZ_EL_SEGMENT_START_TIME_INVALID", "AZ_EL_SEGMENT_END_TIME_INVALID", "AZ_EL_SEGMENT_VALID_TIME_RANGE_INVALID", "AZ_EL_SEGMENT_END_TIME_TOO_LATE", "AZ_EL_TOTAL_DURATION_EXCEEDED" ] }, "EphemerisErrorReason":{ "type":"structure", "required":[ "errorCode", "errorMessage" ], "members":{ "errorCode":{ "shape":"EphemerisErrorCode", "documentation":"The error code identifying the type of validation failure.
See the Troubleshooting Invalid Ephemerides guide for error code details.
" }, "errorMessage":{ "shape":"ErrorString", "documentation":"A human-readable message describing the validation failure.
Provides specific details about what failed and may include suggestions for remediation.
" } }, "documentation":"Detailed error information for ephemeris validation failures.
Provides an error code and descriptive message to help diagnose and resolve validation issues.
" }, "EphemerisErrorReasonList":{ "type":"list", "member":{"shape":"EphemerisErrorReason"}, "max":50, "min":1 }, "EphemerisFilter":{ "type":"structure", "members":{ "azEl":{ "shape":"AzElEphemerisFilter", "documentation":"Filter for AzElEphemeris.
" } }, "documentation":"Filter for selecting contacts that use a specific ephemeris\".
", "union":true }, "EphemerisIdResponse":{ "type":"structure", "members":{ "ephemerisId":{ "shape":"Uuid", "documentation":"The AWS Ground Station ephemeris ID.
" } } }, "EphemerisInvalidReason":{ "type":"string", "enum":[ "METADATA_INVALID", "TIME_RANGE_INVALID", "TRAJECTORY_INVALID", "KMS_KEY_INVALID", "VALIDATION_ERROR" ] }, "EphemerisItem":{ "type":"structure", "members":{ "ephemerisId":{ "shape":"Uuid", "documentation":"The AWS Ground Station ephemeris ID.
" }, "ephemerisType":{ "shape":"EphemerisType", "documentation":"The type of ephemeris.
" }, "status":{ "shape":"EphemerisStatus", "documentation":"The status of the ephemeris.
" }, "priority":{ "shape":"EphemerisPriority", "documentation":"A priority score that determines which ephemeris to use when multiple ephemerides overlap.
Higher numbers take precedence. The default is 1. Must be 1 or greater.
" }, "enabled":{ "shape":"Boolean", "documentation":"Whether or not the ephemeris is enabled.
" }, "creationTime":{ "shape":"Timestamp", "documentation":"The time the ephemeris was uploaded in UTC.
" }, "name":{ "shape":"SafeName", "documentation":"A name that you can use to identify the ephemeris.
" }, "sourceS3Object":{ "shape":"S3Object", "documentation":"Source Amazon S3 object used for the ephemeris.
" } }, "documentation":"Ephemeris item.
" }, "EphemerisMetaData":{ "type":"structure", "required":["source"], "members":{ "source":{ "shape":"EphemerisSource", "documentation":"The EphemerisSource that generated a given ephemeris.
UUID of a customer-provided ephemeris.
This field is not populated for default ephemerides from Space Track.
" }, "epoch":{ "shape":"Timestamp", "documentation":"The epoch of a default, ephemeris from Space Track in UTC.
This field is not populated for customer-provided ephemerides.
" }, "name":{ "shape":"SafeName", "documentation":"A name string associated with the ephemeris. Used as a human-readable identifier for the ephemeris.
A name is only returned for customer-provider ephemerides that have a name associated.
" } }, "documentation":"Metadata describing a particular ephemeris.
" }, "EphemerisPriority":{ "type":"integer", "box":true, "max":99999, "min":0 }, "EphemerisResponseData":{ "type":"structure", "required":["ephemerisType"], "members":{ "ephemerisId":{ "shape":"Uuid", "documentation":"Unique identifier of the ephemeris. Appears only for custom ephemerides.
" }, "ephemerisType":{ "shape":"EphemerisType", "documentation":"Type of ephemeris.
" } }, "documentation":"Ephemeris data for a contact.
" }, "EphemerisSource":{ "type":"string", "enum":[ "CUSTOMER_PROVIDED", "SPACE_TRACK" ] }, "EphemerisStatus":{ "type":"string", "enum":[ "VALIDATING", "INVALID", "ERROR", "ENABLED", "DISABLED", "EXPIRED" ] }, "EphemerisStatusList":{ "type":"list", "member":{"shape":"EphemerisStatus"}, "max":500, "min":0 }, "EphemerisType":{ "type":"string", "enum":[ "TLE", "OEM", "AZ_EL", "SERVICE_MANAGED" ] }, "EphemerisTypeDescription":{ "type":"structure", "members":{ "tle":{"shape":"EphemerisDescription"}, "oem":{"shape":"EphemerisDescription"}, "azEl":{"shape":"EphemerisDescription"} }, "documentation":"", "union":true }, "ErrorString":{ "type":"string", "max":1000, "min":0 }, "Frequency":{ "type":"structure", "required":[ "value", "units" ], "members":{ "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.
" }, "units":{ "shape":"FrequencyUnits", "documentation":"Frequency units.
" } }, "documentation":"Object that describes the frequency.
" }, "FrequencyBandwidth":{ "type":"structure", "required":[ "value", "units" ], "members":{ "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.
Frequency bandwidth units.
" } }, "documentation":"Object that describes the frequency bandwidth.
" }, "FrequencyUnits":{ "type":"string", "enum":[ "GHz", "MHz", "kHz" ] }, "GetAgentConfigurationRequest":{ "type":"structure", "required":["agentId"], "members":{ "agentId":{ "shape":"Uuid", "documentation":"UUID of agent to get configuration information for.
", "location":"uri", "locationName":"agentId" } } }, "GetAgentConfigurationResponse":{ "type":"structure", "members":{ "agentId":{ "shape":"Uuid", "documentation":"UUID of agent.
" }, "taskingDocument":{ "shape":"String", "documentation":"Tasking document for agent.
" } } }, "GetAgentTaskResponseUrlRequest":{ "type":"structure", "required":[ "agentId", "taskId" ], "members":{ "agentId":{ "shape":"Uuid", "documentation":"UUID of agent requesting the response URL.
", "location":"uri", "locationName":"agentId" }, "taskId":{ "shape":"Uuid", "documentation":"GUID of the agent task for which the response URL is being requested.
", "location":"uri", "locationName":"taskId" } } }, "GetAgentTaskResponseUrlResponse":{ "type":"structure", "required":[ "agentId", "taskId", "presignedLogUrl" ], "members":{ "agentId":{ "shape":"Uuid", "documentation":"UUID of the agent.
" }, "taskId":{ "shape":"Uuid", "documentation":"GUID of the agent task.
" }, "presignedLogUrl":{ "shape":"String", "documentation":"Presigned URL for uploading agent task response logs.
" } } }, "GetConfigRequest":{ "type":"structure", "required":[ "configId", "configType" ], "members":{ "configId":{ "shape":"Uuid", "documentation":"UUID of a Config.
Type of a Config.
" }, "GetConfigResponse":{ "type":"structure", "required":[ "configId", "configArn", "name", "configData" ], "members":{ "configId":{ "shape":"String", "documentation":"
UUID of a Config.
ARN of a Config
Name of a Config.
Type of a Config.
Data elements in a Config.
Tags assigned to a Config.
" }, "GetDataflowEndpointGroupRequest":{ "type":"structure", "required":["dataflowEndpointGroupId"], "members":{ "dataflowEndpointGroupId":{ "shape":"Uuid", "documentation":"
UUID of a dataflow endpoint group.
", "location":"uri", "locationName":"dataflowEndpointGroupId" } }, "documentation":"" }, "GetDataflowEndpointGroupResponse":{ "type":"structure", "members":{ "dataflowEndpointGroupId":{ "shape":"Uuid", "documentation":"
UUID of a dataflow endpoint group.
" }, "dataflowEndpointGroupArn":{ "shape":"DataflowEndpointGroupArn", "documentation":"ARN 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.
" }, "contactPrePassDurationSeconds":{ "shape":"DataflowEndpointGroupDurationInSeconds", "documentation":"Amount of time, in seconds, before a contact starts that the Ground Station Dataflow Endpoint Group will be in a PREPASS state. A Ground Station Dataflow Endpoint Group State Change event will be emitted when the Dataflow Endpoint Group enters and exits the PREPASS state.
Amount of time, in seconds, after a contact ends that the Ground Station Dataflow Endpoint Group will be in a POSTPASS state. A Ground Station Dataflow Endpoint Group State Change event will be emitted when the Dataflow Endpoint Group enters and exits the POSTPASS state.
" }, "GetMinuteUsageRequest":{ "type":"structure", "required":[ "month", "year" ], "members":{ "month":{ "shape":"Month", "documentation":"
The month being requested, with a value of 1-12.
" }, "year":{ "shape":"Year", "documentation":"The year being requested, in the format of YYYY.
" } }, "documentation":"" }, "GetMinuteUsageResponse":{ "type":"structure", "members":{ "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.
" }, "upcomingMinutesScheduled":{ "shape":"Integer", "documentation":"Upcoming minutes scheduled for an account, specific to the month being requested.
" }, "totalScheduledMinutes":{ "shape":"Integer", "documentation":"Total scheduled minutes for an account, specific to the month being requested.
" }, "estimatedMinutesRemaining":{ "shape":"Integer", "documentation":"Estimated number of minutes remaining for an account, specific to the month being requested.
" } }, "documentation":"" }, "GetMissionProfileRequest":{ "type":"structure", "required":["missionProfileId"], "members":{ "missionProfileId":{ "shape":"Uuid", "documentation":"UUID of a mission profile.
", "location":"uri", "locationName":"missionProfileId" } }, "documentation":"" }, "GetMissionProfileResponse":{ "type":"structure", "members":{ "missionProfileId":{ "shape":"Uuid", "documentation":"
UUID of a mission profile.
" }, "missionProfileArn":{ "shape":"MissionProfileArn", "documentation":"ARN of a mission profile.
" }, "name":{ "shape":"SafeName", "documentation":"Name of a mission profile.
" }, "region":{ "shape":"AWSRegion", "documentation":"Region of a mission profile.
" }, "contactPrePassDurationSeconds":{ "shape":"DurationInSeconds", "documentation":"Amount of time prior to contact start you’d like to receive a CloudWatch event indicating an upcoming pass.
" }, "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.
" }, "minimumViableContactDurationSeconds":{ "shape":"PositiveDurationInSeconds", "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":{ "shape":"DataflowEdgeList", "documentation":"A list of lists of ARNs. Each list of ARNs is an edge, with a from Config and a to Config.
ARN of a tracking Config.
ARN of a telemetry sink Config.
Tags assigned to a mission profile.
" }, "streamsKmsKey":{ "shape":"KmsKey", "documentation":"KMS key to use for encrypting streams.
" }, "streamsKmsRole":{ "shape":"RoleArn", "documentation":"Role to use for encrypting streams with KMS key.
" } }, "documentation":"" }, "GetSatelliteRequest":{ "type":"structure", "required":["satelliteId"], "members":{ "satelliteId":{ "shape":"Uuid", "documentation":"
UUID of a satellite.
", "location":"uri", "locationName":"satelliteId" } }, "documentation":"" }, "GetSatelliteResponse":{ "type":"structure", "members":{ "satelliteId":{ "shape":"Uuid", "documentation":"UUID of a satellite.
" }, "satelliteArn":{ "shape":"satelliteArn", "documentation":"ARN of a satellite.
" }, "noradSatelliteID":{ "shape":"noradSatelliteID", "documentation":"NORAD satellite ID number.
" }, "groundStations":{ "shape":"GroundStationIdList", "documentation":"A list of ground stations to which the satellite is on-boarded.
" }, "currentEphemeris":{ "shape":"EphemerisMetaData", "documentation":"The current ephemeris being used to compute the trajectory of the satellite.
" } }, "documentation":"" }, "GroundStationData":{ "type":"structure", "members":{ "groundStationId":{ "shape":"GroundStationName", "documentation":"UUID of a ground station.
" }, "groundStationName":{ "shape":"GroundStationName", "documentation":"Name of a ground station.
" }, "region":{ "shape":"AWSRegion", "documentation":"Ground station Region.
" } }, "documentation":"Information about the ground station data.
" }, "GroundStationIdList":{ "type":"list", "member":{"shape":"GroundStationName"}, "max":500, "min":0 }, "GroundStationList":{ "type":"list", "member":{"shape":"GroundStationData"} }, "GroundStationName":{ "type":"string", "max":500, "min":4, "pattern":"[ a-zA-Z0-9-._:=]{4,256}" }, "ISO8601TimeRange":{ "type":"structure", "required":[ "startTime", "endTime" ], "members":{ "startTime":{ "shape":"SyntheticTimestamp_date_time", "documentation":"Start time in ISO 8601 format in Coordinated Universal Time (UTC).
Example: 2026-11-15T10:28:48.000Z
End time in ISO 8601 format in Coordinated Universal Time (UTC).
Example: 2024-01-15T12:00:00.000Z
Time range specified using ISO 8601 format timestamps.
" }, "InstanceId":{ "type":"string", "max":64, "min":10, "pattern":"[a-z0-9-]{10,64}" }, "InstanceType":{ "type":"string", "max":64, "min":1, "pattern":"[a-z0-9.-]{1,64}" }, "Integer":{ "type":"integer", "box":true }, "IntegerRange":{ "type":"structure", "required":[ "minimum", "maximum" ], "members":{ "minimum":{ "shape":"Integer", "documentation":"A minimum value.
" }, "maximum":{ "shape":"Integer", "documentation":"A maximum value.
" } }, "documentation":"An integer range that has a minimum and maximum value.
" }, "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 }, "IpAddressList":{ "type":"list", "member":{"shape":"IpV4Address"}, "max":20, "min":1 }, "IpV4Address":{ "type":"string", "max":16, "min":7, "pattern":"\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}" }, "JsonString":{ "type":"string", "max":8192, "min":2, "pattern":"[{}\\[\\]:.,\"0-9A-Za-z\\-_\\s]{2,8192}" }, "KeyAliasArn":{ "type":"string", "max":512, "min":1, "pattern":"arn:aws[a-zA-Z-]{0,16}:kms:[-a-z0-9]{1,50}:[0-9]{12}:((alias/[a-zA-Z0-9:/_-]{1,256}))" }, "KeyAliasName":{ "type":"string", "max":256, "min":1, "pattern":"alias/[a-zA-Z0-9:/_-]+" }, "KeyArn":{"type":"string"}, "KinesisDataStreamArn":{ "type":"string", "max":275, "min":37, "pattern":"arn:[a-z0-9-.]{1,63}:kinesis:[-a-z0-9]{1,50}:[0-9]{12}:stream/[a-zA-Z0-9_.-]{1,128}" }, "KinesisDataStreamData":{ "type":"structure", "required":[ "kinesisRoleArn", "kinesisDataStreamArn" ], "members":{ "kinesisRoleArn":{ "shape":"RoleArn", "documentation":"ARN of the IAM Role used by AWS Ground Station to deliver telemetry.
" }, "kinesisDataStreamArn":{ "shape":"KinesisDataStreamArn", "documentation":"ARN of the Kinesis Data Stream to deliver telemetry to.
" } }, "documentation":"Information for telemetry delivery to Kinesis Data Streams.
" }, "KmsKey":{ "type":"structure", "members":{ "kmsKeyArn":{ "shape":"KeyArn", "documentation":"KMS Key Arn.
" }, "kmsAliasArn":{ "shape":"KeyAliasArn", "documentation":"KMS Alias Arn.
" }, "kmsAliasName":{ "shape":"KeyAliasName", "documentation":"KMS Alias Name.
" } }, "documentation":"KMS key info.
", "union":true }, "ListConfigsRequest":{ "type":"structure", "members":{ "maxResults":{ "shape":"PaginationMaxResults", "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.
" }, "ListConfigsResponse":{ "type":"structure", "members":{ "nextToken":{ "shape":"PaginationToken", "documentation":"
Next token returned in the response of a previous ListConfigs call. Used to get the next page of results.
List of Config items.
" }, "ListContactsRequest":{ "type":"structure", "required":[ "statusList", "startTime", "endTime" ], "members":{ "maxResults":{ "shape":"PaginationMaxResults", "documentation":"
Maximum number of contacts returned.
" }, "nextToken":{ "shape":"PaginationToken", "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.
" }, "startTime":{ "shape":"Timestamp", "documentation":"Start time of a contact in UTC.
" }, "endTime":{ "shape":"Timestamp", "documentation":"End time of a contact in UTC.
" }, "groundStation":{ "shape":"GroundStationName", "documentation":"Name of a ground station.
" }, "satelliteArn":{ "shape":"satelliteArn", "documentation":"ARN of a satellite.
" }, "missionProfileArn":{ "shape":"MissionProfileArn", "documentation":"ARN of a mission profile.
" }, "ephemeris":{ "shape":"EphemerisFilter", "documentation":"Filter for selecting contacts that use a specific ephemeris\".
" } }, "documentation":"" }, "ListContactsResponse":{ "type":"structure", "members":{ "nextToken":{ "shape":"PaginationToken", "documentation":"
Next token returned in the response of a previous ListContacts call. Used to get the next page of results.
List of contacts.
" } }, "documentation":"" }, "ListDataflowEndpointGroupsRequest":{ "type":"structure", "members":{ "maxResults":{ "shape":"PaginationMaxResults", "documentation":"
Maximum number of dataflow endpoint groups returned.
", "location":"querystring", "locationName":"maxResults" }, "nextToken":{ "shape":"PaginationToken", "documentation":"Next token returned in the request of a previous ListDataflowEndpointGroups call. Used to get the next page of results.
" }, "ListDataflowEndpointGroupsResponse":{ "type":"structure", "members":{ "nextToken":{ "shape":"PaginationToken", "documentation":"
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.
" } }, "documentation":"" }, "ListEphemeridesRequest":{ "type":"structure", "required":[ "startTime", "endTime" ], "members":{ "satelliteId":{ "shape":"Uuid", "documentation":"
The AWS Ground Station satellite ID to list ephemeris for.
" }, "ephemerisType":{ "shape":"EphemerisType", "documentation":"Filter ephemerides by type. If not specified, all ephemeris types will be returned.
" }, "startTime":{ "shape":"Timestamp", "documentation":"The start time for the list operation in UTC. Returns ephemerides with expiration times within your specified time range.
" }, "endTime":{ "shape":"Timestamp", "documentation":"The end time for the list operation in UTC. Returns ephemerides with expiration times within your specified time range.
" }, "statusList":{ "shape":"EphemerisStatusList", "documentation":"The list of ephemeris status to return.
" }, "maxResults":{ "shape":"PaginationMaxResults", "documentation":"Maximum number of ephemerides to return.
", "location":"querystring", "locationName":"maxResults" }, "nextToken":{ "shape":"PaginationToken", "documentation":"Pagination token.
", "location":"querystring", "locationName":"nextToken" } } }, "ListEphemeridesResponse":{ "type":"structure", "members":{ "nextToken":{ "shape":"PaginationToken", "documentation":"Pagination token.
" }, "ephemerides":{ "shape":"EphemeridesList", "documentation":"List of ephemerides.
" } } }, "ListGroundStationsRequest":{ "type":"structure", "members":{ "satelliteId":{ "shape":"Uuid", "documentation":"Satellite ID to retrieve on-boarded ground stations.
", "location":"querystring", "locationName":"satelliteId" }, "maxResults":{ "shape":"PaginationMaxResults", "documentation":"Maximum number of ground stations returned.
", "location":"querystring", "locationName":"maxResults" }, "nextToken":{ "shape":"PaginationToken", "documentation":"Next token that can be supplied in the next call to get the next page of ground stations.
", "location":"querystring", "locationName":"nextToken" } }, "documentation":"" }, "ListGroundStationsResponse":{ "type":"structure", "members":{ "nextToken":{ "shape":"PaginationToken", "documentation":"Next token that can be supplied in the next call to get the next page of ground stations.
" }, "groundStationList":{ "shape":"GroundStationList", "documentation":"List of ground stations.
" } }, "documentation":"" }, "ListMissionProfilesRequest":{ "type":"structure", "members":{ "maxResults":{ "shape":"PaginationMaxResults", "documentation":"Maximum number of mission profiles returned.
", "location":"querystring", "locationName":"maxResults" }, "nextToken":{ "shape":"PaginationToken", "documentation":"Next token returned in the request of a previous ListMissionProfiles call. Used to get the next page of results.
" }, "ListMissionProfilesResponse":{ "type":"structure", "members":{ "nextToken":{ "shape":"PaginationToken", "documentation":"
Next token returned in the response of a previous ListMissionProfiles call. Used to get the next page of results.
List of mission profiles.
" } }, "documentation":"" }, "ListSatellitesRequest":{ "type":"structure", "members":{ "maxResults":{ "shape":"PaginationMaxResults", "documentation":"
Maximum number of satellites returned.
", "location":"querystring", "locationName":"maxResults" }, "nextToken":{ "shape":"PaginationToken", "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":"PaginationToken", "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":"AnyArn", "documentation":"ARN of a resource.
", "location":"uri", "locationName":"resourceArn" } }, "documentation":"" }, "ListTagsForResourceResponse":{ "type":"structure", "members":{ "tags":{ "shape":"TagsMap", "documentation":"Tags assigned to a resource.
" } }, "documentation":"" }, "Long":{ "type":"long", "box":true }, "MissionProfileArn":{ "type":"string", "max":138, "min":89, "pattern":"arn:aws:groundstation:[-a-z0-9]{1,50}:[0-9]{12}:mission-profile/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}" }, "MissionProfileIdResponse":{ "type":"structure", "members":{ "missionProfileId":{ "shape":"Uuid", "documentation":"UUID of a mission profile.
" } }, "documentation":"" }, "MissionProfileList":{ "type":"list", "member":{"shape":"MissionProfileListItem"} }, "MissionProfileListItem":{ "type":"structure", "members":{ "missionProfileId":{ "shape":"Uuid", "documentation":"
UUID of a mission profile.
" }, "missionProfileArn":{ "shape":"MissionProfileArn", "documentation":"ARN of a mission profile.
" }, "region":{ "shape":"AWSRegion", "documentation":"Region of a mission profile.
" }, "name":{ "shape":"SafeName", "documentation":"Name of a mission profile.
" } }, "documentation":"Item in a list of mission profiles.
" }, "Month":{ "type":"integer", "box":true, "max":12, "min":1 }, "OEMEphemeris":{ "type":"structure", "members":{ "s3Object":{ "shape":"S3Object", "documentation":"The Amazon S3 object that contains the ephemeris data.
" }, "oemData":{ "shape":"UnboundedString", "documentation":"OEM data that you provide directly instead of using an Amazon S3 object.
" } }, "documentation":"Ephemeris data in Orbit Ephemeris Message (OEM) format.
AWS Ground Station processes OEM ephemerides according to the CCSDS standard with some extra restrictions. OEM files should be in KVN format. For more detail about the OEM format that AWS Ground Station supports, see OEM ephemeris format in the AWS Ground Station user guide.
" }, "PaginationMaxResults":{ "type":"integer", "box":true, "max":100, "min":1 }, "PaginationToken":{ "type":"string", "max":1000, "min":3, "pattern":"[A-Za-z0-9-/+_.=]+" }, "Polarization":{ "type":"string", "enum":[ "RIGHT_HAND", "LEFT_HAND", "NONE" ] }, "PositiveDurationInSeconds":{ "type":"integer", "box":true, "max":21600, "min":1 }, "ProgramTrackSettings":{ "type":"structure", "members":{ "azEl":{ "shape":"AzElProgramTrackSettings", "documentation":"Program track settings for AzElEphemeris.
" } }, "documentation":"Program track settings for an antenna during a contact.
", "union":true }, "RangedConnectionDetails":{ "type":"structure", "required":["socketAddress"], "members":{ "socketAddress":{ "shape":"RangedSocketAddress", "documentation":"A ranged socket address.
" }, "mtu":{ "shape":"RangedConnectionDetailsMtuInteger", "documentation":"Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.
" } }, "documentation":"Ingress address of AgentEndpoint with a port range and an optional mtu.
" }, "RangedConnectionDetailsMtuInteger":{ "type":"integer", "box":true, "max":1500, "min":1400 }, "RangedSocketAddress":{ "type":"structure", "required":[ "name", "portRange" ], "members":{ "name":{ "shape":"IpV4Address", "documentation":"IPv4 socket address.
" }, "portRange":{ "shape":"IntegerRange", "documentation":"Port range of a socket address.
" } }, "documentation":"A socket address with a port range.
" }, "RegisterAgentRequest":{ "type":"structure", "required":[ "discoveryData", "agentDetails" ], "members":{ "discoveryData":{ "shape":"DiscoveryData", "documentation":"Data for associating an agent with the capabilities it is managing.
" }, "agentDetails":{ "shape":"AgentDetails", "documentation":"Detailed information about the agent being registered.
" }, "tags":{ "shape":"TagsMap", "documentation":"Tags assigned to an Agent.
UUID of registered agent.
" } } }, "ReserveContactRequest":{ "type":"structure", "required":[ "missionProfileArn", "startTime", "endTime", "groundStation" ], "members":{ "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 in UTC.
" }, "endTime":{ "shape":"Timestamp", "documentation":"End time of a contact in UTC.
" }, "groundStation":{ "shape":"GroundStationName", "documentation":"Name of a ground station.
" }, "tags":{ "shape":"TagsMap", "documentation":"Tags assigned to a contact.
" }, "trackingOverrides":{ "shape":"TrackingOverrides", "documentation":"Tracking configuration overrides for the contact.
" } }, "documentation":"" }, "ResourceInUseException":{ "type":"structure", "members":{ "message":{"shape":"String"} }, "documentation":"
The specified resource is in use by non-terminal state contacts and cannot be modified or deleted.
", "error":{ "httpStatusCode":409, "senderFault":true }, "exception":true }, "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", "max":165, "min":30, "pattern":"arn:[a-z0-9-.]{1,63}:iam::[0-9]{12}:role/[\\w+=,.@-]{1,64}" }, "S3BucketName":{ "type":"string", "max":63, "min":3, "pattern":"[a-z0-9.-]{3,63}" }, "S3KeyPrefix":{ "type":"string", "max":900, "min":1, "pattern":"([a-zA-Z0-9_\\-=/]|\\{satellite_id\\}|\\{config\\-name}|\\{s3\\-config-id}|\\{year\\}|\\{month\\}|\\{day\\}){1,900}" }, "S3Object":{ "type":"structure", "members":{ "bucket":{ "shape":"S3BucketName", "documentation":"An Amazon S3 Bucket name.
" }, "key":{ "shape":"S3ObjectKey", "documentation":"An Amazon S3 key for the ephemeris.
" }, "version":{ "shape":"S3VersionId", "documentation":"For versioned Amazon S3 objects, the version to use for the ephemeris.
" } }, "documentation":"Object stored in Amazon S3 containing ephemeris data.
" }, "S3ObjectKey":{ "type":"string", "max":1024, "min":1, "pattern":"[a-zA-Z0-9!*'\\)\\(./_-]{1,1024}" }, "S3RecordingConfig":{ "type":"structure", "required":[ "bucketArn", "roleArn" ], "members":{ "bucketArn":{ "shape":"BucketArn", "documentation":"ARN of the bucket to record to.
" }, "roleArn":{ "shape":"RoleArn", "documentation":"ARN of the role Ground Station assumes to write data to the bucket.
" }, "prefix":{ "shape":"S3KeyPrefix", "documentation":"S3 Key prefix to prefice data files.
" } }, "documentation":"Information about an S3 recording Config.
ARN of the bucket used.
" }, "keyTemplate":{ "shape":"String", "documentation":"Key template used for the S3 Recording Configuration
" } }, "documentation":"Details about an S3 recording Config used in a contact.
UUID of a satellite.
" }, "satelliteArn":{ "shape":"satelliteArn", "documentation":"ARN of a satellite.
" }, "noradSatelliteID":{ "shape":"noradSatelliteID", "documentation":"NORAD satellite ID number.
" }, "groundStations":{ "shape":"GroundStationIdList", "documentation":"A list of ground stations to which the satellite is on-boarded.
" }, "currentEphemeris":{ "shape":"EphemerisMetaData", "documentation":"The current ephemeris being used to compute the trajectory of the satellite.
" } }, "documentation":"Item in a list of satellites.
" }, "SecurityDetails":{ "type":"structure", "required":[ "subnetIds", "securityGroupIds", "roleArn" ], "members":{ "subnetIds":{ "shape":"SubnetList", "documentation":"A list of subnets where AWS Ground Station places elastic network interfaces to send streams to your instances.
" }, "securityGroupIds":{ "shape":"SecurityGroupIdList", "documentation":"The security groups to attach to the elastic network interfaces.
" }, "roleArn":{ "shape":"RoleArn", "documentation":"ARN to a role needed for connecting streams to your instances.
" } }, "documentation":"Information about endpoints.
" }, "SecurityGroupIdList":{ "type":"list", "member":{"shape":"String"} }, "ServiceQuotaExceededException":{ "type":"structure", "members":{ "message":{"shape":"String"}, "parameterName":{ "shape":"String", "documentation":"Parameter name that caused the exception
" } }, "documentation":"Request would cause a service quota to be exceeded.
", "error":{ "httpStatusCode":402, "senderFault":true }, "exception":true }, "SignatureMap":{ "type":"map", "key":{"shape":"String"}, "value":{"shape":"Boolean"} }, "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":{ "configType":{ "shape":"ConfigCapabilityType", "documentation":"Type of a Config.
UUID of a Config.
Additional details for a Config, if type is dataflow-endpoint or antenna-downlink-demod-decode
Region of a dataflow source.
" } }, "documentation":"Dataflow details for the source side.
" }, "SpectrumConfig":{ "type":"structure", "required":[ "centerFrequency", "bandwidth" ], "members":{ "centerFrequency":{ "shape":"Frequency", "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.
First line of two-line element set (TLE) data.
" }, "tleLine2":{ "shape":"TleLineTwo", "documentation":"Second line of two-line element set (TLE) data.
" }, "validTimeRange":{ "shape":"TimeRange", "documentation":"The valid time range for the TLE. Time ranges must be continuous without gaps or overlaps.
" } }, "documentation":"Two-line element set (TLE) data.
" }, "TLEDataList":{ "type":"list", "member":{"shape":"TLEData"}, "max":500, "min":1 }, "TLEEphemeris":{ "type":"structure", "members":{ "s3Object":{ "shape":"S3Object", "documentation":"The Amazon S3 object that contains the ephemeris data.
" }, "tleData":{ "shape":"TLEDataList", "documentation":"TLE data that you provide directly instead of using an Amazon S3 object.
" } }, "documentation":"Two-line element set (TLE) ephemeris.
For more detail about providing Two-line element sets to AWS Ground Station, see the TLE section of the AWS Ground Station user guide.
" }, "TagKeys":{ "type":"list", "member":{"shape":"UnboundedString"}, "max":500, "min":0 }, "TagResourceRequest":{ "type":"structure", "required":[ "resourceArn", "tags" ], "members":{ "resourceArn":{ "shape":"AnyArn", "documentation":"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"} }, "TelemetrySinkConfig":{ "type":"structure", "required":[ "telemetrySinkType", "telemetrySinkData" ], "members":{ "telemetrySinkType":{ "shape":"TelemetrySinkType", "documentation":"The type of telemetry sink.
" }, "telemetrySinkData":{ "shape":"TelemetrySinkData", "documentation":"Information about the telemetry sink specified by the telemetrySinkType.
Information about a telemetry sink Config.
Information about a telemetry sink of type KINESIS_DATA_STREAM.
Information about a telemetry sink.
", "union":true }, "TelemetrySinkType":{ "type":"string", "enum":["KINESIS_DATA_STREAM"] }, "TimeAzEl":{ "type":"structure", "required":[ "dt", "az", "el" ], "members":{ "dt":{ "shape":"Double", "documentation":"Time offset in atomic seconds from the segment's reference epoch.
All dt values within a segment must be in ascending order with no duplicates.
dt values may be:
negative
expressed as fractions of a second
expressed in scientific notation
Azimuth angle at the specified time.
Valid ranges by unit:
DEGREE_ANGLE: -180 to 360 degrees, measured clockwise from true north
RADIAN: -π to 2π radians, measured clockwise from true north
Elevation angle at the specified time.
Valid ranges by unit:
DEGREE_ANGLE: -90 to 90 degrees, where 0 is the horizon, 90 is zenith, and negative values are below the horizon
RADIAN: -π/2 to π/2 radians, where 0 is the horizon, π/2 is zenith, and negative values are below the horizon
Time-tagged azimuth elevation pointing data.
Specifies the antenna pointing direction at a specific time offset from the segment's reference epoch.
" }, "TimeAzElList":{ "type":"list", "member":{"shape":"TimeAzEl"}, "min":5 }, "TimeRange":{ "type":"structure", "required":[ "startTime", "endTime" ], "members":{ "startTime":{ "shape":"Timestamp", "documentation":"Unix epoch timestamp in UTC at which the time range starts.
" }, "endTime":{ "shape":"Timestamp", "documentation":"Unix epoch timestamp in UTC at which the time range ends.
" } }, "documentation":"A time range with a start and end time.
" }, "Timestamp":{"type":"timestamp"}, "TleLineOne":{ "type":"string", "max":69, "min":69, "pattern":"1 [ 0-9]{5}[A-Z] [ 0-9]{5}[ A-Z]{3} [ 0-9]{5}[.][ 0-9]{8} (?:(?:[ 0+-][.][ 0-9]{8})|(?: [ +-][.][ 0-9]{7})) [ +-][ 0-9]{5}[+-][ 0-9] [ +-][ 0-9]{5}[+-][ 0-9] [ 0-9] [ 0-9]{4}[ 0-9]" }, "TleLineTwo":{ "type":"string", "max":69, "min":69, "pattern":"2 [ 0-9]{5} [ 0-9]{3}[.][ 0-9]{4} [ 0-9]{3}[.][ 0-9]{4} [ 0-9]{7} [ 0-9]{3}[.][ 0-9]{4} [ 0-9]{3}[.][ 0-9]{4} [ 0-9]{2}[.][ 0-9]{13}[ 0-9]" }, "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.
Program track settings to override for antenna tracking during the contact.
" } }, "documentation":"Overrides the default tracking configuration on an antenna during a contact.
" }, "UnboundedString":{ "type":"string", "min":1, "pattern":"[\\s\\S]+" }, "UntagResourceRequest":{ "type":"structure", "required":[ "resourceArn", "tagKeys" ], "members":{ "resourceArn":{ "shape":"AnyArn", "documentation":"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":"" }, "UpdateAgentStatusRequest":{ "type":"structure", "required":[ "agentId", "taskId", "aggregateStatus", "componentStatuses" ], "members":{ "agentId":{ "shape":"Uuid", "documentation":"UUID of agent to update.
", "location":"uri", "locationName":"agentId" }, "taskId":{ "shape":"Uuid", "documentation":"GUID of agent task.
" }, "aggregateStatus":{ "shape":"AggregateStatus", "documentation":"Aggregate status for agent.
" }, "componentStatuses":{ "shape":"ComponentStatusList", "documentation":"List of component statuses for agent.
" } } }, "UpdateAgentStatusResponse":{ "type":"structure", "required":["agentId"], "members":{ "agentId":{ "shape":"Uuid", "documentation":"UUID of updated agent.
" } } }, "UpdateConfigRequest":{ "type":"structure", "required":[ "configId", "name", "configType", "configData" ], "members":{ "configId":{ "shape":"Uuid", "documentation":"UUID of a Config.
Name of a Config.
Type of a Config.
Parameters of a Config.
" }, "UpdateEphemerisRequest":{ "type":"structure", "required":[ "ephemerisId", "enabled" ], "members":{ "ephemerisId":{ "shape":"Uuid", "documentation":"
The AWS Ground Station ephemeris ID.
", "location":"uri", "locationName":"ephemerisId" }, "enabled":{ "shape":"Boolean", "documentation":"Enable or disable the ephemeris. Changing this value doesn't require re-validation.
" }, "name":{ "shape":"SafeName", "documentation":"A name that you can use to identify the ephemeris.
" }, "priority":{ "shape":"EphemerisPriority", "documentation":"A priority score that determines which ephemeris to use when multiple ephemerides overlap.
Higher numbers take precedence. The default is 1. Must be 1 or greater.
" } } }, "UpdateMissionProfileRequest":{ "type":"structure", "required":["missionProfileId"], "members":{ "missionProfileId":{ "shape":"Uuid", "documentation":"UUID of a mission profile.
", "location":"uri", "locationName":"missionProfileId" }, "name":{ "shape":"SafeName", "documentation":"Name of a mission profile.
" }, "contactPrePassDurationSeconds":{ "shape":"DurationInSeconds", "documentation":"Amount of time after a contact ends that you’d like to receive a Ground Station Contact State Change event indicating the pass has finished.
" }, "contactPostPassDurationSeconds":{ "shape":"DurationInSeconds", "documentation":"Amount of time after a contact ends that you’d like to receive a Ground Station Contact State Change event indicating the pass has finished.
" }, "minimumViableContactDurationSeconds":{ "shape":"PositiveDurationInSeconds", "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":{ "shape":"DataflowEdgeList", "documentation":"A list of lists of ARNs. Each list of ARNs is an edge, with a from Config and a to Config.
ARN of a tracking Config.
ARN of a telemetry sink Config.
KMS key to use for encrypting streams.
" }, "streamsKmsRole":{ "shape":"RoleArn", "documentation":"Role to use for encrypting streams with KMS key.
" } }, "documentation":"" }, "UplinkAwsGroundStationAgentEndpoint":{ "type":"structure", "required":[ "name", "dataflowDetails" ], "members":{ "name":{ "shape":"SafeName", "documentation":"
Uplink dataflow endpoint name
" }, "dataflowDetails":{ "shape":"UplinkDataflowDetails", "documentation":"Dataflow details for the uplink endpoint
" } }, "documentation":"Definition for an uplink agent endpoint
" }, "UplinkAwsGroundStationAgentEndpointDetails":{ "type":"structure", "required":[ "name", "dataflowDetails" ], "members":{ "name":{ "shape":"SafeName", "documentation":"Uplink dataflow endpoint name
" }, "dataflowDetails":{ "shape":"UplinkDataflowDetails", "documentation":"Dataflow details for the uplink endpoint
" }, "agentStatus":{ "shape":"AgentStatus", "documentation":"Status of the agent associated with the uplink dataflow endpoint
" }, "auditResults":{ "shape":"AuditResults", "documentation":"Health audit results for the uplink dataflow endpoint
" } }, "documentation":"Details for an uplink agent endpoint
" }, "UplinkConnectionDetails":{ "type":"structure", "required":[ "ingressAddressAndPort", "agentIpAndPortAddress" ], "members":{ "ingressAddressAndPort":{"shape":"ConnectionDetails"}, "agentIpAndPortAddress":{"shape":"RangedConnectionDetails"} }, "documentation":"Connection details for customer to Agent and Agent to Ground Station
" }, "UplinkDataflowDetails":{ "type":"structure", "members":{ "agentConnectionDetails":{ "shape":"UplinkConnectionDetails", "documentation":"Uplink connection details for customer to Agent and Agent to Ground Station
" } }, "documentation":"Dataflow details for an uplink endpoint
", "union":true }, "UplinkEchoConfig":{ "type":"structure", "required":[ "enabled", "antennaUplinkConfigArn" ], "members":{ "enabled":{ "shape":"Boolean", "documentation":"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 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.
" }