types

package
v1.27.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 3, 2024 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Index

Examples

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AgentDetails added in v1.17.0

type AgentDetails struct {

	// Current agent version.
	//
	// This member is required.
	AgentVersion *string

	// List of versions being used by agent components.
	//
	// This member is required.
	ComponentVersions []ComponentVersion

	// ID of EC2 instance agent is running on.
	//
	// This member is required.
	InstanceId *string

	// Type of EC2 instance agent is running on.
	//
	// This member is required.
	InstanceType *string

	// List of CPU cores reserved for the agent.
	AgentCpuCores []int32

	// 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.
	ReservedCpuCores []int32
	// contains filtered or unexported fields
}

Detailed information about the agent.

type AgentStatus added in v1.17.0

type AgentStatus string
const (
	AgentStatusSuccess  AgentStatus = "SUCCESS"
	AgentStatusFailed   AgentStatus = "FAILED"
	AgentStatusActive   AgentStatus = "ACTIVE"
	AgentStatusInactive AgentStatus = "INACTIVE"
)

Enum values for AgentStatus

func (AgentStatus) Values added in v1.17.0

func (AgentStatus) Values() []AgentStatus

Values returns all known values for AgentStatus. 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 AggregateStatus added in v1.17.0

type AggregateStatus struct {

	// Aggregate status.
	//
	// This member is required.
	Status AgentStatus

	// Sparse map of failure signatures.
	SignatureMap map[string]bool
	// contains filtered or unexported fields
}

Aggregate status of Agent components.

type AngleUnits

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

Enum values for AngleUnits

func (AngleUnits) Values added in v0.29.0

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 AntennaDemodDecodeDetails added in v1.2.0

type AntennaDemodDecodeDetails struct {

	// Name of an antenna demod decode output node used in a contact.
	OutputNode *string
	// contains filtered or unexported fields
}

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

type AntennaDownlinkConfig

type AntennaDownlinkConfig struct {

	// Object that describes a spectral Config .
	//
	// This member is required.
	SpectrumConfig *SpectrumConfig
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

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

	// Whether or not uplink transmit is disabled.
	TransmitDisabled *bool
	// contains filtered or unexported fields
}

Information about the uplink Config of an antenna.

type AuditResults added in v1.17.0

type AuditResults string
const (
	AuditResultsHealthy   AuditResults = "HEALTHY"
	AuditResultsUnhealthy AuditResults = "UNHEALTHY"
)

Enum values for AuditResults

func (AuditResults) Values added in v1.17.0

func (AuditResults) Values() []AuditResults

Values returns all known values for AuditResults. 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 AwsGroundStationAgentEndpoint added in v1.17.0

type AwsGroundStationAgentEndpoint struct {

	// The egress address of AgentEndpoint.
	//
	// This member is required.
	EgressAddress *ConnectionDetails

	// The ingress address of AgentEndpoint.
	//
	// This member is required.
	IngressAddress *RangedConnectionDetails

	// Name string associated with AgentEndpoint. Used as a human-readable identifier
	// for AgentEndpoint.
	//
	// This member is required.
	Name *string

	// The status of AgentEndpoint.
	AgentStatus AgentStatus

	// The results of the audit.
	AuditResults AuditResults
	// contains filtered or unexported fields
}

Information about AwsGroundStationAgentEndpoint.

type BandwidthUnits

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

Enum values for BandwidthUnits

func (BandwidthUnits) Values added in v0.29.0

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 CapabilityHealth added in v1.18.0

type CapabilityHealth string
const (
	CapabilityHealthUnhealthy CapabilityHealth = "UNHEALTHY"
	CapabilityHealthHealthy   CapabilityHealth = "HEALTHY"
)

Enum values for CapabilityHealth

func (CapabilityHealth) Values added in v1.18.0

Values returns all known values for CapabilityHealth. 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 CapabilityHealthReason added in v1.18.0

type CapabilityHealthReason string
const (
	CapabilityHealthReasonNoRegisteredAgent        CapabilityHealthReason = "NO_REGISTERED_AGENT"
	CapabilityHealthReasonInvalidIpOwnership       CapabilityHealthReason = "INVALID_IP_OWNERSHIP"
	CapabilityHealthReasonNotAuthorizedToCreateSlr CapabilityHealthReason = "NOT_AUTHORIZED_TO_CREATE_SLR"
	CapabilityHealthReasonUnverifiedIpOwnership    CapabilityHealthReason = "UNVERIFIED_IP_OWNERSHIP"
	CapabilityHealthReasonInitializingDataplane    CapabilityHealthReason = "INITIALIZING_DATAPLANE"
	CapabilityHealthReasonDataplaneFailure         CapabilityHealthReason = "DATAPLANE_FAILURE"
	CapabilityHealthReasonHealthy                  CapabilityHealthReason = "HEALTHY"
)

Enum values for CapabilityHealthReason

func (CapabilityHealthReason) Values added in v1.18.0

Values returns all known values for CapabilityHealthReason. 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 ComponentStatusData added in v1.17.0

type ComponentStatusData struct {

	// Capability ARN of the component.
	//
	// This member is required.
	CapabilityArn *string

	// The Component type.
	//
	// This member is required.
	ComponentType *string

	// Dataflow UUID associated with the component.
	//
	// This member is required.
	DataflowId *string

	// Component status.
	//
	// This member is required.
	Status AgentStatus

	// Bytes received by the component.
	BytesReceived *int64

	// Bytes sent by the component.
	BytesSent *int64

	// Packets dropped by component.
	PacketsDropped *int64
	// contains filtered or unexported fields
}

Data on the status of agent components.

type ComponentVersion added in v1.17.0

type ComponentVersion struct {

	// Component type.
	//
	// This member is required.
	ComponentType *string

	// List of versions.
	//
	// This member is required.
	Versions []string
	// contains filtered or unexported fields
}

Version information for agent components.

type ConfigCapabilityType

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

Enum values for ConfigCapabilityType

func (ConfigCapabilityType) Values added in v0.29.0

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 ConfigDetails added in v1.2.0

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

Details for certain Config object types in a contact.

The following types satisfy this interface:

ConfigDetailsMemberAntennaDemodDecodeDetails
ConfigDetailsMemberEndpointDetails
ConfigDetailsMemberS3RecordingDetails
Example (OutputUsage)
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/groundstation/types"
)

func main() {
	var union types.ConfigDetails
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.ConfigDetailsMemberAntennaDemodDecodeDetails:
		_ = v.Value // Value is types.AntennaDemodDecodeDetails

	case *types.ConfigDetailsMemberEndpointDetails:
		_ = v.Value // Value is types.EndpointDetails

	case *types.ConfigDetailsMemberS3RecordingDetails:
		_ = v.Value // Value is types.S3RecordingDetails

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}
Output:

type ConfigDetailsMemberAntennaDemodDecodeDetails added in v1.2.0

type ConfigDetailsMemberAntennaDemodDecodeDetails struct {
	Value AntennaDemodDecodeDetails
	// contains filtered or unexported fields
}

Details for antenna demod decode Config in a contact.

type ConfigDetailsMemberEndpointDetails added in v1.2.0

type ConfigDetailsMemberEndpointDetails struct {
	Value EndpointDetails
	// contains filtered or unexported fields
}

Information about the endpoint details.

type ConfigDetailsMemberS3RecordingDetails added in v1.3.0

type ConfigDetailsMemberS3RecordingDetails struct {
	Value S3RecordingDetails
	// contains filtered or unexported fields
}

Details for an S3 recording Config in a contact.

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
	// contains filtered or unexported fields
}

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
ConfigTypeDataMemberS3RecordingConfig
ConfigTypeDataMemberTrackingConfig
ConfigTypeDataMemberUplinkEchoConfig
Example (OutputUsage)
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/groundstation/types"
)

func main() {
	var union types.ConfigTypeData
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.ConfigTypeDataMemberAntennaDownlinkConfig:
		_ = v.Value // Value is types.AntennaDownlinkConfig

	case *types.ConfigTypeDataMemberAntennaDownlinkDemodDecodeConfig:
		_ = v.Value // Value is types.AntennaDownlinkDemodDecodeConfig

	case *types.ConfigTypeDataMemberAntennaUplinkConfig:
		_ = v.Value // Value is types.AntennaUplinkConfig

	case *types.ConfigTypeDataMemberDataflowEndpointConfig:
		_ = v.Value // Value is types.DataflowEndpointConfig

	case *types.ConfigTypeDataMemberS3RecordingConfig:
		_ = v.Value // Value is types.S3RecordingConfig

	case *types.ConfigTypeDataMemberTrackingConfig:
		_ = v.Value // Value is types.TrackingConfig

	case *types.ConfigTypeDataMemberUplinkEchoConfig:
		_ = v.Value // Value is types.UplinkEchoConfig

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}
Output:

type ConfigTypeDataMemberAntennaDownlinkConfig

type ConfigTypeDataMemberAntennaDownlinkConfig struct {
	Value AntennaDownlinkConfig
	// contains filtered or unexported fields
}

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

type ConfigTypeDataMemberAntennaDownlinkDemodDecodeConfig

type ConfigTypeDataMemberAntennaDownlinkDemodDecodeConfig struct {
	Value AntennaDownlinkDemodDecodeConfig
	// contains filtered or unexported fields
}

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

type ConfigTypeDataMemberAntennaUplinkConfig

type ConfigTypeDataMemberAntennaUplinkConfig struct {
	Value AntennaUplinkConfig
	// contains filtered or unexported fields
}

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

type ConfigTypeDataMemberDataflowEndpointConfig

type ConfigTypeDataMemberDataflowEndpointConfig struct {
	Value DataflowEndpointConfig
	// contains filtered or unexported fields
}

Information about the dataflow endpoint Config .

type ConfigTypeDataMemberS3RecordingConfig added in v1.3.0

type ConfigTypeDataMemberS3RecordingConfig struct {
	Value S3RecordingConfig
	// contains filtered or unexported fields
}

Information about an S3 recording Config .

type ConfigTypeDataMemberTrackingConfig

type ConfigTypeDataMemberTrackingConfig struct {
	Value TrackingConfig
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

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 ConnectionDetails added in v1.17.0

type ConnectionDetails struct {

	// A socket address.
	//
	// This member is required.
	SocketAddress *SocketAddress

	// Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.
	Mtu *int32
	// contains filtered or unexported fields
}

Egress address of AgentEndpoint with an optional mtu.

type ContactData

type ContactData struct {

	// UUID of a contact.
	ContactId *string

	// Status of a contact.
	ContactStatus ContactStatus

	// End time of a contact in UTC.
	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 in UTC.
	StartTime *time.Time

	// Tags assigned to a contact.
	Tags map[string]string

	// 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.
	VisibilityEndTime *time.Time

	// 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.
	VisibilityStartTime *time.Time
	// contains filtered or unexported fields
}

Data describing a contact.

type ContactStatus

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

Enum values for ContactStatus

func (ContactStatus) Values added in v0.29.0

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 (
	CriticalityPreferred Criticality = "PREFERRED"
	CriticalityRemoved   Criticality = "REMOVED"
	CriticalityRequired  Criticality = "REQUIRED"
)

Enum values for Criticality

func (Criticality) Values added in v0.29.0

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 DataflowDetail added in v1.2.0

type DataflowDetail struct {

	// Dataflow details for the destination side.
	Destination *Destination

	// Error message for a dataflow.
	ErrorMessage *string

	// Dataflow details for the source side.
	Source *Source
	// contains filtered or unexported fields
}

Information about a dataflow edge used in a contact.

type DataflowEndpoint

type DataflowEndpoint struct {

	// Socket address of a dataflow endpoint.
	Address *SocketAddress

	// Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.
	Mtu *int32

	// Name of a dataflow endpoint.
	Name *string

	// Status of a dataflow endpoint.
	Status EndpointStatus
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

Item in a list of DataflowEndpoint groups.

type DecodeConfig

type DecodeConfig struct {

	// Unvalidated JSON of a decode Config .
	//
	// This member is required.
	UnvalidatedJSON *string
	// contains filtered or unexported fields
}

Information about the decode Config .

type DemodulationConfig

type DemodulationConfig struct {

	// Unvalidated JSON of a demodulation Config .
	//
	// This member is required.
	UnvalidatedJSON *string
	// contains filtered or unexported fields
}

Information about the demodulation Config .

type DependencyException

type DependencyException struct {
	Message *string

	ErrorCodeOverride *string

	ParameterName *string
	// contains filtered or unexported fields
}

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 Destination added in v1.2.0

type Destination struct {

	// Additional details for a Config , if type is dataflow endpoint or antenna demod
	// decode.
	ConfigDetails ConfigDetails

	// UUID of a Config .
	ConfigId *string

	// Type of a Config .
	ConfigType ConfigCapabilityType

	// Region of a dataflow destination.
	DataflowDestinationRegion *string
	// contains filtered or unexported fields
}

Dataflow details for the destination side.

type DiscoveryData added in v1.17.0

type DiscoveryData struct {

	// List of capabilities to associate with agent.
	//
	// This member is required.
	CapabilityArns []string

	// List of private IP addresses to associate with agent.
	//
	// This member is required.
	PrivateIpAddresses []string

	// List of public IP addresses to associate with agent.
	//
	// This member is required.
	PublicIpAddresses []string
	// contains filtered or unexported fields
}

Data for agent discovery.

type Eirp

type Eirp struct {

	// Units of an EIRP.
	//
	// This member is required.
	Units EirpUnits

	// Value of an EIRP. Valid values are between 20.0 to 50.0 dBW.
	//
	// This member is required.
	Value *float64
	// contains filtered or unexported fields
}

Object that represents EIRP.

type EirpUnits

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

Enum values for EirpUnits

func (EirpUnits) Values added in v0.29.0

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
	// contains filtered or unexported fields
}

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

type EndpointDetails

type EndpointDetails struct {

	// An agent endpoint.
	AwsGroundStationAgentEndpoint *AwsGroundStationAgentEndpoint

	// A dataflow endpoint.
	Endpoint *DataflowEndpoint

	// Health reasons for a dataflow endpoint. This field is ignored when calling
	// CreateDataflowEndpointGroup .
	HealthReasons []CapabilityHealthReason

	// A dataflow endpoint health status. This field is ignored when calling
	// CreateDataflowEndpointGroup .
	HealthStatus CapabilityHealth

	// Endpoint security details including a list of subnets, a list of security
	// groups and a role to connect streams to instances.
	SecurityDetails *SecurityDetails
	// contains filtered or unexported fields
}

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 added in v0.29.0

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 EphemerisData added in v1.14.0

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

Ephemeris data.

The following types satisfy this interface:

EphemerisDataMemberOem
EphemerisDataMemberTle
Example (OutputUsage)
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/groundstation/types"
)

func main() {
	var union types.EphemerisData
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.EphemerisDataMemberOem:
		_ = v.Value // Value is types.OEMEphemeris

	case *types.EphemerisDataMemberTle:
		_ = v.Value // Value is types.TLEEphemeris

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}
Output:

type EphemerisDataMemberOem added in v1.14.0

type EphemerisDataMemberOem struct {
	Value OEMEphemeris
	// contains filtered or unexported fields
}

Ephemeris data in Orbit Ephemeris Message (OEM) format.

type EphemerisDataMemberTle added in v1.14.0

type EphemerisDataMemberTle struct {
	Value TLEEphemeris
	// contains filtered or unexported fields
}

Two-line element set (TLE) ephemeris.

type EphemerisDescription added in v1.14.0

type EphemerisDescription struct {

	// Supplied ephemeris data.
	EphemerisData *string

	// Source S3 object used for the ephemeris.
	SourceS3Object *S3Object
	// contains filtered or unexported fields
}

Description of ephemeris.

type EphemerisInvalidReason added in v1.14.0

type EphemerisInvalidReason string
const (
	// Provided spacecraft identifiers such as spacecraft NORAD Id are invalid
	EphemerisInvalidReasonMetadataInvalid EphemerisInvalidReason = "METADATA_INVALID"
	// Start, end, or expiration time(s) are invalid for the provided ephemeris
	EphemerisInvalidReasonTimeRangeInvalid EphemerisInvalidReason = "TIME_RANGE_INVALID"
	// Provided ephemeris defines invalid spacecraft trajectory
	EphemerisInvalidReasonTrajectoryInvalid EphemerisInvalidReason = "TRAJECTORY_INVALID"
	// Provided KMS key is invalid
	EphemerisInvalidReasonKmsKeyInvalid EphemerisInvalidReason = "KMS_KEY_INVALID"
	// Internal Service Error occurred while processing ephemeris
	EphemerisInvalidReasonValidationError EphemerisInvalidReason = "VALIDATION_ERROR"
)

Enum values for EphemerisInvalidReason

func (EphemerisInvalidReason) Values added in v1.14.0

Values returns all known values for EphemerisInvalidReason. 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 EphemerisItem added in v1.14.0

type EphemerisItem struct {

	// The time the ephemeris was uploaded in UTC.
	CreationTime *time.Time

	// Whether or not the ephemeris is enabled.
	Enabled *bool

	// The AWS Ground Station ephemeris ID.
	EphemerisId *string

	// A name string associated with the ephemeris. Used as a human-readable
	// identifier for the ephemeris.
	Name *string

	// Customer-provided priority score to establish the order in which overlapping
	// ephemerides should be used. The default for customer-provided ephemeris priority
	// is 1, and higher numbers take precedence. Priority must be 1 or greater
	Priority *int32

	// Source S3 object used for the ephemeris.
	SourceS3Object *S3Object

	// The status of the ephemeris.
	Status EphemerisStatus
	// contains filtered or unexported fields
}

Ephemeris item.

type EphemerisMetaData added in v1.14.0

type EphemerisMetaData struct {

	// The EphemerisSource that generated a given ephemeris.
	//
	// This member is required.
	Source EphemerisSource

	// UUID of a customer-provided ephemeris. This field is not populated for default
	// ephemerides from Space Track.
	EphemerisId *string

	// The epoch of a default, ephemeris from Space Track in UTC. This field is not
	// populated for customer-provided ephemerides.
	Epoch *time.Time

	// 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.
	Name *string
	// contains filtered or unexported fields
}

Metadata describing a particular ephemeris.

type EphemerisSource added in v1.14.0

type EphemerisSource string
const (
	EphemerisSourceCustomerProvided EphemerisSource = "CUSTOMER_PROVIDED"
	EphemerisSourceSpaceTrack       EphemerisSource = "SPACE_TRACK"
)

Enum values for EphemerisSource

func (EphemerisSource) Values added in v1.14.0

func (EphemerisSource) Values() []EphemerisSource

Values returns all known values for EphemerisSource. 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 EphemerisStatus added in v1.14.0

type EphemerisStatus string
const (
	EphemerisStatusValidating EphemerisStatus = "VALIDATING"
	EphemerisStatusInvalid    EphemerisStatus = "INVALID"
	EphemerisStatusError      EphemerisStatus = "ERROR"
	EphemerisStatusEnabled    EphemerisStatus = "ENABLED"
	EphemerisStatusDisabled   EphemerisStatus = "DISABLED"
	EphemerisStatusExpired    EphemerisStatus = "EXPIRED"
)

Enum values for EphemerisStatus

func (EphemerisStatus) Values added in v1.14.0

func (EphemerisStatus) Values() []EphemerisStatus

Values returns all known values for EphemerisStatus. 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 EphemerisTypeDescription added in v1.14.0

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

The following types satisfy this interface:

EphemerisTypeDescriptionMemberOem
EphemerisTypeDescriptionMemberTle
Example (OutputUsage)
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/groundstation/types"
)

func main() {
	var union types.EphemerisTypeDescription
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.EphemerisTypeDescriptionMemberOem:
		_ = v.Value // Value is types.EphemerisDescription

	case *types.EphemerisTypeDescriptionMemberTle:
		_ = v.Value // Value is types.EphemerisDescription

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}
Output:

type EphemerisTypeDescriptionMemberOem added in v1.14.0

type EphemerisTypeDescriptionMemberOem struct {
	Value EphemerisDescription
	// contains filtered or unexported fields
}

Description of ephemeris.

type EphemerisTypeDescriptionMemberTle added in v1.14.0

type EphemerisTypeDescriptionMemberTle struct {
	Value EphemerisDescription
	// contains filtered or unexported fields
}

Description of ephemeris.

type Frequency

type Frequency struct {

	// Frequency units.
	//
	// This member is required.
	Units FrequencyUnits

	// Frequency value. Valid values are between 2200 to 2300 MHz and 7750 to 8400 MHz
	// for downlink and 2025 to 2120 MHz for uplink.
	//
	// This member is required.
	Value *float64
	// contains filtered or unexported fields
}

Object that describes the frequency.

type FrequencyBandwidth

type FrequencyBandwidth struct {

	// Frequency bandwidth units.
	//
	// This member is required.
	Units BandwidthUnits

	// 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.
	//
	// This member is required.
	Value *float64
	// contains filtered or unexported fields
}

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 added in v0.29.0

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
	// contains filtered or unexported fields
}

Information about the ground station data.

type IntegerRange added in v1.17.0

type IntegerRange struct {

	// A maximum value.
	//
	// This member is required.
	Maximum *int32

	// A minimum value.
	//
	// This member is required.
	Minimum *int32
	// contains filtered or unexported fields
}

An integer range that has a minimum and maximum value.

type InvalidParameterException

type InvalidParameterException struct {
	Message *string

	ErrorCodeOverride *string

	ParameterName *string
	// contains filtered or unexported fields
}

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 KmsKey added in v1.17.0

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

AWS Key Management Service (KMS) Key.

The following types satisfy this interface:

KmsKeyMemberKmsAliasArn
KmsKeyMemberKmsAliasName
KmsKeyMemberKmsKeyArn
Example (OutputUsage)
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/groundstation/types"
)

func main() {
	var union types.KmsKey
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.KmsKeyMemberKmsAliasArn:
		_ = v.Value // Value is string

	case *types.KmsKeyMemberKmsAliasName:
		_ = v.Value // Value is string

	case *types.KmsKeyMemberKmsKeyArn:
		_ = v.Value // Value is string

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}
Output:

type KmsKeyMemberKmsAliasArn added in v1.17.0

type KmsKeyMemberKmsAliasArn struct {
	Value string
	// contains filtered or unexported fields
}

KMS Alias Arn.

type KmsKeyMemberKmsAliasName added in v1.20.0

type KmsKeyMemberKmsAliasName struct {
	Value string
	// contains filtered or unexported fields
}

KMS Alias Name.

type KmsKeyMemberKmsKeyArn added in v1.17.0

type KmsKeyMemberKmsKeyArn struct {
	Value string
	// contains filtered or unexported fields
}

KMS Key Arn.

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
	// contains filtered or unexported fields
}

Item in a list of mission profiles.

type OEMEphemeris added in v1.14.0

type OEMEphemeris struct {

	// The data for an OEM ephemeris, supplied directly in the request rather than
	// through an S3 object.
	OemData *string

	// Identifies the S3 object to be used as the ephemeris.
	S3Object *S3Object
	// contains filtered or unexported fields
}

Ephemeris data in Orbit Ephemeris Message (OEM) format.

type Polarization

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

Enum values for Polarization

func (Polarization) Values added in v0.29.0

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 RangedConnectionDetails added in v1.17.0

type RangedConnectionDetails struct {

	// A ranged socket address.
	//
	// This member is required.
	SocketAddress *RangedSocketAddress

	// Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.
	Mtu *int32
	// contains filtered or unexported fields
}

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

type RangedSocketAddress added in v1.17.0

type RangedSocketAddress struct {

	// IPv4 socket address.
	//
	// This member is required.
	Name *string

	// Port range of a socket address.
	//
	// This member is required.
	PortRange *IntegerRange
	// contains filtered or unexported fields
}

A socket address with a port range.

type ResourceLimitExceededException

type ResourceLimitExceededException struct {
	Message *string

	ErrorCodeOverride *string

	ParameterName *string
	// contains filtered or unexported fields
}

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

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

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 S3Object added in v1.14.0

type S3Object struct {

	// An Amazon S3 Bucket name.
	Bucket *string

	// An Amazon S3 key for the ephemeris.
	Key *string

	// For versioned S3 objects, the version to use for the ephemeris.
	Version *string
	// contains filtered or unexported fields
}

Object stored in S3 containing ephemeris data.

type S3RecordingConfig added in v1.3.0

type S3RecordingConfig struct {

	// ARN of the bucket to record to.
	//
	// This member is required.
	BucketArn *string

	// ARN of the role Ground Station assumes to write data to the bucket.
	//
	// This member is required.
	RoleArn *string

	// S3 Key prefix to prefice data files.
	Prefix *string
	// contains filtered or unexported fields
}

Information about an S3 recording Config .

type S3RecordingDetails added in v1.3.0

type S3RecordingDetails struct {

	// ARN of the bucket used.
	BucketArn *string

	// Key template used for the S3 Recording Configuration
	KeyTemplate *string
	// contains filtered or unexported fields
}

Details about an S3 recording Config used in a contact.

type SatelliteListItem

type SatelliteListItem struct {

	// The current ephemeris being used to compute the trajectory of the satellite.
	CurrentEphemeris *EphemerisMetaData

	// 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
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

Information about the socket address.

type Source added in v1.2.0

type Source struct {

	// Additional details for a Config , if type is dataflow-endpoint or
	// antenna-downlink-demod-decode
	ConfigDetails ConfigDetails

	// UUID of a Config .
	ConfigId *string

	// Type of a Config .
	ConfigType ConfigCapabilityType

	// Region of a dataflow source.
	DataflowSourceRegion *string
	// contains filtered or unexported fields
}

Dataflow details for the source side.

type SpectrumConfig

type SpectrumConfig struct {

	// 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.
	//
	// This member is required.
	Bandwidth *FrequencyBandwidth

	// 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.
	//
	// This member is required.
	CenterFrequency *Frequency

	// Polarization of a spectral Config . Capturing both "RIGHT_HAND" and "LEFT_HAND"
	// polarization requires two separate configs.
	Polarization Polarization
	// contains filtered or unexported fields
}

Object that describes a spectral Config .

type TLEData added in v1.14.0

type TLEData struct {

	// First line of two-line element set (TLE) data.
	//
	// This member is required.
	TleLine1 *string

	// Second line of two-line element set (TLE) data.
	//
	// This member is required.
	TleLine2 *string

	// The valid time range for the TLE. Gaps or overlap are not permitted.
	//
	// This member is required.
	ValidTimeRange *TimeRange
	// contains filtered or unexported fields
}

Two-line element set (TLE) data.

type TLEEphemeris added in v1.14.0

type TLEEphemeris struct {

	// Identifies the S3 object to be used as the ephemeris.
	S3Object *S3Object

	// The data for a TLE ephemeris, supplied directly in the request rather than
	// through an S3 object.
	TleData []TLEData
	// contains filtered or unexported fields
}

Two-line element set (TLE) ephemeris.

type TimeRange added in v1.14.0

type TimeRange struct {

	// Time in UTC at which the time range ends.
	//
	// This member is required.
	EndTime *time.Time

	// Time in UTC at which the time range starts.
	//
	// This member is required.
	StartTime *time.Time
	// contains filtered or unexported fields
}

A time range with a start and end time.

type TrackingConfig

type TrackingConfig struct {

	// Current setting for autotrack.
	//
	// This member is required.
	Autotrack Criticality
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

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 . Valid values are between 2025 to
	// 2120 MHz.
	//
	// This member is required.
	CenterFrequency *Frequency

	// Polarization of an uplink spectral Config . Capturing both "RIGHT_HAND" and
	// "LEFT_HAND" polarization requires two separate configs.
	Polarization Polarization
	// contains filtered or unexported fields
}

Information about the uplink spectral Config .

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL