GroundStationClientProtocol
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.
public protocol GroundStationClientProtocol
Requirements
cancelContact(input:completion:)
Cancels a contact with a specified contact ID.
func cancelContact(input: CancelContactInput, completion: @escaping (ClientRuntime.SdkResult<CancelContactOutputResponse, CancelContactOutputError>) -> Void)
createConfig(input:completion:)
Creates a Config with the specified configData parameters. Only one type of configData can be specified.
func createConfig(input: CreateConfigInput, completion: @escaping (ClientRuntime.SdkResult<CreateConfigOutputResponse, CreateConfigOutputError>) -> Void)
createDataflowEndpointGroup(input:completion:)
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.
func createDataflowEndpointGroup(input: CreateDataflowEndpointGroupInput, completion: @escaping (ClientRuntime.SdkResult<CreateDataflowEndpointGroupOutputResponse, CreateDataflowEndpointGroupOutputError>) -> Void)
createMissionProfile(input:completion:)
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.
func createMissionProfile(input: CreateMissionProfileInput, completion: @escaping (ClientRuntime.SdkResult<CreateMissionProfileOutputResponse, CreateMissionProfileOutputError>) -> Void)
deleteConfig(input:completion:)
Deletes a Config.
func deleteConfig(input: DeleteConfigInput, completion: @escaping (ClientRuntime.SdkResult<DeleteConfigOutputResponse, DeleteConfigOutputError>) -> Void)
deleteDataflowEndpointGroup(input:completion:)
Deletes a dataflow endpoint group.
func deleteDataflowEndpointGroup(input: DeleteDataflowEndpointGroupInput, completion: @escaping (ClientRuntime.SdkResult<DeleteDataflowEndpointGroupOutputResponse, DeleteDataflowEndpointGroupOutputError>) -> Void)
deleteMissionProfile(input:completion:)
Deletes a mission profile.
func deleteMissionProfile(input: DeleteMissionProfileInput, completion: @escaping (ClientRuntime.SdkResult<DeleteMissionProfileOutputResponse, DeleteMissionProfileOutputError>) -> Void)
describeContact(input:completion:)
Describes an existing contact.
func describeContact(input: DescribeContactInput, completion: @escaping (ClientRuntime.SdkResult<DescribeContactOutputResponse, DescribeContactOutputError>) -> Void)
getConfig(input:completion:)
Returns Config information. Only one Config response can be returned.
func getConfig(input: GetConfigInput, completion: @escaping (ClientRuntime.SdkResult<GetConfigOutputResponse, GetConfigOutputError>) -> Void)
getDataflowEndpointGroup(input:completion:)
Returns the dataflow endpoint group.
func getDataflowEndpointGroup(input: GetDataflowEndpointGroupInput, completion: @escaping (ClientRuntime.SdkResult<GetDataflowEndpointGroupOutputResponse, GetDataflowEndpointGroupOutputError>) -> Void)
getMinuteUsage(input:completion:)
Returns the number of minutes used by account.
func getMinuteUsage(input: GetMinuteUsageInput, completion: @escaping (ClientRuntime.SdkResult<GetMinuteUsageOutputResponse, GetMinuteUsageOutputError>) -> Void)
getMissionProfile(input:completion:)
Returns a mission profile.
func getMissionProfile(input: GetMissionProfileInput, completion: @escaping (ClientRuntime.SdkResult<GetMissionProfileOutputResponse, GetMissionProfileOutputError>) -> Void)
getSatellite(input:completion:)
Returns a satellite.
func getSatellite(input: GetSatelliteInput, completion: @escaping (ClientRuntime.SdkResult<GetSatelliteOutputResponse, GetSatelliteOutputError>) -> Void)
listConfigs(input:completion:)
Returns a list of Config objects.
func listConfigs(input: ListConfigsInput, completion: @escaping (ClientRuntime.SdkResult<ListConfigsOutputResponse, ListConfigsOutputError>) -> Void)
listContacts(input:completion:)
Returns a list of contacts. If statusList contains AVAILABLE, the request must include groundStation, missionprofileArn, and satelliteArn.
func listContacts(input: ListContactsInput, completion: @escaping (ClientRuntime.SdkResult<ListContactsOutputResponse, ListContactsOutputError>) -> Void)
listDataflowEndpointGroups(input:completion:)
Returns a list of DataflowEndpoint groups.
func listDataflowEndpointGroups(input: ListDataflowEndpointGroupsInput, completion: @escaping (ClientRuntime.SdkResult<ListDataflowEndpointGroupsOutputResponse, ListDataflowEndpointGroupsOutputError>) -> Void)
listGroundStations(input:completion:)
Returns a list of ground stations.
func listGroundStations(input: ListGroundStationsInput, completion: @escaping (ClientRuntime.SdkResult<ListGroundStationsOutputResponse, ListGroundStationsOutputError>) -> Void)
listMissionProfiles(input:completion:)
Returns a list of mission profiles.
func listMissionProfiles(input: ListMissionProfilesInput, completion: @escaping (ClientRuntime.SdkResult<ListMissionProfilesOutputResponse, ListMissionProfilesOutputError>) -> Void)
listSatellites(input:completion:)
Returns a list of satellites.
func listSatellites(input: ListSatellitesInput, completion: @escaping (ClientRuntime.SdkResult<ListSatellitesOutputResponse, ListSatellitesOutputError>) -> Void)
listTagsForResource(input:completion:)
Returns a list of tags for a specified resource.
func listTagsForResource(input: ListTagsForResourceInput, completion: @escaping (ClientRuntime.SdkResult<ListTagsForResourceOutputResponse, ListTagsForResourceOutputError>) -> Void)
reserveContact(input:completion:)
Reserves a contact using specified parameters.
func reserveContact(input: ReserveContactInput, completion: @escaping (ClientRuntime.SdkResult<ReserveContactOutputResponse, ReserveContactOutputError>) -> Void)
tagResource(input:completion:)
Assigns a tag to a resource.
func tagResource(input: TagResourceInput, completion: @escaping (ClientRuntime.SdkResult<TagResourceOutputResponse, TagResourceOutputError>) -> Void)
untagResource(input:completion:)
Deassigns a resource tag.
func untagResource(input: UntagResourceInput, completion: @escaping (ClientRuntime.SdkResult<UntagResourceOutputResponse, UntagResourceOutputError>) -> Void)
updateConfig(input:completion:)
Updates the Config used when scheduling contacts. Updating a Config will not update the execution parameters for existing future contacts scheduled with this Config.
func updateConfig(input: UpdateConfigInput, completion: @escaping (ClientRuntime.SdkResult<UpdateConfigOutputResponse, UpdateConfigOutputError>) -> Void)
updateMissionProfile(input:completion:)
Updates a mission profile. Updating a mission profile will not update the execution parameters for existing future contacts.
func updateMissionProfile(input: UpdateMissionProfileInput, completion: @escaping (ClientRuntime.SdkResult<UpdateMissionProfileOutputResponse, UpdateMissionProfileOutputError>) -> Void)