aws-elixir v1.0.11

View Source AWS.GroundStation (aws-elixir v1.0.11)

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.

Link to this section Summary

Functions

cancel_contact(client, contact_id, input, options \\ [])

Cancels or stops a contact with a specified contact ID based on its position in the contact lifecycle.

create_config(client, input, options \\ [])

Creates a Config with the specified configData parameters.

create_dataflow_endpoint_group(client, input, options \\ [])

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

create_dataflow_endpoint_group_v2(client, input, options \\ [])

Creates a DataflowEndpoint group containing the specified list of Ground Station Agent based endpoints.

create_ephemeris(client, input, options \\ [])

Create an ephemeris with your specified EphemerisData.

create_mission_profile(client, input, options \\ [])

Creates a mission profile.

delete_config(client, config_id, config_type, input, options \\ [])

Deletes a Config.

delete_dataflow_endpoint_group(client, dataflow_endpoint_group_id, input, options \\ [])

Deletes a dataflow endpoint group.

delete_ephemeris(client, ephemeris_id, input, options \\ [])

Delete an ephemeris.

delete_mission_profile(client, mission_profile_id, input, options \\ [])

Deletes a mission profile.

describe_contact(client, contact_id, options \\ [])

Describes an existing contact.

describe_contact_version(client, contact_id, version_id, options \\ [])

Describes a specific version of a contact.

describe_ephemeris(client, ephemeris_id, options \\ [])

Retrieve information about an existing ephemeris.

get_agent_configuration(client, agent_id, options \\ [])

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

get_agent_task_response_url(client, agent_id, task_id, options \\ [])

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

get_config(client, config_id, config_type, options \\ [])

Returns Config information.

get_dataflow_endpoint_group(client, dataflow_endpoint_group_id, options \\ [])

Returns the dataflow endpoint group.

get_minute_usage(client, input, options \\ [])

Returns the number of reserved minutes used by account.

get_mission_profile(client, mission_profile_id, options \\ [])

Returns a mission profile.

get_satellite(client, satellite_id, options \\ [])

Returns a satellite.

list_antennas(client, ground_station_id, max_results \\ nil, next_token \\ nil, options \\ [])

Returns a list of antennas at a specified ground station.

list_configs(client, max_results \\ nil, next_token \\ nil, options \\ [])

Returns a list of Config objects.

list_contact_versions(client, contact_id, max_results \\ nil, next_token \\ nil, options \\ [])

Returns a list of versions for a specified contact.

list_contacts(client, input, options \\ [])

Returns a list of contacts.

list_dataflow_endpoint_groups(client, max_results \\ nil, next_token \\ nil, options \\ [])

Returns a list of DataflowEndpoint groups.

list_ephemerides(client, input, options \\ [])

List your existing ephemerides.

list_ground_station_reservations(client, ground_station_id, end_time, max_results \\ nil, next_token \\ nil, reservation_types \\ nil, start_time, options \\ [])

Returns a list of reservations for a specified ground station.

list_ground_stations(client, max_results \\ nil, next_token \\ nil, satellite_id \\ nil, options \\ [])

Returns a list of ground stations.

list_mission_profiles(client, max_results \\ nil, next_token \\ nil, options \\ [])

Returns a list of mission profiles.

list_satellites(client, max_results \\ nil, next_token \\ nil, options \\ [])

Returns a list of satellites.

list_tags_for_resource(client, resource_arn, options \\ [])

Returns a list of tags for a specified resource.

metadata()
register_agent(client, input, options \\ [])

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

reserve_contact(client, input, options \\ [])

Reserves a contact using specified parameters.

tag_resource(client, resource_arn, input, options \\ [])

Assigns a tag to a resource.

untag_resource(client, resource_arn, input, options \\ [])

Deassigns a resource tag.

update_agent_status(client, agent_id, input, options \\ [])

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

update_config(client, config_id, config_type, input, options \\ [])

Updates the Config used when scheduling contacts.

update_contact(client, contact_id, input, options \\ [])

Updates a specific contact.

update_ephemeris(client, ephemeris_id, input, options \\ [])

Update an existing ephemeris.

update_mission_profile(client, mission_profile_id, input, options \\ [])

Updates a mission profile.

Link to this section Functions

Link to this function

cancel_contact(client, contact_id, input, options \\ [])

View Source

Cancels or stops a contact with a specified contact ID based on its position in the contact lifecycle.

For contacts that:

  • Have yet to start, the contact will be cancelled.

  • Have started but have yet to finish, the contact will be stopped.

Link to this function

create_config(client, input, options \\ [])

View Source

Creates a Config with the specified configData parameters.

Only one type of configData can be specified.

Link to this function

create_dataflow_endpoint_group(client, input, options \\ [])

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_v2(client, input, options \\ [])

View Source

Creates a DataflowEndpoint group containing the specified list of Ground Station Agent based endpoints.

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_ephemeris(client, input, options \\ [])

View Source

Create an ephemeris with your specified EphemerisData.

Link to this function

create_mission_profile(client, input, options \\ [])

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

delete_config(client, config_id, config_type, input, options \\ [])

View Source

Deletes a Config.

Link to this function

delete_dataflow_endpoint_group(client, dataflow_endpoint_group_id, input, options \\ [])

View Source

Deletes a dataflow endpoint group.

Link to this function

delete_ephemeris(client, ephemeris_id, input, options \\ [])

View Source

Delete an ephemeris.

Link to this function

delete_mission_profile(client, mission_profile_id, input, options \\ [])

View Source

Deletes a mission profile.

Link to this function

describe_contact(client, contact_id, options \\ [])

View Source

Describes an existing contact.

Link to this function

describe_contact_version(client, contact_id, version_id, options \\ [])

View Source

Describes a specific version of a contact.

Link to this function

describe_ephemeris(client, ephemeris_id, options \\ [])

View Source

Retrieve information about an existing ephemeris.

Link to this function

get_agent_configuration(client, agent_id, options \\ [])

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_task_response_url(client, agent_id, task_id, options \\ [])

View Source

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

Gets a presigned URL for uploading agent task response logs.

Link to this function

get_config(client, config_id, config_type, options \\ [])

View Source

Returns Config information.

Only one Config response can be returned.

Link to this function

get_dataflow_endpoint_group(client, dataflow_endpoint_group_id, options \\ [])

View Source

Returns the dataflow endpoint group.

Link to this function

get_minute_usage(client, input, options \\ [])

View Source

Returns the number of reserved minutes used by account.

Link to this function

get_mission_profile(client, mission_profile_id, options \\ [])

View Source

Returns a mission profile.

Link to this function

get_satellite(client, satellite_id, options \\ [])

View Source

Returns a satellite.

Link to this function

list_antennas(client, ground_station_id, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Returns a list of antennas at a specified ground station.

Link to this function

list_configs(client, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Returns a list of Config objects.

Link to this function

list_contact_versions(client, contact_id, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Returns a list of versions for a specified contact.

Link to this function

list_contacts(client, input, options \\ [])

View Source

Returns a list of contacts.

If statusList contains AVAILABLE, the request must include groundStation, missionprofileArn, and satelliteArn.

Link to this function

list_dataflow_endpoint_groups(client, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Returns a list of DataflowEndpoint groups.

Link to this function

list_ephemerides(client, input, options \\ [])

View Source

List your existing ephemerides.

Link to this function

list_ground_station_reservations(client, ground_station_id, end_time, max_results \\ nil, next_token \\ nil, reservation_types \\ nil, start_time, options \\ [])

View Source

Returns a list of reservations for a specified ground station.

Link to this function

list_ground_stations(client, max_results \\ nil, next_token \\ nil, satellite_id \\ nil, options \\ [])

View Source

Returns a list of ground stations.

Link to this function

list_mission_profiles(client, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Returns a list of mission profiles.

Link to this function

list_satellites(client, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Returns a list of satellites.

Link to this function

list_tags_for_resource(client, resource_arn, options \\ [])

View Source

Returns a list of tags for a specified resource.

Link to this function

metadata()

View Source
Link to this function

register_agent(client, input, options \\ [])

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

reserve_contact(client, input, options \\ [])

View Source

Reserves a contact using specified parameters.

Link to this function

tag_resource(client, resource_arn, input, options \\ [])

View Source

Assigns a tag to a resource.

Link to this function

untag_resource(client, resource_arn, input, options \\ [])

View Source

Deassigns a resource tag.

Link to this function

update_agent_status(client, agent_id, input, options \\ [])

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_config(client, config_id, config_type, input, options \\ [])

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_contact(client, contact_id, input, options \\ [])

View Source

Updates a specific contact.

Link to this function

update_ephemeris(client, ephemeris_id, input, options \\ [])

View Source

Update an existing ephemeris.

Link to this function

update_mission_profile(client, mission_profile_id, input, options \\ [])

View Source

Updates a mission profile.

Updating a mission profile will not update the execution parameters for existing future contacts.