Class: Aws::GroundStation::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::GroundStation::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb
Overview
An API client for GroundStation. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::GroundStation::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#cancel_contact(params = {}) ⇒ Types::ContactIdResponse
Cancels a contact with a specified contact ID.
-
#create_config(params = {}) ⇒ Types::ConfigIdResponse
Creates a
Config
with the specifiedconfigData
parameters. -
#create_dataflow_endpoint_group(params = {}) ⇒ Types::DataflowEndpointGroupIdResponse
Creates a
DataflowEndpoint
group containing the specified list ofDataflowEndpoint
objects. -
#create_ephemeris(params = {}) ⇒ Types::EphemerisIdResponse
Creates an Ephemeris with the specified
EphemerisData
. -
#create_mission_profile(params = {}) ⇒ Types::MissionProfileIdResponse
Creates a mission profile.
-
#delete_config(params = {}) ⇒ Types::ConfigIdResponse
Deletes a
Config
. -
#delete_dataflow_endpoint_group(params = {}) ⇒ Types::DataflowEndpointGroupIdResponse
Deletes a dataflow endpoint group.
-
#delete_ephemeris(params = {}) ⇒ Types::EphemerisIdResponse
Deletes an ephemeris.
-
#delete_mission_profile(params = {}) ⇒ Types::MissionProfileIdResponse
Deletes a mission profile.
-
#describe_contact(params = {}) ⇒ Types::DescribeContactResponse
Describes an existing contact.
-
#describe_ephemeris(params = {}) ⇒ Types::DescribeEphemerisResponse
Describes an existing ephemeris.
-
#get_agent_configuration(params = {}) ⇒ Types::GetAgentConfigurationResponse
For use by AWS Ground Station Agent and shouldn't be called directly. -
#get_config(params = {}) ⇒ Types::GetConfigResponse
Returns
Config
information. -
#get_dataflow_endpoint_group(params = {}) ⇒ Types::GetDataflowEndpointGroupResponse
Returns the dataflow endpoint group.
-
#get_minute_usage(params = {}) ⇒ Types::GetMinuteUsageResponse
Returns the number of reserved minutes used by account.
-
#get_mission_profile(params = {}) ⇒ Types::GetMissionProfileResponse
Returns a mission profile.
-
#get_satellite(params = {}) ⇒ Types::GetSatelliteResponse
Returns a satellite.
-
#list_configs(params = {}) ⇒ Types::ListConfigsResponse
Returns a list of
Config
objects. -
#list_contacts(params = {}) ⇒ Types::ListContactsResponse
Returns a list of contacts.
-
#list_dataflow_endpoint_groups(params = {}) ⇒ Types::ListDataflowEndpointGroupsResponse
Returns a list of
DataflowEndpoint
groups. -
#list_ephemerides(params = {}) ⇒ Types::ListEphemeridesResponse
List existing ephemerides.
-
#list_ground_stations(params = {}) ⇒ Types::ListGroundStationsResponse
Returns a list of ground stations.
-
#list_mission_profiles(params = {}) ⇒ Types::ListMissionProfilesResponse
Returns a list of mission profiles.
-
#list_satellites(params = {}) ⇒ Types::ListSatellitesResponse
Returns a list of satellites.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Returns a list of tags for a specified resource.
-
#register_agent(params = {}) ⇒ Types::RegisterAgentResponse
For use by AWS Ground Station Agent and shouldn't be called directly. -
#reserve_contact(params = {}) ⇒ Types::ContactIdResponse
Reserves a contact using specified parameters.
-
#tag_resource(params = {}) ⇒ Struct
Assigns a tag to a resource.
-
#untag_resource(params = {}) ⇒ Struct
Deassigns a resource tag.
-
#update_agent_status(params = {}) ⇒ Types::UpdateAgentStatusResponse
For use by AWS Ground Station Agent and shouldn't be called directly. -
#update_config(params = {}) ⇒ Types::ConfigIdResponse
Updates the
Config
used when scheduling contacts. -
#update_ephemeris(params = {}) ⇒ Types::EphemerisIdResponse
Updates an existing ephemeris.
-
#update_mission_profile(params = {}) ⇒ Types::MissionProfileIdResponse
Updates a mission profile.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
-
#wait_until(waiter_name, params = {}, options = {}) {|w.waiter| ... } ⇒ Boolean
Polls an API operation until a resource enters a desired state.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
422 423 424 |
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 422 def initialize(*args) super end |
Instance Method Details
#cancel_contact(params = {}) ⇒ Types::ContactIdResponse
Cancels a contact with a specified contact ID.
451 452 453 454 |
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 451 def cancel_contact(params = {}, = {}) req = build_request(:cancel_contact, params) req.send_request() end |
#create_config(params = {}) ⇒ Types::ConfigIdResponse
Creates a Config
with the specified configData
parameters.
Only one type of configData
can be specified.
558 559 560 561 |
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 558 def create_config(params = {}, = {}) req = build_request(:create_config, params) req.send_request() end |
#create_dataflow_endpoint_group(params = {}) ⇒ Types::DataflowEndpointGroupIdResponse
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.
656 657 658 659 |
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 656 def create_dataflow_endpoint_group(params = {}, = {}) req = build_request(:create_dataflow_endpoint_group, params) req.send_request() end |
#create_ephemeris(params = {}) ⇒ Types::EphemerisIdResponse
Creates an Ephemeris with the specified EphemerisData
.
751 752 753 754 |
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 751 def create_ephemeris(params = {}, = {}) req = build_request(:create_ephemeris, params) req.send_request() end |
#create_mission_profile(params = {}) ⇒ Types::MissionProfileIdResponse
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.
828 829 830 831 |
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 828 def create_mission_profile(params = {}, = {}) req = build_request(:create_mission_profile, params) req.send_request() end |
#delete_config(params = {}) ⇒ Types::ConfigIdResponse
Deletes a Config
.
864 865 866 867 |
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 864 def delete_config(params = {}, = {}) req = build_request(:delete_config, params) req.send_request() end |
#delete_dataflow_endpoint_group(params = {}) ⇒ Types::DataflowEndpointGroupIdResponse
Deletes a dataflow endpoint group.
892 893 894 895 |
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 892 def delete_dataflow_endpoint_group(params = {}, = {}) req = build_request(:delete_dataflow_endpoint_group, params) req.send_request() end |
#delete_ephemeris(params = {}) ⇒ Types::EphemerisIdResponse
Deletes an ephemeris
920 921 922 923 |
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 920 def delete_ephemeris(params = {}, = {}) req = build_request(:delete_ephemeris, params) req.send_request() end |
#delete_mission_profile(params = {}) ⇒ Types::MissionProfileIdResponse
Deletes a mission profile.
948 949 950 951 |
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 948 def delete_mission_profile(params = {}, = {}) req = build_request(:delete_mission_profile, params) req.send_request() end |
#describe_contact(params = {}) ⇒ Types::DescribeContactResponse
Describes an existing contact.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- contact_scheduled
1072 1073 1074 1075 |
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 1072 def describe_contact(params = {}, = {}) req = build_request(:describe_contact, params) req.send_request() end |
#describe_ephemeris(params = {}) ⇒ Types::DescribeEphemerisResponse
Describes an existing ephemeris.
1126 1127 1128 1129 |
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 1126 def describe_ephemeris(params = {}, = {}) req = build_request(:describe_ephemeris, params) req.send_request() end |
#get_agent_configuration(params = {}) ⇒ Types::GetAgentConfigurationResponse
Gets the latest configuration information for a registered agent.
1160 1161 1162 1163 |
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 1160 def get_agent_configuration(params = {}, = {}) req = build_request(:get_agent_configuration, params) req.send_request() end |
#get_config(params = {}) ⇒ Types::GetConfigResponse
Returns Config
information.
Only one Config
response can be returned.
1230 1231 1232 1233 |
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 1230 def get_config(params = {}, = {}) req = build_request(:get_config, params) req.send_request() end |
#get_dataflow_endpoint_group(params = {}) ⇒ Types::GetDataflowEndpointGroupResponse
Returns the dataflow endpoint group.
1292 1293 1294 1295 |
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 1292 def get_dataflow_endpoint_group(params = {}, = {}) req = build_request(:get_dataflow_endpoint_group, params) req.send_request() end |
#get_minute_usage(params = {}) ⇒ Types::GetMinuteUsageResponse
Returns the number of reserved minutes used by account.
1332 1333 1334 1335 |
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 1332 def get_minute_usage(params = {}, = {}) req = build_request(:get_minute_usage, params) req.send_request() end |
#get_mission_profile(params = {}) ⇒ Types::GetMissionProfileResponse
Returns a mission profile.
1387 1388 1389 1390 |
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 1387 def get_mission_profile(params = {}, = {}) req = build_request(:get_mission_profile, params) req.send_request() end |
#get_satellite(params = {}) ⇒ Types::GetSatelliteResponse
Returns a satellite.
1427 1428 1429 1430 |
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 1427 def get_satellite(params = {}, = {}) req = build_request(:get_satellite, params) req.send_request() end |
#list_configs(params = {}) ⇒ Types::ListConfigsResponse
Returns a list of Config
objects.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1468 1469 1470 1471 |
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 1468 def list_configs(params = {}, = {}) req = build_request(:list_configs, params) req.send_request() end |
#list_contacts(params = {}) ⇒ Types::ListContactsResponse
Returns a list of contacts.
If statusList
contains AVAILABLE, the request must include
groundStation
, missionprofileArn
, and satelliteArn
.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1549 1550 1551 1552 |
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 1549 def list_contacts(params = {}, = {}) req = build_request(:list_contacts, params) req.send_request() end |
#list_dataflow_endpoint_groups(params = {}) ⇒ Types::ListDataflowEndpointGroupsResponse
Returns a list of DataflowEndpoint
groups.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1589 1590 1591 1592 |
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 1589 def list_dataflow_endpoint_groups(params = {}, = {}) req = build_request(:list_dataflow_endpoint_groups, params) req.send_request() end |
#list_ephemerides(params = {}) ⇒ Types::ListEphemeridesResponse
List existing ephemerides.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1654 1655 1656 1657 |
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 1654 def list_ephemerides(params = {}, = {}) req = build_request(:list_ephemerides, params) req.send_request() end |
#list_ground_stations(params = {}) ⇒ Types::ListGroundStationsResponse
Returns a list of ground stations.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1698 1699 1700 1701 |
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 1698 def list_ground_stations(params = {}, = {}) req = build_request(:list_ground_stations, params) req.send_request() end |
#list_mission_profiles(params = {}) ⇒ Types::ListMissionProfilesResponse
Returns a list of mission profiles.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1739 1740 1741 1742 |
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 1739 def list_mission_profiles(params = {}, = {}) req = build_request(:list_mission_profiles, params) req.send_request() end |
#list_satellites(params = {}) ⇒ Types::ListSatellitesResponse
Returns a list of satellites.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1785 1786 1787 1788 |
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 1785 def list_satellites(params = {}, = {}) req = build_request(:list_satellites, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Returns a list of tags for a specified resource.
1814 1815 1816 1817 |
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 1814 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#register_agent(params = {}) ⇒ Types::RegisterAgentResponse
Registers a new agent with AWS Ground Station.
1866 1867 1868 1869 |
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 1866 def register_agent(params = {}, = {}) req = build_request(:register_agent, params) req.send_request() end |
#reserve_contact(params = {}) ⇒ Types::ContactIdResponse
Reserves a contact using specified parameters.
1916 1917 1918 1919 |
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 1916 def reserve_contact(params = {}, = {}) req = build_request(:reserve_contact, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Assigns a tag to a resource.
1944 1945 1946 1947 |
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 1944 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Deassigns a resource tag.
1970 1971 1972 1973 |
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 1970 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_agent_status(params = {}) ⇒ Types::UpdateAgentStatusResponse
Update the status of the agent.
2029 2030 2031 2032 |
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 2029 def update_agent_status(params = {}, = {}) req = build_request(:update_agent_status, params) req.send_request() end |
#update_config(params = {}) ⇒ Types::ConfigIdResponse
Updates the Config
used when scheduling contacts.
Updating a Config
will not update the execution parameters for
existing future contacts scheduled with this Config
.
2139 2140 2141 2142 |
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 2139 def update_config(params = {}, = {}) req = build_request(:update_config, params) req.send_request() end |
#update_ephemeris(params = {}) ⇒ Types::EphemerisIdResponse
Updates an existing ephemeris
2187 2188 2189 2190 |
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 2187 def update_ephemeris(params = {}, = {}) req = build_request(:update_ephemeris, params) req.send_request() end |
#update_mission_profile(params = {}) ⇒ Types::MissionProfileIdResponse
Updates a mission profile.
Updating a mission profile will not update the execution parameters for existing future contacts.
2263 2264 2265 2266 |
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 2263 def update_mission_profile(params = {}, = {}) req = build_request(:update_mission_profile, params) req.send_request() end |
#wait_until(waiter_name, params = {}, options = {}) {|w.waiter| ... } ⇒ Boolean
Polls an API operation until a resource enters a desired state.
Basic Usage
A waiter will call an API operation until:
- It is successful
- It enters a terminal state
- It makes the maximum number of attempts
In between attempts, the waiter will sleep.
# polls in a loop, sleeping between attempts
client.wait_until(waiter_name, params)
Configuration
You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. You can pass configuration as the final arguments hash.
# poll for ~25 seconds
client.wait_until(waiter_name, params, {
max_attempts: 5,
delay: 5,
})
Callbacks
You can be notified before each polling attempt and before each
delay. If you throw :success
or :failure
from these callbacks,
it will terminate the waiter.
started_at = Time.now
client.wait_until(waiter_name, params, {
# disable max attempts
max_attempts: nil,
# poll for 1 hour, instead of a number of attempts
before_wait: -> (attempts, response) do
throw :failure if Time.now - started_at > 3600
end
})
Handling Errors
When a waiter is unsuccessful, it will raise an error. All of the failure errors extend from Waiters::Errors::WaiterFailed.
begin
client.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
# resource did not enter the desired state in time
end
Valid Waiters
The following table lists the valid waiter names, the operations they call,
and the default :delay
and :max_attempts
values.
waiter_name | params | :delay | :max_attempts |
---|---|---|---|
contact_scheduled | #describe_contact | 5 | 180 |
2373 2374 2375 2376 2377 |
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 2373 def wait_until(waiter_name, params = {}, = {}) w = waiter(waiter_name, ) yield(w.waiter) if block_given? # deprecated w.wait(params) end |