# Data Types
<a name="API_Types"></a>

The AWS Ground Station API contains several data types that various actions use. This section describes each data type in detail.

**Note**  
The order of each element in a data type structure is not guaranteed. Applications should not assume a particular order.

The following data types are supported:
+  [AgentDetails](API_AgentDetails.md) 
+  [AggregateStatus](API_AggregateStatus.md) 
+  [AntennaDemodDecodeDetails](API_AntennaDemodDecodeDetails.md) 
+  [AntennaDownlinkConfig](API_AntennaDownlinkConfig.md) 
+  [AntennaDownlinkDemodDecodeConfig](API_AntennaDownlinkDemodDecodeConfig.md) 
+  [AntennaUplinkConfig](API_AntennaUplinkConfig.md) 
+  [AwsGroundStationAgentEndpoint](API_AwsGroundStationAgentEndpoint.md) 
+  [AzElEphemeris](API_AzElEphemeris.md) 
+  [AzElEphemerisFilter](API_AzElEphemerisFilter.md) 
+  [AzElProgramTrackSettings](API_AzElProgramTrackSettings.md) 
+  [AzElSegment](API_AzElSegment.md) 
+  [AzElSegments](API_AzElSegments.md) 
+  [AzElSegmentsData](API_AzElSegmentsData.md) 
+  [ComponentStatusData](API_ComponentStatusData.md) 
+  [ComponentVersion](API_ComponentVersion.md) 
+  [ConfigDetails](API_ConfigDetails.md) 
+  [ConfigListItem](API_ConfigListItem.md) 
+  [ConfigTypeData](API_ConfigTypeData.md) 
+  [ConnectionDetails](API_ConnectionDetails.md) 
+  [ContactData](API_ContactData.md) 
+  [CreateEndpointDetails](API_CreateEndpointDetails.md) 
+  [DataflowDetail](API_DataflowDetail.md) 
+  [DataflowEndpoint](API_DataflowEndpoint.md) 
+  [DataflowEndpointConfig](API_DataflowEndpointConfig.md) 
+  [DataflowEndpointListItem](API_DataflowEndpointListItem.md) 
+  [DecodeConfig](API_DecodeConfig.md) 
+  [DemodulationConfig](API_DemodulationConfig.md) 
+  [Destination](API_Destination.md) 
+  [DiscoveryData](API_DiscoveryData.md) 
+  [DownlinkAwsGroundStationAgentEndpoint](API_DownlinkAwsGroundStationAgentEndpoint.md) 
+  [DownlinkAwsGroundStationAgentEndpointDetails](API_DownlinkAwsGroundStationAgentEndpointDetails.md) 
+  [DownlinkConnectionDetails](API_DownlinkConnectionDetails.md) 
+  [DownlinkDataflowDetails](API_DownlinkDataflowDetails.md) 
+  [Eirp](API_Eirp.md) 
+  [Elevation](API_Elevation.md) 
+  [EndpointDetails](API_EndpointDetails.md) 
+  [EphemerisData](API_EphemerisData.md) 
+  [EphemerisDescription](API_EphemerisDescription.md) 
+  [EphemerisErrorReason](API_EphemerisErrorReason.md) 
+  [EphemerisFilter](API_EphemerisFilter.md) 
+  [EphemerisItem](API_EphemerisItem.md) 
+  [EphemerisMetaData](API_EphemerisMetaData.md) 
+  [EphemerisResponseData](API_EphemerisResponseData.md) 
+  [EphemerisTypeDescription](API_EphemerisTypeDescription.md) 
+  [Frequency](API_Frequency.md) 
+  [FrequencyBandwidth](API_FrequencyBandwidth.md) 
+  [GroundStationData](API_GroundStationData.md) 
+  [IntegerRange](API_IntegerRange.md) 
+  [ISO8601TimeRange](API_ISO8601TimeRange.md) 
+  [KinesisDataStreamData](API_KinesisDataStreamData.md) 
+  [KmsKey](API_KmsKey.md) 
+  [MissionProfileListItem](API_MissionProfileListItem.md) 
+  [OEMEphemeris](API_OEMEphemeris.md) 
+  [ProgramTrackSettings](API_ProgramTrackSettings.md) 
+  [RangedConnectionDetails](API_RangedConnectionDetails.md) 
+  [RangedSocketAddress](API_RangedSocketAddress.md) 
+  [S3Object](API_S3Object.md) 
+  [S3RecordingConfig](API_S3RecordingConfig.md) 
+  [S3RecordingDetails](API_S3RecordingDetails.md) 
+  [SatelliteListItem](API_SatelliteListItem.md) 
+  [SecurityDetails](API_SecurityDetails.md) 
+  [SocketAddress](API_SocketAddress.md) 
+  [Source](API_Source.md) 
+  [SpectrumConfig](API_SpectrumConfig.md) 
+  [TelemetrySinkConfig](API_TelemetrySinkConfig.md) 
+  [TelemetrySinkData](API_TelemetrySinkData.md) 
+  [TimeAzEl](API_TimeAzEl.md) 
+  [TimeRange](API_TimeRange.md) 
+  [TLEData](API_TLEData.md) 
+  [TLEEphemeris](API_TLEEphemeris.md) 
+  [TrackingConfig](API_TrackingConfig.md) 
+  [TrackingOverrides](API_TrackingOverrides.md) 
+  [UplinkAwsGroundStationAgentEndpoint](API_UplinkAwsGroundStationAgentEndpoint.md) 
+  [UplinkAwsGroundStationAgentEndpointDetails](API_UplinkAwsGroundStationAgentEndpointDetails.md) 
+  [UplinkConnectionDetails](API_UplinkConnectionDetails.md) 
+  [UplinkDataflowDetails](API_UplinkDataflowDetails.md) 
+  [UplinkEchoConfig](API_UplinkEchoConfig.md) 
+  [UplinkSpectrumConfig](API_UplinkSpectrumConfig.md) 

# AgentDetails
<a name="API_AgentDetails"></a>

Detailed information about the agent.

## Contents
<a name="API_AgentDetails_Contents"></a>

 ** agentVersion **   <a name="groundstation-Type-AgentDetails-agentVersion"></a>
Current agent version.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `(0|[1-9]\d*)(\.(0|[1-9]\d*))*`   
Required: Yes

 ** componentVersions **   <a name="groundstation-Type-AgentDetails-componentVersions"></a>
List of versions being used by agent components.  
Type: Array of [ComponentVersion](API_ComponentVersion.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 20 items.  
Required: Yes

 ** instanceId **   <a name="groundstation-Type-AgentDetails-instanceId"></a>
ID of EC2 instance agent is running on.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 64.  
Pattern: `[a-z0-9-]{10,64}`   
Required: Yes

 ** instanceType **   <a name="groundstation-Type-AgentDetails-instanceType"></a>
Type of EC2 instance agent is running on.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[a-z0-9.-]{1,64}`   
Required: Yes

 ** agentCpuCores **   <a name="groundstation-Type-AgentDetails-agentCpuCores"></a>
List of CPU cores reserved for the agent.  
Type: Array of integers  
Array Members: Minimum number of 0 items. Maximum number of 256 items.  
Required: No

 ** reservedCpuCores **   <a name="groundstation-Type-AgentDetails-reservedCpuCores"></a>
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.  
Type: Array of integers  
Array Members: Minimum number of 0 items. Maximum number of 256 items.  
Required: No

## See Also
<a name="API_AgentDetails_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/groundstation-2019-05-23/AgentDetails) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/groundstation-2019-05-23/AgentDetails) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/groundstation-2019-05-23/AgentDetails) 

# AggregateStatus
<a name="API_AggregateStatus"></a>

Aggregate status of Agent components.

## Contents
<a name="API_AggregateStatus_Contents"></a>

 ** status **   <a name="groundstation-Type-AggregateStatus-status"></a>
Aggregate status.  
Type: String  
Valid Values: `SUCCESS | FAILED | ACTIVE | INACTIVE`   
Required: Yes

 ** signatureMap **   <a name="groundstation-Type-AggregateStatus-signatureMap"></a>
Sparse map of failure signatures.  
Type: String to boolean map  
Required: No

## See Also
<a name="API_AggregateStatus_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/groundstation-2019-05-23/AggregateStatus) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/groundstation-2019-05-23/AggregateStatus) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/groundstation-2019-05-23/AggregateStatus) 

# AntennaDemodDecodeDetails
<a name="API_AntennaDemodDecodeDetails"></a>

Details about an antenna demod decode `Config` used in a contact.

## Contents
<a name="API_AntennaDemodDecodeDetails_Contents"></a>

 ** outputNode **   <a name="groundstation-Type-AntennaDemodDecodeDetails-outputNode"></a>
Name of an antenna demod decode output node used in a contact.  
Type: String  
Required: No

## See Also
<a name="API_AntennaDemodDecodeDetails_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/groundstation-2019-05-23/AntennaDemodDecodeDetails) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/groundstation-2019-05-23/AntennaDemodDecodeDetails) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/groundstation-2019-05-23/AntennaDemodDecodeDetails) 

# AntennaDownlinkConfig
<a name="API_AntennaDownlinkConfig"></a>

Information about how AWS Ground Station should configure an antenna for downlink during a contact.

## Contents
<a name="API_AntennaDownlinkConfig_Contents"></a>

 ** spectrumConfig **   <a name="groundstation-Type-AntennaDownlinkConfig-spectrumConfig"></a>
Object that describes a spectral `Config`.  
Type: [SpectrumConfig](API_SpectrumConfig.md) object  
Required: Yes

## See Also
<a name="API_AntennaDownlinkConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/groundstation-2019-05-23/AntennaDownlinkConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/groundstation-2019-05-23/AntennaDownlinkConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/groundstation-2019-05-23/AntennaDownlinkConfig) 

# AntennaDownlinkDemodDecodeConfig
<a name="API_AntennaDownlinkDemodDecodeConfig"></a>

Information about how AWS Ground Station should configure an antenna for downlink demod decode during a contact.

## Contents
<a name="API_AntennaDownlinkDemodDecodeConfig_Contents"></a>

 ** decodeConfig **   <a name="groundstation-Type-AntennaDownlinkDemodDecodeConfig-decodeConfig"></a>
Information about the decode `Config`.  
Type: [DecodeConfig](API_DecodeConfig.md) object  
Required: Yes

 ** demodulationConfig **   <a name="groundstation-Type-AntennaDownlinkDemodDecodeConfig-demodulationConfig"></a>
Information about the demodulation `Config`.  
Type: [DemodulationConfig](API_DemodulationConfig.md) object  
Required: Yes

 ** spectrumConfig **   <a name="groundstation-Type-AntennaDownlinkDemodDecodeConfig-spectrumConfig"></a>
Information about the spectral `Config`.  
Type: [SpectrumConfig](API_SpectrumConfig.md) object  
Required: Yes

## See Also
<a name="API_AntennaDownlinkDemodDecodeConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/groundstation-2019-05-23/AntennaDownlinkDemodDecodeConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/groundstation-2019-05-23/AntennaDownlinkDemodDecodeConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/groundstation-2019-05-23/AntennaDownlinkDemodDecodeConfig) 

# AntennaUplinkConfig
<a name="API_AntennaUplinkConfig"></a>

Information about the uplink `Config` of an antenna.

## Contents
<a name="API_AntennaUplinkConfig_Contents"></a>

 ** spectrumConfig **   <a name="groundstation-Type-AntennaUplinkConfig-spectrumConfig"></a>
Information about the uplink spectral `Config`.  
Type: [UplinkSpectrumConfig](API_UplinkSpectrumConfig.md) object  
Required: Yes

 ** targetEirp **   <a name="groundstation-Type-AntennaUplinkConfig-targetEirp"></a>
EIRP of the target.  
Type: [Eirp](API_Eirp.md) object  
Required: Yes

 ** transmitDisabled **   <a name="groundstation-Type-AntennaUplinkConfig-transmitDisabled"></a>
Whether or not uplink transmit is disabled.  
Type: Boolean  
Required: No

## See Also
<a name="API_AntennaUplinkConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/groundstation-2019-05-23/AntennaUplinkConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/groundstation-2019-05-23/AntennaUplinkConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/groundstation-2019-05-23/AntennaUplinkConfig) 

# AwsGroundStationAgentEndpoint
<a name="API_AwsGroundStationAgentEndpoint"></a>

Information about AwsGroundStationAgentEndpoint.

## Contents
<a name="API_AwsGroundStationAgentEndpoint_Contents"></a>

 ** egressAddress **   <a name="groundstation-Type-AwsGroundStationAgentEndpoint-egressAddress"></a>
The egress address of AgentEndpoint.  
Type: [ConnectionDetails](API_ConnectionDetails.md) object  
Required: Yes

 ** ingressAddress **   <a name="groundstation-Type-AwsGroundStationAgentEndpoint-ingressAddress"></a>
The ingress address of AgentEndpoint.  
Type: [RangedConnectionDetails](API_RangedConnectionDetails.md) object  
Required: Yes

 ** name **   <a name="groundstation-Type-AwsGroundStationAgentEndpoint-name"></a>
Name string associated with AgentEndpoint. Used as a human-readable identifier for AgentEndpoint.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[ a-zA-Z0-9_:-]{1,256}`   
Required: Yes

 ** agentStatus **   <a name="groundstation-Type-AwsGroundStationAgentEndpoint-agentStatus"></a>
The status of AgentEndpoint.  
Type: String  
Valid Values: `SUCCESS | FAILED | ACTIVE | INACTIVE`   
Required: No

 ** auditResults **   <a name="groundstation-Type-AwsGroundStationAgentEndpoint-auditResults"></a>
The results of the audit.  
Type: String  
Valid Values: `HEALTHY | UNHEALTHY`   
Required: No

## See Also
<a name="API_AwsGroundStationAgentEndpoint_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/groundstation-2019-05-23/AwsGroundStationAgentEndpoint) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/groundstation-2019-05-23/AwsGroundStationAgentEndpoint) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/groundstation-2019-05-23/AwsGroundStationAgentEndpoint) 

# AzElEphemeris
<a name="API_AzElEphemeris"></a>

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](https://docs.aws.amazon.com/ground-station/latest/ug/providing-azimuth-elevation-ephemeris-data.html) of the AWS Ground Station User Guide. 

## Contents
<a name="API_AzElEphemeris_Contents"></a>

 ** data **   <a name="groundstation-Type-AzElEphemeris-data"></a>
Azimuth elevation segment data.  
You can provide data inline in the request or through an Amazon S3 object reference.  
Type: [AzElSegmentsData](API_AzElSegmentsData.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: Yes

 ** groundStation **   <a name="groundstation-Type-AzElEphemeris-groundStation"></a>
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.  
Type: String  
Length Constraints: Minimum length of 4. Maximum length of 500.  
Pattern: `[ a-zA-Z0-9-._:=]{4,256}`   
Required: Yes

## See Also
<a name="API_AzElEphemeris_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/groundstation-2019-05-23/AzElEphemeris) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/groundstation-2019-05-23/AzElEphemeris) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/groundstation-2019-05-23/AzElEphemeris) 

# AzElEphemerisFilter
<a name="API_AzElEphemerisFilter"></a>

Filter for selecting contacts that use a specific [AzElEphemeris](API_AzElEphemeris.md).

## Contents
<a name="API_AzElEphemerisFilter_Contents"></a>

 ** id **   <a name="groundstation-Type-AzElEphemerisFilter-id"></a>
Unique identifier of the azimuth elevation ephemeris.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: Yes

## See Also
<a name="API_AzElEphemerisFilter_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/groundstation-2019-05-23/AzElEphemerisFilter) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/groundstation-2019-05-23/AzElEphemerisFilter) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/groundstation-2019-05-23/AzElEphemerisFilter) 

# AzElProgramTrackSettings
<a name="API_AzElProgramTrackSettings"></a>

Program track settings for [AzElEphemeris](API_AzElEphemeris.md).

## Contents
<a name="API_AzElProgramTrackSettings_Contents"></a>

 ** ephemerisId **   <a name="groundstation-Type-AzElProgramTrackSettings-ephemerisId"></a>
Unique identifier of the azimuth elevation ephemeris.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: Yes

## See Also
<a name="API_AzElProgramTrackSettings_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/groundstation-2019-05-23/AzElProgramTrackSettings) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/groundstation-2019-05-23/AzElProgramTrackSettings) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/groundstation-2019-05-23/AzElProgramTrackSettings) 

# AzElSegment
<a name="API_AzElSegment"></a>

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. 

## Contents
<a name="API_AzElSegment_Contents"></a>

 ** azElList **   <a name="groundstation-Type-AzElSegment-azElList"></a>
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.   
Type: Array of [TimeAzEl](API_TimeAzEl.md) objects  
Array Members: Minimum number of 5 items.  
Required: Yes

 ** referenceEpoch **   <a name="groundstation-Type-AzElSegment-referenceEpoch"></a>
The reference time for this segment in ISO 8601 format in Coordinated Universal Time (UTC).  
All time values within the segment's [AzElSegment:azElList](#groundstation-Type-AzElSegment-azElList) are specified as offsets in atomic seconds from this reference epoch.  
Example: `2024-01-15T12:00:00.000Z`   
Type: Timestamp  
Required: Yes

 ** validTimeRange **   <a name="groundstation-Type-AzElSegment-validTimeRange"></a>
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.   
Type: [ISO8601TimeRange](API_ISO8601TimeRange.md) object  
Required: Yes

## See Also
<a name="API_AzElSegment_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/groundstation-2019-05-23/AzElSegment) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/groundstation-2019-05-23/AzElSegment) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/groundstation-2019-05-23/AzElSegment) 

# AzElSegments
<a name="API_AzElSegments"></a>

Azimuth elevation segment collection.

Contains five or more time-ordered segments that define antenna pointing angles over the ephemeris validity period.

## Contents
<a name="API_AzElSegments_Contents"></a>

 ** angleUnit **   <a name="groundstation-Type-AzElSegments-angleUnit"></a>
The unit of measure for azimuth and elevation angles. All angles in all segments must use the same unit.  
Type: String  
Valid Values: `DEGREE_ANGLE | RADIAN`   
Required: Yes

 ** azElSegmentList **   <a name="groundstation-Type-AzElSegments-azElSegmentList"></a>
List of azimuth elevation segments.  
Must contain between 1 and 100 segments. Segments must be in chronological order with no overlaps.  
Type: Array of [AzElSegment](API_AzElSegment.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 100 items.  
Required: Yes

## See Also
<a name="API_AzElSegments_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/groundstation-2019-05-23/AzElSegments) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/groundstation-2019-05-23/AzElSegments) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/groundstation-2019-05-23/AzElSegments) 

# AzElSegmentsData
<a name="API_AzElSegmentsData"></a>

Container for azimuth elevation segment data.

Specify either [AzElSegmentsData:s3Object](#groundstation-Type-AzElSegmentsData-s3Object) to reference data in Amazon S3, or [AzElSegmentsData:azElData](#groundstation-Type-AzElSegmentsData-azElData) to provide data inline.

## Contents
<a name="API_AzElSegmentsData_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** azElData **   <a name="groundstation-Type-AzElSegmentsData-azElData"></a>
Azimuth elevation segment data provided directly in the request.  
Use this option for smaller datasets or when Amazon S3 access is not available.  
Type: [AzElSegments](API_AzElSegments.md) object  
Required: No

 ** s3Object **   <a name="groundstation-Type-AzElSegmentsData-s3Object"></a>
The Amazon S3 object containing azimuth elevation segment data.  
The Amazon S3 object must contain JSON-formatted azimuth elevation data matching the [AzElSegments](API_AzElSegments.md) structure.  
Type: [S3Object](API_S3Object.md) object  
Required: No

## See Also
<a name="API_AzElSegmentsData_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/groundstation-2019-05-23/AzElSegmentsData) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/groundstation-2019-05-23/AzElSegmentsData) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/groundstation-2019-05-23/AzElSegmentsData) 

# ComponentStatusData
<a name="API_ComponentStatusData"></a>

Data on the status of agent components.

## Contents
<a name="API_ComponentStatusData_Contents"></a>

 ** capabilityArn **   <a name="groundstation-Type-ComponentStatusData-capabilityArn"></a>
Capability ARN of the component.  
Type: String  
Required: Yes

 ** componentType **   <a name="groundstation-Type-ComponentStatusData-componentType"></a>
The Component type.  
Type: String  
Pattern: `[a-zA-Z0-9_]{1,64}`   
Required: Yes

 ** dataflowId **   <a name="groundstation-Type-ComponentStatusData-dataflowId"></a>
Dataflow UUID associated with the component.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: Yes

 ** status **   <a name="groundstation-Type-ComponentStatusData-status"></a>
Component status.  
Type: String  
Valid Values: `SUCCESS | FAILED | ACTIVE | INACTIVE`   
Required: Yes

 ** bytesReceived **   <a name="groundstation-Type-ComponentStatusData-bytesReceived"></a>
Bytes received by the component.  
Type: Long  
Required: No

 ** bytesSent **   <a name="groundstation-Type-ComponentStatusData-bytesSent"></a>
Bytes sent by the component.  
Type: Long  
Required: No

 ** packetsDropped **   <a name="groundstation-Type-ComponentStatusData-packetsDropped"></a>
Packets dropped by component.  
Type: Long  
Required: No

## See Also
<a name="API_ComponentStatusData_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/groundstation-2019-05-23/ComponentStatusData) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/groundstation-2019-05-23/ComponentStatusData) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/groundstation-2019-05-23/ComponentStatusData) 

# ComponentVersion
<a name="API_ComponentVersion"></a>

Version information for agent components.

## Contents
<a name="API_ComponentVersion_Contents"></a>

 ** componentType **   <a name="groundstation-Type-ComponentVersion-componentType"></a>
Component type.  
Type: String  
Pattern: `[a-zA-Z0-9_]{1,64}`   
Required: Yes

 ** versions **   <a name="groundstation-Type-ComponentVersion-versions"></a>
List of versions.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 20 items.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `(0|[1-9]\d*)(\.(0|[1-9]\d*))*`   
Required: Yes

## See Also
<a name="API_ComponentVersion_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/groundstation-2019-05-23/ComponentVersion) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/groundstation-2019-05-23/ComponentVersion) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/groundstation-2019-05-23/ComponentVersion) 

# ConfigDetails
<a name="API_ConfigDetails"></a>

Details for certain `Config` object types in a contact.

## Contents
<a name="API_ConfigDetails_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** antennaDemodDecodeDetails **   <a name="groundstation-Type-ConfigDetails-antennaDemodDecodeDetails"></a>
Details for antenna demod decode `Config` in a contact.  
Type: [AntennaDemodDecodeDetails](API_AntennaDemodDecodeDetails.md) object  
Required: No

 ** endpointDetails **   <a name="groundstation-Type-ConfigDetails-endpointDetails"></a>
Information about the endpoint details.  
Type: [EndpointDetails](API_EndpointDetails.md) object  
Required: No

 ** s3RecordingDetails **   <a name="groundstation-Type-ConfigDetails-s3RecordingDetails"></a>
Details for an S3 recording `Config` in a contact.  
Type: [S3RecordingDetails](API_S3RecordingDetails.md) object  
Required: No

## See Also
<a name="API_ConfigDetails_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/groundstation-2019-05-23/ConfigDetails) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/groundstation-2019-05-23/ConfigDetails) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/groundstation-2019-05-23/ConfigDetails) 

# ConfigListItem
<a name="API_ConfigListItem"></a>

An item in a list of `Config` objects.

## Contents
<a name="API_ConfigListItem_Contents"></a>

 ** configArn **   <a name="groundstation-Type-ConfigListItem-configArn"></a>
ARN of a `Config`.  
Type: String  
Length Constraints: Minimum length of 82. Maximum length of 424.  
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})?`   
Required: No

 ** configId **   <a name="groundstation-Type-ConfigListItem-configId"></a>
UUID of a `Config`.  
Type: String  
Required: No

 ** configType **   <a name="groundstation-Type-ConfigListItem-configType"></a>
Type of a `Config`.  
Type: String  
Valid Values: `antenna-downlink | antenna-downlink-demod-decode | tracking | dataflow-endpoint | antenna-uplink | uplink-echo | s3-recording | telemetry-sink`   
Required: No

 ** name **   <a name="groundstation-Type-ConfigListItem-name"></a>
Name of a `Config`.  
Type: String  
Required: No

## See Also
<a name="API_ConfigListItem_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/groundstation-2019-05-23/ConfigListItem) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/groundstation-2019-05-23/ConfigListItem) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/groundstation-2019-05-23/ConfigListItem) 

# ConfigTypeData
<a name="API_ConfigTypeData"></a>

Object containing the parameters of a `Config`.

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

## Contents
<a name="API_ConfigTypeData_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** antennaDownlinkConfig **   <a name="groundstation-Type-ConfigTypeData-antennaDownlinkConfig"></a>
Information about how AWS Ground Station should configure an antenna for downlink during a contact.  
Type: [AntennaDownlinkConfig](API_AntennaDownlinkConfig.md) object  
Required: No

 ** antennaDownlinkDemodDecodeConfig **   <a name="groundstation-Type-ConfigTypeData-antennaDownlinkDemodDecodeConfig"></a>
Information about how AWS Ground Station should configure an antenna for downlink demod decode during a contact.  
Type: [AntennaDownlinkDemodDecodeConfig](API_AntennaDownlinkDemodDecodeConfig.md) object  
Required: No

 ** antennaUplinkConfig **   <a name="groundstation-Type-ConfigTypeData-antennaUplinkConfig"></a>
Information about how AWS Ground Station should configure an antenna for uplink during a contact.  
Type: [AntennaUplinkConfig](API_AntennaUplinkConfig.md) object  
Required: No

 ** dataflowEndpointConfig **   <a name="groundstation-Type-ConfigTypeData-dataflowEndpointConfig"></a>
Information about the dataflow endpoint `Config`.  
Type: [DataflowEndpointConfig](API_DataflowEndpointConfig.md) object  
Required: No

 ** s3RecordingConfig **   <a name="groundstation-Type-ConfigTypeData-s3RecordingConfig"></a>
Information about an S3 recording `Config`.  
Type: [S3RecordingConfig](API_S3RecordingConfig.md) object  
Required: No

 ** telemetrySinkConfig **   <a name="groundstation-Type-ConfigTypeData-telemetrySinkConfig"></a>
Information about a telemetry sink `Config`.  
Type: [TelemetrySinkConfig](API_TelemetrySinkConfig.md) object  
Required: No

 ** trackingConfig **   <a name="groundstation-Type-ConfigTypeData-trackingConfig"></a>
Object that determines whether tracking should be used during a contact executed with this `Config` in the mission profile.   
Type: [TrackingConfig](API_TrackingConfig.md) object  
Required: No

 ** uplinkEchoConfig **   <a name="groundstation-Type-ConfigTypeData-uplinkEchoConfig"></a>
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.  
Type: [UplinkEchoConfig](API_UplinkEchoConfig.md) object  
Required: No

## See Also
<a name="API_ConfigTypeData_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/groundstation-2019-05-23/ConfigTypeData) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/groundstation-2019-05-23/ConfigTypeData) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/groundstation-2019-05-23/ConfigTypeData) 

# ConnectionDetails
<a name="API_ConnectionDetails"></a>

Egress address of AgentEndpoint with an optional mtu.

## Contents
<a name="API_ConnectionDetails_Contents"></a>

 ** socketAddress **   <a name="groundstation-Type-ConnectionDetails-socketAddress"></a>
A socket address.  
Type: [SocketAddress](API_SocketAddress.md) object  
Required: Yes

 ** mtu **   <a name="groundstation-Type-ConnectionDetails-mtu"></a>
Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.  
Type: Integer  
Required: No

## See Also
<a name="API_ConnectionDetails_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/groundstation-2019-05-23/ConnectionDetails) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/groundstation-2019-05-23/ConnectionDetails) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/groundstation-2019-05-23/ConnectionDetails) 

# ContactData
<a name="API_ContactData"></a>

Data describing a contact.

## Contents
<a name="API_ContactData_Contents"></a>

 ** contactId **   <a name="groundstation-Type-ContactData-contactId"></a>
UUID of a contact.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: No

 ** contactStatus **   <a name="groundstation-Type-ContactData-contactStatus"></a>
Status of a contact.  
Type: String  
Valid Values: `SCHEDULING | FAILED_TO_SCHEDULE | SCHEDULED | CANCELLED | AWS_CANCELLED | PREPASS | PASS | POSTPASS | COMPLETED | FAILED | AVAILABLE | CANCELLING | AWS_FAILED`   
Required: No

 ** endTime **   <a name="groundstation-Type-ContactData-endTime"></a>
End time of a contact in UTC.  
Type: Timestamp  
Required: No

 ** ephemeris **   <a name="groundstation-Type-ContactData-ephemeris"></a>
The ephemeris that determines antenna pointing for the contact.  
Type: [EphemerisResponseData](API_EphemerisResponseData.md) object  
Required: No

 ** errorMessage **   <a name="groundstation-Type-ContactData-errorMessage"></a>
Error message of a contact.  
Type: String  
Required: No

 ** groundStation **   <a name="groundstation-Type-ContactData-groundStation"></a>
Name of a ground station.  
Type: String  
Required: No

 ** maximumElevation **   <a name="groundstation-Type-ContactData-maximumElevation"></a>
Maximum elevation angle of a contact.  
Type: [Elevation](API_Elevation.md) object  
Required: No

 ** missionProfileArn **   <a name="groundstation-Type-ContactData-missionProfileArn"></a>
ARN of a mission profile.  
Type: String  
Length Constraints: Minimum length of 89. Maximum length of 138.  
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}`   
Required: No

 ** postPassEndTime **   <a name="groundstation-Type-ContactData-postPassEndTime"></a>
Amount of time after a contact ends that you’d like to receive a CloudWatch event indicating the pass has finished.  
Type: Timestamp  
Required: No

 ** prePassStartTime **   <a name="groundstation-Type-ContactData-prePassStartTime"></a>
Amount of time prior to contact start you’d like to receive a CloudWatch event indicating an upcoming pass.  
Type: Timestamp  
Required: No

 ** region **   <a name="groundstation-Type-ContactData-region"></a>
Region of a contact.  
Type: String  
Required: No

 ** satelliteArn **   <a name="groundstation-Type-ContactData-satelliteArn"></a>
ARN of a satellite.  
Type: String  
Length Constraints: Minimum length of 82. Maximum length of 132.  
Pattern: `arn:aws:groundstation:([-a-z0-9]{1,50})?:[0-9]{12}:satellite/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: No

 ** startTime **   <a name="groundstation-Type-ContactData-startTime"></a>
Start time of a contact in UTC.  
Type: Timestamp  
Required: No

 ** tags **   <a name="groundstation-Type-ContactData-tags"></a>
Tags assigned to a contact.  
Type: String to string map  
Required: No

 ** visibilityEndTime **   <a name="groundstation-Type-ContactData-visibilityEndTime"></a>
 Projected time in UTC your satellite will set below the [receive mask](https://docs.aws.amazon.com/ground-station/latest/ug/site-masks.html). 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.*   
Type: Timestamp  
Required: No

 ** visibilityStartTime **   <a name="groundstation-Type-ContactData-visibilityStartTime"></a>
 Projected time in UTC your satellite will rise above the [receive mask](https://docs.aws.amazon.com/ground-station/latest/ug/site-masks.html). 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.*   
Type: Timestamp  
Required: No

## See Also
<a name="API_ContactData_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/groundstation-2019-05-23/ContactData) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/groundstation-2019-05-23/ContactData) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/groundstation-2019-05-23/ContactData) 

# CreateEndpointDetails
<a name="API_CreateEndpointDetails"></a>

Endpoint definition used for creating a dataflow endpoint

## Contents
<a name="API_CreateEndpointDetails_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** downlinkAwsGroundStationAgentEndpoint **   <a name="groundstation-Type-CreateEndpointDetails-downlinkAwsGroundStationAgentEndpoint"></a>
Definition for a downlink agent endpoint  
Type: [DownlinkAwsGroundStationAgentEndpoint](API_DownlinkAwsGroundStationAgentEndpoint.md) object  
Required: No

 ** uplinkAwsGroundStationAgentEndpoint **   <a name="groundstation-Type-CreateEndpointDetails-uplinkAwsGroundStationAgentEndpoint"></a>
Definition for an uplink agent endpoint  
Type: [UplinkAwsGroundStationAgentEndpoint](API_UplinkAwsGroundStationAgentEndpoint.md) object  
Required: No

## See Also
<a name="API_CreateEndpointDetails_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/groundstation-2019-05-23/CreateEndpointDetails) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/groundstation-2019-05-23/CreateEndpointDetails) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/groundstation-2019-05-23/CreateEndpointDetails) 

# DataflowDetail
<a name="API_DataflowDetail"></a>

Information about a dataflow edge used in a contact.

## Contents
<a name="API_DataflowDetail_Contents"></a>

 ** destination **   <a name="groundstation-Type-DataflowDetail-destination"></a>
Dataflow details for the destination side.  
Type: [Destination](API_Destination.md) object  
Required: No

 ** errorMessage **   <a name="groundstation-Type-DataflowDetail-errorMessage"></a>
Error message for a dataflow.  
Type: String  
Required: No

 ** source **   <a name="groundstation-Type-DataflowDetail-source"></a>
Dataflow details for the source side.  
Type: [Source](API_Source.md) object  
Required: No

## See Also
<a name="API_DataflowDetail_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/groundstation-2019-05-23/DataflowDetail) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/groundstation-2019-05-23/DataflowDetail) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/groundstation-2019-05-23/DataflowDetail) 

# DataflowEndpoint
<a name="API_DataflowEndpoint"></a>

Information about a dataflow endpoint.

## Contents
<a name="API_DataflowEndpoint_Contents"></a>

 ** address **   <a name="groundstation-Type-DataflowEndpoint-address"></a>
Socket address of a dataflow endpoint.  
Type: [SocketAddress](API_SocketAddress.md) object  
Required: No

 ** mtu **   <a name="groundstation-Type-DataflowEndpoint-mtu"></a>
Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.  
Type: Integer  
Valid Range: Minimum value of 1400. Maximum value of 1500.  
Required: No

 ** name **   <a name="groundstation-Type-DataflowEndpoint-name"></a>
Name of a dataflow endpoint.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[ a-zA-Z0-9_:-]{1,256}`   
Required: No

 ** status **   <a name="groundstation-Type-DataflowEndpoint-status"></a>
Status of a dataflow endpoint.  
Type: String  
Valid Values: `created | creating | deleted | deleting | failed`   
Required: No

## See Also
<a name="API_DataflowEndpoint_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/groundstation-2019-05-23/DataflowEndpoint) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/groundstation-2019-05-23/DataflowEndpoint) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/groundstation-2019-05-23/DataflowEndpoint) 

# DataflowEndpointConfig
<a name="API_DataflowEndpointConfig"></a>

Information about the dataflow endpoint `Config`.

## Contents
<a name="API_DataflowEndpointConfig_Contents"></a>

 ** dataflowEndpointName **   <a name="groundstation-Type-DataflowEndpointConfig-dataflowEndpointName"></a>
Name of a dataflow endpoint.  
Type: String  
Required: Yes

 ** dataflowEndpointRegion **   <a name="groundstation-Type-DataflowEndpointConfig-dataflowEndpointRegion"></a>
Region of a dataflow endpoint.  
Type: String  
Required: No

## See Also
<a name="API_DataflowEndpointConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/groundstation-2019-05-23/DataflowEndpointConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/groundstation-2019-05-23/DataflowEndpointConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/groundstation-2019-05-23/DataflowEndpointConfig) 

# DataflowEndpointListItem
<a name="API_DataflowEndpointListItem"></a>

Item in a list of `DataflowEndpoint` groups.

## Contents
<a name="API_DataflowEndpointListItem_Contents"></a>

 ** dataflowEndpointGroupArn **   <a name="groundstation-Type-DataflowEndpointListItem-dataflowEndpointGroupArn"></a>
ARN of a dataflow endpoint group.  
Type: String  
Length Constraints: Minimum length of 97. Maximum length of 146.  
Pattern: `arn:aws:groundstation:[-a-z0-9]{1,50}:[0-9]{12}:dataflow-endpoint-group/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: No

 ** dataflowEndpointGroupId **   <a name="groundstation-Type-DataflowEndpointListItem-dataflowEndpointGroupId"></a>
UUID of a dataflow endpoint group.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: No

## See Also
<a name="API_DataflowEndpointListItem_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/groundstation-2019-05-23/DataflowEndpointListItem) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/groundstation-2019-05-23/DataflowEndpointListItem) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/groundstation-2019-05-23/DataflowEndpointListItem) 

# DecodeConfig
<a name="API_DecodeConfig"></a>

Information about the decode `Config`.

## Contents
<a name="API_DecodeConfig_Contents"></a>

 ** unvalidatedJSON **   <a name="groundstation-Type-DecodeConfig-unvalidatedJSON"></a>
Unvalidated JSON of a decode `Config`.  
Type: String  
Length Constraints: Minimum length of 2. Maximum length of 8192.  
Pattern: `[{}\[\]:.,"0-9A-Za-z\-_\s]{2,8192}`   
Required: Yes

## See Also
<a name="API_DecodeConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/groundstation-2019-05-23/DecodeConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/groundstation-2019-05-23/DecodeConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/groundstation-2019-05-23/DecodeConfig) 

# DemodulationConfig
<a name="API_DemodulationConfig"></a>

Information about the demodulation `Config`.

## Contents
<a name="API_DemodulationConfig_Contents"></a>

 ** unvalidatedJSON **   <a name="groundstation-Type-DemodulationConfig-unvalidatedJSON"></a>
Unvalidated JSON of a demodulation `Config`.  
Type: String  
Length Constraints: Minimum length of 2. Maximum length of 8192.  
Pattern: `[{}\[\]:.,"0-9A-Za-z\-_\s]{2,8192}`   
Required: Yes

## See Also
<a name="API_DemodulationConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/groundstation-2019-05-23/DemodulationConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/groundstation-2019-05-23/DemodulationConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/groundstation-2019-05-23/DemodulationConfig) 

# Destination
<a name="API_Destination"></a>

Dataflow details for the destination side.

## Contents
<a name="API_Destination_Contents"></a>

 ** configDetails **   <a name="groundstation-Type-Destination-configDetails"></a>
Additional details for a `Config`, if type is dataflow endpoint or antenna demod decode.  
Type: [ConfigDetails](API_ConfigDetails.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

 ** configId **   <a name="groundstation-Type-Destination-configId"></a>
UUID of a `Config`.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: No

 ** configType **   <a name="groundstation-Type-Destination-configType"></a>
Type of a `Config`.  
Type: String  
Valid Values: `antenna-downlink | antenna-downlink-demod-decode | tracking | dataflow-endpoint | antenna-uplink | uplink-echo | s3-recording | telemetry-sink`   
Required: No

 ** dataflowDestinationRegion **   <a name="groundstation-Type-Destination-dataflowDestinationRegion"></a>
Region of a dataflow destination.  
Type: String  
Required: No

## See Also
<a name="API_Destination_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/groundstation-2019-05-23/Destination) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/groundstation-2019-05-23/Destination) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/groundstation-2019-05-23/Destination) 

# DiscoveryData
<a name="API_DiscoveryData"></a>

Data for agent discovery.

## Contents
<a name="API_DiscoveryData_Contents"></a>

 ** capabilityArns **   <a name="groundstation-Type-DiscoveryData-capabilityArns"></a>
List of capabilities to associate with agent.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 20 items.  
Required: Yes

 ** privateIpAddresses **   <a name="groundstation-Type-DiscoveryData-privateIpAddresses"></a>
List of private IP addresses to associate with agent.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 20 items.  
Length Constraints: Minimum length of 7. Maximum length of 16.  
Pattern: `\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}`   
Required: Yes

 ** publicIpAddresses **   <a name="groundstation-Type-DiscoveryData-publicIpAddresses"></a>
List of public IP addresses to associate with agent.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 20 items.  
Length Constraints: Minimum length of 7. Maximum length of 16.  
Pattern: `\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}`   
Required: Yes

## See Also
<a name="API_DiscoveryData_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/groundstation-2019-05-23/DiscoveryData) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/groundstation-2019-05-23/DiscoveryData) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/groundstation-2019-05-23/DiscoveryData) 

# DownlinkAwsGroundStationAgentEndpoint
<a name="API_DownlinkAwsGroundStationAgentEndpoint"></a>

Definition for a downlink agent endpoint

## Contents
<a name="API_DownlinkAwsGroundStationAgentEndpoint_Contents"></a>

 ** dataflowDetails **   <a name="groundstation-Type-DownlinkAwsGroundStationAgentEndpoint-dataflowDetails"></a>
Dataflow details for the downlink endpoint  
Type: [DownlinkDataflowDetails](API_DownlinkDataflowDetails.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: Yes

 ** name **   <a name="groundstation-Type-DownlinkAwsGroundStationAgentEndpoint-name"></a>
Downlink dataflow endpoint name  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[ a-zA-Z0-9_:-]{1,256}`   
Required: Yes

## See Also
<a name="API_DownlinkAwsGroundStationAgentEndpoint_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/groundstation-2019-05-23/DownlinkAwsGroundStationAgentEndpoint) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/groundstation-2019-05-23/DownlinkAwsGroundStationAgentEndpoint) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/groundstation-2019-05-23/DownlinkAwsGroundStationAgentEndpoint) 

# DownlinkAwsGroundStationAgentEndpointDetails
<a name="API_DownlinkAwsGroundStationAgentEndpointDetails"></a>

Details for a downlink agent endpoint

## Contents
<a name="API_DownlinkAwsGroundStationAgentEndpointDetails_Contents"></a>

 ** dataflowDetails **   <a name="groundstation-Type-DownlinkAwsGroundStationAgentEndpointDetails-dataflowDetails"></a>
Dataflow details for the downlink endpoint  
Type: [DownlinkDataflowDetails](API_DownlinkDataflowDetails.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: Yes

 ** name **   <a name="groundstation-Type-DownlinkAwsGroundStationAgentEndpointDetails-name"></a>
Downlink dataflow endpoint name  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[ a-zA-Z0-9_:-]{1,256}`   
Required: Yes

 ** agentStatus **   <a name="groundstation-Type-DownlinkAwsGroundStationAgentEndpointDetails-agentStatus"></a>
Status of the agent associated with the downlink dataflow endpoint  
Type: String  
Valid Values: `SUCCESS | FAILED | ACTIVE | INACTIVE`   
Required: No

 ** auditResults **   <a name="groundstation-Type-DownlinkAwsGroundStationAgentEndpointDetails-auditResults"></a>
Health audit results for the downlink dataflow endpoint  
Type: String  
Valid Values: `HEALTHY | UNHEALTHY`   
Required: No

## See Also
<a name="API_DownlinkAwsGroundStationAgentEndpointDetails_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/groundstation-2019-05-23/DownlinkAwsGroundStationAgentEndpointDetails) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/groundstation-2019-05-23/DownlinkAwsGroundStationAgentEndpointDetails) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/groundstation-2019-05-23/DownlinkAwsGroundStationAgentEndpointDetails) 

# DownlinkConnectionDetails
<a name="API_DownlinkConnectionDetails"></a>

Connection details for Ground Station to Agent and Agent to customer

## Contents
<a name="API_DownlinkConnectionDetails_Contents"></a>

 ** agentIpAndPortAddress **   <a name="groundstation-Type-DownlinkConnectionDetails-agentIpAndPortAddress"></a>
Ingress address of AgentEndpoint with a port range and an optional mtu.  
Type: [RangedConnectionDetails](API_RangedConnectionDetails.md) object  
Required: Yes

 ** egressAddressAndPort **   <a name="groundstation-Type-DownlinkConnectionDetails-egressAddressAndPort"></a>
Egress address of AgentEndpoint with an optional mtu.  
Type: [ConnectionDetails](API_ConnectionDetails.md) object  
Required: Yes

## See Also
<a name="API_DownlinkConnectionDetails_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/groundstation-2019-05-23/DownlinkConnectionDetails) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/groundstation-2019-05-23/DownlinkConnectionDetails) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/groundstation-2019-05-23/DownlinkConnectionDetails) 

# DownlinkDataflowDetails
<a name="API_DownlinkDataflowDetails"></a>

Dataflow details for a downlink endpoint

## Contents
<a name="API_DownlinkDataflowDetails_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** agentConnectionDetails **   <a name="groundstation-Type-DownlinkDataflowDetails-agentConnectionDetails"></a>
Downlink connection details for customer to Agent and Agent to Ground Station  
Type: [DownlinkConnectionDetails](API_DownlinkConnectionDetails.md) object  
Required: No

## See Also
<a name="API_DownlinkDataflowDetails_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/groundstation-2019-05-23/DownlinkDataflowDetails) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/groundstation-2019-05-23/DownlinkDataflowDetails) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/groundstation-2019-05-23/DownlinkDataflowDetails) 

# Eirp
<a name="API_Eirp"></a>

Object that represents EIRP.

## Contents
<a name="API_Eirp_Contents"></a>

 ** units **   <a name="groundstation-Type-Eirp-units"></a>
Units of an EIRP.  
Type: String  
Valid Values: `dBW`   
Required: Yes

 ** value **   <a name="groundstation-Type-Eirp-value"></a>
Value of an EIRP. Valid values are between 20.0 to 50.0 dBW.  
Type: Double  
Required: Yes

## See Also
<a name="API_Eirp_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/groundstation-2019-05-23/Eirp) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/groundstation-2019-05-23/Eirp) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/groundstation-2019-05-23/Eirp) 

# Elevation
<a name="API_Elevation"></a>

Elevation angle of the satellite in the sky during a contact.

## Contents
<a name="API_Elevation_Contents"></a>

 ** unit **   <a name="groundstation-Type-Elevation-unit"></a>
Elevation angle units.  
Type: String  
Valid Values: `DEGREE_ANGLE | RADIAN`   
Required: Yes

 ** value **   <a name="groundstation-Type-Elevation-value"></a>
Elevation angle value.  
Type: Double  
Required: Yes

## See Also
<a name="API_Elevation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/groundstation-2019-05-23/Elevation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/groundstation-2019-05-23/Elevation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/groundstation-2019-05-23/Elevation) 

# EndpointDetails
<a name="API_EndpointDetails"></a>

Information about the endpoint details.

## Contents
<a name="API_EndpointDetails_Contents"></a>

 ** awsGroundStationAgentEndpoint **   <a name="groundstation-Type-EndpointDetails-awsGroundStationAgentEndpoint"></a>
An agent endpoint.  
Type: [AwsGroundStationAgentEndpoint](API_AwsGroundStationAgentEndpoint.md) object  
Required: No

 ** downlinkAwsGroundStationAgentEndpoint **   <a name="groundstation-Type-EndpointDetails-downlinkAwsGroundStationAgentEndpoint"></a>
Definition for a downlink agent endpoint  
Type: [DownlinkAwsGroundStationAgentEndpointDetails](API_DownlinkAwsGroundStationAgentEndpointDetails.md) object  
Required: No

 ** endpoint **   <a name="groundstation-Type-EndpointDetails-endpoint"></a>
A dataflow endpoint.  
Type: [DataflowEndpoint](API_DataflowEndpoint.md) object  
Required: No

 ** healthReasons **   <a name="groundstation-Type-EndpointDetails-healthReasons"></a>
Health reasons for a dataflow endpoint. This field is ignored when calling `CreateDataflowEndpointGroup`.  
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 500 items.  
Valid Values: `NO_REGISTERED_AGENT | INVALID_IP_OWNERSHIP | NOT_AUTHORIZED_TO_CREATE_SLR | UNVERIFIED_IP_OWNERSHIP | INITIALIZING_DATAPLANE | DATAPLANE_FAILURE | HEALTHY`   
Required: No

 ** healthStatus **   <a name="groundstation-Type-EndpointDetails-healthStatus"></a>
A dataflow endpoint health status. This field is ignored when calling `CreateDataflowEndpointGroup`.  
Type: String  
Valid Values: `HEALTHY | UNHEALTHY`   
Required: No

 ** securityDetails **   <a name="groundstation-Type-EndpointDetails-securityDetails"></a>
Endpoint security details including a list of subnets, a list of security groups and a role to connect streams to instances.  
Type: [SecurityDetails](API_SecurityDetails.md) object  
Required: No

 ** uplinkAwsGroundStationAgentEndpoint **   <a name="groundstation-Type-EndpointDetails-uplinkAwsGroundStationAgentEndpoint"></a>
Definition for an uplink agent endpoint  
Type: [UplinkAwsGroundStationAgentEndpointDetails](API_UplinkAwsGroundStationAgentEndpointDetails.md) object  
Required: No

## See Also
<a name="API_EndpointDetails_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/groundstation-2019-05-23/EndpointDetails) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/groundstation-2019-05-23/EndpointDetails) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/groundstation-2019-05-23/EndpointDetails) 

# EphemerisData
<a name="API_EphemerisData"></a>

Ephemeris data.

## Contents
<a name="API_EphemerisData_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** azEl **   <a name="groundstation-Type-EphemerisData-azEl"></a>
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](https://docs.aws.amazon.com/ground-station/latest/ug/providing-azimuth-elevation-ephemeris-data.html) of the AWS Ground Station User Guide.   
Type: [AzElEphemeris](API_AzElEphemeris.md) object  
Required: No

 ** oem **   <a name="groundstation-Type-EphemerisData-oem"></a>
Ephemeris data in Orbit Ephemeris Message (OEM) format.  
 AWS Ground Station processes OEM ephemerides according to the [CCSDS standard](https://ccsds.org/Pubs/502x0b3e1.pdf) 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](https://docs.aws.amazon.com/ground-station/latest/ug/providing-oem-ephemeris-data.html#oem-ephemeris-format) in the AWS Ground Station user guide.   
Type: [OEMEphemeris](API_OEMEphemeris.md) object  
Required: No

 ** tle **   <a name="groundstation-Type-EphemerisData-tle"></a>
Two-line element set (TLE) ephemeris.  
 For more detail about providing Two-line element sets to AWS Ground Station, see the [TLE section](https://docs.aws.amazon.com/ground-station/latest/ug/providing-tle-ephemeris-data.html) of the AWS Ground Station user guide.   
Type: [TLEEphemeris](API_TLEEphemeris.md) object  
Required: No

## See Also
<a name="API_EphemerisData_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/groundstation-2019-05-23/EphemerisData) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/groundstation-2019-05-23/EphemerisData) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/groundstation-2019-05-23/EphemerisData) 

# EphemerisDescription
<a name="API_EphemerisDescription"></a>

Description of ephemeris.

## Contents
<a name="API_EphemerisDescription_Contents"></a>

 ** ephemerisData **   <a name="groundstation-Type-EphemerisDescription-ephemerisData"></a>
Supplied ephemeris data.  
Type: String  
Length Constraints: Minimum length of 1.  
Pattern: `[\s\S]+`   
Required: No

 ** sourceS3Object **   <a name="groundstation-Type-EphemerisDescription-sourceS3Object"></a>
Source Amazon S3 object used for the ephemeris.  
Type: [S3Object](API_S3Object.md) object  
Required: No

## See Also
<a name="API_EphemerisDescription_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/groundstation-2019-05-23/EphemerisDescription) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/groundstation-2019-05-23/EphemerisDescription) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/groundstation-2019-05-23/EphemerisDescription) 

# EphemerisErrorReason
<a name="API_EphemerisErrorReason"></a>

Detailed error information for ephemeris validation failures.

Provides an error code and descriptive message to help diagnose and resolve validation issues.

## Contents
<a name="API_EphemerisErrorReason_Contents"></a>

 ** errorCode **   <a name="groundstation-Type-EphemerisErrorReason-errorCode"></a>
The error code identifying the type of validation failure.  
See the [Troubleshooting Invalid Ephemerides guide](https://docs.aws.amazon.com/ground-station/latest/ug/troubleshooting-invalid-ephemerides.html) for error code details.  
Type: String  
Valid Values: `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`   
Required: Yes

 ** errorMessage **   <a name="groundstation-Type-EphemerisErrorReason-errorMessage"></a>
A human-readable message describing the validation failure.  
Provides specific details about what failed and may include suggestions for remediation.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1000.  
Required: Yes

## See Also
<a name="API_EphemerisErrorReason_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/groundstation-2019-05-23/EphemerisErrorReason) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/groundstation-2019-05-23/EphemerisErrorReason) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/groundstation-2019-05-23/EphemerisErrorReason) 

# EphemerisFilter
<a name="API_EphemerisFilter"></a>

Filter for selecting contacts that use a specific ephemeris".

## Contents
<a name="API_EphemerisFilter_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** azEl **   <a name="groundstation-Type-EphemerisFilter-azEl"></a>
Filter for [AzElEphemeris](API_AzElEphemeris.md).  
Type: [AzElEphemerisFilter](API_AzElEphemerisFilter.md) object  
Required: No

## See Also
<a name="API_EphemerisFilter_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/groundstation-2019-05-23/EphemerisFilter) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/groundstation-2019-05-23/EphemerisFilter) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/groundstation-2019-05-23/EphemerisFilter) 

# EphemerisItem
<a name="API_EphemerisItem"></a>

Ephemeris item.

## Contents
<a name="API_EphemerisItem_Contents"></a>

 ** creationTime **   <a name="groundstation-Type-EphemerisItem-creationTime"></a>
The time the ephemeris was uploaded in UTC.  
Type: Timestamp  
Required: No

 ** enabled **   <a name="groundstation-Type-EphemerisItem-enabled"></a>
Whether or not the ephemeris is enabled.  
Type: Boolean  
Required: No

 ** ephemerisId **   <a name="groundstation-Type-EphemerisItem-ephemerisId"></a>
The AWS Ground Station ephemeris ID.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: No

 ** ephemerisType **   <a name="groundstation-Type-EphemerisItem-ephemerisType"></a>
The type of ephemeris.  
Type: String  
Valid Values: `TLE | OEM | AZ_EL | SERVICE_MANAGED`   
Required: No

 ** name **   <a name="groundstation-Type-EphemerisItem-name"></a>
A name that you can use to identify the ephemeris.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[ a-zA-Z0-9_:-]{1,256}`   
Required: No

 ** priority **   <a name="groundstation-Type-EphemerisItem-priority"></a>
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.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 99999.  
Required: No

 ** sourceS3Object **   <a name="groundstation-Type-EphemerisItem-sourceS3Object"></a>
Source Amazon S3 object used for the ephemeris.  
Type: [S3Object](API_S3Object.md) object  
Required: No

 ** status **   <a name="groundstation-Type-EphemerisItem-status"></a>
The status of the ephemeris.  
Type: String  
Valid Values: `VALIDATING | INVALID | ERROR | ENABLED | DISABLED | EXPIRED`   
Required: No

## See Also
<a name="API_EphemerisItem_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/groundstation-2019-05-23/EphemerisItem) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/groundstation-2019-05-23/EphemerisItem) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/groundstation-2019-05-23/EphemerisItem) 

# EphemerisMetaData
<a name="API_EphemerisMetaData"></a>

Metadata describing a particular ephemeris.

## Contents
<a name="API_EphemerisMetaData_Contents"></a>

 ** source **   <a name="groundstation-Type-EphemerisMetaData-source"></a>
The `EphemerisSource` that generated a given ephemeris.  
Type: String  
Valid Values: `CUSTOMER_PROVIDED | SPACE_TRACK`   
Required: Yes

 ** ephemerisId **   <a name="groundstation-Type-EphemerisMetaData-ephemerisId"></a>
UUID of a customer-provided ephemeris.  
This field is not populated for default ephemerides from Space Track.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: No

 ** epoch **   <a name="groundstation-Type-EphemerisMetaData-epoch"></a>
The epoch of a default, ephemeris from Space Track in UTC.  
This field is not populated for customer-provided ephemerides.  
Type: Timestamp  
Required: No

 ** name **   <a name="groundstation-Type-EphemerisMetaData-name"></a>
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.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[ a-zA-Z0-9_:-]{1,256}`   
Required: No

## See Also
<a name="API_EphemerisMetaData_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/groundstation-2019-05-23/EphemerisMetaData) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/groundstation-2019-05-23/EphemerisMetaData) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/groundstation-2019-05-23/EphemerisMetaData) 

# EphemerisResponseData
<a name="API_EphemerisResponseData"></a>

Ephemeris data for a contact.

## Contents
<a name="API_EphemerisResponseData_Contents"></a>

 ** ephemerisType **   <a name="groundstation-Type-EphemerisResponseData-ephemerisType"></a>
Type of ephemeris.  
Type: String  
Valid Values: `TLE | OEM | AZ_EL | SERVICE_MANAGED`   
Required: Yes

 ** ephemerisId **   <a name="groundstation-Type-EphemerisResponseData-ephemerisId"></a>
Unique identifier of the ephemeris. Appears only for custom ephemerides.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: No

## See Also
<a name="API_EphemerisResponseData_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/groundstation-2019-05-23/EphemerisResponseData) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/groundstation-2019-05-23/EphemerisResponseData) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/groundstation-2019-05-23/EphemerisResponseData) 

# EphemerisTypeDescription
<a name="API_EphemerisTypeDescription"></a>



## Contents
<a name="API_EphemerisTypeDescription_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** azEl **   <a name="groundstation-Type-EphemerisTypeDescription-azEl"></a>
Description of ephemeris.  
Type: [EphemerisDescription](API_EphemerisDescription.md) object  
Required: No

 ** oem **   <a name="groundstation-Type-EphemerisTypeDescription-oem"></a>
Description of ephemeris.  
Type: [EphemerisDescription](API_EphemerisDescription.md) object  
Required: No

 ** tle **   <a name="groundstation-Type-EphemerisTypeDescription-tle"></a>
Description of ephemeris.  
Type: [EphemerisDescription](API_EphemerisDescription.md) object  
Required: No

## See Also
<a name="API_EphemerisTypeDescription_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/groundstation-2019-05-23/EphemerisTypeDescription) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/groundstation-2019-05-23/EphemerisTypeDescription) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/groundstation-2019-05-23/EphemerisTypeDescription) 

# Frequency
<a name="API_Frequency"></a>

Object that describes the frequency.

## Contents
<a name="API_Frequency_Contents"></a>

 ** units **   <a name="groundstation-Type-Frequency-units"></a>
Frequency units.  
Type: String  
Valid Values: `GHz | MHz | kHz`   
Required: Yes

 ** value **   <a name="groundstation-Type-Frequency-value"></a>
Frequency value. Valid values are between 2200 to 2300 MHz and 7750 to 8400 MHz for downlink and 2025 to 2120 MHz for uplink.  
Type: Double  
Required: Yes

## See Also
<a name="API_Frequency_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/groundstation-2019-05-23/Frequency) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/groundstation-2019-05-23/Frequency) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/groundstation-2019-05-23/Frequency) 

# FrequencyBandwidth
<a name="API_FrequencyBandwidth"></a>

Object that describes the frequency bandwidth. 

## Contents
<a name="API_FrequencyBandwidth_Contents"></a>

 ** units **   <a name="groundstation-Type-FrequencyBandwidth-units"></a>
Frequency bandwidth units.  
Type: String  
Valid Values: `GHz | MHz | kHz`   
Required: Yes

 ** value **   <a name="groundstation-Type-FrequencyBandwidth-value"></a>
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.
Type: Double  
Required: Yes

## See Also
<a name="API_FrequencyBandwidth_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/groundstation-2019-05-23/FrequencyBandwidth) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/groundstation-2019-05-23/FrequencyBandwidth) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/groundstation-2019-05-23/FrequencyBandwidth) 

# GroundStationData
<a name="API_GroundStationData"></a>

Information about the ground station data.

## Contents
<a name="API_GroundStationData_Contents"></a>

 ** groundStationId **   <a name="groundstation-Type-GroundStationData-groundStationId"></a>
UUID of a ground station.  
Type: String  
Length Constraints: Minimum length of 4. Maximum length of 500.  
Pattern: `[ a-zA-Z0-9-._:=]{4,256}`   
Required: No

 ** groundStationName **   <a name="groundstation-Type-GroundStationData-groundStationName"></a>
Name of a ground station.  
Type: String  
Length Constraints: Minimum length of 4. Maximum length of 500.  
Pattern: `[ a-zA-Z0-9-._:=]{4,256}`   
Required: No

 ** region **   <a name="groundstation-Type-GroundStationData-region"></a>
Ground station Region.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[\w-]+`   
Required: No

## See Also
<a name="API_GroundStationData_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/groundstation-2019-05-23/GroundStationData) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/groundstation-2019-05-23/GroundStationData) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/groundstation-2019-05-23/GroundStationData) 

# IntegerRange
<a name="API_IntegerRange"></a>

An integer range that has a minimum and maximum value.

## Contents
<a name="API_IntegerRange_Contents"></a>

 ** maximum **   <a name="groundstation-Type-IntegerRange-maximum"></a>
A maximum value.  
Type: Integer  
Required: Yes

 ** minimum **   <a name="groundstation-Type-IntegerRange-minimum"></a>
A minimum value.  
Type: Integer  
Required: Yes

## See Also
<a name="API_IntegerRange_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/groundstation-2019-05-23/IntegerRange) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/groundstation-2019-05-23/IntegerRange) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/groundstation-2019-05-23/IntegerRange) 

# ISO8601TimeRange
<a name="API_ISO8601TimeRange"></a>

Time range specified using ISO 8601 format timestamps.

## Contents
<a name="API_ISO8601TimeRange_Contents"></a>

 ** endTime **   <a name="groundstation-Type-ISO8601TimeRange-endTime"></a>
End time in ISO 8601 format in Coordinated Universal Time (UTC).  
Example: `2024-01-15T12:00:00.000Z`   
Type: Timestamp  
Required: Yes

 ** startTime **   <a name="groundstation-Type-ISO8601TimeRange-startTime"></a>
Start time in ISO 8601 format in Coordinated Universal Time (UTC).  
Example: `2026-11-15T10:28:48.000Z`   
Type: Timestamp  
Required: Yes

## See Also
<a name="API_ISO8601TimeRange_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/groundstation-2019-05-23/ISO8601TimeRange) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/groundstation-2019-05-23/ISO8601TimeRange) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/groundstation-2019-05-23/ISO8601TimeRange) 

# KinesisDataStreamData
<a name="API_KinesisDataStreamData"></a>

Information for telemetry delivery to Kinesis Data Streams.

## Contents
<a name="API_KinesisDataStreamData_Contents"></a>

 ** kinesisDataStreamArn **   <a name="groundstation-Type-KinesisDataStreamData-kinesisDataStreamArn"></a>
ARN of the Kinesis Data Stream to deliver telemetry to.  
Type: String  
Length Constraints: Minimum length of 37. Maximum length of 275.  
Pattern: `arn:[a-z0-9-.]{1,63}:kinesis:[-a-z0-9]{1,50}:[0-9]{12}:stream/[a-zA-Z0-9_.-]{1,128}`   
Required: Yes

 ** kinesisRoleArn **   <a name="groundstation-Type-KinesisDataStreamData-kinesisRoleArn"></a>
ARN of the IAM Role used by AWS Ground Station to deliver telemetry.  
Type: String  
Length Constraints: Minimum length of 30. Maximum length of 165.  
Pattern: `arn:[a-z0-9-.]{1,63}:iam::[0-9]{12}:role/[\w+=,.@-]{1,64}`   
Required: Yes

## See Also
<a name="API_KinesisDataStreamData_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/groundstation-2019-05-23/KinesisDataStreamData) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/groundstation-2019-05-23/KinesisDataStreamData) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/groundstation-2019-05-23/KinesisDataStreamData) 

# KmsKey
<a name="API_KmsKey"></a>

KMS key info.

## Contents
<a name="API_KmsKey_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** kmsAliasArn **   <a name="groundstation-Type-KmsKey-kmsAliasArn"></a>
KMS Alias Arn.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 512.  
Pattern: `arn:aws[a-zA-Z-]{0,16}:kms:[-a-z0-9]{1,50}:[0-9]{12}:((alias/[a-zA-Z0-9:/_-]{1,256}))`   
Required: No

 ** kmsAliasName **   <a name="groundstation-Type-KmsKey-kmsAliasName"></a>
KMS Alias Name.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `alias/[a-zA-Z0-9:/_-]+`   
Required: No

 ** kmsKeyArn **   <a name="groundstation-Type-KmsKey-kmsKeyArn"></a>
KMS Key Arn.  
Type: String  
Required: No

## See Also
<a name="API_KmsKey_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/groundstation-2019-05-23/KmsKey) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/groundstation-2019-05-23/KmsKey) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/groundstation-2019-05-23/KmsKey) 

# MissionProfileListItem
<a name="API_MissionProfileListItem"></a>

Item in a list of mission profiles.

## Contents
<a name="API_MissionProfileListItem_Contents"></a>

 ** missionProfileArn **   <a name="groundstation-Type-MissionProfileListItem-missionProfileArn"></a>
ARN of a mission profile.  
Type: String  
Length Constraints: Minimum length of 89. Maximum length of 138.  
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}`   
Required: No

 ** missionProfileId **   <a name="groundstation-Type-MissionProfileListItem-missionProfileId"></a>
UUID of a mission profile.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: No

 ** name **   <a name="groundstation-Type-MissionProfileListItem-name"></a>
Name of a mission profile.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[ a-zA-Z0-9_:-]{1,256}`   
Required: No

 ** region **   <a name="groundstation-Type-MissionProfileListItem-region"></a>
Region of a mission profile.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[\w-]+`   
Required: No

## See Also
<a name="API_MissionProfileListItem_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/groundstation-2019-05-23/MissionProfileListItem) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/groundstation-2019-05-23/MissionProfileListItem) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/groundstation-2019-05-23/MissionProfileListItem) 

# OEMEphemeris
<a name="API_OEMEphemeris"></a>

Ephemeris data in Orbit Ephemeris Message (OEM) format.

 AWS Ground Station processes OEM ephemerides according to the [CCSDS standard](https://ccsds.org/Pubs/502x0b3e1.pdf) 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](https://docs.aws.amazon.com/ground-station/latest/ug/providing-oem-ephemeris-data.html#oem-ephemeris-format) in the AWS Ground Station user guide. 

## Contents
<a name="API_OEMEphemeris_Contents"></a>

 ** oemData **   <a name="groundstation-Type-OEMEphemeris-oemData"></a>
OEM data that you provide directly instead of using an Amazon S3 object.  
Type: String  
Length Constraints: Minimum length of 1.  
Pattern: `[\s\S]+`   
Required: No

 ** s3Object **   <a name="groundstation-Type-OEMEphemeris-s3Object"></a>
The Amazon S3 object that contains the ephemeris data.  
Type: [S3Object](API_S3Object.md) object  
Required: No

## See Also
<a name="API_OEMEphemeris_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/groundstation-2019-05-23/OEMEphemeris) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/groundstation-2019-05-23/OEMEphemeris) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/groundstation-2019-05-23/OEMEphemeris) 

# ProgramTrackSettings
<a name="API_ProgramTrackSettings"></a>

Program track settings for an antenna during a contact.

## Contents
<a name="API_ProgramTrackSettings_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** azEl **   <a name="groundstation-Type-ProgramTrackSettings-azEl"></a>
Program track settings for [AzElEphemeris](API_AzElEphemeris.md).  
Type: [AzElProgramTrackSettings](API_AzElProgramTrackSettings.md) object  
Required: No

## See Also
<a name="API_ProgramTrackSettings_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/groundstation-2019-05-23/ProgramTrackSettings) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/groundstation-2019-05-23/ProgramTrackSettings) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/groundstation-2019-05-23/ProgramTrackSettings) 

# RangedConnectionDetails
<a name="API_RangedConnectionDetails"></a>

Ingress address of AgentEndpoint with a port range and an optional mtu.

## Contents
<a name="API_RangedConnectionDetails_Contents"></a>

 ** socketAddress **   <a name="groundstation-Type-RangedConnectionDetails-socketAddress"></a>
A ranged socket address.  
Type: [RangedSocketAddress](API_RangedSocketAddress.md) object  
Required: Yes

 ** mtu **   <a name="groundstation-Type-RangedConnectionDetails-mtu"></a>
Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.  
Type: Integer  
Valid Range: Minimum value of 1400. Maximum value of 1500.  
Required: No

## See Also
<a name="API_RangedConnectionDetails_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/groundstation-2019-05-23/RangedConnectionDetails) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/groundstation-2019-05-23/RangedConnectionDetails) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/groundstation-2019-05-23/RangedConnectionDetails) 

# RangedSocketAddress
<a name="API_RangedSocketAddress"></a>

A socket address with a port range.

## Contents
<a name="API_RangedSocketAddress_Contents"></a>

 ** name **   <a name="groundstation-Type-RangedSocketAddress-name"></a>
IPv4 socket address.  
Type: String  
Length Constraints: Minimum length of 7. Maximum length of 16.  
Pattern: `\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}`   
Required: Yes

 ** portRange **   <a name="groundstation-Type-RangedSocketAddress-portRange"></a>
Port range of a socket address.  
Type: [IntegerRange](API_IntegerRange.md) object  
Required: Yes

## See Also
<a name="API_RangedSocketAddress_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/groundstation-2019-05-23/RangedSocketAddress) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/groundstation-2019-05-23/RangedSocketAddress) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/groundstation-2019-05-23/RangedSocketAddress) 

# S3Object
<a name="API_S3Object"></a>

Object stored in Amazon S3 containing ephemeris data.

## Contents
<a name="API_S3Object_Contents"></a>

 ** bucket **   <a name="groundstation-Type-S3Object-bucket"></a>
An Amazon S3 Bucket name.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 63.  
Pattern: `[a-z0-9.-]{3,63}`   
Required: No

 ** key **   <a name="groundstation-Type-S3Object-key"></a>
An Amazon S3 key for the ephemeris.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `[a-zA-Z0-9!*'\)\(./_-]{1,1024}`   
Required: No

 ** version **   <a name="groundstation-Type-S3Object-version"></a>
For versioned Amazon S3 objects, the version to use for the ephemeris.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `[\s\S]{1,1024}`   
Required: No

## See Also
<a name="API_S3Object_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/groundstation-2019-05-23/S3Object) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/groundstation-2019-05-23/S3Object) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/groundstation-2019-05-23/S3Object) 

# S3RecordingConfig
<a name="API_S3RecordingConfig"></a>

Information about an S3 recording `Config`.

## Contents
<a name="API_S3RecordingConfig_Contents"></a>

 ** bucketArn **   <a name="groundstation-Type-S3RecordingConfig-bucketArn"></a>
ARN of the bucket to record to.  
Type: String  
Required: Yes

 ** roleArn **   <a name="groundstation-Type-S3RecordingConfig-roleArn"></a>
ARN of the role Ground Station assumes to write data to the bucket.  
Type: String  
Length Constraints: Minimum length of 30. Maximum length of 165.  
Pattern: `arn:[a-z0-9-.]{1,63}:iam::[0-9]{12}:role/[\w+=,.@-]{1,64}`   
Required: Yes

 ** prefix **   <a name="groundstation-Type-S3RecordingConfig-prefix"></a>
S3 Key prefix to prefice data files.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 900.  
Pattern: `([a-zA-Z0-9_\-=/]|\{satellite_id\}|\{config\-name}|\{s3\-config-id}|\{year\}|\{month\}|\{day\}){1,900}`   
Required: No

## See Also
<a name="API_S3RecordingConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/groundstation-2019-05-23/S3RecordingConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/groundstation-2019-05-23/S3RecordingConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/groundstation-2019-05-23/S3RecordingConfig) 

# S3RecordingDetails
<a name="API_S3RecordingDetails"></a>

Details about an S3 recording `Config` used in a contact.

## Contents
<a name="API_S3RecordingDetails_Contents"></a>

 ** bucketArn **   <a name="groundstation-Type-S3RecordingDetails-bucketArn"></a>
ARN of the bucket used.  
Type: String  
Required: No

 ** keyTemplate **   <a name="groundstation-Type-S3RecordingDetails-keyTemplate"></a>
Key template used for the S3 Recording Configuration  
Type: String  
Required: No

## See Also
<a name="API_S3RecordingDetails_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/groundstation-2019-05-23/S3RecordingDetails) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/groundstation-2019-05-23/S3RecordingDetails) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/groundstation-2019-05-23/S3RecordingDetails) 

# SatelliteListItem
<a name="API_SatelliteListItem"></a>

Item in a list of satellites.

## Contents
<a name="API_SatelliteListItem_Contents"></a>

 ** currentEphemeris **   <a name="groundstation-Type-SatelliteListItem-currentEphemeris"></a>
The current ephemeris being used to compute the trajectory of the satellite.  
Type: [EphemerisMetaData](API_EphemerisMetaData.md) object  
Required: No

 ** groundStations **   <a name="groundstation-Type-SatelliteListItem-groundStations"></a>
A list of ground stations to which the satellite is on-boarded.  
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 500 items.  
Length Constraints: Minimum length of 4. Maximum length of 500.  
Pattern: `[ a-zA-Z0-9-._:=]{4,256}`   
Required: No

 ** noradSatelliteID **   <a name="groundstation-Type-SatelliteListItem-noradSatelliteID"></a>
NORAD satellite ID number.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 99999.  
Required: No

 ** satelliteArn **   <a name="groundstation-Type-SatelliteListItem-satelliteArn"></a>
ARN of a satellite.  
Type: String  
Length Constraints: Minimum length of 82. Maximum length of 132.  
Pattern: `arn:aws:groundstation:([-a-z0-9]{1,50})?:[0-9]{12}:satellite/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: No

 ** satelliteId **   <a name="groundstation-Type-SatelliteListItem-satelliteId"></a>
UUID of a satellite.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: No

## See Also
<a name="API_SatelliteListItem_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/groundstation-2019-05-23/SatelliteListItem) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/groundstation-2019-05-23/SatelliteListItem) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/groundstation-2019-05-23/SatelliteListItem) 

# SecurityDetails
<a name="API_SecurityDetails"></a>

Information about endpoints.

## Contents
<a name="API_SecurityDetails_Contents"></a>

 ** roleArn **   <a name="groundstation-Type-SecurityDetails-roleArn"></a>
ARN to a role needed for connecting streams to your instances.   
Type: String  
Length Constraints: Minimum length of 30. Maximum length of 165.  
Pattern: `arn:[a-z0-9-.]{1,63}:iam::[0-9]{12}:role/[\w+=,.@-]{1,64}`   
Required: Yes

 ** securityGroupIds **   <a name="groundstation-Type-SecurityDetails-securityGroupIds"></a>
The security groups to attach to the elastic network interfaces.  
Type: Array of strings  
Required: Yes

 ** subnetIds **   <a name="groundstation-Type-SecurityDetails-subnetIds"></a>
A list of subnets where AWS Ground Station places elastic network interfaces to send streams to your instances.  
Type: Array of strings  
Required: Yes

## See Also
<a name="API_SecurityDetails_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/groundstation-2019-05-23/SecurityDetails) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/groundstation-2019-05-23/SecurityDetails) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/groundstation-2019-05-23/SecurityDetails) 

# SocketAddress
<a name="API_SocketAddress"></a>

Information about the socket address.

## Contents
<a name="API_SocketAddress_Contents"></a>

 ** name **   <a name="groundstation-Type-SocketAddress-name"></a>
Name of a socket address.  
Type: String  
Required: Yes

 ** port **   <a name="groundstation-Type-SocketAddress-port"></a>
Port of a socket address.  
Type: Integer  
Required: Yes

## See Also
<a name="API_SocketAddress_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/groundstation-2019-05-23/SocketAddress) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/groundstation-2019-05-23/SocketAddress) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/groundstation-2019-05-23/SocketAddress) 

# Source
<a name="API_Source"></a>

Dataflow details for the source side.

## Contents
<a name="API_Source_Contents"></a>

 ** configDetails **   <a name="groundstation-Type-Source-configDetails"></a>
Additional details for a `Config`, if type is `dataflow-endpoint` or `antenna-downlink-demod-decode`   
Type: [ConfigDetails](API_ConfigDetails.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

 ** configId **   <a name="groundstation-Type-Source-configId"></a>
UUID of a `Config`.  
Type: String  
Required: No

 ** configType **   <a name="groundstation-Type-Source-configType"></a>
Type of a `Config`.  
Type: String  
Valid Values: `antenna-downlink | antenna-downlink-demod-decode | tracking | dataflow-endpoint | antenna-uplink | uplink-echo | s3-recording | telemetry-sink`   
Required: No

 ** dataflowSourceRegion **   <a name="groundstation-Type-Source-dataflowSourceRegion"></a>
Region of a dataflow source.  
Type: String  
Required: No

## See Also
<a name="API_Source_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/groundstation-2019-05-23/Source) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/groundstation-2019-05-23/Source) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/groundstation-2019-05-23/Source) 

# SpectrumConfig
<a name="API_SpectrumConfig"></a>

Object that describes a spectral `Config`.

## Contents
<a name="API_SpectrumConfig_Contents"></a>

 ** bandwidth **   <a name="groundstation-Type-SpectrumConfig-bandwidth"></a>
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.
Type: [FrequencyBandwidth](API_FrequencyBandwidth.md) object  
Required: Yes

 ** centerFrequency **   <a name="groundstation-Type-SpectrumConfig-centerFrequency"></a>
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.  
Type: [Frequency](API_Frequency.md) object  
Required: Yes

 ** polarization **   <a name="groundstation-Type-SpectrumConfig-polarization"></a>
Polarization of a spectral `Config`. Capturing both `"RIGHT_HAND"` and `"LEFT_HAND"` polarization requires two separate configs.  
Type: String  
Valid Values: `RIGHT_HAND | LEFT_HAND | NONE`   
Required: No

## See Also
<a name="API_SpectrumConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/groundstation-2019-05-23/SpectrumConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/groundstation-2019-05-23/SpectrumConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/groundstation-2019-05-23/SpectrumConfig) 

# TelemetrySinkConfig
<a name="API_TelemetrySinkConfig"></a>

Information about a telemetry sink `Config`.

## Contents
<a name="API_TelemetrySinkConfig_Contents"></a>

 ** telemetrySinkData **   <a name="groundstation-Type-TelemetrySinkConfig-telemetrySinkData"></a>
Information about the telemetry sink specified by the `telemetrySinkType`.  
Type: [TelemetrySinkData](API_TelemetrySinkData.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: Yes

 ** telemetrySinkType **   <a name="groundstation-Type-TelemetrySinkConfig-telemetrySinkType"></a>
The type of telemetry sink.  
Type: String  
Valid Values: `KINESIS_DATA_STREAM`   
Required: Yes

## See Also
<a name="API_TelemetrySinkConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/groundstation-2019-05-23/TelemetrySinkConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/groundstation-2019-05-23/TelemetrySinkConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/groundstation-2019-05-23/TelemetrySinkConfig) 

# TelemetrySinkData
<a name="API_TelemetrySinkData"></a>

Information about a telemetry sink.

## Contents
<a name="API_TelemetrySinkData_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** kinesisDataStreamData **   <a name="groundstation-Type-TelemetrySinkData-kinesisDataStreamData"></a>
Information about a telemetry sink of type `KINESIS_DATA_STREAM`.  
Type: [KinesisDataStreamData](API_KinesisDataStreamData.md) object  
Required: No

## See Also
<a name="API_TelemetrySinkData_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/groundstation-2019-05-23/TelemetrySinkData) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/groundstation-2019-05-23/TelemetrySinkData) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/groundstation-2019-05-23/TelemetrySinkData) 

# TimeAzEl
<a name="API_TimeAzEl"></a>

Time-tagged azimuth elevation pointing data.

Specifies the antenna pointing direction at a specific time offset from the segment's reference epoch.

## Contents
<a name="API_TimeAzEl_Contents"></a>

 ** az **   <a name="groundstation-Type-TimeAzEl-az"></a>
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
Type: Double  
Required: Yes

 ** dt **   <a name="groundstation-Type-TimeAzEl-dt"></a>
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
Type: Double  
Required: Yes

 ** el **   <a name="groundstation-Type-TimeAzEl-el"></a>
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 
Type: Double  
Required: Yes

## See Also
<a name="API_TimeAzEl_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/groundstation-2019-05-23/TimeAzEl) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/groundstation-2019-05-23/TimeAzEl) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/groundstation-2019-05-23/TimeAzEl) 

# TimeRange
<a name="API_TimeRange"></a>

A time range with a start and end time.

## Contents
<a name="API_TimeRange_Contents"></a>

 ** endTime **   <a name="groundstation-Type-TimeRange-endTime"></a>
Unix epoch timestamp in UTC at which the time range ends.  
Type: Timestamp  
Required: Yes

 ** startTime **   <a name="groundstation-Type-TimeRange-startTime"></a>
Unix epoch timestamp in UTC at which the time range starts.  
Type: Timestamp  
Required: Yes

## See Also
<a name="API_TimeRange_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/groundstation-2019-05-23/TimeRange) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/groundstation-2019-05-23/TimeRange) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/groundstation-2019-05-23/TimeRange) 

# TLEData
<a name="API_TLEData"></a>

Two-line element set (TLE) data.

## Contents
<a name="API_TLEData_Contents"></a>

 ** tleLine1 **   <a name="groundstation-Type-TLEData-tleLine1"></a>
First line of two-line element set (TLE) data.  
Type: String  
Length Constraints: Fixed length of 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]`   
Required: Yes

 ** tleLine2 **   <a name="groundstation-Type-TLEData-tleLine2"></a>
Second line of two-line element set (TLE) data.  
Type: String  
Length Constraints: Fixed length of 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]`   
Required: Yes

 ** validTimeRange **   <a name="groundstation-Type-TLEData-validTimeRange"></a>
The valid time range for the TLE. Time ranges must be continuous without gaps or overlaps.  
Type: [TimeRange](API_TimeRange.md) object  
Required: Yes

## See Also
<a name="API_TLEData_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/groundstation-2019-05-23/TLEData) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/groundstation-2019-05-23/TLEData) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/groundstation-2019-05-23/TLEData) 

# TLEEphemeris
<a name="API_TLEEphemeris"></a>

Two-line element set (TLE) ephemeris.

 For more detail about providing Two-line element sets to AWS Ground Station, see the [TLE section](https://docs.aws.amazon.com/ground-station/latest/ug/providing-tle-ephemeris-data.html) of the AWS Ground Station user guide. 

## Contents
<a name="API_TLEEphemeris_Contents"></a>

 ** s3Object **   <a name="groundstation-Type-TLEEphemeris-s3Object"></a>
The Amazon S3 object that contains the ephemeris data.  
Type: [S3Object](API_S3Object.md) object  
Required: No

 ** tleData **   <a name="groundstation-Type-TLEEphemeris-tleData"></a>
TLE data that you provide directly instead of using an Amazon S3 object.  
Type: Array of [TLEData](API_TLEData.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 500 items.  
Required: No

## See Also
<a name="API_TLEEphemeris_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/groundstation-2019-05-23/TLEEphemeris) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/groundstation-2019-05-23/TLEEphemeris) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/groundstation-2019-05-23/TLEEphemeris) 

# TrackingConfig
<a name="API_TrackingConfig"></a>

Object that determines whether tracking should be used during a contact executed with this `Config` in the mission profile.

## Contents
<a name="API_TrackingConfig_Contents"></a>

 ** autotrack **   <a name="groundstation-Type-TrackingConfig-autotrack"></a>
Current setting for autotrack.  
Type: String  
Valid Values: `REQUIRED | PREFERRED | REMOVED`   
Required: Yes

## See Also
<a name="API_TrackingConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/groundstation-2019-05-23/TrackingConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/groundstation-2019-05-23/TrackingConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/groundstation-2019-05-23/TrackingConfig) 

# TrackingOverrides
<a name="API_TrackingOverrides"></a>

Overrides the default tracking configuration on an antenna during a contact.

## Contents
<a name="API_TrackingOverrides_Contents"></a>

 ** programTrackSettings **   <a name="groundstation-Type-TrackingOverrides-programTrackSettings"></a>
Program track settings to override for antenna tracking during the contact.  
Type: [ProgramTrackSettings](API_ProgramTrackSettings.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: Yes

## See Also
<a name="API_TrackingOverrides_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/groundstation-2019-05-23/TrackingOverrides) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/groundstation-2019-05-23/TrackingOverrides) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/groundstation-2019-05-23/TrackingOverrides) 

# UplinkAwsGroundStationAgentEndpoint
<a name="API_UplinkAwsGroundStationAgentEndpoint"></a>

Definition for an uplink agent endpoint

## Contents
<a name="API_UplinkAwsGroundStationAgentEndpoint_Contents"></a>

 ** dataflowDetails **   <a name="groundstation-Type-UplinkAwsGroundStationAgentEndpoint-dataflowDetails"></a>
Dataflow details for the uplink endpoint  
Type: [UplinkDataflowDetails](API_UplinkDataflowDetails.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: Yes

 ** name **   <a name="groundstation-Type-UplinkAwsGroundStationAgentEndpoint-name"></a>
Uplink dataflow endpoint name  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[ a-zA-Z0-9_:-]{1,256}`   
Required: Yes

## See Also
<a name="API_UplinkAwsGroundStationAgentEndpoint_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/groundstation-2019-05-23/UplinkAwsGroundStationAgentEndpoint) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/groundstation-2019-05-23/UplinkAwsGroundStationAgentEndpoint) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/groundstation-2019-05-23/UplinkAwsGroundStationAgentEndpoint) 

# UplinkAwsGroundStationAgentEndpointDetails
<a name="API_UplinkAwsGroundStationAgentEndpointDetails"></a>

Details for an uplink agent endpoint

## Contents
<a name="API_UplinkAwsGroundStationAgentEndpointDetails_Contents"></a>

 ** dataflowDetails **   <a name="groundstation-Type-UplinkAwsGroundStationAgentEndpointDetails-dataflowDetails"></a>
Dataflow details for the uplink endpoint  
Type: [UplinkDataflowDetails](API_UplinkDataflowDetails.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: Yes

 ** name **   <a name="groundstation-Type-UplinkAwsGroundStationAgentEndpointDetails-name"></a>
Uplink dataflow endpoint name  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[ a-zA-Z0-9_:-]{1,256}`   
Required: Yes

 ** agentStatus **   <a name="groundstation-Type-UplinkAwsGroundStationAgentEndpointDetails-agentStatus"></a>
Status of the agent associated with the uplink dataflow endpoint  
Type: String  
Valid Values: `SUCCESS | FAILED | ACTIVE | INACTIVE`   
Required: No

 ** auditResults **   <a name="groundstation-Type-UplinkAwsGroundStationAgentEndpointDetails-auditResults"></a>
Health audit results for the uplink dataflow endpoint  
Type: String  
Valid Values: `HEALTHY | UNHEALTHY`   
Required: No

## See Also
<a name="API_UplinkAwsGroundStationAgentEndpointDetails_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/groundstation-2019-05-23/UplinkAwsGroundStationAgentEndpointDetails) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/groundstation-2019-05-23/UplinkAwsGroundStationAgentEndpointDetails) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/groundstation-2019-05-23/UplinkAwsGroundStationAgentEndpointDetails) 

# UplinkConnectionDetails
<a name="API_UplinkConnectionDetails"></a>

Connection details for customer to Agent and Agent to Ground Station

## Contents
<a name="API_UplinkConnectionDetails_Contents"></a>

 ** agentIpAndPortAddress **   <a name="groundstation-Type-UplinkConnectionDetails-agentIpAndPortAddress"></a>
Ingress address of AgentEndpoint with a port range and an optional mtu.  
Type: [RangedConnectionDetails](API_RangedConnectionDetails.md) object  
Required: Yes

 ** ingressAddressAndPort **   <a name="groundstation-Type-UplinkConnectionDetails-ingressAddressAndPort"></a>
Egress address of AgentEndpoint with an optional mtu.  
Type: [ConnectionDetails](API_ConnectionDetails.md) object  
Required: Yes

## See Also
<a name="API_UplinkConnectionDetails_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/groundstation-2019-05-23/UplinkConnectionDetails) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/groundstation-2019-05-23/UplinkConnectionDetails) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/groundstation-2019-05-23/UplinkConnectionDetails) 

# UplinkDataflowDetails
<a name="API_UplinkDataflowDetails"></a>

Dataflow details for an uplink endpoint

## Contents
<a name="API_UplinkDataflowDetails_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** agentConnectionDetails **   <a name="groundstation-Type-UplinkDataflowDetails-agentConnectionDetails"></a>
Uplink connection details for customer to Agent and Agent to Ground Station  
Type: [UplinkConnectionDetails](API_UplinkConnectionDetails.md) object  
Required: No

## See Also
<a name="API_UplinkDataflowDetails_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/groundstation-2019-05-23/UplinkDataflowDetails) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/groundstation-2019-05-23/UplinkDataflowDetails) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/groundstation-2019-05-23/UplinkDataflowDetails) 

# UplinkEchoConfig
<a name="API_UplinkEchoConfig"></a>

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.

## Contents
<a name="API_UplinkEchoConfig_Contents"></a>

 ** antennaUplinkConfigArn **   <a name="groundstation-Type-UplinkEchoConfig-antennaUplinkConfigArn"></a>
ARN of an uplink `Config`.  
Type: String  
Length Constraints: Minimum length of 82. Maximum length of 424.  
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})?`   
Required: Yes

 ** enabled **   <a name="groundstation-Type-UplinkEchoConfig-enabled"></a>
Whether or not an uplink `Config` is enabled.  
Type: Boolean  
Required: Yes

## See Also
<a name="API_UplinkEchoConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/groundstation-2019-05-23/UplinkEchoConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/groundstation-2019-05-23/UplinkEchoConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/groundstation-2019-05-23/UplinkEchoConfig) 

# UplinkSpectrumConfig
<a name="API_UplinkSpectrumConfig"></a>

Information about the uplink spectral `Config`.

## Contents
<a name="API_UplinkSpectrumConfig_Contents"></a>

 ** centerFrequency **   <a name="groundstation-Type-UplinkSpectrumConfig-centerFrequency"></a>
Center frequency of an uplink spectral `Config`. Valid values are between 2025 to 2120 MHz.  
Type: [Frequency](API_Frequency.md) object  
Required: Yes

 ** polarization **   <a name="groundstation-Type-UplinkSpectrumConfig-polarization"></a>
Polarization of an uplink spectral `Config`. Capturing both `"RIGHT_HAND"` and `"LEFT_HAND"` polarization requires two separate configs.  
Type: String  
Valid Values: `RIGHT_HAND | LEFT_HAND | NONE`   
Required: No

## See Also
<a name="API_UplinkSpectrumConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/groundstation-2019-05-23/UplinkSpectrumConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/groundstation-2019-05-23/UplinkSpectrumConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/groundstation-2019-05-23/UplinkSpectrumConfig)