aws-sdk-groundstation 1.3.0 → 1.8.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
- SHA1:
3
- metadata.gz: 6f7d66fff7c932346c77023de1091af069b7c1d5
4
- data.tar.gz: 22ff735b6ff956e1c20b506c14bd75a13389bb7e
2
+ SHA256:
3
+ metadata.gz: 0b056be1d72604f9c9c520b5881516d7fccfece8d9ddb237736e67598ef62f65
4
+ data.tar.gz: 6e76216e2aec3db463a6fa38fe0409775cf93d1b1ecd8aea1295dbc375ba0d6a
5
5
  SHA512:
6
- metadata.gz: 481985134e349064f02d46cce4461081706fb52ccef9ba5dcd6216d19f560173b06604910c1800b762effa3f266dd01fa116d92c4f08537d473347619875991c
7
- data.tar.gz: 326a6cbfd0722ada706ec1d09ffe92755761598ab317576e8b2701a4eee3cadf42f2a379a81d6be3f5b10cb2b26c8e137199bb23a02fc63d19696dd7fb02662d
6
+ metadata.gz: 111ce4dbd19950d59ac2017d989a70418030e7716021d0cae79d8f14eabfcf4ca4854f32059222abb5750fc7c44f5c2ad64774a69a4f7d591d769fcf56958e9e
7
+ data.tar.gz: c8f7719266c37fda1039a1fa6e07b84eacfd286f0faad495c37020b1f2ba624c9dc9c540e879e505399d803fac6cf7288554844dbca7415f77b5f432dad8ef49
@@ -24,17 +24,20 @@ require_relative 'aws-sdk-groundstation/customizations'
24
24
  # methods each accept a hash of request parameters and return a response
25
25
  # structure.
26
26
  #
27
+ # ground_station = Aws::GroundStation::Client.new
28
+ # resp = ground_station.cancel_contact(params)
29
+ #
27
30
  # See {Client} for more information.
28
31
  #
29
32
  # # Errors
30
33
  #
31
- # Errors returned from AWS Ground Station all
32
- # extend {Errors::ServiceError}.
34
+ # Errors returned from AWS Ground Station are defined in the
35
+ # {Errors} module and all extend {Errors::ServiceError}.
33
36
  #
34
37
  # begin
35
38
  # # do stuff
36
39
  # rescue Aws::GroundStation::Errors::ServiceError
37
- # # rescues all service API errors
40
+ # # rescues all AWS Ground Station API errors
38
41
  # end
39
42
  #
40
43
  # See {Errors} for more information.
@@ -42,6 +45,6 @@ require_relative 'aws-sdk-groundstation/customizations'
42
45
  # @service
43
46
  module Aws::GroundStation
44
47
 
45
- GEM_VERSION = '1.3.0'
48
+ GEM_VERSION = '1.8.0'
46
49
 
47
50
  end
@@ -30,6 +30,18 @@ require 'aws-sdk-core/plugins/protocols/rest_json.rb'
30
30
  Aws::Plugins::GlobalConfiguration.add_identifier(:groundstation)
31
31
 
32
32
  module Aws::GroundStation
33
+ # An API client for GroundStation. To construct a client, you need to configure a `:region` and `:credentials`.
34
+ #
35
+ # client = Aws::GroundStation::Client.new(
36
+ # region: region_name,
37
+ # credentials: credentials,
38
+ # # ...
39
+ # )
40
+ #
41
+ # For details on configuring region and credentials see
42
+ # the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
43
+ #
44
+ # See {#initialize} for a full list of supported configuration options.
33
45
  class Client < Seahorse::Client::Base
34
46
 
35
47
  include Aws::ClientStubs
@@ -93,7 +105,7 @@ module Aws::GroundStation
93
105
  # @option options [required, String] :region
94
106
  # The AWS region to connect to. The configured `:region` is
95
107
  # used to determine the service `:endpoint`. When not passed,
96
- # a default `:region` is search for in the following locations:
108
+ # a default `:region` is searched for in the following locations:
97
109
  #
98
110
  # * `Aws.config[:region]`
99
111
  # * `ENV['AWS_REGION']`
@@ -108,6 +120,12 @@ module Aws::GroundStation
108
120
  # When set to `true`, a thread polling for endpoints will be running in
109
121
  # the background every 60 secs (default). Defaults to `false`.
110
122
  #
123
+ # @option options [Boolean] :adaptive_retry_wait_to_fill (true)
124
+ # Used only in `adaptive` retry mode. When true, the request will sleep
125
+ # until there is sufficent client side capacity to retry the request.
126
+ # When false, the request will raise a `RetryCapacityNotAvailableError` and will
127
+ # not retry instead of sleeping.
128
+ #
111
129
  # @option options [Boolean] :client_side_monitoring (false)
112
130
  # When `true`, client-side metrics will be collected for all API requests from
113
131
  # this client.
@@ -132,6 +150,10 @@ module Aws::GroundStation
132
150
  # When `true`, an attempt is made to coerce request parameters into
133
151
  # the required types.
134
152
  #
153
+ # @option options [Boolean] :correct_clock_skew (true)
154
+ # Used only in `standard` and adaptive retry modes. Specifies whether to apply
155
+ # a clock skew correction and retry requests with skewed client clocks.
156
+ #
135
157
  # @option options [Boolean] :disable_host_prefix_injection (false)
136
158
  # Set to true to disable SDK automatically adding host prefix
137
159
  # to default service endpoint when available.
@@ -139,7 +161,7 @@ module Aws::GroundStation
139
161
  # @option options [String] :endpoint
140
162
  # The client endpoint is normally constructed from the `:region`
141
163
  # option. You should only configure an `:endpoint` when connecting
142
- # to test endpoints. This should be avalid HTTP(S) URI.
164
+ # to test endpoints. This should be a valid HTTP(S) URI.
143
165
  #
144
166
  # @option options [Integer] :endpoint_cache_max_entries (1000)
145
167
  # Used for the maximum size limit of the LRU cache storing endpoints data
@@ -154,7 +176,7 @@ module Aws::GroundStation
154
176
  # requests fetching endpoints information. Defaults to 60 sec.
155
177
  #
156
178
  # @option options [Boolean] :endpoint_discovery (false)
157
- # When set to `true`, endpoint discovery will be enabled for operations when available. Defaults to `false`.
179
+ # When set to `true`, endpoint discovery will be enabled for operations when available.
158
180
  #
159
181
  # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
160
182
  # The log formatter.
@@ -166,15 +188,29 @@ module Aws::GroundStation
166
188
  # The Logger instance to send log messages to. If this option
167
189
  # is not set, logging will be disabled.
168
190
  #
191
+ # @option options [Integer] :max_attempts (3)
192
+ # An integer representing the maximum number attempts that will be made for
193
+ # a single request, including the initial attempt. For example,
194
+ # setting this value to 5 will result in a request being retried up to
195
+ # 4 times. Used in `standard` and `adaptive` retry modes.
196
+ #
169
197
  # @option options [String] :profile ("default")
170
198
  # Used when loading credentials from the shared credentials file
171
199
  # at HOME/.aws/credentials. When not specified, 'default' is used.
172
200
  #
201
+ # @option options [Proc] :retry_backoff
202
+ # A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
203
+ # This option is only used in the `legacy` retry mode.
204
+ #
173
205
  # @option options [Float] :retry_base_delay (0.3)
174
- # The base delay in seconds used by the default backoff function.
206
+ # The base delay in seconds used by the default backoff function. This option
207
+ # is only used in the `legacy` retry mode.
175
208
  #
176
209
  # @option options [Symbol] :retry_jitter (:none)
177
- # A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number.
210
+ # A delay randomiser function used by the default backoff function.
211
+ # Some predefined functions can be referenced by name - :none, :equal, :full,
212
+ # otherwise a Proc that takes and returns a number. This option is only used
213
+ # in the `legacy` retry mode.
178
214
  #
179
215
  # @see https://www.awsarchitectureblog.com/2015/03/backoff.html
180
216
  #
@@ -182,11 +218,30 @@ module Aws::GroundStation
182
218
  # The maximum number of times to retry failed requests. Only
183
219
  # ~ 500 level server errors and certain ~ 400 level client errors
184
220
  # are retried. Generally, these are throttling errors, data
185
- # checksum errors, networking errors, timeout errors and auth
186
- # errors from expired credentials.
221
+ # checksum errors, networking errors, timeout errors, auth errors,
222
+ # endpoint discovery, and errors from expired credentials.
223
+ # This option is only used in the `legacy` retry mode.
187
224
  #
188
225
  # @option options [Integer] :retry_max_delay (0)
189
- # The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function.
226
+ # The maximum number of seconds to delay between retries (0 for no limit)
227
+ # used by the default backoff function. This option is only used in the
228
+ # `legacy` retry mode.
229
+ #
230
+ # @option options [String] :retry_mode ("legacy")
231
+ # Specifies which retry algorithm to use. Values are:
232
+ #
233
+ # * `legacy` - The pre-existing retry behavior. This is default value if
234
+ # no retry mode is provided.
235
+ #
236
+ # * `standard` - A standardized set of retry rules across the AWS SDKs.
237
+ # This includes support for retry quotas, which limit the number of
238
+ # unsuccessful retries a client can make.
239
+ #
240
+ # * `adaptive` - An experimental retry mode that includes all the
241
+ # functionality of `standard` mode along with automatic client side
242
+ # throttling. This is a provisional mode that may change behavior
243
+ # in the future.
244
+ #
190
245
  #
191
246
  # @option options [String] :secret_access_key
192
247
  #
@@ -209,16 +264,15 @@ module Aws::GroundStation
209
264
  # requests through. Formatted like 'http://proxy.com:123'.
210
265
  #
211
266
  # @option options [Float] :http_open_timeout (15) The number of
212
- # seconds to wait when opening a HTTP session before rasing a
267
+ # seconds to wait when opening a HTTP session before raising a
213
268
  # `Timeout::Error`.
214
269
  #
215
270
  # @option options [Integer] :http_read_timeout (60) The default
216
271
  # number of seconds to wait for response data. This value can
217
- # safely be set
218
- # per-request on the session yeidled by {#session_for}.
272
+ # safely be set per-request on the session.
219
273
  #
220
274
  # @option options [Float] :http_idle_timeout (5) The number of
221
- # seconds a connection is allowed to sit idble before it is
275
+ # seconds a connection is allowed to sit idle before it is
222
276
  # considered stale. Stale connections are closed and removed
223
277
  # from the pool before making a request.
224
278
  #
@@ -227,7 +281,7 @@ module Aws::GroundStation
227
281
  # request body. This option has no effect unless the request has
228
282
  # "Expect" header set to "100-continue". Defaults to `nil` which
229
283
  # disables this behaviour. This value can safely be set per
230
- # request on the session yeidled by {#session_for}.
284
+ # request on the session.
231
285
  #
232
286
  # @option options [Boolean] :http_wire_trace (false) When `true`,
233
287
  # HTTP debug output will be sent to the `:logger`.
@@ -352,6 +406,7 @@ module Aws::GroundStation
352
406
  # },
353
407
  # dataflow_endpoint_config: {
354
408
  # dataflow_endpoint_name: "String", # required
409
+ # dataflow_endpoint_region: "String",
355
410
  # },
356
411
  # tracking_config: {
357
412
  # autotrack: "PREFERRED", # required, accepts PREFERRED, REMOVED, REQUIRED
@@ -443,7 +498,7 @@ module Aws::GroundStation
443
498
  # Creates a mission profile.
444
499
  #
445
500
  # `dataflowEdges` is a list of lists of strings. Each lower level list
446
- # of strings has two elements: a *from ARN* and a *to ARN*.
501
+ # of strings has two elements: a *from* ARN and a *to* ARN.
447
502
  #
448
503
  # @option params [Integer] :contact_post_pass_duration_seconds
449
504
  # Amount of time after a contact ends that you’d like to receive a
@@ -454,8 +509,8 @@ module Aws::GroundStation
454
509
  # CloudWatch event indicating an upcoming pass.
455
510
  #
456
511
  # @option params [required, Array<Array>] :dataflow_edges
457
- # A list of lists of ARNs. Each list of ARNs is an edge, with a from
458
- # `Config` and a to `Config`.
512
+ # A list of lists of ARNs. Each list of ARNs is an edge, with a *from*
513
+ # `Config` and a *to* `Config`.
459
514
  #
460
515
  # @option params [required, Integer] :minimum_viable_contact_duration_seconds
461
516
  # Smallest amount of time in seconds that you’d like to see for an
@@ -543,7 +598,7 @@ module Aws::GroundStation
543
598
  # Deletes a dataflow endpoint group.
544
599
  #
545
600
  # @option params [required, String] :dataflow_endpoint_group_id
546
- # ID of a dataflow endpoint group.
601
+ # UUID of a dataflow endpoint group.
547
602
  #
548
603
  # @return [Types::DataflowEndpointGroupIdResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
549
604
  #
@@ -612,6 +667,7 @@ module Aws::GroundStation
612
667
  # * {Types::DescribeContactResponse#mission_profile_arn #mission_profile_arn} => String
613
668
  # * {Types::DescribeContactResponse#post_pass_end_time #post_pass_end_time} => Time
614
669
  # * {Types::DescribeContactResponse#pre_pass_start_time #pre_pass_start_time} => Time
670
+ # * {Types::DescribeContactResponse#region #region} => String
615
671
  # * {Types::DescribeContactResponse#satellite_arn #satellite_arn} => String
616
672
  # * {Types::DescribeContactResponse#start_time #start_time} => Time
617
673
  # * {Types::DescribeContactResponse#tags #tags} => Hash&lt;String,String&gt;
@@ -625,7 +681,7 @@ module Aws::GroundStation
625
681
  # @example Response structure
626
682
  #
627
683
  # resp.contact_id #=> String
628
- # resp.contact_status #=> String, one of "AVAILABLE", "AWS_CANCELLED", "CANCELLED", "COMPLETED", "FAILED", "FAILED_TO_SCHEDULE", "PASS", "POSTPASS", "PREPASS", "SCHEDULED", "SCHEDULING"
684
+ # resp.contact_status #=> String, one of "AVAILABLE", "AWS_CANCELLED", "CANCELLED", "CANCELLING", "COMPLETED", "FAILED", "FAILED_TO_SCHEDULE", "PASS", "POSTPASS", "PREPASS", "SCHEDULED", "SCHEDULING"
629
685
  # resp.end_time #=> Time
630
686
  # resp.error_message #=> String
631
687
  # resp.ground_station #=> String
@@ -634,6 +690,7 @@ module Aws::GroundStation
634
690
  # resp.mission_profile_arn #=> String
635
691
  # resp.post_pass_end_time #=> Time
636
692
  # resp.pre_pass_start_time #=> Time
693
+ # resp.region #=> String
637
694
  # resp.satellite_arn #=> String
638
695
  # resp.start_time #=> Time
639
696
  # resp.tags #=> Hash
@@ -695,6 +752,7 @@ module Aws::GroundStation
695
752
  # resp.config_data.antenna_uplink_config.target_eirp.units #=> String, one of "dBW"
696
753
  # resp.config_data.antenna_uplink_config.target_eirp.value #=> Float
697
754
  # resp.config_data.dataflow_endpoint_config.dataflow_endpoint_name #=> String
755
+ # resp.config_data.dataflow_endpoint_config.dataflow_endpoint_region #=> String
698
756
  # resp.config_data.tracking_config.autotrack #=> String, one of "PREFERRED", "REMOVED", "REQUIRED"
699
757
  # resp.config_data.uplink_echo_config.antenna_uplink_config_arn #=> String
700
758
  # resp.config_data.uplink_echo_config.enabled #=> Boolean
@@ -757,6 +815,46 @@ module Aws::GroundStation
757
815
  req.send_request(options)
758
816
  end
759
817
 
818
+ # Returns the number of minutes used by account.
819
+ #
820
+ # @option params [required, Integer] :month
821
+ # The month being requested, with a value of 1-12.
822
+ #
823
+ # @option params [required, Integer] :year
824
+ # The year being requested, in the format of YYYY.
825
+ #
826
+ # @return [Types::GetMinuteUsageResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
827
+ #
828
+ # * {Types::GetMinuteUsageResponse#estimated_minutes_remaining #estimated_minutes_remaining} => Integer
829
+ # * {Types::GetMinuteUsageResponse#is_reserved_minutes_customer #is_reserved_minutes_customer} => Boolean
830
+ # * {Types::GetMinuteUsageResponse#total_reserved_minute_allocation #total_reserved_minute_allocation} => Integer
831
+ # * {Types::GetMinuteUsageResponse#total_scheduled_minutes #total_scheduled_minutes} => Integer
832
+ # * {Types::GetMinuteUsageResponse#upcoming_minutes_scheduled #upcoming_minutes_scheduled} => Integer
833
+ #
834
+ # @example Request syntax with placeholder values
835
+ #
836
+ # resp = client.get_minute_usage({
837
+ # month: 1, # required
838
+ # year: 1, # required
839
+ # })
840
+ #
841
+ # @example Response structure
842
+ #
843
+ # resp.estimated_minutes_remaining #=> Integer
844
+ # resp.is_reserved_minutes_customer #=> Boolean
845
+ # resp.total_reserved_minute_allocation #=> Integer
846
+ # resp.total_scheduled_minutes #=> Integer
847
+ # resp.upcoming_minutes_scheduled #=> Integer
848
+ #
849
+ # @see http://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/GetMinuteUsage AWS API Documentation
850
+ #
851
+ # @overload get_minute_usage(params = {})
852
+ # @param [Hash] params ({})
853
+ def get_minute_usage(params = {}, options = {})
854
+ req = build_request(:get_minute_usage, params)
855
+ req.send_request(options)
856
+ end
857
+
760
858
  # Returns a mission profile.
761
859
  #
762
860
  # @option params [required, String] :mission_profile_id
@@ -806,6 +904,41 @@ module Aws::GroundStation
806
904
  req.send_request(options)
807
905
  end
808
906
 
907
+ # Returns a satellite.
908
+ #
909
+ # @option params [required, String] :satellite_id
910
+ # UUID of a satellite.
911
+ #
912
+ # @return [Types::GetSatelliteResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
913
+ #
914
+ # * {Types::GetSatelliteResponse#ground_stations #ground_stations} => Array&lt;String&gt;
915
+ # * {Types::GetSatelliteResponse#norad_satellite_id #norad_satellite_id} => Integer
916
+ # * {Types::GetSatelliteResponse#satellite_arn #satellite_arn} => String
917
+ # * {Types::GetSatelliteResponse#satellite_id #satellite_id} => String
918
+ #
919
+ # @example Request syntax with placeholder values
920
+ #
921
+ # resp = client.get_satellite({
922
+ # satellite_id: "String", # required
923
+ # })
924
+ #
925
+ # @example Response structure
926
+ #
927
+ # resp.ground_stations #=> Array
928
+ # resp.ground_stations[0] #=> String
929
+ # resp.norad_satellite_id #=> Integer
930
+ # resp.satellite_arn #=> String
931
+ # resp.satellite_id #=> String
932
+ #
933
+ # @see http://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/GetSatellite AWS API Documentation
934
+ #
935
+ # @overload get_satellite(params = {})
936
+ # @param [Hash] params ({})
937
+ def get_satellite(params = {}, options = {})
938
+ req = build_request(:get_satellite, params)
939
+ req.send_request(options)
940
+ end
941
+
809
942
  # Returns a list of `Config` objects.
810
943
  #
811
944
  # @option params [Integer] :max_results
@@ -820,6 +953,8 @@ module Aws::GroundStation
820
953
  # * {Types::ListConfigsResponse#config_list #config_list} => Array&lt;Types::ConfigListItem&gt;
821
954
  # * {Types::ListConfigsResponse#next_token #next_token} => String
822
955
  #
956
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
957
+ #
823
958
  # @example Request syntax with placeholder values
824
959
  #
825
960
  # resp = client.list_configs({
@@ -848,7 +983,7 @@ module Aws::GroundStation
848
983
  # Returns a list of contacts.
849
984
  #
850
985
  # If `statusList` contains AVAILABLE, the request must include
851
- # `groundstation`, `missionprofileArn`, and `satelliteArn`.
986
+ # `groundStation`, `missionprofileArn`, and `satelliteArn`.
852
987
  #
853
988
  # @option params [required, Time,DateTime,Date,Integer,String] :end_time
854
989
  # End time of a contact.
@@ -880,6 +1015,8 @@ module Aws::GroundStation
880
1015
  # * {Types::ListContactsResponse#contact_list #contact_list} => Array&lt;Types::ContactData&gt;
881
1016
  # * {Types::ListContactsResponse#next_token #next_token} => String
882
1017
  #
1018
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1019
+ #
883
1020
  # @example Request syntax with placeholder values
884
1021
  #
885
1022
  # resp = client.list_contacts({
@@ -890,14 +1027,14 @@ module Aws::GroundStation
890
1027
  # next_token: "String",
891
1028
  # satellite_arn: "satelliteArn",
892
1029
  # start_time: Time.now, # required
893
- # status_list: ["AVAILABLE"], # required, accepts AVAILABLE, AWS_CANCELLED, CANCELLED, COMPLETED, FAILED, FAILED_TO_SCHEDULE, PASS, POSTPASS, PREPASS, SCHEDULED, SCHEDULING
1030
+ # status_list: ["AVAILABLE"], # required, accepts AVAILABLE, AWS_CANCELLED, CANCELLED, CANCELLING, COMPLETED, FAILED, FAILED_TO_SCHEDULE, PASS, POSTPASS, PREPASS, SCHEDULED, SCHEDULING
894
1031
  # })
895
1032
  #
896
1033
  # @example Response structure
897
1034
  #
898
1035
  # resp.contact_list #=> Array
899
1036
  # resp.contact_list[0].contact_id #=> String
900
- # resp.contact_list[0].contact_status #=> String, one of "AVAILABLE", "AWS_CANCELLED", "CANCELLED", "COMPLETED", "FAILED", "FAILED_TO_SCHEDULE", "PASS", "POSTPASS", "PREPASS", "SCHEDULED", "SCHEDULING"
1037
+ # resp.contact_list[0].contact_status #=> String, one of "AVAILABLE", "AWS_CANCELLED", "CANCELLED", "CANCELLING", "COMPLETED", "FAILED", "FAILED_TO_SCHEDULE", "PASS", "POSTPASS", "PREPASS", "SCHEDULED", "SCHEDULING"
901
1038
  # resp.contact_list[0].end_time #=> Time
902
1039
  # resp.contact_list[0].error_message #=> String
903
1040
  # resp.contact_list[0].ground_station #=> String
@@ -906,6 +1043,7 @@ module Aws::GroundStation
906
1043
  # resp.contact_list[0].mission_profile_arn #=> String
907
1044
  # resp.contact_list[0].post_pass_end_time #=> Time
908
1045
  # resp.contact_list[0].pre_pass_start_time #=> Time
1046
+ # resp.contact_list[0].region #=> String
909
1047
  # resp.contact_list[0].satellite_arn #=> String
910
1048
  # resp.contact_list[0].start_time #=> Time
911
1049
  # resp.contact_list[0].tags #=> Hash
@@ -936,6 +1074,8 @@ module Aws::GroundStation
936
1074
  # * {Types::ListDataflowEndpointGroupsResponse#dataflow_endpoint_group_list #dataflow_endpoint_group_list} => Array&lt;Types::DataflowEndpointListItem&gt;
937
1075
  # * {Types::ListDataflowEndpointGroupsResponse#next_token #next_token} => String
938
1076
  #
1077
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1078
+ #
939
1079
  # @example Request syntax with placeholder values
940
1080
  #
941
1081
  # resp = client.list_dataflow_endpoint_groups({
@@ -959,6 +1099,50 @@ module Aws::GroundStation
959
1099
  req.send_request(options)
960
1100
  end
961
1101
 
1102
+ # Returns a list of ground stations.
1103
+ #
1104
+ # @option params [Integer] :max_results
1105
+ # Maximum number of ground stations returned.
1106
+ #
1107
+ # @option params [String] :next_token
1108
+ # Next token that can be supplied in the next call to get the next page
1109
+ # of ground stations.
1110
+ #
1111
+ # @option params [String] :satellite_id
1112
+ # Satellite ID to retrieve on-boarded ground stations.
1113
+ #
1114
+ # @return [Types::ListGroundStationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1115
+ #
1116
+ # * {Types::ListGroundStationsResponse#ground_station_list #ground_station_list} => Array&lt;Types::GroundStationData&gt;
1117
+ # * {Types::ListGroundStationsResponse#next_token #next_token} => String
1118
+ #
1119
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1120
+ #
1121
+ # @example Request syntax with placeholder values
1122
+ #
1123
+ # resp = client.list_ground_stations({
1124
+ # max_results: 1,
1125
+ # next_token: "String",
1126
+ # satellite_id: "String",
1127
+ # })
1128
+ #
1129
+ # @example Response structure
1130
+ #
1131
+ # resp.ground_station_list #=> Array
1132
+ # resp.ground_station_list[0].ground_station_id #=> String
1133
+ # resp.ground_station_list[0].ground_station_name #=> String
1134
+ # resp.ground_station_list[0].region #=> String
1135
+ # resp.next_token #=> String
1136
+ #
1137
+ # @see http://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/ListGroundStations AWS API Documentation
1138
+ #
1139
+ # @overload list_ground_stations(params = {})
1140
+ # @param [Hash] params ({})
1141
+ def list_ground_stations(params = {}, options = {})
1142
+ req = build_request(:list_ground_stations, params)
1143
+ req.send_request(options)
1144
+ end
1145
+
962
1146
  # Returns a list of mission profiles.
963
1147
  #
964
1148
  # @option params [Integer] :max_results
@@ -973,6 +1157,8 @@ module Aws::GroundStation
973
1157
  # * {Types::ListMissionProfilesResponse#mission_profile_list #mission_profile_list} => Array&lt;Types::MissionProfileListItem&gt;
974
1158
  # * {Types::ListMissionProfilesResponse#next_token #next_token} => String
975
1159
  #
1160
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1161
+ #
976
1162
  # @example Request syntax with placeholder values
977
1163
  #
978
1164
  # resp = client.list_mission_profiles({
@@ -998,6 +1184,77 @@ module Aws::GroundStation
998
1184
  req.send_request(options)
999
1185
  end
1000
1186
 
1187
+ # Returns a list of satellites.
1188
+ #
1189
+ # @option params [Integer] :max_results
1190
+ # Maximum number of satellites returned.
1191
+ #
1192
+ # @option params [String] :next_token
1193
+ # Next token that can be supplied in the next call to get the next page
1194
+ # of satellites.
1195
+ #
1196
+ # @return [Types::ListSatellitesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1197
+ #
1198
+ # * {Types::ListSatellitesResponse#next_token #next_token} => String
1199
+ # * {Types::ListSatellitesResponse#satellites #satellites} => Array&lt;Types::SatelliteListItem&gt;
1200
+ #
1201
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1202
+ #
1203
+ # @example Request syntax with placeholder values
1204
+ #
1205
+ # resp = client.list_satellites({
1206
+ # max_results: 1,
1207
+ # next_token: "String",
1208
+ # })
1209
+ #
1210
+ # @example Response structure
1211
+ #
1212
+ # resp.next_token #=> String
1213
+ # resp.satellites #=> Array
1214
+ # resp.satellites[0].ground_stations #=> Array
1215
+ # resp.satellites[0].ground_stations[0] #=> String
1216
+ # resp.satellites[0].norad_satellite_id #=> Integer
1217
+ # resp.satellites[0].satellite_arn #=> String
1218
+ # resp.satellites[0].satellite_id #=> String
1219
+ #
1220
+ # @see http://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/ListSatellites AWS API Documentation
1221
+ #
1222
+ # @overload list_satellites(params = {})
1223
+ # @param [Hash] params ({})
1224
+ def list_satellites(params = {}, options = {})
1225
+ req = build_request(:list_satellites, params)
1226
+ req.send_request(options)
1227
+ end
1228
+
1229
+ # Returns a list of tags for a specified resource.
1230
+ #
1231
+ # @option params [required, String] :resource_arn
1232
+ # ARN of a resource.
1233
+ #
1234
+ # @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1235
+ #
1236
+ # * {Types::ListTagsForResourceResponse#tags #tags} => Hash&lt;String,String&gt;
1237
+ #
1238
+ # @example Request syntax with placeholder values
1239
+ #
1240
+ # resp = client.list_tags_for_resource({
1241
+ # resource_arn: "String", # required
1242
+ # })
1243
+ #
1244
+ # @example Response structure
1245
+ #
1246
+ # resp.tags #=> Hash
1247
+ # resp.tags["String"] #=> String
1248
+ #
1249
+ # @see http://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/ListTagsForResource AWS API Documentation
1250
+ #
1251
+ # @overload list_tags_for_resource(params = {})
1252
+ # @param [Hash] params ({})
1253
+ def list_tags_for_resource(params = {}, options = {})
1254
+ req = build_request(:list_tags_for_resource, params)
1255
+ req.send_request(options)
1256
+ end
1257
+
1001
1258
  # Reserves a contact using specified parameters.
1002
1259
  #
1003
1260
  # @option params [required, Time,DateTime,Date,Integer,String] :end_time
@@ -1048,13 +1305,67 @@ module Aws::GroundStation
1048
1305
  req.send_request(options)
1049
1306
  end
1050
1307
 
1308
+ # Assigns a tag to a resource.
1309
+ #
1310
+ # @option params [required, String] :resource_arn
1311
+ # ARN of a resource tag.
1312
+ #
1313
+ # @option params [required, Hash<String,String>] :tags
1314
+ # Tags assigned to a resource.
1315
+ #
1316
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1317
+ #
1318
+ # @example Request syntax with placeholder values
1319
+ #
1320
+ # resp = client.tag_resource({
1321
+ # resource_arn: "String", # required
1322
+ # tags: { # required
1323
+ # "String" => "String",
1324
+ # },
1325
+ # })
1326
+ #
1327
+ # @see http://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/TagResource AWS API Documentation
1328
+ #
1329
+ # @overload tag_resource(params = {})
1330
+ # @param [Hash] params ({})
1331
+ def tag_resource(params = {}, options = {})
1332
+ req = build_request(:tag_resource, params)
1333
+ req.send_request(options)
1334
+ end
1335
+
1336
+ # Deassigns a resource tag.
1337
+ #
1338
+ # @option params [required, String] :resource_arn
1339
+ # ARN of a resource.
1340
+ #
1341
+ # @option params [required, Array<String>] :tag_keys
1342
+ # Keys of a resource tag.
1343
+ #
1344
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1345
+ #
1346
+ # @example Request syntax with placeholder values
1347
+ #
1348
+ # resp = client.untag_resource({
1349
+ # resource_arn: "String", # required
1350
+ # tag_keys: ["String"], # required
1351
+ # })
1352
+ #
1353
+ # @see http://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/UntagResource AWS API Documentation
1354
+ #
1355
+ # @overload untag_resource(params = {})
1356
+ # @param [Hash] params ({})
1357
+ def untag_resource(params = {}, options = {})
1358
+ req = build_request(:untag_resource, params)
1359
+ req.send_request(options)
1360
+ end
1361
+
1051
1362
  # Updates the `Config` used when scheduling contacts.
1052
1363
  #
1053
1364
  # Updating a `Config` will not update the execution parameters for
1054
1365
  # existing future contacts scheduled with this `Config`.
1055
1366
  #
1056
1367
  # @option params [required, Types::ConfigTypeData] :config_data
1057
- # Parameters for a `Config`.
1368
+ # Parameters of a `Config`.
1058
1369
  #
1059
1370
  # @option params [required, String] :config_id
1060
1371
  # UUID of a `Config`.
@@ -1122,6 +1433,7 @@ module Aws::GroundStation
1122
1433
  # },
1123
1434
  # dataflow_endpoint_config: {
1124
1435
  # dataflow_endpoint_name: "String", # required
1436
+ # dataflow_endpoint_region: "String",
1125
1437
  # },
1126
1438
  # tracking_config: {
1127
1439
  # autotrack: "PREFERRED", # required, accepts PREFERRED, REMOVED, REQUIRED
@@ -1165,8 +1477,8 @@ module Aws::GroundStation
1165
1477
  # CloudWatch event indicating the pass has finished.
1166
1478
  #
1167
1479
  # @option params [Array<Array>] :dataflow_edges
1168
- # A list of lists of ARNs. Each list of ARNs is an edge, with a from
1169
- # `Config` and a to `Config`.
1480
+ # A list of lists of ARNs. Each list of ARNs is an edge, with a *from*
1481
+ # `Config` and a *to* `Config`.
1170
1482
  #
1171
1483
  # @option params [Integer] :minimum_viable_contact_duration_seconds
1172
1484
  # Smallest amount of time in seconds that you’d like to see for an
@@ -1174,7 +1486,7 @@ module Aws::GroundStation
1174
1486
  # contacts shorter than this duration.
1175
1487
  #
1176
1488
  # @option params [required, String] :mission_profile_id
1177
- # ID of a mission profile.
1489
+ # UUID of a mission profile.
1178
1490
  #
1179
1491
  # @option params [String] :name
1180
1492
  # Name of a mission profile.
@@ -1213,244 +1525,6 @@ module Aws::GroundStation
1213
1525
  req.send_request(options)
1214
1526
  end
1215
1527
 
1216
- # Returns the number of minutes used by account.
1217
- #
1218
- # @option params [required, Integer] :month
1219
- # The month being requested, with a value of 1-12.
1220
- #
1221
- # @option params [required, Integer] :year
1222
- # The year being requested, in the format of YYYY.
1223
- #
1224
- # @return [Types::GetMinuteUsageResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1225
- #
1226
- # * {Types::GetMinuteUsageResponse#estimated_minutes_remaining #estimated_minutes_remaining} => Integer
1227
- # * {Types::GetMinuteUsageResponse#is_reserved_minutes_customer #is_reserved_minutes_customer} => Boolean
1228
- # * {Types::GetMinuteUsageResponse#total_reserved_minute_allocation #total_reserved_minute_allocation} => Integer
1229
- # * {Types::GetMinuteUsageResponse#total_scheduled_minutes #total_scheduled_minutes} => Integer
1230
- # * {Types::GetMinuteUsageResponse#upcoming_minutes_scheduled #upcoming_minutes_scheduled} => Integer
1231
- #
1232
- # @example Request syntax with placeholder values
1233
- #
1234
- # resp = client.get_minute_usage({
1235
- # month: 1, # required
1236
- # year: 1, # required
1237
- # })
1238
- #
1239
- # @example Response structure
1240
- #
1241
- # resp.estimated_minutes_remaining #=> Integer
1242
- # resp.is_reserved_minutes_customer #=> Boolean
1243
- # resp.total_reserved_minute_allocation #=> Integer
1244
- # resp.total_scheduled_minutes #=> Integer
1245
- # resp.upcoming_minutes_scheduled #=> Integer
1246
- #
1247
- # @see http://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/GetMinuteUsage AWS API Documentation
1248
- #
1249
- # @overload get_minute_usage(params = {})
1250
- # @param [Hash] params ({})
1251
- def get_minute_usage(params = {}, options = {})
1252
- req = build_request(:get_minute_usage, params)
1253
- req.send_request(options)
1254
- end
1255
-
1256
- # Returns a satellite.
1257
- #
1258
- # @option params [required, String] :satellite_id
1259
- # UUID of a satellite.
1260
- #
1261
- # @return [Types::GetSatelliteResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1262
- #
1263
- # * {Types::GetSatelliteResponse#date_created #date_created} => Time
1264
- # * {Types::GetSatelliteResponse#last_updated #last_updated} => Time
1265
- # * {Types::GetSatelliteResponse#norad_satellite_id #norad_satellite_id} => Integer
1266
- # * {Types::GetSatelliteResponse#satellite_arn #satellite_arn} => String
1267
- # * {Types::GetSatelliteResponse#satellite_id #satellite_id} => String
1268
- # * {Types::GetSatelliteResponse#tags #tags} => Hash&lt;String,String&gt;
1269
- #
1270
- # @example Request syntax with placeholder values
1271
- #
1272
- # resp = client.get_satellite({
1273
- # satellite_id: "String", # required
1274
- # })
1275
- #
1276
- # @example Response structure
1277
- #
1278
- # resp.date_created #=> Time
1279
- # resp.last_updated #=> Time
1280
- # resp.norad_satellite_id #=> Integer
1281
- # resp.satellite_arn #=> String
1282
- # resp.satellite_id #=> String
1283
- # resp.tags #=> Hash
1284
- # resp.tags["String"] #=> String
1285
- #
1286
- # @see http://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/GetSatellite AWS API Documentation
1287
- #
1288
- # @overload get_satellite(params = {})
1289
- # @param [Hash] params ({})
1290
- def get_satellite(params = {}, options = {})
1291
- req = build_request(:get_satellite, params)
1292
- req.send_request(options)
1293
- end
1294
-
1295
- # Returns a list of ground stations.
1296
- #
1297
- # @option params [Integer] :max_results
1298
- # Maximum number of ground stations returned.
1299
- #
1300
- # @option params [String] :next_token
1301
- # Next token that can be supplied in the next call to get the next page
1302
- # of ground stations.
1303
- #
1304
- # @return [Types::ListGroundStationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1305
- #
1306
- # * {Types::ListGroundStationsResponse#ground_station_list #ground_station_list} => Array&lt;Types::GroundStationData&gt;
1307
- # * {Types::ListGroundStationsResponse#next_token #next_token} => String
1308
- #
1309
- # @example Request syntax with placeholder values
1310
- #
1311
- # resp = client.list_ground_stations({
1312
- # max_results: 1,
1313
- # next_token: "String",
1314
- # })
1315
- #
1316
- # @example Response structure
1317
- #
1318
- # resp.ground_station_list #=> Array
1319
- # resp.ground_station_list[0].ground_station_id #=> String
1320
- # resp.ground_station_list[0].ground_station_name #=> String
1321
- # resp.ground_station_list[0].region #=> String
1322
- # resp.next_token #=> String
1323
- #
1324
- # @see http://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/ListGroundStations AWS API Documentation
1325
- #
1326
- # @overload list_ground_stations(params = {})
1327
- # @param [Hash] params ({})
1328
- def list_ground_stations(params = {}, options = {})
1329
- req = build_request(:list_ground_stations, params)
1330
- req.send_request(options)
1331
- end
1332
-
1333
- # Returns a list of satellites.
1334
- #
1335
- # @option params [Integer] :max_results
1336
- # Maximum number of satellites returned.
1337
- #
1338
- # @option params [String] :next_token
1339
- # Next token that can be supplied in the next call to get the next page
1340
- # of satellites.
1341
- #
1342
- # @return [Types::ListSatellitesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1343
- #
1344
- # * {Types::ListSatellitesResponse#next_token #next_token} => String
1345
- # * {Types::ListSatellitesResponse#satellites #satellites} => Array&lt;Types::SatelliteListItem&gt;
1346
- #
1347
- # @example Request syntax with placeholder values
1348
- #
1349
- # resp = client.list_satellites({
1350
- # max_results: 1,
1351
- # next_token: "String",
1352
- # })
1353
- #
1354
- # @example Response structure
1355
- #
1356
- # resp.next_token #=> String
1357
- # resp.satellites #=> Array
1358
- # resp.satellites[0].norad_satellite_id #=> Integer
1359
- # resp.satellites[0].satellite_arn #=> String
1360
- # resp.satellites[0].satellite_id #=> String
1361
- #
1362
- # @see http://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/ListSatellites AWS API Documentation
1363
- #
1364
- # @overload list_satellites(params = {})
1365
- # @param [Hash] params ({})
1366
- def list_satellites(params = {}, options = {})
1367
- req = build_request(:list_satellites, params)
1368
- req.send_request(options)
1369
- end
1370
-
1371
- # Returns a list of tags or a specified resource.
1372
- #
1373
- # @option params [required, String] :resource_arn
1374
- # ARN of a resource.
1375
- #
1376
- # @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1377
- #
1378
- # * {Types::ListTagsForResourceResponse#tags #tags} => Hash&lt;String,String&gt;
1379
- #
1380
- # @example Request syntax with placeholder values
1381
- #
1382
- # resp = client.list_tags_for_resource({
1383
- # resource_arn: "String", # required
1384
- # })
1385
- #
1386
- # @example Response structure
1387
- #
1388
- # resp.tags #=> Hash
1389
- # resp.tags["String"] #=> String
1390
- #
1391
- # @see http://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/ListTagsForResource AWS API Documentation
1392
- #
1393
- # @overload list_tags_for_resource(params = {})
1394
- # @param [Hash] params ({})
1395
- def list_tags_for_resource(params = {}, options = {})
1396
- req = build_request(:list_tags_for_resource, params)
1397
- req.send_request(options)
1398
- end
1399
-
1400
- # Assigns a tag to a resource.
1401
- #
1402
- # @option params [required, String] :resource_arn
1403
- # ARN of a resource tag.
1404
- #
1405
- # @option params [Hash<String,String>] :tags
1406
- # Tags assigned to a resource.
1407
- #
1408
- # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1409
- #
1410
- # @example Request syntax with placeholder values
1411
- #
1412
- # resp = client.tag_resource({
1413
- # resource_arn: "String", # required
1414
- # tags: {
1415
- # "String" => "String",
1416
- # },
1417
- # })
1418
- #
1419
- # @see http://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/TagResource AWS API Documentation
1420
- #
1421
- # @overload tag_resource(params = {})
1422
- # @param [Hash] params ({})
1423
- def tag_resource(params = {}, options = {})
1424
- req = build_request(:tag_resource, params)
1425
- req.send_request(options)
1426
- end
1427
-
1428
- # Deassigns a resource tag.
1429
- #
1430
- # @option params [required, String] :resource_arn
1431
- # ARN of a resource.
1432
- #
1433
- # @option params [required, Array<String>] :tag_keys
1434
- # Keys of a resource tag.
1435
- #
1436
- # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1437
- #
1438
- # @example Request syntax with placeholder values
1439
- #
1440
- # resp = client.untag_resource({
1441
- # resource_arn: "String", # required
1442
- # tag_keys: ["String"], # required
1443
- # })
1444
- #
1445
- # @see http://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/UntagResource AWS API Documentation
1446
- #
1447
- # @overload untag_resource(params = {})
1448
- # @param [Hash] params ({})
1449
- def untag_resource(params = {}, options = {})
1450
- req = build_request(:untag_resource, params)
1451
- req.send_request(options)
1452
- end
1453
-
1454
1528
  # @!endgroup
1455
1529
 
1456
1530
  # @param params ({})
@@ -1464,7 +1538,7 @@ module Aws::GroundStation
1464
1538
  params: params,
1465
1539
  config: config)
1466
1540
  context[:gem_name] = 'aws-sdk-groundstation'
1467
- context[:gem_version] = '1.3.0'
1541
+ context[:gem_version] = '1.8.0'
1468
1542
  Seahorse::Client::Request.new(handlers, context)
1469
1543
  end
1470
1544