GroundStation

public struct GroundStation

Client object for interacting with AWS GroundStation service.

Welcome to the AWS Ground Station API Reference. AWS Ground Station is a fully managed service that enables you to control satellite communications, downlink and process satellite data, and scale your satellite operations efficiently and cost-effectively without having to build or manage your own ground station infrastructure.

Member variables

client
Undocumented
Declaration
Swift

public let client: AWSClient

Initialization


                    
                    
                    init(accessKeyId:secretAccessKey:sessionToken:region:endpoint:middlewares:eventLoopGroupProvider:)

Initialize the GroundStation client

Declaration

Swift

public init(accessKeyId: String? = nil, secretAccessKey: String? = nil, sessionToken: String? = nil, region: AWSSDKSwiftCore.Region? = nil, endpoint: String? = nil, middlewares: [AWSServiceMiddleware] = [], eventLoopGroupProvider: AWSClient.EventLoopGroupProvider = .useAWSClientShared)

Parameters

`accessKeyId`	Public access key provided by AWS
`secretAccessKey`	Private access key provided by AWS
`sessionToken`	Token provided by STS.AssumeRole() which allows access to another AWS account
`region`	Region of server you want to communicate with
`endpoint`	Custom endpoint URL to use instead of standard AWS servers
`middlewares`	Array of middlewares to apply to requests and responses
`eventLoopGroupProvider`	EventLoopGroup to use. Use `useAWSClientShared` if the client shall manage its own EventLoopGroup.

API Calls


                    
                    
                    cancelContact(_:)

Cancels a contact with a specified contact ID.

Declaration

Swift

public func cancelContact(_ input: CancelContactRequest) -> EventLoopFuture<ContactIdResponse>

createConfig(_:)
Creates a Config with the specified configData parameters. Only one type of configData can be specified.
Declaration
Swift

public func createConfig(_ input: CreateConfigRequest) -> EventLoopFuture<ConfigIdResponse>
createDataflowEndpointGroup(_:)
Creates a DataflowEndpoint group containing the specified list of DataflowEndpoint objects. The name field in each endpoint is used in your mission profile DataflowEndpointConfig to specify which endpoints to use during a contact. When a contact uses multiple DataflowEndpointConfig objects, each Config must match a DataflowEndpoint in the same group.
Declaration
Swift

public func createDataflowEndpointGroup(_ input: CreateDataflowEndpointGroupRequest) -> EventLoopFuture<DataflowEndpointGroupIdResponse>
createMissionProfile(_:)
Creates a mission profile. dataflowEdges is a list of lists of strings. Each lower level list of strings has two elements: a from ARN and a to ARN.
Declaration
Swift

public func createMissionProfile(_ input: CreateMissionProfileRequest) -> EventLoopFuture<MissionProfileIdResponse>


                    
                    
                    deleteConfig(_:)

Deletes a Config.

Declaration

Swift

public func deleteConfig(_ input: DeleteConfigRequest) -> EventLoopFuture<ConfigIdResponse>


                    
                    
                    deleteDataflowEndpointGroup(_:)

Deletes a dataflow endpoint group.

Declaration

Swift

public func deleteDataflowEndpointGroup(_ input: DeleteDataflowEndpointGroupRequest) -> EventLoopFuture<DataflowEndpointGroupIdResponse>


                    
                    
                    deleteMissionProfile(_:)

Deletes a mission profile.

Declaration

Swift

public func deleteMissionProfile(_ input: DeleteMissionProfileRequest) -> EventLoopFuture<MissionProfileIdResponse>


                    
                    
                    describeContact(_:)

Describes an existing contact.

Declaration

Swift

public func describeContact(_ input: DescribeContactRequest) -> EventLoopFuture<DescribeContactResponse>

getConfig(_:)
Returns Config information. Only one Config response can be returned.
Declaration
Swift

public func getConfig(_ input: GetConfigRequest) -> EventLoopFuture<GetConfigResponse>


                    
                    
                    getDataflowEndpointGroup(_:)

Returns the dataflow endpoint group.

Declaration

Swift

public func getDataflowEndpointGroup(_ input: GetDataflowEndpointGroupRequest) -> EventLoopFuture<GetDataflowEndpointGroupResponse>


                    
                    
                    getMinuteUsage(_:)

Returns the number of minutes used by account.

Declaration

Swift

public func getMinuteUsage(_ input: GetMinuteUsageRequest) -> EventLoopFuture<GetMinuteUsageResponse>


                    
                    
                    getMissionProfile(_:)

Returns a mission profile.

Declaration

Swift

public func getMissionProfile(_ input: GetMissionProfileRequest) -> EventLoopFuture<GetMissionProfileResponse>


                    
                    
                    getSatellite(_:)

Returns a satellite.

Declaration

Swift

public func getSatellite(_ input: GetSatelliteRequest) -> EventLoopFuture<GetSatelliteResponse>


                    
                    
                    listConfigs(_:)

Returns a list of Config objects.

Declaration

Swift

public func listConfigs(_ input: ListConfigsRequest) -> EventLoopFuture<ListConfigsResponse>

listContacts(_:)
Returns a list of contacts. If statusList contains AVAILABLE, the request must include groundStation, missionprofileArn, and satelliteArn.
Declaration
Swift

public func listContacts(_ input: ListContactsRequest) -> EventLoopFuture<ListContactsResponse>


                    
                    
                    listDataflowEndpointGroups(_:)

Returns a list of DataflowEndpoint groups.

Declaration

Swift

public func listDataflowEndpointGroups(_ input: ListDataflowEndpointGroupsRequest) -> EventLoopFuture<ListDataflowEndpointGroupsResponse>


                    
                    
                    listGroundStations(_:)

Returns a list of ground stations.

Declaration

Swift

public func listGroundStations(_ input: ListGroundStationsRequest) -> EventLoopFuture<ListGroundStationsResponse>


                    
                    
                    listMissionProfiles(_:)

Returns a list of mission profiles.

Declaration

Swift

public func listMissionProfiles(_ input: ListMissionProfilesRequest) -> EventLoopFuture<ListMissionProfilesResponse>


                    
                    
                    listSatellites(_:)

Returns a list of satellites.

Declaration

Swift

public func listSatellites(_ input: ListSatellitesRequest) -> EventLoopFuture<ListSatellitesResponse>


                    
                    
                    listTagsForResource(_:)

Returns a list of tags for a specified resource.

Declaration

Swift

public func listTagsForResource(_ input: ListTagsForResourceRequest) -> EventLoopFuture<ListTagsForResourceResponse>


                    
                    
                    reserveContact(_:)

Reserves a contact using specified parameters.

Declaration

Swift

public func reserveContact(_ input: ReserveContactRequest) -> EventLoopFuture<ContactIdResponse>


                    
                    
                    tagResource(_:)

Assigns a tag to a resource.

Declaration

Swift

public func tagResource(_ input: TagResourceRequest) -> EventLoopFuture<TagResourceResponse>


                    
                    
                    untagResource(_:)

Deassigns a resource tag.

Declaration

Swift

public func untagResource(_ input: UntagResourceRequest) -> EventLoopFuture<UntagResourceResponse>

updateConfig(_:)
Updates the Config used when scheduling contacts. Updating a Config will not update the execution parameters for existing future contacts scheduled with this Config.
Declaration
Swift

public func updateConfig(_ input: UpdateConfigRequest) -> EventLoopFuture<ConfigIdResponse>
updateMissionProfile(_:)
Updates a mission profile. Updating a mission profile will not update the execution parameters for existing future contacts.
Declaration
Swift

public func updateMissionProfile(_ input: UpdateMissionProfileRequest) -> EventLoopFuture<MissionProfileIdResponse>

Paginators


                    
                    
                    listConfigsPaginator(_:onPage:)

Returns a list of Config objects.

Declaration

Swift

public func listConfigsPaginator(_ input: ListConfigsRequest, onPage: @escaping (ListConfigsResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>

listContactsPaginator(_:onPage:)
Returns a list of contacts. If statusList contains AVAILABLE, the request must include groundStation, missionprofileArn, and satelliteArn.
Declaration
Swift

public func listContactsPaginator(_ input: ListContactsRequest, onPage: @escaping (ListContactsResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>


                    
                    
                    listDataflowEndpointGroupsPaginator(_:onPage:)

Returns a list of DataflowEndpoint groups.

Declaration

Swift

public func listDataflowEndpointGroupsPaginator(_ input: ListDataflowEndpointGroupsRequest, onPage: @escaping (ListDataflowEndpointGroupsResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>


                    
                    
                    listGroundStationsPaginator(_:onPage:)

Returns a list of ground stations.

Declaration

Swift

public func listGroundStationsPaginator(_ input: ListGroundStationsRequest, onPage: @escaping (ListGroundStationsResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>


                    
                    
                    listMissionProfilesPaginator(_:onPage:)

Returns a list of mission profiles.

Declaration

Swift

public func listMissionProfilesPaginator(_ input: ListMissionProfilesRequest, onPage: @escaping (ListMissionProfilesResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>


                    
                    
                    listSatellitesPaginator(_:onPage:)

Returns a list of satellites.

Declaration

Swift

public func listSatellitesPaginator(_ input: ListSatellitesRequest, onPage: @escaping (ListSatellitesResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>

Shapes


                    
                    
                    ListConfigsRequest

Undocumented

Declaration

Swift

public struct ListConfigsRequest : AWSShape

extension GroundStation.ListConfigsRequest: AWSPaginateStringToken


                    
                    
                    ListContactsRequest

Undocumented

Declaration

Swift

public struct ListContactsRequest : AWSShape

extension GroundStation.ListContactsRequest: AWSPaginateStringToken


                    
                    
                    ListDataflowEndpointGroupsRequest

Undocumented

Declaration

Swift

public struct ListDataflowEndpointGroupsRequest : AWSShape

extension GroundStation.ListDataflowEndpointGroupsRequest: AWSPaginateStringToken


                    
                    
                    ListGroundStationsRequest

Undocumented

Declaration

Swift

public struct ListGroundStationsRequest : AWSShape

extension GroundStation.ListGroundStationsRequest: AWSPaginateStringToken


                    
                    
                    ListMissionProfilesRequest

Undocumented

Declaration

Swift

public struct ListMissionProfilesRequest : AWSShape

extension GroundStation.ListMissionProfilesRequest: AWSPaginateStringToken


                    
                    
                    ListSatellitesRequest

Undocumented

Declaration

Swift

public struct ListSatellitesRequest : AWSShape

extension GroundStation.ListSatellitesRequest: AWSPaginateStringToken

AntennaDemodDecodeDetails
Undocumented
See more
Declaration
Swift

public struct AntennaDemodDecodeDetails : AWSShape
AntennaDownlinkConfig
Undocumented
See more
Declaration
Swift

public struct AntennaDownlinkConfig : AWSShape
AntennaDownlinkDemodDecodeConfig
Undocumented
See more
Declaration
Swift

public struct AntennaDownlinkDemodDecodeConfig : AWSShape
AntennaUplinkConfig
Undocumented
See more
Declaration
Swift

public struct AntennaUplinkConfig : AWSShape
CancelContactRequest
Undocumented
See more
Declaration
Swift

public struct CancelContactRequest : AWSShape
ConfigDetails
Undocumented
See more
Declaration
Swift

public struct ConfigDetails : AWSShape
ConfigIdResponse
Undocumented
See more
Declaration
Swift

public struct ConfigIdResponse : AWSShape
ConfigListItem
Undocumented
See more
Declaration
Swift

public struct ConfigListItem : AWSShape
ConfigTypeData
Undocumented
See more
Declaration
Swift

public struct ConfigTypeData : AWSShape
ContactData
Undocumented
See more
Declaration
Swift

public struct ContactData : AWSShape
ContactIdResponse
Undocumented
See more
Declaration
Swift

public struct ContactIdResponse : AWSShape
CreateConfigRequest
Undocumented
See more
Declaration
Swift

public struct CreateConfigRequest : AWSShape
CreateDataflowEndpointGroupRequest
Undocumented
See more
Declaration
Swift

public struct CreateDataflowEndpointGroupRequest : AWSShape
CreateMissionProfileRequest
Undocumented
See more
Declaration
Swift

public struct CreateMissionProfileRequest : AWSShape
DataflowDetail
Undocumented
See more
Declaration
Swift

public struct DataflowDetail : AWSShape
DataflowEndpoint
Undocumented
See more
Declaration
Swift

public struct DataflowEndpoint : AWSShape
DataflowEndpointConfig
Undocumented
See more
Declaration
Swift

public struct DataflowEndpointConfig : AWSShape
DataflowEndpointGroupIdResponse
Undocumented
See more
Declaration
Swift

public struct DataflowEndpointGroupIdResponse : AWSShape
DataflowEndpointListItem
Undocumented
See more
Declaration
Swift

public struct DataflowEndpointListItem : AWSShape
DecodeConfig
Undocumented
See more
Declaration
Swift

public struct DecodeConfig : AWSShape
DeleteConfigRequest
Undocumented
See more
Declaration
Swift

public struct DeleteConfigRequest : AWSShape
DeleteDataflowEndpointGroupRequest
Undocumented
See more
Declaration
Swift

public struct DeleteDataflowEndpointGroupRequest : AWSShape
DeleteMissionProfileRequest
Undocumented
See more
Declaration
Swift

public struct DeleteMissionProfileRequest : AWSShape
DemodulationConfig
Undocumented
See more
Declaration
Swift

public struct DemodulationConfig : AWSShape
DescribeContactRequest
Undocumented
See more
Declaration
Swift

public struct DescribeContactRequest : AWSShape
DescribeContactResponse
Undocumented
See more
Declaration
Swift

public struct DescribeContactResponse : AWSShape
Destination
Undocumented
See more
Declaration
Swift

public struct Destination : AWSShape
Eirp
Undocumented
See more
Declaration
Swift

public struct Eirp : AWSShape
Elevation
Undocumented
See more
Declaration
Swift

public struct Elevation : AWSShape
EndpointDetails
Undocumented
See more
Declaration
Swift

public struct EndpointDetails : AWSShape
Frequency
Undocumented
See more
Declaration
Swift

public struct Frequency : AWSShape
FrequencyBandwidth
Undocumented
See more
Declaration
Swift

public struct FrequencyBandwidth : AWSShape
GetConfigRequest
Undocumented
See more
Declaration
Swift

public struct GetConfigRequest : AWSShape
GetConfigResponse
Undocumented
See more
Declaration
Swift

public struct GetConfigResponse : AWSShape
GetDataflowEndpointGroupRequest
Undocumented
See more
Declaration
Swift

public struct GetDataflowEndpointGroupRequest : AWSShape
GetDataflowEndpointGroupResponse
Undocumented
See more
Declaration
Swift

public struct GetDataflowEndpointGroupResponse : AWSShape
GetMinuteUsageRequest
Undocumented
See more
Declaration
Swift

public struct GetMinuteUsageRequest : AWSShape
GetMinuteUsageResponse
Undocumented
See more
Declaration
Swift

public struct GetMinuteUsageResponse : AWSShape
GetMissionProfileRequest
Undocumented
See more
Declaration
Swift

public struct GetMissionProfileRequest : AWSShape
GetMissionProfileResponse
Undocumented
See more
Declaration
Swift

public struct GetMissionProfileResponse : AWSShape
GetSatelliteRequest
Undocumented
See more
Declaration
Swift

public struct GetSatelliteRequest : AWSShape
GetSatelliteResponse
Undocumented
See more
Declaration
Swift

public struct GetSatelliteResponse : AWSShape
GroundStationData
Undocumented
See more
Declaration
Swift

public struct GroundStationData : AWSShape
ListConfigsResponse
Undocumented
See more
Declaration
Swift

public struct ListConfigsResponse : AWSShape
ListContactsResponse
Undocumented
See more
Declaration
Swift

public struct ListContactsResponse : AWSShape
ListDataflowEndpointGroupsResponse
Undocumented
See more
Declaration
Swift

public struct ListDataflowEndpointGroupsResponse : AWSShape
ListGroundStationsResponse
Undocumented
See more
Declaration
Swift

public struct ListGroundStationsResponse : AWSShape
ListMissionProfilesResponse
Undocumented
See more
Declaration
Swift

public struct ListMissionProfilesResponse : AWSShape
ListSatellitesResponse
Undocumented
See more
Declaration
Swift

public struct ListSatellitesResponse : AWSShape
ListTagsForResourceRequest
Undocumented
See more
Declaration
Swift

public struct ListTagsForResourceRequest : AWSShape
ListTagsForResourceResponse
Undocumented
See more
Declaration
Swift

public struct ListTagsForResourceResponse : AWSShape
MissionProfileIdResponse
Undocumented
See more
Declaration
Swift

public struct MissionProfileIdResponse : AWSShape
MissionProfileListItem
Undocumented
See more
Declaration
Swift

public struct MissionProfileListItem : AWSShape
ReserveContactRequest
Undocumented
See more
Declaration
Swift

public struct ReserveContactRequest : AWSShape
SatelliteListItem
Undocumented
See more
Declaration
Swift

public struct SatelliteListItem : AWSShape
SecurityDetails
Undocumented
See more
Declaration
Swift

public struct SecurityDetails : AWSShape
SocketAddress
Undocumented
See more
Declaration
Swift

public struct SocketAddress : AWSShape
Source
Undocumented
See more
Declaration
Swift

public struct Source : AWSShape
SpectrumConfig
Undocumented
See more
Declaration
Swift

public struct SpectrumConfig : AWSShape
TagResourceRequest
Undocumented
See more
Declaration
Swift

public struct TagResourceRequest : AWSShape
TagResourceResponse
Undocumented
See more
Declaration
Swift

public struct TagResourceResponse : AWSShape
TrackingConfig
Undocumented
See more
Declaration
Swift

public struct TrackingConfig : AWSShape
UntagResourceRequest
Undocumented
See more
Declaration
Swift

public struct UntagResourceRequest : AWSShape
UntagResourceResponse
Undocumented
See more
Declaration
Swift

public struct UntagResourceResponse : AWSShape
UpdateConfigRequest
Undocumented
See more
Declaration
Swift

public struct UpdateConfigRequest : AWSShape
UpdateMissionProfileRequest
Undocumented
See more
Declaration
Swift

public struct UpdateMissionProfileRequest : AWSShape
UplinkEchoConfig
Undocumented
See more
Declaration
Swift

public struct UplinkEchoConfig : AWSShape
UplinkSpectrumConfig
Undocumented
See more
Declaration
Swift

public struct UplinkSpectrumConfig : AWSShape

Enums


                    
                    
                    AngleUnits

Undocumented

Declaration

Swift

public enum AngleUnits : String, CustomStringConvertible, Codable


                    
                    
                    BandwidthUnits

Undocumented

Declaration

Swift

public enum BandwidthUnits : String, CustomStringConvertible, Codable


                    
                    
                    ConfigCapabilityType

Undocumented

Declaration

Swift

public enum ConfigCapabilityType : String, CustomStringConvertible, Codable


                    
                    
                    ContactStatus

Undocumented

Declaration

Swift

public enum ContactStatus : String, CustomStringConvertible, Codable


                    
                    
                    Criticality

Undocumented

Declaration

Swift

public enum Criticality : String, CustomStringConvertible, Codable


                    
                    
                    EirpUnits

Undocumented

Declaration

Swift

public enum EirpUnits : String, CustomStringConvertible, Codable


                    
                    
                    EndpointStatus

Undocumented

Declaration

Swift

public enum EndpointStatus : String, CustomStringConvertible, Codable


                    
                    
                    FrequencyUnits

Undocumented

Declaration

Swift

public enum FrequencyUnits : String, CustomStringConvertible, Codable


                    
                    
                    Polarization

Undocumented

Declaration

Swift

public enum Polarization : String, CustomStringConvertible, Codable