aws_groundstation
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.Summary
Functions
-
cancel_contact(Client, ContactId, Input)
Cancels a contact with a specified contact ID.
- cancel_contact(Client, ContactId, Input0, Options0)
-
create_config(Client, Input)
Creates a
Configwith the specifiedconfigDataparameters. - create_config(Client, Input0, Options0)
-
create_dataflow_endpoint_group(Client, Input)
Creates a
DataflowEndpointgroup containing the specified list ofDataflowEndpointobjects. - create_dataflow_endpoint_group(Client, Input0, Options0)
-
create_mission_profile(Client, Input)
Creates a mission profile.
- create_mission_profile(Client, Input0, Options0)
-
delete_config(Client, ConfigId, ConfigType, Input)
Deletes a
Config. - delete_config(Client, ConfigId, ConfigType, Input0, Options0)
-
delete_dataflow_endpoint_group(Client, DataflowEndpointGroupId, Input)
Deletes a dataflow endpoint group.
- delete_dataflow_endpoint_group(Client, DataflowEndpointGroupId, Input0, Options0)
-
delete_mission_profile(Client, MissionProfileId, Input)
Deletes a mission profile.
- delete_mission_profile(Client, MissionProfileId, Input0, Options0)
-
describe_contact(Client, ContactId)
Describes an existing contact.
- describe_contact(Client, ContactId, QueryMap, HeadersMap)
- describe_contact(Client, ContactId, QueryMap, HeadersMap, Options0)
-
get_config(Client, ConfigId, ConfigType)
Returns
Configinformation. - get_config(Client, ConfigId, ConfigType, QueryMap, HeadersMap)
- get_config(Client, ConfigId, ConfigType, QueryMap, HeadersMap, Options0)
-
get_dataflow_endpoint_group(Client, DataflowEndpointGroupId)
Returns the dataflow endpoint group.
- get_dataflow_endpoint_group(Client, DataflowEndpointGroupId, QueryMap, HeadersMap)
- get_dataflow_endpoint_group(Client, DataflowEndpointGroupId, QueryMap, HeadersMap, Options0)
-
get_minute_usage(Client, Input)
Returns the number of minutes used by account.
- get_minute_usage(Client, Input0, Options0)
-
get_mission_profile(Client, MissionProfileId)
Returns a mission profile.
- get_mission_profile(Client, MissionProfileId, QueryMap, HeadersMap)
- get_mission_profile(Client, MissionProfileId, QueryMap, HeadersMap, Options0)
-
get_satellite(Client, SatelliteId)
Returns a satellite.
- get_satellite(Client, SatelliteId, QueryMap, HeadersMap)
- get_satellite(Client, SatelliteId, QueryMap, HeadersMap, Options0)
-
list_configs(Client)
Returns a list of
Configobjects. - list_configs(Client, QueryMap, HeadersMap)
- list_configs(Client, QueryMap, HeadersMap, Options0)
-
list_contacts(Client, Input)
Returns a list of contacts.
- list_contacts(Client, Input0, Options0)
-
list_dataflow_endpoint_groups(Client)
Returns a list of
DataflowEndpointgroups. - list_dataflow_endpoint_groups(Client, QueryMap, HeadersMap)
- list_dataflow_endpoint_groups(Client, QueryMap, HeadersMap, Options0)
-
list_ground_stations(Client)
Returns a list of ground stations.
- list_ground_stations(Client, QueryMap, HeadersMap)
- list_ground_stations(Client, QueryMap, HeadersMap, Options0)
-
list_mission_profiles(Client)
Returns a list of mission profiles.
- list_mission_profiles(Client, QueryMap, HeadersMap)
- list_mission_profiles(Client, QueryMap, HeadersMap, Options0)
-
list_satellites(Client)
Returns a list of satellites.
- list_satellites(Client, QueryMap, HeadersMap)
- list_satellites(Client, QueryMap, HeadersMap, Options0)
-
list_tags_for_resource(Client, ResourceArn)
Returns a list of tags for a specified resource.
- list_tags_for_resource(Client, ResourceArn, QueryMap, HeadersMap)
- list_tags_for_resource(Client, ResourceArn, QueryMap, HeadersMap, Options0)
-
reserve_contact(Client, Input)
Reserves a contact using specified parameters.
- reserve_contact(Client, Input0, Options0)
-
tag_resource(Client, ResourceArn, Input)
Assigns a tag to a resource.
- tag_resource(Client, ResourceArn, Input0, Options0)
-
untag_resource(Client, ResourceArn, Input)
Deassigns a resource tag.
- untag_resource(Client, ResourceArn, Input0, Options0)
-
update_config(Client, ConfigId, ConfigType, Input)
Updates the
Configused when scheduling contacts. - update_config(Client, ConfigId, ConfigType, Input0, Options0)
-
update_mission_profile(Client, MissionProfileId, Input)
Updates a mission profile.
- update_mission_profile(Client, MissionProfileId, Input0, Options0)
Functions
cancel_contact(Client, ContactId, Input)
Cancels a contact with a specified contact ID.
cancel_contact(Client, ContactId, Input0, Options0)
create_config(Client, Input)
Creates a Config with the specified configData parameters.
configData can be specified.
create_config(Client, Input0, Options0)
create_dataflow_endpoint_group(Client, Input)
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.
DataflowEndpointConfig objects, each
Config must match a DataflowEndpoint in the same group.
create_dataflow_endpoint_group(Client, Input0, Options0)
create_mission_profile(Client, Input)
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.
create_mission_profile(Client, Input0, Options0)
delete_config(Client, ConfigId, ConfigType, Input)
Deletes a Config.
delete_config(Client, ConfigId, ConfigType, Input0, Options0)
delete_dataflow_endpoint_group(Client, DataflowEndpointGroupId, Input)
Deletes a dataflow endpoint group.
delete_dataflow_endpoint_group(Client, DataflowEndpointGroupId, Input0, Options0)
delete_mission_profile(Client, MissionProfileId, Input)
Deletes a mission profile.
delete_mission_profile(Client, MissionProfileId, Input0, Options0)
describe_contact(Client, ContactId)
Describes an existing contact.
describe_contact(Client, ContactId, QueryMap, HeadersMap)
describe_contact(Client, ContactId, QueryMap, HeadersMap, Options0)
get_config(Client, ConfigId, ConfigType)
Returns Config information.
Config response can be returned.
get_config(Client, ConfigId, ConfigType, QueryMap, HeadersMap)
get_config(Client, ConfigId, ConfigType, QueryMap, HeadersMap, Options0)
get_dataflow_endpoint_group(Client, DataflowEndpointGroupId)
Returns the dataflow endpoint group.
get_dataflow_endpoint_group(Client, DataflowEndpointGroupId, QueryMap, HeadersMap)
get_dataflow_endpoint_group(Client, DataflowEndpointGroupId, QueryMap, HeadersMap, Options0)
get_minute_usage(Client, Input)
Returns the number of minutes used by account.
get_minute_usage(Client, Input0, Options0)
get_mission_profile(Client, MissionProfileId)
Returns a mission profile.
get_mission_profile(Client, MissionProfileId, QueryMap, HeadersMap)
get_mission_profile(Client, MissionProfileId, QueryMap, HeadersMap, Options0)
get_satellite(Client, SatelliteId)
Returns a satellite.
get_satellite(Client, SatelliteId, QueryMap, HeadersMap)
get_satellite(Client, SatelliteId, QueryMap, HeadersMap, Options0)
list_configs(Client)
Returns a list of Config objects.
list_configs(Client, QueryMap, HeadersMap)
list_configs(Client, QueryMap, HeadersMap, Options0)
list_contacts(Client, Input)
Returns a list of contacts.
IfstatusList contains AVAILABLE, the request must include
groundStation, missionprofileArn, and satelliteArn.
list_contacts(Client, Input0, Options0)
list_dataflow_endpoint_groups(Client)
Returns a list of DataflowEndpoint groups.
list_dataflow_endpoint_groups(Client, QueryMap, HeadersMap)
list_dataflow_endpoint_groups(Client, QueryMap, HeadersMap, Options0)
list_ground_stations(Client)
Returns a list of ground stations.
list_ground_stations(Client, QueryMap, HeadersMap)
list_ground_stations(Client, QueryMap, HeadersMap, Options0)
list_mission_profiles(Client)
Returns a list of mission profiles.
list_mission_profiles(Client, QueryMap, HeadersMap)
list_mission_profiles(Client, QueryMap, HeadersMap, Options0)
list_satellites(Client)
Returns a list of satellites.
list_satellites(Client, QueryMap, HeadersMap)
list_satellites(Client, QueryMap, HeadersMap, Options0)
list_tags_for_resource(Client, ResourceArn)
Returns a list of tags for a specified resource.
list_tags_for_resource(Client, ResourceArn, QueryMap, HeadersMap)
list_tags_for_resource(Client, ResourceArn, QueryMap, HeadersMap, Options0)
reserve_contact(Client, Input)
Reserves a contact using specified parameters.
reserve_contact(Client, Input0, Options0)
tag_resource(Client, ResourceArn, Input)
Assigns a tag to a resource.
tag_resource(Client, ResourceArn, Input0, Options0)
untag_resource(Client, ResourceArn, Input)
Deassigns a resource tag.
untag_resource(Client, ResourceArn, Input0, Options0)
update_config(Client, ConfigId, ConfigType, Input)
Updates the Config used when scheduling contacts.
Config will not update the execution parameters for existing
future contacts scheduled with this Config.
update_config(Client, ConfigId, ConfigType, Input0, Options0)
update_mission_profile(Client, MissionProfileId, Input)
Updates a mission profile.
Updating a mission profile will not update the execution parameters for existing future contacts.