Documentation

Index

Examples

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AngleUnits

type AngleUnits string
const (
	AngleUnitsDegreeAngle AngleUnits = "DEGREE_ANGLE"
	AngleUnitsRadian      AngleUnits = "RADIAN"
)

    Enum values for AngleUnits

    func (AngleUnits) Values

    func (AngleUnits) Values() []AngleUnits

      Values returns all known values for AngleUnits. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

      type AntennaDownlinkConfig

      type AntennaDownlinkConfig struct {
      
      	// Object that describes a spectral Config.
      	//
      	// This member is required.
      	SpectrumConfig *SpectrumConfig
      }

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

        type AntennaDownlinkDemodDecodeConfig

        type AntennaDownlinkDemodDecodeConfig struct {
        
        	// Information about the decode Config.
        	//
        	// This member is required.
        	DecodeConfig *DecodeConfig
        
        	// Information about the demodulation Config.
        	//
        	// This member is required.
        	DemodulationConfig *DemodulationConfig
        
        	// Information about the spectral Config.
        	//
        	// This member is required.
        	SpectrumConfig *SpectrumConfig
        }

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

          type AntennaUplinkConfig

          type AntennaUplinkConfig struct {
          
          	// Information about the uplink spectral Config.
          	//
          	// This member is required.
          	SpectrumConfig *UplinkSpectrumConfig
          
          	// EIRP of the target.
          	//
          	// This member is required.
          	TargetEirp *Eirp
          
          	TransmitDisabled *bool
          }

            Information about the uplink Config of an antenna.

            type BandwidthUnits

            type BandwidthUnits string
            const (
            	BandwidthUnitsGhz BandwidthUnits = "GHz"
            	BandwidthUnitsMhz BandwidthUnits = "MHz"
            	BandwidthUnitsKhz BandwidthUnits = "kHz"
            )

              Enum values for BandwidthUnits

              func (BandwidthUnits) Values

              func (BandwidthUnits) Values() []BandwidthUnits

                Values returns all known values for BandwidthUnits. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

                type ConfigCapabilityType

                type ConfigCapabilityType string
                const (
                	ConfigCapabilityTypeAntennaDownlink            ConfigCapabilityType = "antenna-downlink"
                	ConfigCapabilityTypeAntennaDownlinkDemodDecode ConfigCapabilityType = "antenna-downlink-demod-decode"
                	ConfigCapabilityTypeTracking                   ConfigCapabilityType = "tracking"
                	ConfigCapabilityTypeDataflowEndpoint           ConfigCapabilityType = "dataflow-endpoint"
                	ConfigCapabilityTypeAntennaUplink              ConfigCapabilityType = "antenna-uplink"
                	ConfigCapabilityTypeUplinkEcho                 ConfigCapabilityType = "uplink-echo"
                )

                  Enum values for ConfigCapabilityType

                  func (ConfigCapabilityType) Values

                    Values returns all known values for ConfigCapabilityType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

                    type ConfigListItem

                    type ConfigListItem struct {
                    
                    	// ARN of a Config.
                    	ConfigArn *string
                    
                    	// UUID of a Config.
                    	ConfigId *string
                    
                    	// Type of a Config.
                    	ConfigType ConfigCapabilityType
                    
                    	// Name of a Config.
                    	Name *string
                    }

                      An item in a list of Config objects.

                      type ConfigTypeData

                      type ConfigTypeData interface {
                      	// contains filtered or unexported methods
                      }

                        Object containing the parameters of a Config. See the subtype definitions for what each type of Config contains.

                        The following types satisfy this interface:

                        ConfigTypeDataMemberAntennaDownlinkConfig
                        ConfigTypeDataMemberAntennaDownlinkDemodDecodeConfig
                        ConfigTypeDataMemberAntennaUplinkConfig
                        ConfigTypeDataMemberDataflowEndpointConfig
                        ConfigTypeDataMemberTrackingConfig
                        ConfigTypeDataMemberUplinkEchoConfig
                        
                        Example (OutputUsage)
                        Output:
                        
                        

                        type ConfigTypeDataMemberAntennaDownlinkConfig

                        type ConfigTypeDataMemberAntennaDownlinkConfig struct {
                        	Value AntennaDownlinkConfig
                        }

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

                          type ConfigTypeDataMemberAntennaDownlinkDemodDecodeConfig

                          type ConfigTypeDataMemberAntennaDownlinkDemodDecodeConfig struct {
                          	Value AntennaDownlinkDemodDecodeConfig
                          }

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

                            type ConfigTypeDataMemberAntennaUplinkConfig

                            type ConfigTypeDataMemberAntennaUplinkConfig struct {
                            	Value AntennaUplinkConfig
                            }

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

                              type ConfigTypeDataMemberDataflowEndpointConfig

                              type ConfigTypeDataMemberDataflowEndpointConfig struct {
                              	Value DataflowEndpointConfig
                              }

                                Information about the dataflow endpoint Config.

                                type ConfigTypeDataMemberTrackingConfig

                                type ConfigTypeDataMemberTrackingConfig struct {
                                	Value TrackingConfig
                                }

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

                                  type ConfigTypeDataMemberUplinkEchoConfig

                                  type ConfigTypeDataMemberUplinkEchoConfig struct {
                                  	Value UplinkEchoConfig
                                  }

                                    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 ContactData

                                    type ContactData struct {
                                    
                                    	// UUID of a contact.
                                    	ContactId *string
                                    
                                    	// Status of a contact.
                                    	ContactStatus ContactStatus
                                    
                                    	// End time of a contact.
                                    	EndTime *time.Time
                                    
                                    	// Error message of a contact.
                                    	ErrorMessage *string
                                    
                                    	// Name of a ground station.
                                    	GroundStation *string
                                    
                                    	// Maximum elevation angle of a contact.
                                    	MaximumElevation *Elevation
                                    
                                    	// ARN of a mission profile.
                                    	MissionProfileArn *string
                                    
                                    	// Amount of time after a contact ends that you’d like to receive a CloudWatch
                                    	// event indicating the pass has finished.
                                    	PostPassEndTime *time.Time
                                    
                                    	// Amount of time prior to contact start you’d like to receive a CloudWatch event
                                    	// indicating an upcoming pass.
                                    	PrePassStartTime *time.Time
                                    
                                    	// Region of a contact.
                                    	Region *string
                                    
                                    	// ARN of a satellite.
                                    	SatelliteArn *string
                                    
                                    	// Start time of a contact.
                                    	StartTime *time.Time
                                    
                                    	// Tags assigned to a contact.
                                    	Tags map[string]string
                                    }

                                      Data describing a contact.

                                      type ContactStatus

                                      type ContactStatus string
                                      const (
                                      	ContactStatusScheduling       ContactStatus = "SCHEDULING"
                                      	ContactStatusFailedToSchedule ContactStatus = "FAILED_TO_SCHEDULE"
                                      	ContactStatusScheduled        ContactStatus = "SCHEDULED"
                                      	ContactStatusCancelled        ContactStatus = "CANCELLED"
                                      	ContactStatusAwsCancelled     ContactStatus = "AWS_CANCELLED"
                                      	ContactStatusPrepass          ContactStatus = "PREPASS"
                                      	ContactStatusPass             ContactStatus = "PASS"
                                      	ContactStatusPostpass         ContactStatus = "POSTPASS"
                                      	ContactStatusCompleted        ContactStatus = "COMPLETED"
                                      	ContactStatusFailed           ContactStatus = "FAILED"
                                      	ContactStatusAvailable        ContactStatus = "AVAILABLE"
                                      	ContactStatusCancelling       ContactStatus = "CANCELLING"
                                      )

                                        Enum values for ContactStatus

                                        func (ContactStatus) Values

                                        func (ContactStatus) Values() []ContactStatus

                                          Values returns all known values for ContactStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

                                          type Criticality

                                          type Criticality string
                                          const (
                                          	CriticalityRequired  Criticality = "REQUIRED"
                                          	CriticalityPreferred Criticality = "PREFERRED"
                                          	CriticalityRemoved   Criticality = "REMOVED"
                                          )

                                            Enum values for Criticality

                                            func (Criticality) Values

                                            func (Criticality) Values() []Criticality

                                              Values returns all known values for Criticality. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

                                              type DataflowEndpoint

                                              type DataflowEndpoint struct {
                                              
                                              	// Socket address of a dataflow endpoint.
                                              	Address *SocketAddress
                                              
                                              	Mtu *int32
                                              
                                              	// Name of a dataflow endpoint.
                                              	Name *string
                                              
                                              	// Status of a dataflow endpoint.
                                              	Status EndpointStatus
                                              }

                                                Information about a dataflow endpoint.

                                                type DataflowEndpointConfig

                                                type DataflowEndpointConfig struct {
                                                
                                                	// Name of a dataflow endpoint.
                                                	//
                                                	// This member is required.
                                                	DataflowEndpointName *string
                                                
                                                	// Region of a dataflow endpoint.
                                                	DataflowEndpointRegion *string
                                                }

                                                  Information about the dataflow endpoint Config.

                                                  type DataflowEndpointListItem

                                                  type DataflowEndpointListItem struct {
                                                  
                                                  	// ARN of a dataflow endpoint group.
                                                  	DataflowEndpointGroupArn *string
                                                  
                                                  	// UUID of a dataflow endpoint group.
                                                  	DataflowEndpointGroupId *string
                                                  }

                                                    Item in a list of DataflowEndpoint groups.

                                                    type DecodeConfig

                                                    type DecodeConfig struct {
                                                    
                                                    	// Unvalidated JSON of a decode Config.
                                                    	//
                                                    	// This member is required.
                                                    	UnvalidatedJSON *string
                                                    }

                                                      Information about the decode Config.

                                                      type DemodulationConfig

                                                      type DemodulationConfig struct {
                                                      
                                                      	// Unvalidated JSON of a demodulation Config.
                                                      	//
                                                      	// This member is required.
                                                      	UnvalidatedJSON *string
                                                      }

                                                        Information about the demodulation Config.

                                                        type DependencyException

                                                        type DependencyException struct {
                                                        	Message *string
                                                        
                                                        	ParameterName *string
                                                        }

                                                          Dependency encountered an error.

                                                          func (*DependencyException) Error

                                                          func (e *DependencyException) Error() string

                                                          func (*DependencyException) ErrorCode

                                                          func (e *DependencyException) ErrorCode() string

                                                          func (*DependencyException) ErrorFault

                                                          func (e *DependencyException) ErrorFault() smithy.ErrorFault

                                                          func (*DependencyException) ErrorMessage

                                                          func (e *DependencyException) ErrorMessage() string

                                                          type Eirp

                                                          type Eirp struct {
                                                          
                                                          	// Units of an EIRP.
                                                          	//
                                                          	// This member is required.
                                                          	Units EirpUnits
                                                          
                                                          	// Value of an EIRP.
                                                          	//
                                                          	// This member is required.
                                                          	Value *float64
                                                          }

                                                            Object that represents EIRP.

                                                            type EirpUnits

                                                            type EirpUnits string
                                                            const (
                                                            	EirpUnitsDbw EirpUnits = "dBW"
                                                            )

                                                              Enum values for EirpUnits

                                                              func (EirpUnits) Values

                                                              func (EirpUnits) Values() []EirpUnits

                                                                Values returns all known values for EirpUnits. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

                                                                type Elevation

                                                                type Elevation struct {
                                                                
                                                                	// Elevation angle units.
                                                                	//
                                                                	// This member is required.
                                                                	Unit AngleUnits
                                                                
                                                                	// Elevation angle value.
                                                                	//
                                                                	// This member is required.
                                                                	Value *float64
                                                                }

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

                                                                  type EndpointDetails

                                                                  type EndpointDetails struct {
                                                                  
                                                                  	// A dataflow endpoint.
                                                                  	Endpoint *DataflowEndpoint
                                                                  
                                                                  	// Endpoint security details.
                                                                  	SecurityDetails *SecurityDetails
                                                                  }

                                                                    Information about the endpoint details.

                                                                    type EndpointStatus

                                                                    type EndpointStatus string
                                                                    const (
                                                                    	EndpointStatusCreated  EndpointStatus = "created"
                                                                    	EndpointStatusCreating EndpointStatus = "creating"
                                                                    	EndpointStatusDeleted  EndpointStatus = "deleted"
                                                                    	EndpointStatusDeleting EndpointStatus = "deleting"
                                                                    	EndpointStatusFailed   EndpointStatus = "failed"
                                                                    )

                                                                      Enum values for EndpointStatus

                                                                      func (EndpointStatus) Values

                                                                      func (EndpointStatus) Values() []EndpointStatus

                                                                        Values returns all known values for EndpointStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

                                                                        type Frequency

                                                                        type Frequency struct {
                                                                        
                                                                        	// Frequency units.
                                                                        	//
                                                                        	// This member is required.
                                                                        	Units FrequencyUnits
                                                                        
                                                                        	// Frequency value.
                                                                        	//
                                                                        	// This member is required.
                                                                        	Value *float64
                                                                        }

                                                                          Object that describes the frequency.

                                                                          type FrequencyBandwidth

                                                                          type FrequencyBandwidth struct {
                                                                          
                                                                          	// Frequency bandwidth units.
                                                                          	//
                                                                          	// This member is required.
                                                                          	Units BandwidthUnits
                                                                          
                                                                          	// Frequency bandwidth value.
                                                                          	//
                                                                          	// This member is required.
                                                                          	Value *float64
                                                                          }

                                                                            Object that describes the frequency bandwidth.

                                                                            type FrequencyUnits

                                                                            type FrequencyUnits string
                                                                            const (
                                                                            	FrequencyUnitsGhz FrequencyUnits = "GHz"
                                                                            	FrequencyUnitsMhz FrequencyUnits = "MHz"
                                                                            	FrequencyUnitsKhz FrequencyUnits = "kHz"
                                                                            )

                                                                              Enum values for FrequencyUnits

                                                                              func (FrequencyUnits) Values

                                                                              func (FrequencyUnits) Values() []FrequencyUnits

                                                                                Values returns all known values for FrequencyUnits. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

                                                                                type GroundStationData

                                                                                type GroundStationData struct {
                                                                                
                                                                                	// UUID of a ground station.
                                                                                	GroundStationId *string
                                                                                
                                                                                	// Name of a ground station.
                                                                                	GroundStationName *string
                                                                                
                                                                                	// Ground station Region.
                                                                                	Region *string
                                                                                }

                                                                                  Information about the ground station data.

                                                                                  type InvalidParameterException

                                                                                  type InvalidParameterException struct {
                                                                                  	Message *string
                                                                                  
                                                                                  	ParameterName *string
                                                                                  }

                                                                                    One or more parameters are not valid.

                                                                                    func (*InvalidParameterException) Error

                                                                                    func (e *InvalidParameterException) Error() string

                                                                                    func (*InvalidParameterException) ErrorCode

                                                                                    func (e *InvalidParameterException) ErrorCode() string

                                                                                    func (*InvalidParameterException) ErrorFault

                                                                                    func (*InvalidParameterException) ErrorMessage

                                                                                    func (e *InvalidParameterException) ErrorMessage() string

                                                                                    type MissionProfileListItem

                                                                                    type MissionProfileListItem struct {
                                                                                    
                                                                                    	// ARN of a mission profile.
                                                                                    	MissionProfileArn *string
                                                                                    
                                                                                    	// UUID of a mission profile.
                                                                                    	MissionProfileId *string
                                                                                    
                                                                                    	// Name of a mission profile.
                                                                                    	Name *string
                                                                                    
                                                                                    	// Region of a mission profile.
                                                                                    	Region *string
                                                                                    }

                                                                                      Item in a list of mission profiles.

                                                                                      type Polarization

                                                                                      type Polarization string
                                                                                      const (
                                                                                      	PolarizationRightHand Polarization = "RIGHT_HAND"
                                                                                      	PolarizationLeftHand  Polarization = "LEFT_HAND"
                                                                                      	PolarizationNone      Polarization = "NONE"
                                                                                      )

                                                                                        Enum values for Polarization

                                                                                        func (Polarization) Values

                                                                                        func (Polarization) Values() []Polarization

                                                                                          Values returns all known values for Polarization. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

                                                                                          type ResourceLimitExceededException

                                                                                          type ResourceLimitExceededException struct {
                                                                                          	Message *string
                                                                                          
                                                                                          	ParameterName *string
                                                                                          }

                                                                                            Account limits for this resource have been exceeded.

                                                                                            func (*ResourceLimitExceededException) Error

                                                                                            func (*ResourceLimitExceededException) ErrorCode

                                                                                            func (e *ResourceLimitExceededException) ErrorCode() string

                                                                                            func (*ResourceLimitExceededException) ErrorFault

                                                                                            func (*ResourceLimitExceededException) ErrorMessage

                                                                                            func (e *ResourceLimitExceededException) ErrorMessage() string

                                                                                            type ResourceNotFoundException

                                                                                            type ResourceNotFoundException struct {
                                                                                            	Message *string
                                                                                            }

                                                                                              Resource was not found.

                                                                                              func (*ResourceNotFoundException) Error

                                                                                              func (e *ResourceNotFoundException) Error() string

                                                                                              func (*ResourceNotFoundException) ErrorCode

                                                                                              func (e *ResourceNotFoundException) ErrorCode() string

                                                                                              func (*ResourceNotFoundException) ErrorFault

                                                                                              func (*ResourceNotFoundException) ErrorMessage

                                                                                              func (e *ResourceNotFoundException) ErrorMessage() string

                                                                                              type SatelliteListItem

                                                                                              type SatelliteListItem struct {
                                                                                              
                                                                                              	// A list of ground stations to which the satellite is on-boarded.
                                                                                              	GroundStations []string
                                                                                              
                                                                                              	// NORAD satellite ID number.
                                                                                              	NoradSatelliteID int32
                                                                                              
                                                                                              	// ARN of a satellite.
                                                                                              	SatelliteArn *string
                                                                                              
                                                                                              	// UUID of a satellite.
                                                                                              	SatelliteId *string
                                                                                              }

                                                                                                Item in a list of satellites.

                                                                                                type SecurityDetails

                                                                                                type SecurityDetails struct {
                                                                                                
                                                                                                	// ARN to a role needed for connecting streams to your instances.
                                                                                                	//
                                                                                                	// This member is required.
                                                                                                	RoleArn *string
                                                                                                
                                                                                                	// The security groups to attach to the elastic network interfaces.
                                                                                                	//
                                                                                                	// This member is required.
                                                                                                	SecurityGroupIds []string
                                                                                                
                                                                                                	// A list of subnets where AWS Ground Station places elastic network interfaces to
                                                                                                	// send streams to your instances.
                                                                                                	//
                                                                                                	// This member is required.
                                                                                                	SubnetIds []string
                                                                                                }

                                                                                                  Information about endpoints.

                                                                                                  type SocketAddress

                                                                                                  type SocketAddress struct {
                                                                                                  
                                                                                                  	// Name of a socket address.
                                                                                                  	//
                                                                                                  	// This member is required.
                                                                                                  	Name *string
                                                                                                  
                                                                                                  	// Port of a socket address.
                                                                                                  	//
                                                                                                  	// This member is required.
                                                                                                  	Port *int32
                                                                                                  }

                                                                                                    Information about the socket address.

                                                                                                    type SpectrumConfig

                                                                                                    type SpectrumConfig struct {
                                                                                                    
                                                                                                    	// Bandwidth of a spectral Config.
                                                                                                    	//
                                                                                                    	// This member is required.
                                                                                                    	Bandwidth *FrequencyBandwidth
                                                                                                    
                                                                                                    	// Center frequency of a spectral Config.
                                                                                                    	//
                                                                                                    	// This member is required.
                                                                                                    	CenterFrequency *Frequency
                                                                                                    
                                                                                                    	// Polarization of a spectral Config.
                                                                                                    	Polarization Polarization
                                                                                                    }

                                                                                                      Object that describes a spectral Config.

                                                                                                      type TrackingConfig

                                                                                                      type TrackingConfig struct {
                                                                                                      
                                                                                                      	// Current setting for autotrack.
                                                                                                      	//
                                                                                                      	// This member is required.
                                                                                                      	Autotrack Criticality
                                                                                                      }

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

                                                                                                        type UnknownUnionMember

                                                                                                        type UnknownUnionMember struct {
                                                                                                        	Tag   string
                                                                                                        	Value []byte
                                                                                                        }

                                                                                                          UnknownUnionMember is returned when a union member is returned over the wire, but has an unknown tag.

                                                                                                          type UplinkEchoConfig

                                                                                                          type UplinkEchoConfig struct {
                                                                                                          
                                                                                                          	// ARN of an uplink Config.
                                                                                                          	//
                                                                                                          	// This member is required.
                                                                                                          	AntennaUplinkConfigArn *string
                                                                                                          
                                                                                                          	// Whether or not an uplink Config is enabled.
                                                                                                          	//
                                                                                                          	// This member is required.
                                                                                                          	Enabled *bool
                                                                                                          }

                                                                                                            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 UplinkSpectrumConfig

                                                                                                            type UplinkSpectrumConfig struct {
                                                                                                            
                                                                                                            	// Center frequency of an uplink spectral Config.
                                                                                                            	//
                                                                                                            	// This member is required.
                                                                                                            	CenterFrequency *Frequency
                                                                                                            
                                                                                                            	// Polarization of an uplink spectral Config.
                                                                                                            	Polarization Polarization
                                                                                                            }

                                                                                                              Information about the uplink spectral Config.