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_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_mission_profile(params = {}) ⇒ Types::MissionProfileIdResponse
Deletes a mission profile.
-
#describe_contact(params = {}) ⇒ Types::DescribeContactResponse
Describes an existing contact.
-
#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 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_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.
-
#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_config(params = {}) ⇒ Types::ConfigIdResponse
Updates the
Config
used when scheduling contacts. -
#update_mission_profile(params = {}) ⇒ Types::MissionProfileIdResponse
Updates a mission profile.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
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.
324 325 326 |
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 324 def initialize(*args) super end |
Instance Method Details
#cancel_contact(params = {}) ⇒ Types::ContactIdResponse
Cancels a contact with a specified contact ID.
353 354 355 356 |
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 353 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.
455 456 457 458 |
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 455 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.
514 515 516 517 |
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 514 def create_dataflow_endpoint_group(params = {}, = {}) req = build_request(:create_dataflow_endpoint_group, 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.
578 579 580 581 |
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 578 def create_mission_profile(params = {}, = {}) req = build_request(:create_mission_profile, params) req.send_request() end |
#delete_config(params = {}) ⇒ Types::ConfigIdResponse
Deletes a Config
.
614 615 616 617 |
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 614 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.
642 643 644 645 |
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 642 def delete_dataflow_endpoint_group(params = {}, = {}) req = build_request(:delete_dataflow_endpoint_group, params) req.send_request() end |
#delete_mission_profile(params = {}) ⇒ Types::MissionProfileIdResponse
Deletes a mission profile.
670 671 672 673 |
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 670 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.
755 756 757 758 |
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 755 def describe_contact(params = {}, = {}) req = build_request(:describe_contact, params) req.send_request() end |
#get_config(params = {}) ⇒ Types::GetConfigResponse
Returns Config
information.
Only one Config
response can be returned.
822 823 824 825 |
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 822 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.
867 868 869 870 |
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 867 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 minutes used by account.
907 908 909 910 |
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 907 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.
956 957 958 959 |
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 956 def get_mission_profile(params = {}, = {}) req = build_request(:get_mission_profile, params) req.send_request() end |
#get_satellite(params = {}) ⇒ Types::GetSatelliteResponse
Returns a satellite.
991 992 993 994 |
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 991 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.
1032 1033 1034 1035 |
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 1032 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.
1111 1112 1113 1114 |
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 1111 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.
1151 1152 1153 1154 |
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 1151 def list_dataflow_endpoint_groups(params = {}, = {}) req = build_request(:list_dataflow_endpoint_groups, 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.
1195 1196 1197 1198 |
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 1195 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.
1236 1237 1238 1239 |
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 1236 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.
1278 1279 1280 1281 |
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 1278 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.
1307 1308 1309 1310 |
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 1307 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#reserve_contact(params = {}) ⇒ Types::ContactIdResponse
Reserves a contact using specified parameters.
1357 1358 1359 1360 |
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 1357 def reserve_contact(params = {}, = {}) req = build_request(:reserve_contact, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Assigns a tag to a resource.
1385 1386 1387 1388 |
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 1385 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Deassigns a resource tag.
1411 1412 1413 1414 |
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 1411 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, 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
.
1516 1517 1518 1519 |
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 1516 def update_config(params = {}, = {}) req = build_request(:update_config, 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.
1578 1579 1580 1581 |
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 1578 def update_mission_profile(params = {}, = {}) req = build_request(:update_mission_profile, params) req.send_request() end |