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.
", "operations": { "CancelContact": "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": "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.
", "DeleteEphemeris": "Delete an ephemeris.
", "DeleteMissionProfile": "Deletes a mission profile.
", "DescribeContact": "Describes an existing contact.
", "DescribeContactVersion": "Describes a specific version of a contact.
", "DescribeEphemeris": "Retrieve information about an existing ephemeris.
", "GetAgentConfiguration": " For use by AWS Ground Station Agent and shouldn't be called directly.
Gets the latest configuration information for a registered agent.
", "GetAgentTaskResponseUrl": " For use by AWS Ground Station Agent and shouldn't be called directly.
Gets a presigned URL for uploading agent task response logs.
", "GetConfig": "Returns Config information.
Only one Config response can be returned.
Returns the dataflow endpoint group.
", "GetMinuteUsage": "Returns the number of reserved minutes used by account.
", "GetMissionProfile": "Returns a mission profile.
", "GetSatellite": "Returns a satellite.
", "ListAntennas": "Returns a list of antennas at a specified ground station.
", "ListConfigs": "Returns a list of Config objects.
Returns a list of versions for a specified contact.
", "ListContacts": "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.
", "ListGroundStationReservations": "Returns a list of reservations for a specified ground station.
", "ListGroundStations": "Returns a list of ground stations.
", "ListMissionProfiles": "Returns a list of mission profiles.
", "ListSatellites": "Returns a list of satellites.
", "ListTagsForResource": "Returns a list of tags for a specified resource.
", "RegisterAgent": " For use by AWS Ground Station Agent and shouldn't be called directly.
Registers a new agent with AWS Ground Station.
", "ReserveContact": "Reserves a contact using specified parameters.
", "TagResource": "Assigns a tag to a resource.
", "UntagResource": "Deassigns a resource tag.
", "UpdateAgentStatus": " For use by AWS Ground Station Agent and shouldn't be called directly.
Update the status of the agent.
", "UpdateConfig": "Updates the Config used when scheduling contacts.
Updating a Config will not update the execution parameters for existing future contacts scheduled with this Config.
Updates a specific contact.
", "UpdateEphemeris": "Update an existing ephemeris.
", "UpdateMissionProfile": "Updates a mission profile.
Updating a mission profile will not update the execution parameters for existing future contacts.
" }, "shapes": { "AWSRegion": { "base": null, "refs": { "AntennaListItem$region": "Region of the antenna.
", "GetMissionProfileResponse$region": "Region of a mission profile.
", "GroundStationData$region": "Ground station Region.
", "MissionProfileListItem$region": "Region of a mission profile.
" } }, "AgentCpuCoresList": { "base": null, "refs": { "AgentDetails$reservedCpuCores": "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.
", "AgentDetails$agentCpuCores": "List of CPU cores reserved for the agent.
" } }, "AgentDetails": { "base": "Detailed information about the agent.
", "refs": { "RegisterAgentRequest$agentDetails": "Detailed information about the agent being registered.
" } }, "AgentStatus": { "base": null, "refs": { "AggregateStatus$status": "Aggregate status.
", "AwsGroundStationAgentEndpoint$agentStatus": "The status of AgentEndpoint.
", "ComponentStatusData$status": "Component status.
", "DownlinkAwsGroundStationAgentEndpointDetails$agentStatus": "Status of the agent associated with the downlink dataflow endpoint
", "UplinkAwsGroundStationAgentEndpointDetails$agentStatus": "Status of the agent associated with the uplink dataflow endpoint
" } }, "AggregateStatus": { "base": "Aggregate status of Agent components.
", "refs": { "UpdateAgentStatusRequest$aggregateStatus": "Aggregate status for agent.
" } }, "AngleUnits": { "base": null, "refs": { "AzElSegments$angleUnit": "The unit of measure for azimuth and elevation angles. All angles in all segments must use the same unit.
", "Elevation$unit": "Elevation angle units.
" } }, "AntennaDemodDecodeDetails": { "base": "Details about an antenna demod decode Config used in a contact.
Details for antenna demod decode Config in a contact.
Information about how AWS Ground Station should configure an antenna for downlink during a contact.
", "refs": { "ConfigTypeData$antennaDownlinkConfig": "Information about how AWS Ground Station should configure an antenna for downlink during a contact.
" } }, "AntennaDownlinkDemodDecodeConfig": { "base": "Information about how AWS Ground Station should configure an antenna for downlink demod decode during a contact.
", "refs": { "ConfigTypeData$antennaDownlinkDemodDecodeConfig": "Information about how AWS Ground Station should configure an antenna for downlink demod decode during a contact.
" } }, "AntennaList": { "base": null, "refs": { "ListAntennasResponse$antennaList": "List of antennas.
" } }, "AntennaListItem": { "base": "An antenna at a ground station.
", "refs": { "AntennaList$member": null } }, "AntennaName": { "base": null, "refs": { "AntennaListItem$antennaName": "Name of the antenna.
", "GroundStationReservationListItem$antennaName": "Name of an antenna.
" } }, "AntennaUplinkConfig": { "base": "Information about the uplink Config of an antenna.
Information about how AWS Ground Station should configure an antenna for uplink during a contact.
" } }, "AnyArn": { "base": null, "refs": { "ListTagsForResourceRequest$resourceArn": "ARN of a resource.
", "TagResourceRequest$resourceArn": "ARN of a resource tag.
", "UntagResourceRequest$resourceArn": "ARN of a resource.
" } }, "AuditResults": { "base": null, "refs": { "AwsGroundStationAgentEndpoint$auditResults": "The results of the audit.
", "DownlinkAwsGroundStationAgentEndpointDetails$auditResults": "Health audit results for the downlink dataflow endpoint
", "UplinkAwsGroundStationAgentEndpointDetails$auditResults": "Health audit results for the uplink dataflow endpoint
" } }, "AwsGroundStationAgentEndpoint": { "base": "Information about AwsGroundStationAgentEndpoint.
", "refs": { "EndpointDetails$awsGroundStationAgentEndpoint": "An agent endpoint.
" } }, "AzElEphemeris": { "base": "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.
", "refs": { "EphemerisData$azEl": null } }, "AzElEphemerisFilter": { "base": "Filter for selecting contacts that use a specific AzElEphemeris.
", "refs": { "EphemerisFilter$azEl": "Filter for AzElEphemeris.
" } }, "AzElProgramTrackSettings": { "base": "Program track settings for AzElEphemeris.
", "refs": { "ProgramTrackSettings$azEl": "Program track settings for AzElEphemeris.
" } }, "AzElSegment": { "base": "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.
", "refs": { "AzElSegmentList$member": null } }, "AzElSegmentList": { "base": null, "refs": { "AzElSegments$azElSegmentList": "List of azimuth elevation segments.
Must contain between 1 and 100 segments. Segments must be in chronological order with no overlaps.
" } }, "AzElSegments": { "base": "Azimuth elevation segment collection.
Contains five or more time-ordered segments that define antenna pointing angles over the ephemeris validity period.
", "refs": { "AzElSegmentsData$azElData": "Azimuth elevation segment data provided directly in the request.
Use this option for smaller datasets or when Amazon S3 access is not available.
" } }, "AzElSegmentsData": { "base": "Container for azimuth elevation segment data.
Specify either AzElSegmentsData$s3Object to reference data in Amazon S3, or AzElSegmentsData$azElData to provide data inline.
", "refs": { "AzElEphemeris$data": "Azimuth elevation segment data.
You can provide data inline in the request or through an Amazon S3 object reference.
" } }, "BandwidthUnits": { "base": null, "refs": { "FrequencyBandwidth$units": "Frequency bandwidth units.
" } }, "Boolean": { "base": null, "refs": { "AntennaUplinkConfig$transmitDisabled": "Whether or not uplink transmit is disabled.
", "CreateEphemerisRequest$enabled": "Set to true to enable the ephemeris after validation. Set to false to keep it disabled.
Whether or not the ephemeris is enabled.
", "EphemerisItem$enabled": "Whether or not the ephemeris is enabled.
", "GetMinuteUsageResponse$isReservedMinutesCustomer": "Returns whether or not an account has signed up for the reserved minutes pricing plan, specific to the month being requested.
", "SignatureMap$value": null, "UpdateEphemerisRequest$enabled": "Enable or disable the ephemeris. Changing this value doesn't require re-validation.
", "UplinkEchoConfig$enabled": "Whether or not an uplink Config is enabled.
ARN of the bucket to record to.
", "S3RecordingDetails$bucketArn": "ARN of the bucket used.
" } }, "CancelContactRequest": { "base": "Input for the CancelContact operation.
Capability ARN of the component.
" } }, "CapabilityArnList": { "base": null, "refs": { "DiscoveryData$capabilityArns": "List of capabilities to associate with agent.
" } }, "CapabilityHealth": { "base": null, "refs": { "EndpointDetails$healthStatus": "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.
A client token is a unique, case-sensitive string of up to 64 ASCII characters. It is generated by the client to ensure idempotent operations, allowing safe retries without unintended side effects.
", "refs": { "UpdateContactRequest$clientToken": "A client token is a unique, case-sensitive string of up to 64 ASCII characters. It is generated by the client to ensure idempotent operations, allowing safe retries without unintended side effects.
" } }, "ComponentStatusData": { "base": "Data on the status of agent components.
", "refs": { "ComponentStatusList$member": null } }, "ComponentStatusList": { "base": null, "refs": { "UpdateAgentStatusRequest$componentStatuses": "List of component statuses for agent.
" } }, "ComponentTypeString": { "base": null, "refs": { "ComponentStatusData$componentType": "The Component type.
", "ComponentVersion$componentType": "Component type.
" } }, "ComponentVersion": { "base": "Version information for agent components.
", "refs": { "ComponentVersionList$member": null } }, "ComponentVersionList": { "base": null, "refs": { "AgentDetails$componentVersions": "List of versions being used by agent components.
" } }, "ConfigArn": { "base": null, "refs": { "ConfigIdResponse$configArn": "ARN of a Config.
ARN of a Config.
ARN of a tracking Config.
ARN of a telemetry sink Config.
ARN of a Config
ARN of a tracking Config.
ARN of a telemetry sink Config.
ARN of a tracking Config.
ARN of a telemetry sink Config.
ARN of an uplink Config.
Type of a Config.
Type of a Config.
Type of a Config.
Type of a Config.
Type of a Config.
Type of a Config.
Type of a Config.
Type of a Config.
Details for certain Config object types in a contact.
Additional details for a Config, if type is dataflow endpoint or antenna demod decode.
Additional details for a Config, if type is dataflow-endpoint or antenna-downlink-demod-decode
Response containing the ARN, ID, and type of a Config.
List of Config items.
An item in a list of Config objects.
Object containing the parameters of a Config.
See the subtype definitions for what each type of Config contains.
Parameters of a Config.
Data elements in a Config.
Parameters of a Config.
Egress address of AgentEndpoint with an optional mtu.
", "refs": { "AwsGroundStationAgentEndpoint$egressAddress": "The egress address of AgentEndpoint.
", "DownlinkConnectionDetails$egressAddressAndPort": null, "UplinkConnectionDetails$ingressAddressAndPort": null } }, "ContactData": { "base": "Data describing a contact.
", "refs": { "ContactList$member": null } }, "ContactIdResponse": { "base": "Response containing the ID of a contact.
", "refs": {} }, "ContactList": { "base": null, "refs": { "ListContactsResponse$contactList": "List of contacts.
" } }, "ContactReservationDetails": { "base": "Details of a contact reservation.
", "refs": { "ReservationDetails$contact": "Details of a contact reservation.
" } }, "ContactStatus": { "base": null, "refs": { "ContactData$contactStatus": "Status of a contact.
", "DescribeContactResponse$contactStatus": "Status of a contact.
", "DescribeContactVersionResponse$contactStatus": "Status of a contact.
", "StatusList$member": null } }, "ContactVersion": { "base": "Version information for a contact.
", "refs": { "ContactData$version": "Version information for a contact.
", "ContactVersionsList$member": null, "DescribeContactResponse$version": "Version information for a contact.
", "DescribeContactVersionResponse$version": "Version information for a contact.
" } }, "ContactVersionsList": { "base": null, "refs": { "ListContactVersionsResponse$contactVersionsList": "List of contact versions.
" } }, "CreateConfigRequest": { "base": "Input for the CreateConfig operation.
Input for the CreateDataflowEndpointGroup operation.
Endpoint definition used for creating a dataflow endpoint
", "refs": { "CreateEndpointDetailsList$member": null } }, "CreateEndpointDetailsList": { "base": null, "refs": { "CreateDataflowEndpointGroupV2Request$endpoints": "Dataflow endpoint group's endpoint definitions
" } }, "CreateEphemerisRequest": { "base": null, "refs": {} }, "CreateMissionProfileRequest": { "base": "Input for the CreateMissionProfile operation.
Current setting for autotrack.
" } }, "CustomerEphemerisPriority": { "base": null, "refs": { "CreateEphemerisRequest$priority": "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.
" } }, "DataflowDetail": { "base": "Information about a dataflow edge used in a contact.
", "refs": { "DataflowList$member": null } }, "DataflowEdge": { "base": null, "refs": { "DataflowEdgeList$member": null } }, "DataflowEdgeList": { "base": null, "refs": { "CreateMissionProfileRequest$dataflowEdges": "A list of lists of ARNs. Each list of ARNs is an edge, with a from Config and a to Config.
A list of lists of ARNs. Each list of ARNs is an edge, with a from Config and a to Config.
A list of lists of ARNs. Each list of ARNs is an edge, with a from Config and a to Config.
Information about a dataflow endpoint.
", "refs": { "EndpointDetails$endpoint": "A dataflow endpoint.
" } }, "DataflowEndpointConfig": { "base": "Information about the dataflow endpoint Config.
Information about the dataflow endpoint Config.
ARN of a dataflow endpoint group.
", "GetDataflowEndpointGroupResponse$dataflowEndpointGroupArn": "ARN of a dataflow endpoint group.
" } }, "DataflowEndpointGroupDurationInSeconds": { "base": null, "refs": { "CreateDataflowEndpointGroupRequest$contactPrePassDurationSeconds": " 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.
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.
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.
Response containing the ID of a dataflow endpoint group.
", "refs": {} }, "DataflowEndpointGroupList": { "base": null, "refs": { "ListDataflowEndpointGroupsResponse$dataflowEndpointGroupList": "A list of dataflow endpoint groups.
" } }, "DataflowEndpointListItem": { "base": "Item in a list of DataflowEndpoint groups.
Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.
" } }, "DataflowList": { "base": null, "refs": { "DescribeContactResponse$dataflowList": "List describing source and destination details for each dataflow edge.
", "DescribeContactVersionResponse$dataflowList": "List describing source and destination details for each dataflow edge.
" } }, "DecodeConfig": { "base": "Information about the decode Config.
Information about the decode Config.
Input for the DeleteConfig operation.
Input for the DeleteDataflowEndpointGroup operation.
Input for the DeleteMissionProfile operation.
Information about the demodulation Config.
Information about the demodulation Config.
Dependency encountered an error.
", "refs": {} }, "DescribeContactRequest": { "base": "Input for the DescribeContact operation.
Output for the DescribeContact operation.
Dataflow details for the destination side.
", "refs": { "DataflowDetail$destination": null } }, "DiscoveryData": { "base": "Data for agent discovery.
", "refs": { "RegisterAgentRequest$discoveryData": "Data for associating an agent with the capabilities it is managing.
" } }, "Double": { "base": null, "refs": { "Eirp$value": "Value of an EIRP. Valid values are between 20.0 to 50.0 dBW.
", "Elevation$value": "Elevation angle value.
", "Frequency$value": "Frequency value. Valid values are between 2200 to 2300 MHz and 7750 to 8400 MHz for downlink and 2025 to 2120 MHz for uplink.
", "FrequencyBandwidth$value": "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.
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
Definition for a downlink agent endpoint
", "refs": { "CreateEndpointDetails$downlinkAwsGroundStationAgentEndpoint": "Definition for a downlink agent endpoint
" } }, "DownlinkAwsGroundStationAgentEndpointDetails": { "base": "Details for a downlink agent endpoint
", "refs": { "EndpointDetails$downlinkAwsGroundStationAgentEndpoint": "Definition for a downlink agent endpoint
" } }, "DownlinkConnectionDetails": { "base": "Connection details for Ground Station to Agent and Agent to customer
", "refs": { "DownlinkDataflowDetails$agentConnectionDetails": "Downlink connection details for customer to Agent and Agent to Ground Station
" } }, "DownlinkDataflowDetails": { "base": "Dataflow details for a downlink endpoint
", "refs": { "DownlinkAwsGroundStationAgentEndpoint$dataflowDetails": "Dataflow details for the downlink endpoint
", "DownlinkAwsGroundStationAgentEndpointDetails$dataflowDetails": "Dataflow details for the downlink endpoint
" } }, "DurationInSeconds": { "base": null, "refs": { "CreateMissionProfileRequest$contactPrePassDurationSeconds": "Amount of time prior to contact start you'd like to receive a Ground Station Contact State Change event indicating an upcoming pass.
", "CreateMissionProfileRequest$contactPostPassDurationSeconds": "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.
", "GetMissionProfileResponse$contactPrePassDurationSeconds": "Amount of time prior to contact start you'd like to receive a CloudWatch event indicating an upcoming pass.
", "GetMissionProfileResponse$contactPostPassDurationSeconds": "Amount of time after a contact ends that you'd like to receive a CloudWatch event indicating the pass has finished.
", "UpdateMissionProfileRequest$contactPrePassDurationSeconds": "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.
", "UpdateMissionProfileRequest$contactPostPassDurationSeconds": "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.
" } }, "Eirp": { "base": "Object that represents EIRP.
", "refs": { "AntennaUplinkConfig$targetEirp": "EIRP of the target.
" } }, "EirpUnits": { "base": null, "refs": { "Eirp$units": "Units of an EIRP.
" } }, "Elevation": { "base": "Elevation angle of the satellite in the sky during a contact.
", "refs": { "ContactData$maximumElevation": "Maximum elevation angle of a contact.
", "DescribeContactResponse$maximumElevation": "Maximum elevation angle of a contact.
", "DescribeContactVersionResponse$maximumElevation": "Maximum elevation angle of a contact.
" } }, "EndpointDetails": { "base": "Information about the endpoint details.
", "refs": { "ConfigDetails$endpointDetails": null, "EndpointDetailsList$member": null } }, "EndpointDetailsList": { "base": null, "refs": { "CreateDataflowEndpointGroupRequest$endpointDetails": "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.
", "GetDataflowEndpointGroupResponse$endpointsDetails": "Details of a dataflow endpoint.
" } }, "EndpointStatus": { "base": null, "refs": { "DataflowEndpoint$status": "Status of a dataflow endpoint.
" } }, "EphemeridesList": { "base": null, "refs": { "ListEphemeridesResponse$ephemerides": "List of ephemerides.
" } }, "EphemerisData": { "base": "Ephemeris data.
", "refs": { "CreateEphemerisRequest$ephemeris": "Ephemeris data.
" } }, "EphemerisDescription": { "base": "Description of ephemeris.
", "refs": { "EphemerisTypeDescription$tle": null, "EphemerisTypeDescription$oem": null, "EphemerisTypeDescription$azEl": null } }, "EphemerisErrorCode": { "base": null, "refs": { "EphemerisErrorReason$errorCode": "The error code identifying the type of validation failure.
See the Troubleshooting Invalid Ephemerides guide for error code details.
" } }, "EphemerisErrorReason": { "base": "Detailed error information for ephemeris validation failures.
Provides an error code and descriptive message to help diagnose and resolve validation issues.
", "refs": { "EphemerisErrorReasonList$member": null } }, "EphemerisErrorReasonList": { "base": null, "refs": { "DescribeEphemerisResponse$errorReasons": "Detailed error information for ephemerides with INVALID status.
Provides specific error codes and messages to help diagnose validation failures.
" } }, "EphemerisFilter": { "base": "Filter for selecting contacts that use a specific ephemeris\".
", "refs": { "ListContactsRequest$ephemeris": "Filter for selecting contacts that use a specific ephemeris\".
" } }, "EphemerisIdResponse": { "base": null, "refs": {} }, "EphemerisInvalidReason": { "base": null, "refs": { "DescribeEphemerisResponse$invalidReason": "Reason that an ephemeris failed validation. Appears only when the status is INVALID.
Ephemeris item.
", "refs": { "EphemeridesList$member": null } }, "EphemerisMetaData": { "base": "Metadata describing a particular ephemeris.
", "refs": { "GetSatelliteResponse$currentEphemeris": "The current ephemeris being used to compute the trajectory of the satellite.
", "SatelliteListItem$currentEphemeris": "The current ephemeris being used to compute the trajectory of the satellite.
" } }, "EphemerisPriority": { "base": null, "refs": { "DescribeEphemerisResponse$priority": "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.
", "EphemerisItem$priority": "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.
", "UpdateEphemerisRequest$priority": "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.
" } }, "EphemerisResponseData": { "base": "Ephemeris data for a contact.
", "refs": { "ContactData$ephemeris": "The ephemeris that determines antenna pointing for the contact.
", "DescribeContactResponse$ephemeris": "The ephemeris that determines antenna pointing directions for the contact.
", "DescribeContactVersionResponse$ephemeris": "The ephemeris that determines antenna pointing directions for the contact.
" } }, "EphemerisSource": { "base": null, "refs": { "EphemerisMetaData$source": "The EphemerisSource that generated a given ephemeris.
The status of the ephemeris.
", "EphemerisItem$status": "The status of the ephemeris.
", "EphemerisStatusList$member": null } }, "EphemerisStatusList": { "base": null, "refs": { "ListEphemeridesRequest$statusList": "The list of ephemeris status to return.
" } }, "EphemerisType": { "base": null, "refs": { "EphemerisItem$ephemerisType": "The type of ephemeris.
", "EphemerisResponseData$ephemerisType": "Type of ephemeris.
", "ListEphemeridesRequest$ephemerisType": "Filter ephemerides by type. If not specified, all ephemeris types will be returned.
" } }, "EphemerisTypeDescription": { "base": "", "refs": { "DescribeEphemerisResponse$suppliedData": "Supplied ephemeris data.
" } }, "ErrorString": { "base": null, "refs": { "EphemerisErrorReason$errorMessage": "A human-readable message describing the validation failure.
Provides specific details about what failed and may include suggestions for remediation.
" } }, "Frequency": { "base": "Object that describes the frequency.
", "refs": { "SpectrumConfig$centerFrequency": "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.
Center frequency of an uplink spectral Config. Valid values are between 2025 to 2120 MHz.
Object that describes the frequency bandwidth.
", "refs": { "SpectrumConfig$bandwidth": "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.
Frequency units.
" } }, "GetAgentConfigurationRequest": { "base": null, "refs": {} }, "GetAgentConfigurationResponse": { "base": null, "refs": {} }, "GetAgentTaskResponseUrlRequest": { "base": null, "refs": {} }, "GetAgentTaskResponseUrlResponse": { "base": null, "refs": {} }, "GetConfigRequest": { "base": "Input for the GetConfig operation.
Output for the GetConfig operation.
Input for the GetDataflowEndpointGroup operation.
Output for the GetDataflowEndpointGroup operation.
Input for the GetMinuteUsage operation.
Output for the GetMinuteUsage operation.
Input for the GetMissionProfile operation.
Output for the GetMissionProfile operation.
Input for the GetSatellite operation.
Output for the GetSatellite operation.
Information about the ground station data.
", "refs": { "GroundStationList$member": null } }, "GroundStationIdList": { "base": null, "refs": { "GetSatelliteResponse$groundStations": "A list of ground stations to which the satellite is on-boarded.
", "SatelliteListItem$groundStations": "A list of ground stations to which the satellite is on-boarded.
" } }, "GroundStationList": { "base": null, "refs": { "ListGroundStationsResponse$groundStationList": "List of ground stations.
" } }, "GroundStationName": { "base": null, "refs": { "AntennaListItem$groundStationName": "Name of the ground station the antenna is associated with.
", "AzElEphemeris$groundStation": "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.
", "GroundStationData$groundStationId": "ID of a ground station.
", "GroundStationData$groundStationName": "Name of a ground station.
", "GroundStationIdList$member": null, "GroundStationReservationListItem$groundStationId": "ID of a ground station.
", "ListAntennasRequest$groundStationId": "ID of a ground station.
", "ListContactsRequest$groundStation": "Name of a ground station.
", "ListGroundStationReservationsRequest$groundStationId": "ID of a ground station.
", "ReserveContactRequest$groundStation": "Name of a ground station.
" } }, "GroundStationReservationList": { "base": null, "refs": { "ListGroundStationReservationsResponse$reservationList": "List of ground station reservations.
" } }, "GroundStationReservationListItem": { "base": "Item in a list of ground station reservations.
", "refs": { "GroundStationReservationList$member": null } }, "ISO8601TimeRange": { "base": "Time range specified using ISO 8601 format timestamps.
", "refs": { "AzElSegment$validTimeRange": "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.
" } }, "InstanceId": { "base": null, "refs": { "AgentDetails$instanceId": "ID of EC2 instance agent is running on.
" } }, "InstanceType": { "base": null, "refs": { "AgentDetails$instanceType": "Type of EC2 instance agent is running on.
" } }, "Integer": { "base": null, "refs": { "AgentCpuCoresList$member": null, "ConnectionDetails$mtu": "Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.
", "GetMinuteUsageResponse$totalReservedMinuteAllocation": "Total number of reserved minutes allocated, specific to the month being requested.
", "GetMinuteUsageResponse$upcomingMinutesScheduled": "Upcoming minutes scheduled for an account, specific to the month being requested.
", "GetMinuteUsageResponse$totalScheduledMinutes": "Total scheduled minutes for an account, specific to the month being requested.
", "GetMinuteUsageResponse$estimatedMinutesRemaining": "Estimated number of minutes remaining for an account, specific to the month being requested.
", "IntegerRange$minimum": "A minimum value.
", "IntegerRange$maximum": "A maximum value.
", "SocketAddress$port": "Port of a socket address.
" } }, "IntegerRange": { "base": "An integer range that has a minimum and maximum value.
", "refs": { "RangedSocketAddress$portRange": "Port range of a socket address.
" } }, "InvalidParameterException": { "base": "One or more parameters are not valid.
", "refs": {} }, "IpAddressList": { "base": null, "refs": { "DiscoveryData$publicIpAddresses": "List of public IP addresses to associate with agent.
", "DiscoveryData$privateIpAddresses": "List of private IP addresses to associate with agent.
" } }, "IpV4Address": { "base": null, "refs": { "IpAddressList$member": null, "RangedSocketAddress$name": "IPv4 socket address.
" } }, "JsonString": { "base": null, "refs": { "DecodeConfig$unvalidatedJSON": "Unvalidated JSON of a decode Config.
Unvalidated JSON of a demodulation Config.
KMS Alias Arn.
" } }, "KeyAliasName": { "base": null, "refs": { "KmsKey$kmsAliasName": "KMS Alias Name.
" } }, "KeyArn": { "base": null, "refs": { "CreateEphemerisRequest$kmsKeyArn": "The ARN of the KMS key to use for encrypting the ephemeris.
", "KmsKey$kmsKeyArn": "KMS Key Arn.
" } }, "KinesisDataStreamArn": { "base": null, "refs": { "KinesisDataStreamData$kinesisDataStreamArn": "ARN of the Kinesis Data Stream to deliver telemetry to.
" } }, "KinesisDataStreamData": { "base": "Information for telemetry delivery to Kinesis Data Streams.
", "refs": { "TelemetrySinkData$kinesisDataStreamData": "Information about a telemetry sink of type KINESIS_DATA_STREAM.
KMS key info.
", "refs": { "CreateMissionProfileRequest$streamsKmsKey": "KMS key to use for encrypting streams.
", "GetMissionProfileResponse$streamsKmsKey": "KMS key to use for encrypting streams.
", "UpdateMissionProfileRequest$streamsKmsKey": "KMS key to use for encrypting streams.
" } }, "ListAntennasRequest": { "base": null, "refs": {} }, "ListAntennasResponse": { "base": null, "refs": {} }, "ListConfigsRequest": { "base": "Input for the ListConfigs operation.
Output for the ListConfigs operation.
Input for the ListContacts operation.
Output for the ListContacts operation.
Input for the ListDataflowEndpointGroups operation.
Output for the ListDataflowEndpointGroups operation.
Input for the ListGroundStations operation.
Output for the ListGroundStations operation.
Input for the ListMissionProfiles operation.
Output for the ListMissionProfiles operation.
Input for the ListSatellites operation.
Output for the ListSatellites operation.
Input for the ListTagsForResource operation.
Output for the ListTagsForResource operation.
Bytes sent by the component.
", "ComponentStatusData$bytesReceived": "Bytes received by the component.
", "ComponentStatusData$packetsDropped": "Packets dropped by component.
" } }, "MaintenanceReservationDetails": { "base": "Details of a maintenance reservation.
", "refs": { "ReservationDetails$maintenance": "Details of a maintenance reservation.
" } }, "MaintenanceType": { "base": null, "refs": { "MaintenanceReservationDetails$maintenanceType": "Type of maintenance.
" } }, "MissionProfileArn": { "base": null, "refs": { "ContactData$missionProfileArn": "ARN of a mission profile.
", "DescribeContactResponse$missionProfileArn": "ARN of a mission profile.
", "DescribeContactVersionResponse$missionProfileArn": "ARN of the contact's mission profile.
", "GetMissionProfileResponse$missionProfileArn": "ARN of a mission profile.
", "ListContactsRequest$missionProfileArn": "ARN of a mission profile.
", "MissionProfileListItem$missionProfileArn": "ARN of a mission profile.
", "ReserveContactRequest$missionProfileArn": "ARN of a mission profile.
" } }, "MissionProfileIdResponse": { "base": "Response containing the ID of a mission profile.
", "refs": {} }, "MissionProfileList": { "base": null, "refs": { "ListMissionProfilesResponse$missionProfileList": "List of mission profiles.
" } }, "MissionProfileListItem": { "base": "Item in a list of mission profiles.
", "refs": { "MissionProfileList$member": null } }, "Month": { "base": null, "refs": { "GetMinuteUsageRequest$month": "The month being requested, with a value of 1-12.
" } }, "OEMEphemeris": { "base": "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.
", "refs": { "EphemerisData$oem": null } }, "OemProgramTrackSettings": { "base": "Program track settings for OEMEphemeris.
", "refs": { "ProgramTrackSettings$oem": "Program track settings for OEMEphemeris.
" } }, "PaginationMaxResults": { "base": null, "refs": { "ListAntennasRequest$maxResults": "Maximum number of antennas returned.
", "ListConfigsRequest$maxResults": "Maximum number of Configs returned.
Maximum number of contact versions returned.
", "ListContactsRequest$maxResults": "Maximum number of contacts returned.
", "ListDataflowEndpointGroupsRequest$maxResults": "Maximum number of dataflow endpoint groups returned.
", "ListEphemeridesRequest$maxResults": "Maximum number of ephemerides to return.
", "ListGroundStationReservationsRequest$maxResults": "Maximum number of ground station reservations returned.
", "ListGroundStationsRequest$maxResults": "Maximum number of ground stations returned.
", "ListMissionProfilesRequest$maxResults": "Maximum number of mission profiles returned.
", "ListSatellitesRequest$maxResults": "Maximum number of satellites returned.
" } }, "PaginationToken": { "base": null, "refs": { "ListAntennasRequest$nextToken": "Next token returned in the request of a previous ListAntennas call. Used to get the next page of results.
Next token to be used in a subsequent ListAntennas call to retrieve the next page of results.
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.
Next token returned in the request of a previous ListContactVersions call. Used to get the next page of results.
Next token to be used in a subsequent ListContactVersions call to retrieve the next page of results.
Next token returned in the request of a previous ListContacts call. Used to get the next page of results.
Next token returned in the response of a previous ListContacts call. Used to get the next page of results.
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.
Pagination token.
", "ListEphemeridesResponse$nextToken": "Pagination token.
", "ListGroundStationReservationsRequest$nextToken": "Next token returned in the request of a previous ListGroundStationReservations call. Used to get the next page of results.
Next token to be used in a subsequent ListGroundStationReservations call to retrieve the next page of results.
Next token that can be supplied in the next call to get the next page of ground stations.
", "ListGroundStationsResponse$nextToken": "Next token that can be supplied in the next call to get the next page of ground stations.
", "ListMissionProfilesRequest$nextToken": "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.
Next token that can be supplied in the next call to get the next page of satellites.
", "ListSatellitesResponse$nextToken": "Next token that can be supplied in the next call to get the next page of satellites.
" } }, "Polarization": { "base": null, "refs": { "SpectrumConfig$polarization": "Polarization of a spectral Config. Capturing both \"RIGHT_HAND\" and \"LEFT_HAND\" polarization requires two separate configs.
Polarization of an uplink spectral Config. Capturing both \"RIGHT_HAND\" and \"LEFT_HAND\" polarization requires two separate configs.
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.
", "GetMissionProfileResponse$minimumViableContactDurationSeconds": "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.
", "UpdateMissionProfileRequest$minimumViableContactDurationSeconds": "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.
" } }, "ProgramTrackSettings": { "base": "Program track settings for an antenna during a contact.
", "refs": { "TrackingOverrides$programTrackSettings": "Program track settings to override for antenna tracking during the contact.
" } }, "RangedConnectionDetails": { "base": "Ingress address of AgentEndpoint with a port range and an optional mtu.
", "refs": { "AwsGroundStationAgentEndpoint$ingressAddress": "The ingress address of AgentEndpoint.
", "DownlinkConnectionDetails$agentIpAndPortAddress": null, "UplinkConnectionDetails$agentIpAndPortAddress": null } }, "RangedConnectionDetailsMtuInteger": { "base": null, "refs": { "RangedConnectionDetails$mtu": "Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.
" } }, "RangedSocketAddress": { "base": "A socket address with a port range.
", "refs": { "RangedConnectionDetails$socketAddress": "A ranged socket address.
" } }, "RegisterAgentRequest": { "base": null, "refs": {} }, "RegisterAgentResponse": { "base": null, "refs": {} }, "ReservationDetails": { "base": "Details of a ground station reservation.
", "refs": { "GroundStationReservationListItem$reservationDetails": "Details of a ground station reservation.
" } }, "ReservationType": { "base": null, "refs": { "GroundStationReservationListItem$reservationType": "Type of a ground station reservation.
", "ReservationTypeFilterList$member": null } }, "ReservationTypeFilterList": { "base": null, "refs": { "ListGroundStationReservationsRequest$reservationTypes": "Types of reservations to filter by.
" } }, "ReserveContactRequest": { "base": "Input for the ReserveContact operation.
The specified resource is in use by non-terminal state contacts and cannot be modified or deleted.
", "refs": {} }, "ResourceLimitExceededException": { "base": "Account limits for this resource have been exceeded.
", "refs": {} }, "ResourceNotFoundException": { "base": "Resource was not found.
", "refs": {} }, "RoleArn": { "base": null, "refs": { "CreateMissionProfileRequest$streamsKmsRole": "Role to use for encrypting streams with KMS key.
", "GetMissionProfileResponse$streamsKmsRole": "Role to use for encrypting streams with KMS key.
", "KinesisDataStreamData$kinesisRoleArn": "ARN of the IAM Role used by AWS Ground Station to deliver telemetry.
", "S3RecordingConfig$roleArn": "ARN of the role Ground Station assumes to write data to the bucket.
", "SecurityDetails$roleArn": "ARN to a role needed for connecting streams to your instances.
", "UpdateMissionProfileRequest$streamsKmsRole": "Role to use for encrypting streams with KMS key.
" } }, "S3BucketName": { "base": null, "refs": { "S3Object$bucket": "An Amazon S3 Bucket name.
" } }, "S3KeyPrefix": { "base": null, "refs": { "S3RecordingConfig$prefix": "S3 Key prefix to prefice data files.
" } }, "S3Object": { "base": "Object stored in Amazon S3 containing ephemeris data.
", "refs": { "AzElSegmentsData$s3Object": "The Amazon S3 object containing azimuth elevation segment data.
The Amazon S3 object must contain JSON-formatted azimuth elevation data matching the AzElSegments structure.
", "EphemerisDescription$sourceS3Object": "Source Amazon S3 object used for the ephemeris.
", "EphemerisItem$sourceS3Object": "Source Amazon S3 object used for the ephemeris.
", "OEMEphemeris$s3Object": "The Amazon S3 object that contains the ephemeris data.
", "TLEEphemeris$s3Object": "The Amazon S3 object that contains the ephemeris data.
" } }, "S3ObjectKey": { "base": null, "refs": { "S3Object$key": "An Amazon S3 key for the ephemeris.
" } }, "S3RecordingConfig": { "base": "Information about an S3 recording Config.
Information about an S3 recording Config.
Details about an S3 recording Config used in a contact.
Details for an S3 recording Config in a contact.
For versioned Amazon S3 objects, the version to use for the ephemeris.
" } }, "SafeName": { "base": null, "refs": { "AwsGroundStationAgentEndpoint$name": "Name string associated with AgentEndpoint. Used as a human-readable identifier for AgentEndpoint.
", "CreateConfigRequest$name": "Name of a Config.
A name that you can use to identify the ephemeris.
", "CreateMissionProfileRequest$name": "Name of a mission profile.
", "DataflowEndpoint$name": "Name of a dataflow endpoint.
", "DescribeEphemerisResponse$name": "A name that you can use to identify the ephemeris.
", "DownlinkAwsGroundStationAgentEndpoint$name": "Downlink dataflow endpoint name
", "DownlinkAwsGroundStationAgentEndpointDetails$name": "Downlink dataflow endpoint name
", "EphemerisItem$name": "A name that you can use to identify the ephemeris.
", "EphemerisMetaData$name": "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.
", "GetMissionProfileResponse$name": "Name of a mission profile.
", "MissionProfileListItem$name": "Name of a mission profile.
", "UpdateConfigRequest$name": "Name of a Config.
A name that you can use to identify the ephemeris.
", "UpdateMissionProfileRequest$name": "Name of a mission profile.
", "UplinkAwsGroundStationAgentEndpoint$name": "Uplink dataflow endpoint name
", "UplinkAwsGroundStationAgentEndpointDetails$name": "Uplink dataflow endpoint name
" } }, "SatelliteList": { "base": null, "refs": { "ListSatellitesResponse$satellites": "List of satellites.
" } }, "SatelliteListItem": { "base": "Item in a list of satellites.
", "refs": { "SatelliteList$member": null } }, "SecurityDetails": { "base": "Information about endpoints.
", "refs": { "EndpointDetails$securityDetails": "Endpoint security details including a list of subnets, a list of security groups and a role to connect streams to instances.
" } }, "SecurityGroupIdList": { "base": null, "refs": { "SecurityDetails$securityGroupIds": "The security groups to attach to the elastic network interfaces.
" } }, "ServiceQuotaExceededException": { "base": "Request would cause a service quota to be exceeded.
", "refs": {} }, "SignatureMap": { "base": null, "refs": { "AggregateStatus$signatureMap": "Sparse map of failure signatures.
" } }, "SocketAddress": { "base": "Information about the socket address.
", "refs": { "ConnectionDetails$socketAddress": "A socket address.
", "DataflowEndpoint$address": "Socket address of a dataflow endpoint.
" } }, "Source": { "base": "Dataflow details for the source side.
", "refs": { "DataflowDetail$source": null } }, "SpectrumConfig": { "base": "Object that describes a spectral Config.
Object that describes a spectral Config.
Information about the spectral Config.
Status of a contact reservation.
" } }, "String": { "base": null, "refs": { "AntennaDemodDecodeDetails$outputNode": "Name of an antenna demod decode output node used in a contact.
", "ConfigIdResponse$configId": "UUID of a Config.
UUID of a Config.
Name of a Config.
Name of a ground station.
", "ContactData$errorMessage": "Error message of a contact.
", "ContactData$region": "Region of a contact.
", "ContactVersion$failureMessage": "Failure message for the contact version.
", "DataflowDetail$errorMessage": "Error message for a dataflow.
", "DataflowEndpointConfig$dataflowEndpointName": "Name of a dataflow endpoint.
", "DataflowEndpointConfig$dataflowEndpointRegion": "Region of a dataflow endpoint.
", "DependencyException$message": null, "DependencyException$parameterName": "Name of the parameter that caused the exception.
", "DescribeContactResponse$groundStation": "Ground station for a contact.
", "DescribeContactResponse$errorMessage": "Error message for a contact.
", "DescribeContactResponse$region": "Region where the ReserveContact API was called to schedule this contact.
Ground station for a contact.
", "DescribeContactVersionResponse$errorMessage": "Error message for a contact.
", "DescribeContactVersionResponse$region": "Region where the ReserveContact API was called to schedule this contact.
Region of a dataflow destination.
", "GetAgentConfigurationResponse$taskingDocument": "Tasking document for agent.
", "GetAgentTaskResponseUrlResponse$presignedLogUrl": "Presigned URL for uploading agent task response logs.
", "GetConfigResponse$configId": "UUID of a Config.
Name of a Config.
Name of the invalid parameter.
", "ResourceInUseException$message": null, "ResourceLimitExceededException$message": null, "ResourceLimitExceededException$parameterName": "Name of the parameter that exceeded the resource limit.
", "ResourceNotFoundException$message": null, "S3RecordingDetails$keyTemplate": "Key template used for the S3 Recording Configuration
", "SecurityGroupIdList$member": null, "ServiceQuotaExceededException$message": null, "ServiceQuotaExceededException$parameterName": "Parameter name that caused the exception
", "SignatureMap$key": null, "SocketAddress$name": "Name of a socket address.
", "Source$configId": "UUID of a Config.
Region of a dataflow source.
", "SubnetList$member": null, "TagsMap$key": null, "TagsMap$value": null } }, "SubnetList": { "base": null, "refs": { "SecurityDetails$subnetIds": "A list of subnets where AWS Ground Station places elastic network interfaces to send streams to your instances.
" } }, "SyntheticTimestamp_date_time": { "base": null, "refs": { "AzElSegment$referenceEpoch": "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
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
Start time of the reservation window in UTC.
", "ListGroundStationReservationsRequest$endTime": "End time of the reservation window in UTC.
" } }, "TLEData": { "base": "Two-line element set (TLE) data.
", "refs": { "TLEDataList$member": null } }, "TLEDataList": { "base": null, "refs": { "TLEEphemeris$tleData": "TLE data that you provide directly instead of using an Amazon S3 object.
" } }, "TLEEphemeris": { "base": "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.
", "refs": { "EphemerisData$tle": null } }, "TagKeys": { "base": null, "refs": { "UntagResourceRequest$tagKeys": "Keys of a resource tag.
" } }, "TagResourceRequest": { "base": "Input for the TagResource operation.
Output for the TagResource operation.
Tags assigned to a contact.
", "CreateConfigRequest$tags": "Tags assigned to a Config.
Tags of a dataflow endpoint group.
", "CreateDataflowEndpointGroupV2Request$tags": "Tags of a V2 dataflow endpoint group.
", "CreateEphemerisRequest$tags": "Tags assigned to an ephemeris.
", "CreateMissionProfileRequest$tags": "Tags assigned to a mission profile.
", "DescribeContactResponse$tags": "Tags assigned to a contact.
", "DescribeContactVersionResponse$tags": "Tags assigned to a contact.
", "DescribeEphemerisResponse$tags": "Tags assigned to an ephemeris.
", "GetConfigResponse$tags": "Tags assigned to a Config.
Tags assigned to a dataflow endpoint group.
", "GetMissionProfileResponse$tags": "Tags assigned to a mission profile.
", "ListTagsForResourceResponse$tags": "Tags assigned to a resource.
", "RegisterAgentRequest$tags": "Tags assigned to an Agent.
Tags assigned to a contact.
", "TagResourceRequest$tags": "Tags assigned to a resource.
" } }, "TelemetrySinkConfig": { "base": "Information about a telemetry sink Config.
Information about a telemetry sink Config.
Information about a telemetry sink.
", "refs": { "TelemetrySinkConfig$telemetrySinkData": "Information about the telemetry sink specified by the telemetrySinkType.
The type of telemetry sink.
" } }, "TimeAzEl": { "base": "Time-tagged azimuth elevation pointing data.
Specifies the antenna pointing direction at a specific time offset from the segment's reference epoch.
", "refs": { "TimeAzElList$member": null } }, "TimeAzElList": { "base": null, "refs": { "AzElSegment$azElList": "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.
" } }, "TimeRange": { "base": "A time range with a start and end time.
", "refs": { "TLEData$validTimeRange": "The valid time range for the TLE. Time ranges must be continuous without gaps or overlaps.
" } }, "Timestamp": { "base": null, "refs": { "ContactData$startTime": "Start time of a contact in UTC.
", "ContactData$endTime": "End time of a contact in UTC.
", "ContactData$prePassStartTime": "Start time in UTC of the pre-pass period, at which you receive a CloudWatch event indicating an upcoming pass.
", "ContactData$postPassEndTime": "End time in UTC of the post-pass period, at which you receive a CloudWatch event indicating the pass has finished.
", "ContactData$visibilityStartTime": " 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.
Time the contact version was created in UTC.
", "ContactVersion$activated": "Time the contact version was activated in UTC. A version is activated when it becomes the current active version of the contact.
", "ContactVersion$superseded": "Time the contact version was superseded in UTC. A version is superseded when a newer version becomes active.
", "ContactVersion$lastUpdated": "Time the contact version was last updated in UTC.
", "CreateEphemerisRequest$expirationTime": "An overall expiration time for the ephemeris in UTC, after which it will become EXPIRED.
Start time of a contact in UTC.
", "DescribeContactResponse$endTime": "End time of a contact in UTC.
", "DescribeContactResponse$prePassStartTime": "Start time in UTC of the pre-pass period, at which you receive a CloudWatch event indicating an upcoming pass.
", "DescribeContactResponse$postPassEndTime": "End time in UTC of the post-pass period, at which you receive a CloudWatch event indicating the pass has finished.
", "DescribeContactResponse$visibilityStartTime": "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.
", "DescribeContactResponse$visibilityEndTime": "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.
", "DescribeContactVersionResponse$startTime": "Start time of a contact in UTC.
", "DescribeContactVersionResponse$endTime": "End time of a contact in UTC.
", "DescribeContactVersionResponse$prePassStartTime": "Start time in UTC of the pre-pass period, at which you receive a CloudWatch event indicating an upcoming pass.
", "DescribeContactVersionResponse$postPassEndTime": "End time in UTC of the post-pass period, at which you receive a CloudWatch event indicating the pass has finished.
", "DescribeContactVersionResponse$visibilityStartTime": "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.
", "DescribeContactVersionResponse$visibilityEndTime": "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.
", "DescribeEphemerisResponse$creationTime": "The time the ephemeris was uploaded in UTC.
", "EphemerisItem$creationTime": "The time the ephemeris was uploaded in UTC.
", "EphemerisMetaData$epoch": "The epoch of a default, ephemeris from Space Track in UTC.
This field is not populated for customer-provided ephemerides.
", "GroundStationReservationListItem$startTime": "Start time of a ground station reservation in UTC.
", "GroundStationReservationListItem$endTime": "End time of a ground station reservation in UTC.
", "ListContactsRequest$startTime": "Start time of a contact in UTC.
", "ListContactsRequest$endTime": "End time of a contact in UTC.
", "ListEphemeridesRequest$startTime": "The start time for the list operation in UTC. Returns ephemerides with expiration times within your specified time range.
", "ListEphemeridesRequest$endTime": "The end time for the list operation in UTC. Returns ephemerides with expiration times within your specified time range.
", "ReserveContactRequest$startTime": "Start time of a contact in UTC.
", "ReserveContactRequest$endTime": "End time of a contact in UTC.
", "TimeRange$startTime": "Unix epoch timestamp in UTC at which the time range starts.
", "TimeRange$endTime": "Unix epoch timestamp in UTC at which the time range ends.
" } }, "TleLineOne": { "base": null, "refs": { "TLEData$tleLine1": "First line of two-line element set (TLE) data.
" } }, "TleLineTwo": { "base": null, "refs": { "TLEData$tleLine2": "Second line of two-line element set (TLE) data.
" } }, "TleProgramTrackSettings": { "base": "Program track settings for TLEEphemeris.
", "refs": { "ProgramTrackSettings$tle": "Program track settings for TLEEphemeris.
" } }, "TrackingConfig": { "base": "Object that determines whether tracking should be used during a contact executed with this Config in the mission profile.
Object that determines whether tracking should be used during a contact executed with this Config in the mission profile.
Overrides the default tracking configuration on an antenna during a contact.
", "refs": { "DescribeContactResponse$trackingOverrides": "Tracking configuration overrides specified when the contact was reserved.
", "DescribeContactVersionResponse$trackingOverrides": "Tracking configuration overrides applied to this contact version. For the initial version, these are the overrides specified when the contact was reserved. For subsequent versions, these are the overrides associated with that specific version update.
", "ReserveContactRequest$trackingOverrides": "Tracking configuration overrides for the contact.
", "UpdateContactRequest$trackingOverrides": null } }, "UnboundedString": { "base": null, "refs": { "EphemerisDescription$ephemerisData": "Supplied ephemeris data.
", "OEMEphemeris$oemData": "OEM data that you provide directly instead of using an Amazon S3 object.
", "TagKeys$member": null } }, "UntagResourceRequest": { "base": "Input for the UntagResource operation.
Output for the UntagResource operation.
Input for the UpdateConfig operation.
Input for the UpdateMissionProfile operation.
Definition for an uplink agent endpoint
", "refs": { "CreateEndpointDetails$uplinkAwsGroundStationAgentEndpoint": "Definition for an uplink agent endpoint
" } }, "UplinkAwsGroundStationAgentEndpointDetails": { "base": "Details for an uplink agent endpoint
", "refs": { "EndpointDetails$uplinkAwsGroundStationAgentEndpoint": "Definition for an uplink agent endpoint
" } }, "UplinkConnectionDetails": { "base": "Connection details for customer to Agent and Agent to Ground Station
", "refs": { "UplinkDataflowDetails$agentConnectionDetails": "Uplink connection details for customer to Agent and Agent to Ground Station
" } }, "UplinkDataflowDetails": { "base": "Dataflow details for an uplink endpoint
", "refs": { "UplinkAwsGroundStationAgentEndpoint$dataflowDetails": "Dataflow details for the uplink endpoint
", "UplinkAwsGroundStationAgentEndpointDetails$dataflowDetails": "Dataflow details for the uplink endpoint
" } }, "UplinkEchoConfig": { "base": "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 uplink echo Config.
Parameters from the AntennaUplinkConfig, corresponding to the specified AntennaUplinkConfigArn, are used when this UplinkEchoConfig is used in a contact.
Information about the uplink spectral Config.
Information about the uplink spectral Config.
Unique identifier of the azimuth elevation ephemeris.
", "AzElProgramTrackSettings$ephemerisId": "Unique identifier of the azimuth elevation ephemeris.
", "CancelContactRequest$contactId": "UUID of a contact.
", "ComponentStatusData$dataflowId": "Dataflow UUID associated with the component.
", "ContactData$contactId": "UUID of a contact.
", "ContactIdResponse$contactId": "UUID of a contact.
", "ContactReservationDetails$contactId": "UUID of a contact.
", "CreateDataflowEndpointGroupV2Response$dataflowEndpointGroupId": "Dataflow endpoint group ID
", "CreateEphemerisRequest$satelliteId": "The satellite ID that associates this ephemeris with a satellite in AWS Ground Station.
", "DataflowEndpointGroupIdResponse$dataflowEndpointGroupId": "UUID of a dataflow endpoint group.
", "DataflowEndpointListItem$dataflowEndpointGroupId": "UUID of a dataflow endpoint group.
", "DeleteConfigRequest$configId": "UUID of a Config.
UUID of a dataflow endpoint group.
", "DeleteEphemerisRequest$ephemerisId": "The AWS Ground Station ephemeris ID.
", "DeleteMissionProfileRequest$missionProfileId": "UUID of a mission profile.
", "DescribeContactRequest$contactId": "UUID of a contact.
", "DescribeContactResponse$contactId": "UUID of a contact.
", "DescribeContactVersionRequest$contactId": "UUID of a contact.
", "DescribeContactVersionResponse$contactId": "UUID of a contact.
", "DescribeEphemerisRequest$ephemerisId": "The AWS Ground Station ephemeris ID.
", "DescribeEphemerisResponse$ephemerisId": "The AWS Ground Station ephemeris ID.
", "DescribeEphemerisResponse$satelliteId": "The AWS Ground Station satellite ID associated with ephemeris.
", "Destination$configId": "UUID of a Config.
The AWS Ground Station ephemeris ID.
", "EphemerisItem$ephemerisId": "The AWS Ground Station ephemeris ID.
", "EphemerisMetaData$ephemerisId": "UUID of a customer-provided ephemeris.
This field is not populated for default ephemerides from Space Track.
", "EphemerisResponseData$ephemerisId": "Unique identifier of the ephemeris. Appears only for custom ephemerides.
", "GetAgentConfigurationRequest$agentId": "UUID of agent to get configuration information for.
", "GetAgentConfigurationResponse$agentId": "UUID of agent.
", "GetAgentTaskResponseUrlRequest$agentId": "UUID of agent requesting the response URL.
", "GetAgentTaskResponseUrlRequest$taskId": "GUID of the agent task for which the response URL is being requested.
", "GetAgentTaskResponseUrlResponse$agentId": "UUID of the agent.
", "GetAgentTaskResponseUrlResponse$taskId": "GUID of the agent task.
", "GetConfigRequest$configId": "UUID of a Config.
UUID of a dataflow endpoint group.
", "GetDataflowEndpointGroupResponse$dataflowEndpointGroupId": "UUID of a dataflow endpoint group.
", "GetMissionProfileRequest$missionProfileId": "UUID of a mission profile.
", "GetMissionProfileResponse$missionProfileId": "UUID of a mission profile.
", "GetSatelliteRequest$satelliteId": "UUID of a satellite.
", "GetSatelliteResponse$satelliteId": "UUID of a satellite.
", "ListContactVersionsRequest$contactId": "UUID of a contact.
", "ListEphemeridesRequest$satelliteId": "The AWS Ground Station satellite ID to list ephemeris for.
", "ListGroundStationsRequest$satelliteId": "Satellite ID to retrieve on-boarded ground stations.
", "MissionProfileIdResponse$missionProfileId": "UUID of a mission profile.
", "MissionProfileListItem$missionProfileId": "UUID of a mission profile.
", "OemProgramTrackSettings$ephemerisId": "Unique identifier of the OEM ephemeris.
", "RegisterAgentResponse$agentId": "UUID of registered agent.
", "SatelliteListItem$satelliteId": "UUID of a satellite.
", "TleProgramTrackSettings$ephemerisId": "Unique identifier of the TLE ephemeris.
", "UpdateAgentStatusRequest$agentId": "UUID of agent to update.
", "UpdateAgentStatusRequest$taskId": "GUID of agent task.
", "UpdateAgentStatusResponse$agentId": "UUID of updated agent.
", "UpdateConfigRequest$configId": "UUID of a Config.
UUID of a contact.
", "UpdateContactResponse$contactId": "UUID of a contact.
", "UpdateEphemerisRequest$ephemerisId": "The AWS Ground Station ephemeris ID.
", "UpdateMissionProfileRequest$missionProfileId": "UUID of a mission profile.
" } }, "VersionFailureReasonCode": { "base": null, "refs": { "VersionFailureReasonCodes$member": null } }, "VersionFailureReasonCodes": { "base": null, "refs": { "ContactVersion$failureCodes": "List of failure codes for the contact version.
" } }, "VersionId": { "base": null, "refs": { "ContactIdResponse$versionId": "Version ID of a contact.
", "ContactVersion$versionId": "Version ID of a contact.
", "DescribeContactVersionRequest$versionId": "Version ID of a contact.
", "UpdateContactResponse$versionId": "Version ID of a contact.
" } }, "VersionStatus": { "base": null, "refs": { "ContactVersion$status": "Status of the contact version.
" } }, "VersionString": { "base": null, "refs": { "AgentDetails$agentVersion": "Current agent version.
", "VersionStringList$member": null } }, "VersionStringList": { "base": null, "refs": { "ComponentVersion$versions": "List of versions.
" } }, "Year": { "base": null, "refs": { "GetMinuteUsageRequest$year": "The year being requested, in the format of YYYY.
" } }, "noradSatelliteID": { "base": null, "refs": { "GetSatelliteResponse$noradSatelliteID": "NORAD satellite ID number.
", "SatelliteListItem$noradSatelliteID": "NORAD satellite ID number.
" } }, "satelliteArn": { "base": null, "refs": { "ContactData$satelliteArn": "ARN of a satellite.
", "DescribeContactResponse$satelliteArn": "ARN of a satellite.
", "DescribeContactVersionResponse$satelliteArn": "ARN of a satellite.
", "GetSatelliteResponse$satelliteArn": "ARN of a satellite.
", "ListContactsRequest$satelliteArn": "ARN of a satellite.
", "ReserveContactRequest$satelliteArn": "ARN of a satellite
", "SatelliteListItem$satelliteArn": "ARN of a satellite.
", "UpdateContactRequest$satelliteArn": "ARN of a satellite.
" } } } }