aws
v1.0.4

View Source aws_groundstation (aws v1.0.4)

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 Config with the specified configData parameters.

create_config(Client, Input0, Options0)
create_dataflow_endpoint_group(Client, Input)

Creates a DataflowEndpoint group containing the specified list of DataflowEndpoint objects.

create_dataflow_endpoint_group(Client, Input0, Options0)
create_ephemeris(Client, Input)
Creates an Ephemeris with the specified EphemerisData.
create_ephemeris(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_ephemeris(Client, EphemerisId, Input)
Deletes an ephemeris
delete_ephemeris(Client, EphemerisId, 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)
describe_ephemeris(Client, EphemerisId)
Describes an existing ephemeris.
describe_ephemeris(Client, EphemerisId, QueryMap, HeadersMap)
describe_ephemeris(Client, EphemerisId, QueryMap, HeadersMap, Options0)
get_agent_configuration(Client, AgentId)

For use by AWS Ground Station Agent and shouldn't be called directly.

get_agent_configuration(Client, AgentId, QueryMap, HeadersMap)
get_agent_configuration(Client, AgentId, QueryMap, HeadersMap, Options0)
get_config(Client, ConfigId, ConfigType)

Returns Config information.

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 reserved 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.

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_ephemerides(Client, Input)
List existing ephemerides.
list_ephemerides(Client, Input0, 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)
register_agent(Client, Input)

For use by AWS Ground Station Agent and shouldn't be called directly.

register_agent(Client, Input0, 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_agent_status(Client, AgentId, Input)

For use by AWS Ground Station Agent and shouldn't be called directly.

update_agent_status(Client, AgentId, Input0, Options0)
update_config(Client, ConfigId, ConfigType, Input)

Updates the Config used when scheduling contacts.

update_config(Client, ConfigId, ConfigType, Input0, Options0)
update_ephemeris(Client, EphemerisId, Input)
Updates an existing ephemeris
update_ephemeris(Client, EphemerisId, Input0, Options0)
update_mission_profile(Client, MissionProfileId, Input)

Updates a mission profile.

update_mission_profile(Client, MissionProfileId, Input0, Options0)

Functions

Link to this function

cancel_contact(Client, ContactId, Input)

View Source
Cancels a contact with a specified contact ID.
Link to this function

cancel_contact(Client, ContactId, Input0, Options0)

View Source
Link to this function

create_config(Client, Input)

View Source

Creates a Config with the specified configData parameters.

Only one type of configData can be specified.
Link to this function

create_config(Client, Input0, Options0)

View Source
Link to this function

create_dataflow_endpoint_group(Client, Input)

View Source

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.
Link to this function

create_dataflow_endpoint_group(Client, Input0, Options0)

View Source
Link to this function

create_ephemeris(Client, Input)

View Source
Creates an Ephemeris with the specified EphemerisData.
Link to this function

create_ephemeris(Client, Input0, Options0)

View Source
Link to this function

create_mission_profile(Client, Input)

View Source

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.
Link to this function

create_mission_profile(Client, Input0, Options0)

View Source
Link to this function

delete_config(Client, ConfigId, ConfigType, Input)

View Source
Deletes a Config.
Link to this function

delete_config(Client, ConfigId, ConfigType, Input0, Options0)

View Source
Link to this function

delete_dataflow_endpoint_group(Client, DataflowEndpointGroupId, Input)

View Source
Deletes a dataflow endpoint group.
Link to this function

delete_dataflow_endpoint_group(Client, DataflowEndpointGroupId, Input0, Options0)

View Source
Link to this function

delete_ephemeris(Client, EphemerisId, Input)

View Source
Deletes an ephemeris
Link to this function

delete_ephemeris(Client, EphemerisId, Input0, Options0)

View Source
Link to this function

delete_mission_profile(Client, MissionProfileId, Input)

View Source
Deletes a mission profile.
Link to this function

delete_mission_profile(Client, MissionProfileId, Input0, Options0)

View Source
Link to this function

describe_contact(Client, ContactId)

View Source
Describes an existing contact.
Link to this function

describe_contact(Client, ContactId, QueryMap, HeadersMap)

View Source
Link to this function

describe_contact(Client, ContactId, QueryMap, HeadersMap, Options0)

View Source
Link to this function

describe_ephemeris(Client, EphemerisId)

View Source
Describes an existing ephemeris.
Link to this function

describe_ephemeris(Client, EphemerisId, QueryMap, HeadersMap)

View Source
Link to this function

describe_ephemeris(Client, EphemerisId, QueryMap, HeadersMap, Options0)

View Source
Link to this function

get_agent_configuration(Client, AgentId)

View Source

For use by AWS Ground Station Agent and shouldn't be called directly.

Gets the latest configuration information for a registered agent.
Link to this function

get_agent_configuration(Client, AgentId, QueryMap, HeadersMap)

View Source
Link to this function

get_agent_configuration(Client, AgentId, QueryMap, HeadersMap, Options0)

View Source
Link to this function

get_config(Client, ConfigId, ConfigType)

View Source

Returns Config information.

Only one Config response can be returned.
Link to this function

get_config(Client, ConfigId, ConfigType, QueryMap, HeadersMap)

View Source
Link to this function

get_config(Client, ConfigId, ConfigType, QueryMap, HeadersMap, Options0)

View Source
Link to this function

get_dataflow_endpoint_group(Client, DataflowEndpointGroupId)

View Source
Returns the dataflow endpoint group.
Link to this function

get_dataflow_endpoint_group(Client, DataflowEndpointGroupId, QueryMap, HeadersMap)

View Source
Link to this function

get_dataflow_endpoint_group(Client, DataflowEndpointGroupId, QueryMap, HeadersMap, Options0)

View Source
Link to this function

get_minute_usage(Client, Input)

View Source
Returns the number of reserved minutes used by account.
Link to this function

get_minute_usage(Client, Input0, Options0)

View Source
Link to this function

get_mission_profile(Client, MissionProfileId)

View Source
Returns a mission profile.
Link to this function

get_mission_profile(Client, MissionProfileId, QueryMap, HeadersMap)

View Source
Link to this function

get_mission_profile(Client, MissionProfileId, QueryMap, HeadersMap, Options0)

View Source
Link to this function

get_satellite(Client, SatelliteId)

View Source
Returns a satellite.
Link to this function

get_satellite(Client, SatelliteId, QueryMap, HeadersMap)

View Source
Link to this function

get_satellite(Client, SatelliteId, QueryMap, HeadersMap, Options0)

View Source
Link to this function

list_configs(Client)

View Source
Returns a list of Config objects.
Link to this function

list_configs(Client, QueryMap, HeadersMap)

View Source
Link to this function

list_configs(Client, QueryMap, HeadersMap, Options0)

View Source
Link to this function

list_contacts(Client, Input)

View Source

Returns a list of contacts.

If statusList contains AVAILABLE, the request must include groundStation, missionprofileArn, and satelliteArn.
Link to this function

list_contacts(Client, Input0, Options0)

View Source
Link to this function

list_dataflow_endpoint_groups(Client)

View Source
Returns a list of DataflowEndpoint groups.
Link to this function

list_dataflow_endpoint_groups(Client, QueryMap, HeadersMap)

View Source
Link to this function

list_dataflow_endpoint_groups(Client, QueryMap, HeadersMap, Options0)

View Source
Link to this function

list_ephemerides(Client, Input)

View Source
List existing ephemerides.
Link to this function

list_ephemerides(Client, Input0, Options0)

View Source
Link to this function

list_ground_stations(Client)

View Source
Returns a list of ground stations.
Link to this function

list_ground_stations(Client, QueryMap, HeadersMap)

View Source
Link to this function

list_ground_stations(Client, QueryMap, HeadersMap, Options0)

View Source
Link to this function

list_mission_profiles(Client)

View Source
Returns a list of mission profiles.
Link to this function

list_mission_profiles(Client, QueryMap, HeadersMap)

View Source
Link to this function

list_mission_profiles(Client, QueryMap, HeadersMap, Options0)

View Source
Link to this function

list_satellites(Client)

View Source
Returns a list of satellites.
Link to this function

list_satellites(Client, QueryMap, HeadersMap)

View Source
Link to this function

list_satellites(Client, QueryMap, HeadersMap, Options0)

View Source
Link to this function

list_tags_for_resource(Client, ResourceArn)

View Source
Returns a list of tags for a specified resource.
Link to this function

list_tags_for_resource(Client, ResourceArn, QueryMap, HeadersMap)

View Source
Link to this function

list_tags_for_resource(Client, ResourceArn, QueryMap, HeadersMap, Options0)

View Source
Link to this function

register_agent(Client, Input)

View Source

For use by AWS Ground Station Agent and shouldn't be called directly.

Registers a new agent with AWS Ground Station.
Link to this function

register_agent(Client, Input0, Options0)

View Source
Link to this function

reserve_contact(Client, Input)

View Source
Reserves a contact using specified parameters.
Link to this function

reserve_contact(Client, Input0, Options0)

View Source
Link to this function

tag_resource(Client, ResourceArn, Input)

View Source
Assigns a tag to a resource.
Link to this function

tag_resource(Client, ResourceArn, Input0, Options0)

View Source
Link to this function

untag_resource(Client, ResourceArn, Input)

View Source
Deassigns a resource tag.
Link to this function

untag_resource(Client, ResourceArn, Input0, Options0)

View Source
Link to this function

update_agent_status(Client, AgentId, Input)

View Source

For use by AWS Ground Station Agent and shouldn't be called directly.

Update the status of the agent.
Link to this function

update_agent_status(Client, AgentId, Input0, Options0)

View Source
Link to this function

update_config(Client, ConfigId, ConfigType, Input)

View Source

Updates the Config used when scheduling contacts.

Updating a Config will not update the execution parameters for existing future contacts scheduled with this Config.
Link to this function

update_config(Client, ConfigId, ConfigType, Input0, Options0)

View Source
Link to this function

update_ephemeris(Client, EphemerisId, Input)

View Source
Updates an existing ephemeris
Link to this function

update_ephemeris(Client, EphemerisId, Input0, Options0)

View Source
Link to this function

update_mission_profile(Client, MissionProfileId, Input)

View Source

Updates a mission profile.

Updating a mission profile will not update the execution parameters for existing future contacts.
Link to this function

update_mission_profile(Client, MissionProfileId, Input0, Options0)

View Source