aws-sdk-groundstation 1.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/lib/aws-sdk-groundstation.rb +47 -0
- data/lib/aws-sdk-groundstation/client.rb +1485 -0
- data/lib/aws-sdk-groundstation/client_api.rb +830 -0
- data/lib/aws-sdk-groundstation/customizations.rb +0 -0
- data/lib/aws-sdk-groundstation/errors.rb +72 -0
- data/lib/aws-sdk-groundstation/resource.rb +23 -0
- data/lib/aws-sdk-groundstation/types.rb +2161 -0
- metadata +88 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: fc23dd4555b037b22508330a9007a5084f6ead00
|
4
|
+
data.tar.gz: 7d4a361ae5e0087cba181af261ff4e716e86c205
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 0afb33f7c9d6d45a53f148c3eac1e05776bc06c58355c374be30993cc00086db2fd18f16ef0363e0e915863aa59036b9b1e409f21873145e82767ca8da354d46
|
7
|
+
data.tar.gz: 73ab8eee3444ddc5a5a4b12070656ee84b546a87ac1a386f501666b0408d8ed6d07389815482fdfcb4f97330df6a6e2dd98fb3d04996920c66f82551de584def
|
@@ -0,0 +1,47 @@
|
|
1
|
+
# WARNING ABOUT GENERATED CODE
|
2
|
+
#
|
3
|
+
# This file is generated. See the contributing guide for more information:
|
4
|
+
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
5
|
+
#
|
6
|
+
# WARNING ABOUT GENERATED CODE
|
7
|
+
|
8
|
+
require 'aws-sdk-core'
|
9
|
+
require 'aws-sigv4'
|
10
|
+
|
11
|
+
require_relative 'aws-sdk-groundstation/types'
|
12
|
+
require_relative 'aws-sdk-groundstation/client_api'
|
13
|
+
require_relative 'aws-sdk-groundstation/client'
|
14
|
+
require_relative 'aws-sdk-groundstation/errors'
|
15
|
+
require_relative 'aws-sdk-groundstation/resource'
|
16
|
+
require_relative 'aws-sdk-groundstation/customizations'
|
17
|
+
|
18
|
+
# This module provides support for AWS Ground Station. This module is available in the
|
19
|
+
# `aws-sdk-groundstation` gem.
|
20
|
+
#
|
21
|
+
# # Client
|
22
|
+
#
|
23
|
+
# The {Client} class provides one method for each API operation. Operation
|
24
|
+
# methods each accept a hash of request parameters and return a response
|
25
|
+
# structure.
|
26
|
+
#
|
27
|
+
# See {Client} for more information.
|
28
|
+
#
|
29
|
+
# # Errors
|
30
|
+
#
|
31
|
+
# Errors returned from AWS Ground Station all
|
32
|
+
# extend {Errors::ServiceError}.
|
33
|
+
#
|
34
|
+
# begin
|
35
|
+
# # do stuff
|
36
|
+
# rescue Aws::GroundStation::Errors::ServiceError
|
37
|
+
# # rescues all service API errors
|
38
|
+
# end
|
39
|
+
#
|
40
|
+
# See {Errors} for more information.
|
41
|
+
#
|
42
|
+
# @service
|
43
|
+
module Aws::GroundStation
|
44
|
+
|
45
|
+
GEM_VERSION = '1.0.0'
|
46
|
+
|
47
|
+
end
|
@@ -0,0 +1,1485 @@
|
|
1
|
+
# WARNING ABOUT GENERATED CODE
|
2
|
+
#
|
3
|
+
# This file is generated. See the contributing guide for more information:
|
4
|
+
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
5
|
+
#
|
6
|
+
# WARNING ABOUT GENERATED CODE
|
7
|
+
|
8
|
+
require 'seahorse/client/plugins/content_length.rb'
|
9
|
+
require 'aws-sdk-core/plugins/credentials_configuration.rb'
|
10
|
+
require 'aws-sdk-core/plugins/logging.rb'
|
11
|
+
require 'aws-sdk-core/plugins/param_converter.rb'
|
12
|
+
require 'aws-sdk-core/plugins/param_validator.rb'
|
13
|
+
require 'aws-sdk-core/plugins/user_agent.rb'
|
14
|
+
require 'aws-sdk-core/plugins/helpful_socket_errors.rb'
|
15
|
+
require 'aws-sdk-core/plugins/retry_errors.rb'
|
16
|
+
require 'aws-sdk-core/plugins/global_configuration.rb'
|
17
|
+
require 'aws-sdk-core/plugins/regional_endpoint.rb'
|
18
|
+
require 'aws-sdk-core/plugins/endpoint_discovery.rb'
|
19
|
+
require 'aws-sdk-core/plugins/endpoint_pattern.rb'
|
20
|
+
require 'aws-sdk-core/plugins/response_paging.rb'
|
21
|
+
require 'aws-sdk-core/plugins/stub_responses.rb'
|
22
|
+
require 'aws-sdk-core/plugins/idempotency_token.rb'
|
23
|
+
require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
|
24
|
+
require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
|
25
|
+
require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
|
26
|
+
require 'aws-sdk-core/plugins/transfer_encoding.rb'
|
27
|
+
require 'aws-sdk-core/plugins/signature_v4.rb'
|
28
|
+
require 'aws-sdk-core/plugins/protocols/rest_json.rb'
|
29
|
+
|
30
|
+
Aws::Plugins::GlobalConfiguration.add_identifier(:groundstation)
|
31
|
+
|
32
|
+
module Aws::GroundStation
|
33
|
+
class Client < Seahorse::Client::Base
|
34
|
+
|
35
|
+
include Aws::ClientStubs
|
36
|
+
|
37
|
+
@identifier = :groundstation
|
38
|
+
|
39
|
+
set_api(ClientApi::API)
|
40
|
+
|
41
|
+
add_plugin(Seahorse::Client::Plugins::ContentLength)
|
42
|
+
add_plugin(Aws::Plugins::CredentialsConfiguration)
|
43
|
+
add_plugin(Aws::Plugins::Logging)
|
44
|
+
add_plugin(Aws::Plugins::ParamConverter)
|
45
|
+
add_plugin(Aws::Plugins::ParamValidator)
|
46
|
+
add_plugin(Aws::Plugins::UserAgent)
|
47
|
+
add_plugin(Aws::Plugins::HelpfulSocketErrors)
|
48
|
+
add_plugin(Aws::Plugins::RetryErrors)
|
49
|
+
add_plugin(Aws::Plugins::GlobalConfiguration)
|
50
|
+
add_plugin(Aws::Plugins::RegionalEndpoint)
|
51
|
+
add_plugin(Aws::Plugins::EndpointDiscovery)
|
52
|
+
add_plugin(Aws::Plugins::EndpointPattern)
|
53
|
+
add_plugin(Aws::Plugins::ResponsePaging)
|
54
|
+
add_plugin(Aws::Plugins::StubResponses)
|
55
|
+
add_plugin(Aws::Plugins::IdempotencyToken)
|
56
|
+
add_plugin(Aws::Plugins::JsonvalueConverter)
|
57
|
+
add_plugin(Aws::Plugins::ClientMetricsPlugin)
|
58
|
+
add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
|
59
|
+
add_plugin(Aws::Plugins::TransferEncoding)
|
60
|
+
add_plugin(Aws::Plugins::SignatureV4)
|
61
|
+
add_plugin(Aws::Plugins::Protocols::RestJson)
|
62
|
+
|
63
|
+
# @overload initialize(options)
|
64
|
+
# @param [Hash] options
|
65
|
+
# @option options [required, Aws::CredentialProvider] :credentials
|
66
|
+
# Your AWS credentials. This can be an instance of any one of the
|
67
|
+
# following classes:
|
68
|
+
#
|
69
|
+
# * `Aws::Credentials` - Used for configuring static, non-refreshing
|
70
|
+
# credentials.
|
71
|
+
#
|
72
|
+
# * `Aws::InstanceProfileCredentials` - Used for loading credentials
|
73
|
+
# from an EC2 IMDS on an EC2 instance.
|
74
|
+
#
|
75
|
+
# * `Aws::SharedCredentials` - Used for loading credentials from a
|
76
|
+
# shared file, such as `~/.aws/config`.
|
77
|
+
#
|
78
|
+
# * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
|
79
|
+
#
|
80
|
+
# When `:credentials` are not configured directly, the following
|
81
|
+
# locations will be searched for credentials:
|
82
|
+
#
|
83
|
+
# * `Aws.config[:credentials]`
|
84
|
+
# * The `:access_key_id`, `:secret_access_key`, and `:session_token` options.
|
85
|
+
# * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
|
86
|
+
# * `~/.aws/credentials`
|
87
|
+
# * `~/.aws/config`
|
88
|
+
# * EC2 IMDS instance profile - When used by default, the timeouts are
|
89
|
+
# very aggressive. Construct and pass an instance of
|
90
|
+
# `Aws::InstanceProfileCredentails` to enable retries and extended
|
91
|
+
# timeouts.
|
92
|
+
#
|
93
|
+
# @option options [required, String] :region
|
94
|
+
# The AWS region to connect to. The configured `:region` is
|
95
|
+
# used to determine the service `:endpoint`. When not passed,
|
96
|
+
# a default `:region` is search for in the following locations:
|
97
|
+
#
|
98
|
+
# * `Aws.config[:region]`
|
99
|
+
# * `ENV['AWS_REGION']`
|
100
|
+
# * `ENV['AMAZON_REGION']`
|
101
|
+
# * `ENV['AWS_DEFAULT_REGION']`
|
102
|
+
# * `~/.aws/credentials`
|
103
|
+
# * `~/.aws/config`
|
104
|
+
#
|
105
|
+
# @option options [String] :access_key_id
|
106
|
+
#
|
107
|
+
# @option options [Boolean] :active_endpoint_cache (false)
|
108
|
+
# When set to `true`, a thread polling for endpoints will be running in
|
109
|
+
# the background every 60 secs (default). Defaults to `false`.
|
110
|
+
#
|
111
|
+
# @option options [Boolean] :client_side_monitoring (false)
|
112
|
+
# When `true`, client-side metrics will be collected for all API requests from
|
113
|
+
# this client.
|
114
|
+
#
|
115
|
+
# @option options [String] :client_side_monitoring_client_id ("")
|
116
|
+
# Allows you to provide an identifier for this client which will be attached to
|
117
|
+
# all generated client side metrics. Defaults to an empty string.
|
118
|
+
#
|
119
|
+
# @option options [Integer] :client_side_monitoring_port (31000)
|
120
|
+
# Required for publishing client metrics. The port that the client side monitoring
|
121
|
+
# agent is running on, where client metrics will be published via UDP.
|
122
|
+
#
|
123
|
+
# @option options [Aws::ClientSideMonitoring::Publisher] :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher)
|
124
|
+
# Allows you to provide a custom client-side monitoring publisher class. By default,
|
125
|
+
# will use the Client Side Monitoring Agent Publisher.
|
126
|
+
#
|
127
|
+
# @option options [Boolean] :convert_params (true)
|
128
|
+
# When `true`, an attempt is made to coerce request parameters into
|
129
|
+
# the required types.
|
130
|
+
#
|
131
|
+
# @option options [Boolean] :disable_host_prefix_injection (false)
|
132
|
+
# Set to true to disable SDK automatically adding host prefix
|
133
|
+
# to default service endpoint when available.
|
134
|
+
#
|
135
|
+
# @option options [String] :endpoint
|
136
|
+
# The client endpoint is normally constructed from the `:region`
|
137
|
+
# option. You should only configure an `:endpoint` when connecting
|
138
|
+
# to test endpoints. This should be avalid HTTP(S) URI.
|
139
|
+
#
|
140
|
+
# @option options [Integer] :endpoint_cache_max_entries (1000)
|
141
|
+
# Used for the maximum size limit of the LRU cache storing endpoints data
|
142
|
+
# for endpoint discovery enabled operations. Defaults to 1000.
|
143
|
+
#
|
144
|
+
# @option options [Integer] :endpoint_cache_max_threads (10)
|
145
|
+
# Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.
|
146
|
+
#
|
147
|
+
# @option options [Integer] :endpoint_cache_poll_interval (60)
|
148
|
+
# When :endpoint_discovery and :active_endpoint_cache is enabled,
|
149
|
+
# Use this option to config the time interval in seconds for making
|
150
|
+
# requests fetching endpoints information. Defaults to 60 sec.
|
151
|
+
#
|
152
|
+
# @option options [Boolean] :endpoint_discovery (false)
|
153
|
+
# When set to `true`, endpoint discovery will be enabled for operations when available. Defaults to `false`.
|
154
|
+
#
|
155
|
+
# @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
|
156
|
+
# The log formatter.
|
157
|
+
#
|
158
|
+
# @option options [Symbol] :log_level (:info)
|
159
|
+
# The log level to send messages to the `:logger` at.
|
160
|
+
#
|
161
|
+
# @option options [Logger] :logger
|
162
|
+
# The Logger instance to send log messages to. If this option
|
163
|
+
# is not set, logging will be disabled.
|
164
|
+
#
|
165
|
+
# @option options [String] :profile ("default")
|
166
|
+
# Used when loading credentials from the shared credentials file
|
167
|
+
# at HOME/.aws/credentials. When not specified, 'default' is used.
|
168
|
+
#
|
169
|
+
# @option options [Float] :retry_base_delay (0.3)
|
170
|
+
# The base delay in seconds used by the default backoff function.
|
171
|
+
#
|
172
|
+
# @option options [Symbol] :retry_jitter (:none)
|
173
|
+
# 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.
|
174
|
+
#
|
175
|
+
# @see https://www.awsarchitectureblog.com/2015/03/backoff.html
|
176
|
+
#
|
177
|
+
# @option options [Integer] :retry_limit (3)
|
178
|
+
# The maximum number of times to retry failed requests. Only
|
179
|
+
# ~ 500 level server errors and certain ~ 400 level client errors
|
180
|
+
# are retried. Generally, these are throttling errors, data
|
181
|
+
# checksum errors, networking errors, timeout errors and auth
|
182
|
+
# errors from expired credentials.
|
183
|
+
#
|
184
|
+
# @option options [Integer] :retry_max_delay (0)
|
185
|
+
# The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function.
|
186
|
+
#
|
187
|
+
# @option options [String] :secret_access_key
|
188
|
+
#
|
189
|
+
# @option options [String] :session_token
|
190
|
+
#
|
191
|
+
# @option options [Boolean] :stub_responses (false)
|
192
|
+
# Causes the client to return stubbed responses. By default
|
193
|
+
# fake responses are generated and returned. You can specify
|
194
|
+
# the response data to return or errors to raise by calling
|
195
|
+
# {ClientStubs#stub_responses}. See {ClientStubs} for more information.
|
196
|
+
#
|
197
|
+
# ** Please note ** When response stubbing is enabled, no HTTP
|
198
|
+
# requests are made, and retries are disabled.
|
199
|
+
#
|
200
|
+
# @option options [Boolean] :validate_params (true)
|
201
|
+
# When `true`, request parameters are validated before
|
202
|
+
# sending the request.
|
203
|
+
#
|
204
|
+
# @option options [URI::HTTP,String] :http_proxy A proxy to send
|
205
|
+
# requests through. Formatted like 'http://proxy.com:123'.
|
206
|
+
#
|
207
|
+
# @option options [Float] :http_open_timeout (15) The number of
|
208
|
+
# seconds to wait when opening a HTTP session before rasing a
|
209
|
+
# `Timeout::Error`.
|
210
|
+
#
|
211
|
+
# @option options [Integer] :http_read_timeout (60) The default
|
212
|
+
# number of seconds to wait for response data. This value can
|
213
|
+
# safely be set
|
214
|
+
# per-request on the session yeidled by {#session_for}.
|
215
|
+
#
|
216
|
+
# @option options [Float] :http_idle_timeout (5) The number of
|
217
|
+
# seconds a connection is allowed to sit idble before it is
|
218
|
+
# considered stale. Stale connections are closed and removed
|
219
|
+
# from the pool before making a request.
|
220
|
+
#
|
221
|
+
# @option options [Float] :http_continue_timeout (1) The number of
|
222
|
+
# seconds to wait for a 100-continue response before sending the
|
223
|
+
# request body. This option has no effect unless the request has
|
224
|
+
# "Expect" header set to "100-continue". Defaults to `nil` which
|
225
|
+
# disables this behaviour. This value can safely be set per
|
226
|
+
# request on the session yeidled by {#session_for}.
|
227
|
+
#
|
228
|
+
# @option options [Boolean] :http_wire_trace (false) When `true`,
|
229
|
+
# HTTP debug output will be sent to the `:logger`.
|
230
|
+
#
|
231
|
+
# @option options [Boolean] :ssl_verify_peer (true) When `true`,
|
232
|
+
# SSL peer certificates are verified when establishing a
|
233
|
+
# connection.
|
234
|
+
#
|
235
|
+
# @option options [String] :ssl_ca_bundle Full path to the SSL
|
236
|
+
# certificate authority bundle file that should be used when
|
237
|
+
# verifying peer certificates. If you do not pass
|
238
|
+
# `:ssl_ca_bundle` or `:ssl_ca_directory` the the system default
|
239
|
+
# will be used if available.
|
240
|
+
#
|
241
|
+
# @option options [String] :ssl_ca_directory Full path of the
|
242
|
+
# directory that contains the unbundled SSL certificate
|
243
|
+
# authority files for verifying peer certificates. If you do
|
244
|
+
# not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the
|
245
|
+
# system default will be used if available.
|
246
|
+
#
|
247
|
+
def initialize(*args)
|
248
|
+
super
|
249
|
+
end
|
250
|
+
|
251
|
+
# @!group API Operations
|
252
|
+
|
253
|
+
# Cancels a contact with a specified contact ID.
|
254
|
+
#
|
255
|
+
# @option params [required, String] :contact_id
|
256
|
+
# UUID of a contact.
|
257
|
+
#
|
258
|
+
# @return [Types::ContactIdResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
259
|
+
#
|
260
|
+
# * {Types::ContactIdResponse#contact_id #contact_id} => String
|
261
|
+
#
|
262
|
+
# @example Request syntax with placeholder values
|
263
|
+
#
|
264
|
+
# resp = client.cancel_contact({
|
265
|
+
# contact_id: "String", # required
|
266
|
+
# })
|
267
|
+
#
|
268
|
+
# @example Response structure
|
269
|
+
#
|
270
|
+
# resp.contact_id #=> String
|
271
|
+
#
|
272
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/CancelContact AWS API Documentation
|
273
|
+
#
|
274
|
+
# @overload cancel_contact(params = {})
|
275
|
+
# @param [Hash] params ({})
|
276
|
+
def cancel_contact(params = {}, options = {})
|
277
|
+
req = build_request(:cancel_contact, params)
|
278
|
+
req.send_request(options)
|
279
|
+
end
|
280
|
+
|
281
|
+
# Creates a `Config` with the specified `configData` parameters.
|
282
|
+
#
|
283
|
+
# Only one type of `configData` can be specified.
|
284
|
+
#
|
285
|
+
# @option params [required, Types::ConfigTypeData] :config_data
|
286
|
+
# Parameters of a `Config`.
|
287
|
+
#
|
288
|
+
# @option params [required, String] :name
|
289
|
+
# Name of a `Config`.
|
290
|
+
#
|
291
|
+
# @option params [Hash<String,String>] :tags
|
292
|
+
# Tags assigned to a `Config`.
|
293
|
+
#
|
294
|
+
# @return [Types::ConfigIdResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
295
|
+
#
|
296
|
+
# * {Types::ConfigIdResponse#config_arn #config_arn} => String
|
297
|
+
# * {Types::ConfigIdResponse#config_id #config_id} => String
|
298
|
+
# * {Types::ConfigIdResponse#config_type #config_type} => String
|
299
|
+
#
|
300
|
+
# @example Request syntax with placeholder values
|
301
|
+
#
|
302
|
+
# resp = client.create_config({
|
303
|
+
# config_data: { # required
|
304
|
+
# antenna_downlink_config: {
|
305
|
+
# spectrum_config: { # required
|
306
|
+
# bandwidth: { # required
|
307
|
+
# units: "GHz", # required, accepts GHz, MHz, kHz
|
308
|
+
# value: 1.0, # required
|
309
|
+
# },
|
310
|
+
# center_frequency: { # required
|
311
|
+
# units: "GHz", # required, accepts GHz, MHz, kHz
|
312
|
+
# value: 1.0, # required
|
313
|
+
# },
|
314
|
+
# polarization: "LEFT_HAND", # accepts LEFT_HAND, NONE, RIGHT_HAND
|
315
|
+
# },
|
316
|
+
# },
|
317
|
+
# antenna_downlink_demod_decode_config: {
|
318
|
+
# decode_config: { # required
|
319
|
+
# unvalidated_json: "JsonString", # required
|
320
|
+
# },
|
321
|
+
# demodulation_config: { # required
|
322
|
+
# unvalidated_json: "JsonString", # required
|
323
|
+
# },
|
324
|
+
# spectrum_config: { # required
|
325
|
+
# bandwidth: { # required
|
326
|
+
# units: "GHz", # required, accepts GHz, MHz, kHz
|
327
|
+
# value: 1.0, # required
|
328
|
+
# },
|
329
|
+
# center_frequency: { # required
|
330
|
+
# units: "GHz", # required, accepts GHz, MHz, kHz
|
331
|
+
# value: 1.0, # required
|
332
|
+
# },
|
333
|
+
# polarization: "LEFT_HAND", # accepts LEFT_HAND, NONE, RIGHT_HAND
|
334
|
+
# },
|
335
|
+
# },
|
336
|
+
# antenna_uplink_config: {
|
337
|
+
# spectrum_config: { # required
|
338
|
+
# center_frequency: { # required
|
339
|
+
# units: "GHz", # required, accepts GHz, MHz, kHz
|
340
|
+
# value: 1.0, # required
|
341
|
+
# },
|
342
|
+
# polarization: "LEFT_HAND", # accepts LEFT_HAND, NONE, RIGHT_HAND
|
343
|
+
# },
|
344
|
+
# target_eirp: { # required
|
345
|
+
# units: "dBW", # required, accepts dBW
|
346
|
+
# value: 1.0, # required
|
347
|
+
# },
|
348
|
+
# },
|
349
|
+
# dataflow_endpoint_config: {
|
350
|
+
# dataflow_endpoint_name: "String", # required
|
351
|
+
# },
|
352
|
+
# tracking_config: {
|
353
|
+
# autotrack: "PREFERRED", # required, accepts PREFERRED, REMOVED, REQUIRED
|
354
|
+
# },
|
355
|
+
# uplink_echo_config: {
|
356
|
+
# antenna_uplink_config_arn: "ConfigArn", # required
|
357
|
+
# enabled: false, # required
|
358
|
+
# },
|
359
|
+
# },
|
360
|
+
# name: "SafeName", # required
|
361
|
+
# tags: {
|
362
|
+
# "String" => "String",
|
363
|
+
# },
|
364
|
+
# })
|
365
|
+
#
|
366
|
+
# @example Response structure
|
367
|
+
#
|
368
|
+
# resp.config_arn #=> String
|
369
|
+
# resp.config_id #=> String
|
370
|
+
# resp.config_type #=> String, one of "antenna-downlink", "antenna-downlink-demod-decode", "antenna-uplink", "dataflow-endpoint", "tracking", "uplink-echo"
|
371
|
+
#
|
372
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/CreateConfig AWS API Documentation
|
373
|
+
#
|
374
|
+
# @overload create_config(params = {})
|
375
|
+
# @param [Hash] params ({})
|
376
|
+
def create_config(params = {}, options = {})
|
377
|
+
req = build_request(:create_config, params)
|
378
|
+
req.send_request(options)
|
379
|
+
end
|
380
|
+
|
381
|
+
# Creates a `DataflowEndpoint` group containing the specified list of
|
382
|
+
# `DataflowEndpoint` objects.
|
383
|
+
#
|
384
|
+
# The `name` field in each endpoint is used in your mission profile
|
385
|
+
# `DataflowEndpointConfig` to specify which endpoints to use during a
|
386
|
+
# contact.
|
387
|
+
#
|
388
|
+
# When a contact uses multiple `DataflowEndpointConfig` objects, each
|
389
|
+
# `Config` must match a `DataflowEndpoint` in the same group.
|
390
|
+
#
|
391
|
+
# @option params [required, Array<Types::EndpointDetails>] :endpoint_details
|
392
|
+
# Endpoint details of each endpoint in the dataflow endpoint group.
|
393
|
+
#
|
394
|
+
# @option params [Hash<String,String>] :tags
|
395
|
+
# Tags of a dataflow endpoint group.
|
396
|
+
#
|
397
|
+
# @return [Types::DataflowEndpointGroupIdResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
398
|
+
#
|
399
|
+
# * {Types::DataflowEndpointGroupIdResponse#dataflow_endpoint_group_id #dataflow_endpoint_group_id} => String
|
400
|
+
#
|
401
|
+
# @example Request syntax with placeholder values
|
402
|
+
#
|
403
|
+
# resp = client.create_dataflow_endpoint_group({
|
404
|
+
# endpoint_details: [ # required
|
405
|
+
# {
|
406
|
+
# endpoint: {
|
407
|
+
# address: {
|
408
|
+
# name: "String", # required
|
409
|
+
# port: 1, # required
|
410
|
+
# },
|
411
|
+
# name: "SafeName",
|
412
|
+
# status: "created", # accepts created, creating, deleted, deleting, failed
|
413
|
+
# },
|
414
|
+
# security_details: {
|
415
|
+
# role_arn: "RoleArn", # required
|
416
|
+
# security_group_ids: ["String"], # required
|
417
|
+
# subnet_ids: ["String"], # required
|
418
|
+
# },
|
419
|
+
# },
|
420
|
+
# ],
|
421
|
+
# tags: {
|
422
|
+
# "String" => "String",
|
423
|
+
# },
|
424
|
+
# })
|
425
|
+
#
|
426
|
+
# @example Response structure
|
427
|
+
#
|
428
|
+
# resp.dataflow_endpoint_group_id #=> String
|
429
|
+
#
|
430
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/CreateDataflowEndpointGroup AWS API Documentation
|
431
|
+
#
|
432
|
+
# @overload create_dataflow_endpoint_group(params = {})
|
433
|
+
# @param [Hash] params ({})
|
434
|
+
def create_dataflow_endpoint_group(params = {}, options = {})
|
435
|
+
req = build_request(:create_dataflow_endpoint_group, params)
|
436
|
+
req.send_request(options)
|
437
|
+
end
|
438
|
+
|
439
|
+
# Creates a mission profile.
|
440
|
+
#
|
441
|
+
# `dataflowEdges` is a list of lists of strings. Each lower level list
|
442
|
+
# of strings has two elements: a *from ARN* and a *to ARN*.
|
443
|
+
#
|
444
|
+
# @option params [Integer] :contact_post_pass_duration_seconds
|
445
|
+
# Amount of time after a contact ends that you’d like to receive a
|
446
|
+
# CloudWatch event indicating the pass has finished.
|
447
|
+
#
|
448
|
+
# @option params [Integer] :contact_pre_pass_duration_seconds
|
449
|
+
# Amount of time prior to contact start you’d like to receive a
|
450
|
+
# CloudWatch event indicating an upcoming pass.
|
451
|
+
#
|
452
|
+
# @option params [required, Array<Array>] :dataflow_edges
|
453
|
+
# A list of lists of ARNs. Each list of ARNs is an edge, with a from
|
454
|
+
# `Config` and a to `Config`.
|
455
|
+
#
|
456
|
+
# @option params [required, Integer] :minimum_viable_contact_duration_seconds
|
457
|
+
# Smallest amount of time in seconds that you’d like to see for an
|
458
|
+
# available contact. AWS Ground Station will not present you with
|
459
|
+
# contacts shorter than this duration.
|
460
|
+
#
|
461
|
+
# @option params [required, String] :name
|
462
|
+
# Name of a mission profile.
|
463
|
+
#
|
464
|
+
# @option params [Hash<String,String>] :tags
|
465
|
+
# Tags assigned to a mission profile.
|
466
|
+
#
|
467
|
+
# @option params [required, String] :tracking_config_arn
|
468
|
+
# ARN of a tracking `Config`.
|
469
|
+
#
|
470
|
+
# @return [Types::MissionProfileIdResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
471
|
+
#
|
472
|
+
# * {Types::MissionProfileIdResponse#mission_profile_id #mission_profile_id} => String
|
473
|
+
#
|
474
|
+
# @example Request syntax with placeholder values
|
475
|
+
#
|
476
|
+
# resp = client.create_mission_profile({
|
477
|
+
# contact_post_pass_duration_seconds: 1,
|
478
|
+
# contact_pre_pass_duration_seconds: 1,
|
479
|
+
# dataflow_edges: [ # required
|
480
|
+
# ["ConfigArn"],
|
481
|
+
# ],
|
482
|
+
# minimum_viable_contact_duration_seconds: 1, # required
|
483
|
+
# name: "SafeName", # required
|
484
|
+
# tags: {
|
485
|
+
# "String" => "String",
|
486
|
+
# },
|
487
|
+
# tracking_config_arn: "ConfigArn", # required
|
488
|
+
# })
|
489
|
+
#
|
490
|
+
# @example Response structure
|
491
|
+
#
|
492
|
+
# resp.mission_profile_id #=> String
|
493
|
+
#
|
494
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/CreateMissionProfile AWS API Documentation
|
495
|
+
#
|
496
|
+
# @overload create_mission_profile(params = {})
|
497
|
+
# @param [Hash] params ({})
|
498
|
+
def create_mission_profile(params = {}, options = {})
|
499
|
+
req = build_request(:create_mission_profile, params)
|
500
|
+
req.send_request(options)
|
501
|
+
end
|
502
|
+
|
503
|
+
# Deletes a `Config`.
|
504
|
+
#
|
505
|
+
# @option params [required, String] :config_id
|
506
|
+
# UUID of a `Config`.
|
507
|
+
#
|
508
|
+
# @option params [required, String] :config_type
|
509
|
+
# Type of a `Config`.
|
510
|
+
#
|
511
|
+
# @return [Types::ConfigIdResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
512
|
+
#
|
513
|
+
# * {Types::ConfigIdResponse#config_arn #config_arn} => String
|
514
|
+
# * {Types::ConfigIdResponse#config_id #config_id} => String
|
515
|
+
# * {Types::ConfigIdResponse#config_type #config_type} => String
|
516
|
+
#
|
517
|
+
# @example Request syntax with placeholder values
|
518
|
+
#
|
519
|
+
# resp = client.delete_config({
|
520
|
+
# config_id: "String", # required
|
521
|
+
# config_type: "antenna-downlink", # required, accepts antenna-downlink, antenna-downlink-demod-decode, antenna-uplink, dataflow-endpoint, tracking, uplink-echo
|
522
|
+
# })
|
523
|
+
#
|
524
|
+
# @example Response structure
|
525
|
+
#
|
526
|
+
# resp.config_arn #=> String
|
527
|
+
# resp.config_id #=> String
|
528
|
+
# resp.config_type #=> String, one of "antenna-downlink", "antenna-downlink-demod-decode", "antenna-uplink", "dataflow-endpoint", "tracking", "uplink-echo"
|
529
|
+
#
|
530
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/DeleteConfig AWS API Documentation
|
531
|
+
#
|
532
|
+
# @overload delete_config(params = {})
|
533
|
+
# @param [Hash] params ({})
|
534
|
+
def delete_config(params = {}, options = {})
|
535
|
+
req = build_request(:delete_config, params)
|
536
|
+
req.send_request(options)
|
537
|
+
end
|
538
|
+
|
539
|
+
# Deletes a dataflow endpoint group.
|
540
|
+
#
|
541
|
+
# @option params [required, String] :dataflow_endpoint_group_id
|
542
|
+
# ID of a dataflow endpoint group.
|
543
|
+
#
|
544
|
+
# @return [Types::DataflowEndpointGroupIdResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
545
|
+
#
|
546
|
+
# * {Types::DataflowEndpointGroupIdResponse#dataflow_endpoint_group_id #dataflow_endpoint_group_id} => String
|
547
|
+
#
|
548
|
+
# @example Request syntax with placeholder values
|
549
|
+
#
|
550
|
+
# resp = client.delete_dataflow_endpoint_group({
|
551
|
+
# dataflow_endpoint_group_id: "String", # required
|
552
|
+
# })
|
553
|
+
#
|
554
|
+
# @example Response structure
|
555
|
+
#
|
556
|
+
# resp.dataflow_endpoint_group_id #=> String
|
557
|
+
#
|
558
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/DeleteDataflowEndpointGroup AWS API Documentation
|
559
|
+
#
|
560
|
+
# @overload delete_dataflow_endpoint_group(params = {})
|
561
|
+
# @param [Hash] params ({})
|
562
|
+
def delete_dataflow_endpoint_group(params = {}, options = {})
|
563
|
+
req = build_request(:delete_dataflow_endpoint_group, params)
|
564
|
+
req.send_request(options)
|
565
|
+
end
|
566
|
+
|
567
|
+
# Deletes a mission profile.
|
568
|
+
#
|
569
|
+
# @option params [required, String] :mission_profile_id
|
570
|
+
# UUID of a mission profile.
|
571
|
+
#
|
572
|
+
# @return [Types::MissionProfileIdResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
573
|
+
#
|
574
|
+
# * {Types::MissionProfileIdResponse#mission_profile_id #mission_profile_id} => String
|
575
|
+
#
|
576
|
+
# @example Request syntax with placeholder values
|
577
|
+
#
|
578
|
+
# resp = client.delete_mission_profile({
|
579
|
+
# mission_profile_id: "String", # required
|
580
|
+
# })
|
581
|
+
#
|
582
|
+
# @example Response structure
|
583
|
+
#
|
584
|
+
# resp.mission_profile_id #=> String
|
585
|
+
#
|
586
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/DeleteMissionProfile AWS API Documentation
|
587
|
+
#
|
588
|
+
# @overload delete_mission_profile(params = {})
|
589
|
+
# @param [Hash] params ({})
|
590
|
+
def delete_mission_profile(params = {}, options = {})
|
591
|
+
req = build_request(:delete_mission_profile, params)
|
592
|
+
req.send_request(options)
|
593
|
+
end
|
594
|
+
|
595
|
+
# Describes an existing contact.
|
596
|
+
#
|
597
|
+
# @option params [required, String] :contact_id
|
598
|
+
# UUID of a contact.
|
599
|
+
#
|
600
|
+
# @return [Types::DescribeContactResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
601
|
+
#
|
602
|
+
# * {Types::DescribeContactResponse#contact_id #contact_id} => String
|
603
|
+
# * {Types::DescribeContactResponse#contact_status #contact_status} => String
|
604
|
+
# * {Types::DescribeContactResponse#end_time #end_time} => Time
|
605
|
+
# * {Types::DescribeContactResponse#error_message #error_message} => String
|
606
|
+
# * {Types::DescribeContactResponse#ground_station #ground_station} => String
|
607
|
+
# * {Types::DescribeContactResponse#maximum_elevation #maximum_elevation} => Types::Elevation
|
608
|
+
# * {Types::DescribeContactResponse#mission_profile_arn #mission_profile_arn} => String
|
609
|
+
# * {Types::DescribeContactResponse#post_pass_end_time #post_pass_end_time} => Time
|
610
|
+
# * {Types::DescribeContactResponse#pre_pass_start_time #pre_pass_start_time} => Time
|
611
|
+
# * {Types::DescribeContactResponse#satellite_arn #satellite_arn} => String
|
612
|
+
# * {Types::DescribeContactResponse#start_time #start_time} => Time
|
613
|
+
# * {Types::DescribeContactResponse#tags #tags} => Hash<String,String>
|
614
|
+
#
|
615
|
+
# @example Request syntax with placeholder values
|
616
|
+
#
|
617
|
+
# resp = client.describe_contact({
|
618
|
+
# contact_id: "String", # required
|
619
|
+
# })
|
620
|
+
#
|
621
|
+
# @example Response structure
|
622
|
+
#
|
623
|
+
# resp.contact_id #=> String
|
624
|
+
# resp.contact_status #=> String, one of "AVAILABLE", "AWS_CANCELLED", "CANCELLED", "COMPLETED", "FAILED", "FAILED_TO_SCHEDULE", "PASS", "POSTPASS", "PREPASS", "SCHEDULED", "SCHEDULING"
|
625
|
+
# resp.end_time #=> Time
|
626
|
+
# resp.error_message #=> String
|
627
|
+
# resp.ground_station #=> String
|
628
|
+
# resp.maximum_elevation.unit #=> String, one of "DEGREE_ANGLE", "RADIAN"
|
629
|
+
# resp.maximum_elevation.value #=> Float
|
630
|
+
# resp.mission_profile_arn #=> String
|
631
|
+
# resp.post_pass_end_time #=> Time
|
632
|
+
# resp.pre_pass_start_time #=> Time
|
633
|
+
# resp.satellite_arn #=> String
|
634
|
+
# resp.start_time #=> Time
|
635
|
+
# resp.tags #=> Hash
|
636
|
+
# resp.tags["String"] #=> String
|
637
|
+
#
|
638
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/DescribeContact AWS API Documentation
|
639
|
+
#
|
640
|
+
# @overload describe_contact(params = {})
|
641
|
+
# @param [Hash] params ({})
|
642
|
+
def describe_contact(params = {}, options = {})
|
643
|
+
req = build_request(:describe_contact, params)
|
644
|
+
req.send_request(options)
|
645
|
+
end
|
646
|
+
|
647
|
+
# Returns `Config` information.
|
648
|
+
#
|
649
|
+
# Only one `Config` response can be returned.
|
650
|
+
#
|
651
|
+
# @option params [required, String] :config_id
|
652
|
+
# UUID of a `Config`.
|
653
|
+
#
|
654
|
+
# @option params [required, String] :config_type
|
655
|
+
# Type of a `Config`.
|
656
|
+
#
|
657
|
+
# @return [Types::GetConfigResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
658
|
+
#
|
659
|
+
# * {Types::GetConfigResponse#config_arn #config_arn} => String
|
660
|
+
# * {Types::GetConfigResponse#config_data #config_data} => Types::ConfigTypeData
|
661
|
+
# * {Types::GetConfigResponse#config_id #config_id} => String
|
662
|
+
# * {Types::GetConfigResponse#config_type #config_type} => String
|
663
|
+
# * {Types::GetConfigResponse#name #name} => String
|
664
|
+
# * {Types::GetConfigResponse#tags #tags} => Hash<String,String>
|
665
|
+
#
|
666
|
+
# @example Request syntax with placeholder values
|
667
|
+
#
|
668
|
+
# resp = client.get_config({
|
669
|
+
# config_id: "String", # required
|
670
|
+
# config_type: "antenna-downlink", # required, accepts antenna-downlink, antenna-downlink-demod-decode, antenna-uplink, dataflow-endpoint, tracking, uplink-echo
|
671
|
+
# })
|
672
|
+
#
|
673
|
+
# @example Response structure
|
674
|
+
#
|
675
|
+
# resp.config_arn #=> String
|
676
|
+
# resp.config_data.antenna_downlink_config.spectrum_config.bandwidth.units #=> String, one of "GHz", "MHz", "kHz"
|
677
|
+
# resp.config_data.antenna_downlink_config.spectrum_config.bandwidth.value #=> Float
|
678
|
+
# resp.config_data.antenna_downlink_config.spectrum_config.center_frequency.units #=> String, one of "GHz", "MHz", "kHz"
|
679
|
+
# resp.config_data.antenna_downlink_config.spectrum_config.center_frequency.value #=> Float
|
680
|
+
# resp.config_data.antenna_downlink_config.spectrum_config.polarization #=> String, one of "LEFT_HAND", "NONE", "RIGHT_HAND"
|
681
|
+
# resp.config_data.antenna_downlink_demod_decode_config.decode_config.unvalidated_json #=> String
|
682
|
+
# resp.config_data.antenna_downlink_demod_decode_config.demodulation_config.unvalidated_json #=> String
|
683
|
+
# resp.config_data.antenna_downlink_demod_decode_config.spectrum_config.bandwidth.units #=> String, one of "GHz", "MHz", "kHz"
|
684
|
+
# resp.config_data.antenna_downlink_demod_decode_config.spectrum_config.bandwidth.value #=> Float
|
685
|
+
# resp.config_data.antenna_downlink_demod_decode_config.spectrum_config.center_frequency.units #=> String, one of "GHz", "MHz", "kHz"
|
686
|
+
# resp.config_data.antenna_downlink_demod_decode_config.spectrum_config.center_frequency.value #=> Float
|
687
|
+
# resp.config_data.antenna_downlink_demod_decode_config.spectrum_config.polarization #=> String, one of "LEFT_HAND", "NONE", "RIGHT_HAND"
|
688
|
+
# resp.config_data.antenna_uplink_config.spectrum_config.center_frequency.units #=> String, one of "GHz", "MHz", "kHz"
|
689
|
+
# resp.config_data.antenna_uplink_config.spectrum_config.center_frequency.value #=> Float
|
690
|
+
# resp.config_data.antenna_uplink_config.spectrum_config.polarization #=> String, one of "LEFT_HAND", "NONE", "RIGHT_HAND"
|
691
|
+
# resp.config_data.antenna_uplink_config.target_eirp.units #=> String, one of "dBW"
|
692
|
+
# resp.config_data.antenna_uplink_config.target_eirp.value #=> Float
|
693
|
+
# resp.config_data.dataflow_endpoint_config.dataflow_endpoint_name #=> String
|
694
|
+
# resp.config_data.tracking_config.autotrack #=> String, one of "PREFERRED", "REMOVED", "REQUIRED"
|
695
|
+
# resp.config_data.uplink_echo_config.antenna_uplink_config_arn #=> String
|
696
|
+
# resp.config_data.uplink_echo_config.enabled #=> Boolean
|
697
|
+
# resp.config_id #=> String
|
698
|
+
# resp.config_type #=> String, one of "antenna-downlink", "antenna-downlink-demod-decode", "antenna-uplink", "dataflow-endpoint", "tracking", "uplink-echo"
|
699
|
+
# resp.name #=> String
|
700
|
+
# resp.tags #=> Hash
|
701
|
+
# resp.tags["String"] #=> String
|
702
|
+
#
|
703
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/GetConfig AWS API Documentation
|
704
|
+
#
|
705
|
+
# @overload get_config(params = {})
|
706
|
+
# @param [Hash] params ({})
|
707
|
+
def get_config(params = {}, options = {})
|
708
|
+
req = build_request(:get_config, params)
|
709
|
+
req.send_request(options)
|
710
|
+
end
|
711
|
+
|
712
|
+
# Returns the dataflow endpoint group.
|
713
|
+
#
|
714
|
+
# @option params [required, String] :dataflow_endpoint_group_id
|
715
|
+
# UUID of a dataflow endpoint group.
|
716
|
+
#
|
717
|
+
# @return [Types::GetDataflowEndpointGroupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
718
|
+
#
|
719
|
+
# * {Types::GetDataflowEndpointGroupResponse#dataflow_endpoint_group_arn #dataflow_endpoint_group_arn} => String
|
720
|
+
# * {Types::GetDataflowEndpointGroupResponse#dataflow_endpoint_group_id #dataflow_endpoint_group_id} => String
|
721
|
+
# * {Types::GetDataflowEndpointGroupResponse#endpoints_details #endpoints_details} => Array<Types::EndpointDetails>
|
722
|
+
# * {Types::GetDataflowEndpointGroupResponse#tags #tags} => Hash<String,String>
|
723
|
+
#
|
724
|
+
# @example Request syntax with placeholder values
|
725
|
+
#
|
726
|
+
# resp = client.get_dataflow_endpoint_group({
|
727
|
+
# dataflow_endpoint_group_id: "String", # required
|
728
|
+
# })
|
729
|
+
#
|
730
|
+
# @example Response structure
|
731
|
+
#
|
732
|
+
# resp.dataflow_endpoint_group_arn #=> String
|
733
|
+
# resp.dataflow_endpoint_group_id #=> String
|
734
|
+
# resp.endpoints_details #=> Array
|
735
|
+
# resp.endpoints_details[0].endpoint.address.name #=> String
|
736
|
+
# resp.endpoints_details[0].endpoint.address.port #=> Integer
|
737
|
+
# resp.endpoints_details[0].endpoint.name #=> String
|
738
|
+
# resp.endpoints_details[0].endpoint.status #=> String, one of "created", "creating", "deleted", "deleting", "failed"
|
739
|
+
# resp.endpoints_details[0].security_details.role_arn #=> String
|
740
|
+
# resp.endpoints_details[0].security_details.security_group_ids #=> Array
|
741
|
+
# resp.endpoints_details[0].security_details.security_group_ids[0] #=> String
|
742
|
+
# resp.endpoints_details[0].security_details.subnet_ids #=> Array
|
743
|
+
# resp.endpoints_details[0].security_details.subnet_ids[0] #=> String
|
744
|
+
# resp.tags #=> Hash
|
745
|
+
# resp.tags["String"] #=> String
|
746
|
+
#
|
747
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/GetDataflowEndpointGroup AWS API Documentation
|
748
|
+
#
|
749
|
+
# @overload get_dataflow_endpoint_group(params = {})
|
750
|
+
# @param [Hash] params ({})
|
751
|
+
def get_dataflow_endpoint_group(params = {}, options = {})
|
752
|
+
req = build_request(:get_dataflow_endpoint_group, params)
|
753
|
+
req.send_request(options)
|
754
|
+
end
|
755
|
+
|
756
|
+
# Returns a mission profile.
|
757
|
+
#
|
758
|
+
# @option params [required, String] :mission_profile_id
|
759
|
+
# UUID of a mission profile.
|
760
|
+
#
|
761
|
+
# @return [Types::GetMissionProfileResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
762
|
+
#
|
763
|
+
# * {Types::GetMissionProfileResponse#contact_post_pass_duration_seconds #contact_post_pass_duration_seconds} => Integer
|
764
|
+
# * {Types::GetMissionProfileResponse#contact_pre_pass_duration_seconds #contact_pre_pass_duration_seconds} => Integer
|
765
|
+
# * {Types::GetMissionProfileResponse#dataflow_edges #dataflow_edges} => Array<Array<String>>
|
766
|
+
# * {Types::GetMissionProfileResponse#minimum_viable_contact_duration_seconds #minimum_viable_contact_duration_seconds} => Integer
|
767
|
+
# * {Types::GetMissionProfileResponse#mission_profile_arn #mission_profile_arn} => String
|
768
|
+
# * {Types::GetMissionProfileResponse#mission_profile_id #mission_profile_id} => String
|
769
|
+
# * {Types::GetMissionProfileResponse#name #name} => String
|
770
|
+
# * {Types::GetMissionProfileResponse#region #region} => String
|
771
|
+
# * {Types::GetMissionProfileResponse#tags #tags} => Hash<String,String>
|
772
|
+
# * {Types::GetMissionProfileResponse#tracking_config_arn #tracking_config_arn} => String
|
773
|
+
#
|
774
|
+
# @example Request syntax with placeholder values
|
775
|
+
#
|
776
|
+
# resp = client.get_mission_profile({
|
777
|
+
# mission_profile_id: "String", # required
|
778
|
+
# })
|
779
|
+
#
|
780
|
+
# @example Response structure
|
781
|
+
#
|
782
|
+
# resp.contact_post_pass_duration_seconds #=> Integer
|
783
|
+
# resp.contact_pre_pass_duration_seconds #=> Integer
|
784
|
+
# resp.dataflow_edges #=> Array
|
785
|
+
# resp.dataflow_edges[0] #=> Array
|
786
|
+
# resp.dataflow_edges[0][0] #=> String
|
787
|
+
# resp.minimum_viable_contact_duration_seconds #=> Integer
|
788
|
+
# resp.mission_profile_arn #=> String
|
789
|
+
# resp.mission_profile_id #=> String
|
790
|
+
# resp.name #=> String
|
791
|
+
# resp.region #=> String
|
792
|
+
# resp.tags #=> Hash
|
793
|
+
# resp.tags["String"] #=> String
|
794
|
+
# resp.tracking_config_arn #=> String
|
795
|
+
#
|
796
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/GetMissionProfile AWS API Documentation
|
797
|
+
#
|
798
|
+
# @overload get_mission_profile(params = {})
|
799
|
+
# @param [Hash] params ({})
|
800
|
+
def get_mission_profile(params = {}, options = {})
|
801
|
+
req = build_request(:get_mission_profile, params)
|
802
|
+
req.send_request(options)
|
803
|
+
end
|
804
|
+
|
805
|
+
# Returns a list of `Config` objects.
|
806
|
+
#
|
807
|
+
# @option params [Integer] :max_results
|
808
|
+
# Maximum number of `Configs` returned.
|
809
|
+
#
|
810
|
+
# @option params [String] :next_token
|
811
|
+
# Next token returned in the request of a previous `ListConfigs` call.
|
812
|
+
# Used to get the next page of results.
|
813
|
+
#
|
814
|
+
# @return [Types::ListConfigsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
815
|
+
#
|
816
|
+
# * {Types::ListConfigsResponse#config_list #config_list} => Array<Types::ConfigListItem>
|
817
|
+
# * {Types::ListConfigsResponse#next_token #next_token} => String
|
818
|
+
#
|
819
|
+
# @example Request syntax with placeholder values
|
820
|
+
#
|
821
|
+
# resp = client.list_configs({
|
822
|
+
# max_results: 1,
|
823
|
+
# next_token: "String",
|
824
|
+
# })
|
825
|
+
#
|
826
|
+
# @example Response structure
|
827
|
+
#
|
828
|
+
# resp.config_list #=> Array
|
829
|
+
# resp.config_list[0].config_arn #=> String
|
830
|
+
# resp.config_list[0].config_id #=> String
|
831
|
+
# resp.config_list[0].config_type #=> String, one of "antenna-downlink", "antenna-downlink-demod-decode", "antenna-uplink", "dataflow-endpoint", "tracking", "uplink-echo"
|
832
|
+
# resp.config_list[0].name #=> String
|
833
|
+
# resp.next_token #=> String
|
834
|
+
#
|
835
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/ListConfigs AWS API Documentation
|
836
|
+
#
|
837
|
+
# @overload list_configs(params = {})
|
838
|
+
# @param [Hash] params ({})
|
839
|
+
def list_configs(params = {}, options = {})
|
840
|
+
req = build_request(:list_configs, params)
|
841
|
+
req.send_request(options)
|
842
|
+
end
|
843
|
+
|
844
|
+
# Returns a list of contacts.
|
845
|
+
#
|
846
|
+
# If `statusList` contains AVAILABLE, the request must include
|
847
|
+
# `groundstation`, `missionprofileArn`, and `satelliteArn`.
|
848
|
+
#
|
849
|
+
# @option params [required, Time,DateTime,Date,Integer,String] :end_time
|
850
|
+
# End time of a contact.
|
851
|
+
#
|
852
|
+
# @option params [String] :ground_station
|
853
|
+
# Name of a ground station.
|
854
|
+
#
|
855
|
+
# @option params [Integer] :max_results
|
856
|
+
# Maximum number of contacts returned.
|
857
|
+
#
|
858
|
+
# @option params [String] :mission_profile_arn
|
859
|
+
# ARN of a mission profile.
|
860
|
+
#
|
861
|
+
# @option params [String] :next_token
|
862
|
+
# Next token returned in the request of a previous `ListContacts` call.
|
863
|
+
# Used to get the next page of results.
|
864
|
+
#
|
865
|
+
# @option params [String] :satellite_arn
|
866
|
+
# ARN of a satellite.
|
867
|
+
#
|
868
|
+
# @option params [required, Time,DateTime,Date,Integer,String] :start_time
|
869
|
+
# Start time of a contact.
|
870
|
+
#
|
871
|
+
# @option params [required, Array<String>] :status_list
|
872
|
+
# Status of a contact reservation.
|
873
|
+
#
|
874
|
+
# @return [Types::ListContactsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
875
|
+
#
|
876
|
+
# * {Types::ListContactsResponse#contact_list #contact_list} => Array<Types::ContactData>
|
877
|
+
# * {Types::ListContactsResponse#next_token #next_token} => String
|
878
|
+
#
|
879
|
+
# @example Request syntax with placeholder values
|
880
|
+
#
|
881
|
+
# resp = client.list_contacts({
|
882
|
+
# end_time: Time.now, # required
|
883
|
+
# ground_station: "String",
|
884
|
+
# max_results: 1,
|
885
|
+
# mission_profile_arn: "MissionProfileArn",
|
886
|
+
# next_token: "String",
|
887
|
+
# satellite_arn: "satelliteArn",
|
888
|
+
# start_time: Time.now, # required
|
889
|
+
# status_list: ["AVAILABLE"], # required, accepts AVAILABLE, AWS_CANCELLED, CANCELLED, COMPLETED, FAILED, FAILED_TO_SCHEDULE, PASS, POSTPASS, PREPASS, SCHEDULED, SCHEDULING
|
890
|
+
# })
|
891
|
+
#
|
892
|
+
# @example Response structure
|
893
|
+
#
|
894
|
+
# resp.contact_list #=> Array
|
895
|
+
# resp.contact_list[0].contact_id #=> String
|
896
|
+
# resp.contact_list[0].contact_status #=> String, one of "AVAILABLE", "AWS_CANCELLED", "CANCELLED", "COMPLETED", "FAILED", "FAILED_TO_SCHEDULE", "PASS", "POSTPASS", "PREPASS", "SCHEDULED", "SCHEDULING"
|
897
|
+
# resp.contact_list[0].end_time #=> Time
|
898
|
+
# resp.contact_list[0].error_message #=> String
|
899
|
+
# resp.contact_list[0].ground_station #=> String
|
900
|
+
# resp.contact_list[0].maximum_elevation.unit #=> String, one of "DEGREE_ANGLE", "RADIAN"
|
901
|
+
# resp.contact_list[0].maximum_elevation.value #=> Float
|
902
|
+
# resp.contact_list[0].mission_profile_arn #=> String
|
903
|
+
# resp.contact_list[0].post_pass_end_time #=> Time
|
904
|
+
# resp.contact_list[0].pre_pass_start_time #=> Time
|
905
|
+
# resp.contact_list[0].satellite_arn #=> String
|
906
|
+
# resp.contact_list[0].start_time #=> Time
|
907
|
+
# resp.contact_list[0].tags #=> Hash
|
908
|
+
# resp.contact_list[0].tags["String"] #=> String
|
909
|
+
# resp.next_token #=> String
|
910
|
+
#
|
911
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/ListContacts AWS API Documentation
|
912
|
+
#
|
913
|
+
# @overload list_contacts(params = {})
|
914
|
+
# @param [Hash] params ({})
|
915
|
+
def list_contacts(params = {}, options = {})
|
916
|
+
req = build_request(:list_contacts, params)
|
917
|
+
req.send_request(options)
|
918
|
+
end
|
919
|
+
|
920
|
+
# Returns a list of `DataflowEndpoint` groups.
|
921
|
+
#
|
922
|
+
# @option params [Integer] :max_results
|
923
|
+
# Maximum number of dataflow endpoint groups returned.
|
924
|
+
#
|
925
|
+
# @option params [String] :next_token
|
926
|
+
# Next token returned in the request of a previous
|
927
|
+
# `ListDataflowEndpointGroups` call. Used to get the next page of
|
928
|
+
# results.
|
929
|
+
#
|
930
|
+
# @return [Types::ListDataflowEndpointGroupsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
931
|
+
#
|
932
|
+
# * {Types::ListDataflowEndpointGroupsResponse#dataflow_endpoint_group_list #dataflow_endpoint_group_list} => Array<Types::DataflowEndpointListItem>
|
933
|
+
# * {Types::ListDataflowEndpointGroupsResponse#next_token #next_token} => String
|
934
|
+
#
|
935
|
+
# @example Request syntax with placeholder values
|
936
|
+
#
|
937
|
+
# resp = client.list_dataflow_endpoint_groups({
|
938
|
+
# max_results: 1,
|
939
|
+
# next_token: "String",
|
940
|
+
# })
|
941
|
+
#
|
942
|
+
# @example Response structure
|
943
|
+
#
|
944
|
+
# resp.dataflow_endpoint_group_list #=> Array
|
945
|
+
# resp.dataflow_endpoint_group_list[0].dataflow_endpoint_group_arn #=> String
|
946
|
+
# resp.dataflow_endpoint_group_list[0].dataflow_endpoint_group_id #=> String
|
947
|
+
# resp.next_token #=> String
|
948
|
+
#
|
949
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/ListDataflowEndpointGroups AWS API Documentation
|
950
|
+
#
|
951
|
+
# @overload list_dataflow_endpoint_groups(params = {})
|
952
|
+
# @param [Hash] params ({})
|
953
|
+
def list_dataflow_endpoint_groups(params = {}, options = {})
|
954
|
+
req = build_request(:list_dataflow_endpoint_groups, params)
|
955
|
+
req.send_request(options)
|
956
|
+
end
|
957
|
+
|
958
|
+
# Returns a list of mission profiles.
|
959
|
+
#
|
960
|
+
# @option params [Integer] :max_results
|
961
|
+
# Maximum number of mission profiles returned.
|
962
|
+
#
|
963
|
+
# @option params [String] :next_token
|
964
|
+
# Next token returned in the request of a previous `ListMissionProfiles`
|
965
|
+
# call. Used to get the next page of results.
|
966
|
+
#
|
967
|
+
# @return [Types::ListMissionProfilesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
968
|
+
#
|
969
|
+
# * {Types::ListMissionProfilesResponse#mission_profile_list #mission_profile_list} => Array<Types::MissionProfileListItem>
|
970
|
+
# * {Types::ListMissionProfilesResponse#next_token #next_token} => String
|
971
|
+
#
|
972
|
+
# @example Request syntax with placeholder values
|
973
|
+
#
|
974
|
+
# resp = client.list_mission_profiles({
|
975
|
+
# max_results: 1,
|
976
|
+
# next_token: "String",
|
977
|
+
# })
|
978
|
+
#
|
979
|
+
# @example Response structure
|
980
|
+
#
|
981
|
+
# resp.mission_profile_list #=> Array
|
982
|
+
# resp.mission_profile_list[0].mission_profile_arn #=> String
|
983
|
+
# resp.mission_profile_list[0].mission_profile_id #=> String
|
984
|
+
# resp.mission_profile_list[0].name #=> String
|
985
|
+
# resp.mission_profile_list[0].region #=> String
|
986
|
+
# resp.next_token #=> String
|
987
|
+
#
|
988
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/ListMissionProfiles AWS API Documentation
|
989
|
+
#
|
990
|
+
# @overload list_mission_profiles(params = {})
|
991
|
+
# @param [Hash] params ({})
|
992
|
+
def list_mission_profiles(params = {}, options = {})
|
993
|
+
req = build_request(:list_mission_profiles, params)
|
994
|
+
req.send_request(options)
|
995
|
+
end
|
996
|
+
|
997
|
+
# Reserves a contact using specified parameters.
|
998
|
+
#
|
999
|
+
# @option params [required, Time,DateTime,Date,Integer,String] :end_time
|
1000
|
+
# End time of a contact.
|
1001
|
+
#
|
1002
|
+
# @option params [required, String] :ground_station
|
1003
|
+
# Name of a ground station.
|
1004
|
+
#
|
1005
|
+
# @option params [required, String] :mission_profile_arn
|
1006
|
+
# ARN of a mission profile.
|
1007
|
+
#
|
1008
|
+
# @option params [required, String] :satellite_arn
|
1009
|
+
# ARN of a satellite
|
1010
|
+
#
|
1011
|
+
# @option params [required, Time,DateTime,Date,Integer,String] :start_time
|
1012
|
+
# Start time of a contact.
|
1013
|
+
#
|
1014
|
+
# @option params [Hash<String,String>] :tags
|
1015
|
+
# Tags assigned to a contact.
|
1016
|
+
#
|
1017
|
+
# @return [Types::ContactIdResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1018
|
+
#
|
1019
|
+
# * {Types::ContactIdResponse#contact_id #contact_id} => String
|
1020
|
+
#
|
1021
|
+
# @example Request syntax with placeholder values
|
1022
|
+
#
|
1023
|
+
# resp = client.reserve_contact({
|
1024
|
+
# end_time: Time.now, # required
|
1025
|
+
# ground_station: "String", # required
|
1026
|
+
# mission_profile_arn: "MissionProfileArn", # required
|
1027
|
+
# satellite_arn: "satelliteArn", # required
|
1028
|
+
# start_time: Time.now, # required
|
1029
|
+
# tags: {
|
1030
|
+
# "String" => "String",
|
1031
|
+
# },
|
1032
|
+
# })
|
1033
|
+
#
|
1034
|
+
# @example Response structure
|
1035
|
+
#
|
1036
|
+
# resp.contact_id #=> String
|
1037
|
+
#
|
1038
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/ReserveContact AWS API Documentation
|
1039
|
+
#
|
1040
|
+
# @overload reserve_contact(params = {})
|
1041
|
+
# @param [Hash] params ({})
|
1042
|
+
def reserve_contact(params = {}, options = {})
|
1043
|
+
req = build_request(:reserve_contact, params)
|
1044
|
+
req.send_request(options)
|
1045
|
+
end
|
1046
|
+
|
1047
|
+
# Updates the `Config` used when scheduling contacts.
|
1048
|
+
#
|
1049
|
+
# Updating a `Config` will not update the execution parameters for
|
1050
|
+
# existing future contacts scheduled with this `Config`.
|
1051
|
+
#
|
1052
|
+
# @option params [required, Types::ConfigTypeData] :config_data
|
1053
|
+
# Parameters for a `Config`.
|
1054
|
+
#
|
1055
|
+
# @option params [required, String] :config_id
|
1056
|
+
# UUID of a `Config`.
|
1057
|
+
#
|
1058
|
+
# @option params [required, String] :config_type
|
1059
|
+
# Type of a `Config`.
|
1060
|
+
#
|
1061
|
+
# @option params [required, String] :name
|
1062
|
+
# Name of a `Config`.
|
1063
|
+
#
|
1064
|
+
# @return [Types::ConfigIdResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1065
|
+
#
|
1066
|
+
# * {Types::ConfigIdResponse#config_arn #config_arn} => String
|
1067
|
+
# * {Types::ConfigIdResponse#config_id #config_id} => String
|
1068
|
+
# * {Types::ConfigIdResponse#config_type #config_type} => String
|
1069
|
+
#
|
1070
|
+
# @example Request syntax with placeholder values
|
1071
|
+
#
|
1072
|
+
# resp = client.update_config({
|
1073
|
+
# config_data: { # required
|
1074
|
+
# antenna_downlink_config: {
|
1075
|
+
# spectrum_config: { # required
|
1076
|
+
# bandwidth: { # required
|
1077
|
+
# units: "GHz", # required, accepts GHz, MHz, kHz
|
1078
|
+
# value: 1.0, # required
|
1079
|
+
# },
|
1080
|
+
# center_frequency: { # required
|
1081
|
+
# units: "GHz", # required, accepts GHz, MHz, kHz
|
1082
|
+
# value: 1.0, # required
|
1083
|
+
# },
|
1084
|
+
# polarization: "LEFT_HAND", # accepts LEFT_HAND, NONE, RIGHT_HAND
|
1085
|
+
# },
|
1086
|
+
# },
|
1087
|
+
# antenna_downlink_demod_decode_config: {
|
1088
|
+
# decode_config: { # required
|
1089
|
+
# unvalidated_json: "JsonString", # required
|
1090
|
+
# },
|
1091
|
+
# demodulation_config: { # required
|
1092
|
+
# unvalidated_json: "JsonString", # required
|
1093
|
+
# },
|
1094
|
+
# spectrum_config: { # required
|
1095
|
+
# bandwidth: { # required
|
1096
|
+
# units: "GHz", # required, accepts GHz, MHz, kHz
|
1097
|
+
# value: 1.0, # required
|
1098
|
+
# },
|
1099
|
+
# center_frequency: { # required
|
1100
|
+
# units: "GHz", # required, accepts GHz, MHz, kHz
|
1101
|
+
# value: 1.0, # required
|
1102
|
+
# },
|
1103
|
+
# polarization: "LEFT_HAND", # accepts LEFT_HAND, NONE, RIGHT_HAND
|
1104
|
+
# },
|
1105
|
+
# },
|
1106
|
+
# antenna_uplink_config: {
|
1107
|
+
# spectrum_config: { # required
|
1108
|
+
# center_frequency: { # required
|
1109
|
+
# units: "GHz", # required, accepts GHz, MHz, kHz
|
1110
|
+
# value: 1.0, # required
|
1111
|
+
# },
|
1112
|
+
# polarization: "LEFT_HAND", # accepts LEFT_HAND, NONE, RIGHT_HAND
|
1113
|
+
# },
|
1114
|
+
# target_eirp: { # required
|
1115
|
+
# units: "dBW", # required, accepts dBW
|
1116
|
+
# value: 1.0, # required
|
1117
|
+
# },
|
1118
|
+
# },
|
1119
|
+
# dataflow_endpoint_config: {
|
1120
|
+
# dataflow_endpoint_name: "String", # required
|
1121
|
+
# },
|
1122
|
+
# tracking_config: {
|
1123
|
+
# autotrack: "PREFERRED", # required, accepts PREFERRED, REMOVED, REQUIRED
|
1124
|
+
# },
|
1125
|
+
# uplink_echo_config: {
|
1126
|
+
# antenna_uplink_config_arn: "ConfigArn", # required
|
1127
|
+
# enabled: false, # required
|
1128
|
+
# },
|
1129
|
+
# },
|
1130
|
+
# config_id: "String", # required
|
1131
|
+
# config_type: "antenna-downlink", # required, accepts antenna-downlink, antenna-downlink-demod-decode, antenna-uplink, dataflow-endpoint, tracking, uplink-echo
|
1132
|
+
# name: "SafeName", # required
|
1133
|
+
# })
|
1134
|
+
#
|
1135
|
+
# @example Response structure
|
1136
|
+
#
|
1137
|
+
# resp.config_arn #=> String
|
1138
|
+
# resp.config_id #=> String
|
1139
|
+
# resp.config_type #=> String, one of "antenna-downlink", "antenna-downlink-demod-decode", "antenna-uplink", "dataflow-endpoint", "tracking", "uplink-echo"
|
1140
|
+
#
|
1141
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/UpdateConfig AWS API Documentation
|
1142
|
+
#
|
1143
|
+
# @overload update_config(params = {})
|
1144
|
+
# @param [Hash] params ({})
|
1145
|
+
def update_config(params = {}, options = {})
|
1146
|
+
req = build_request(:update_config, params)
|
1147
|
+
req.send_request(options)
|
1148
|
+
end
|
1149
|
+
|
1150
|
+
# Updates a mission profile.
|
1151
|
+
#
|
1152
|
+
# Updating a mission profile will not update the execution parameters
|
1153
|
+
# for existing future contacts.
|
1154
|
+
#
|
1155
|
+
# @option params [Integer] :contact_post_pass_duration_seconds
|
1156
|
+
# Amount of time after a contact ends that you’d like to receive a
|
1157
|
+
# CloudWatch event indicating the pass has finished.
|
1158
|
+
#
|
1159
|
+
# @option params [Integer] :contact_pre_pass_duration_seconds
|
1160
|
+
# Amount of time after a contact ends that you’d like to receive a
|
1161
|
+
# CloudWatch event indicating the pass has finished.
|
1162
|
+
#
|
1163
|
+
# @option params [Array<Array>] :dataflow_edges
|
1164
|
+
# A list of lists of ARNs. Each list of ARNs is an edge, with a from
|
1165
|
+
# `Config` and a to `Config`.
|
1166
|
+
#
|
1167
|
+
# @option params [Integer] :minimum_viable_contact_duration_seconds
|
1168
|
+
# Smallest amount of time in seconds that you’d like to see for an
|
1169
|
+
# available contact. AWS Ground Station will not present you with
|
1170
|
+
# contacts shorter than this duration.
|
1171
|
+
#
|
1172
|
+
# @option params [required, String] :mission_profile_id
|
1173
|
+
# ID of a mission profile.
|
1174
|
+
#
|
1175
|
+
# @option params [String] :name
|
1176
|
+
# Name of a mission profile.
|
1177
|
+
#
|
1178
|
+
# @option params [String] :tracking_config_arn
|
1179
|
+
# ARN of a tracking `Config`.
|
1180
|
+
#
|
1181
|
+
# @return [Types::MissionProfileIdResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1182
|
+
#
|
1183
|
+
# * {Types::MissionProfileIdResponse#mission_profile_id #mission_profile_id} => String
|
1184
|
+
#
|
1185
|
+
# @example Request syntax with placeholder values
|
1186
|
+
#
|
1187
|
+
# resp = client.update_mission_profile({
|
1188
|
+
# contact_post_pass_duration_seconds: 1,
|
1189
|
+
# contact_pre_pass_duration_seconds: 1,
|
1190
|
+
# dataflow_edges: [
|
1191
|
+
# ["ConfigArn"],
|
1192
|
+
# ],
|
1193
|
+
# minimum_viable_contact_duration_seconds: 1,
|
1194
|
+
# mission_profile_id: "String", # required
|
1195
|
+
# name: "SafeName",
|
1196
|
+
# tracking_config_arn: "ConfigArn",
|
1197
|
+
# })
|
1198
|
+
#
|
1199
|
+
# @example Response structure
|
1200
|
+
#
|
1201
|
+
# resp.mission_profile_id #=> String
|
1202
|
+
#
|
1203
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/UpdateMissionProfile AWS API Documentation
|
1204
|
+
#
|
1205
|
+
# @overload update_mission_profile(params = {})
|
1206
|
+
# @param [Hash] params ({})
|
1207
|
+
def update_mission_profile(params = {}, options = {})
|
1208
|
+
req = build_request(:update_mission_profile, params)
|
1209
|
+
req.send_request(options)
|
1210
|
+
end
|
1211
|
+
|
1212
|
+
# Returns the number of minutes used by account.
|
1213
|
+
#
|
1214
|
+
# @option params [required, Integer] :month
|
1215
|
+
# The month being requested, with a value of 1-12.
|
1216
|
+
#
|
1217
|
+
# @option params [required, Integer] :year
|
1218
|
+
# The year being requested, in the format of YYYY.
|
1219
|
+
#
|
1220
|
+
# @return [Types::GetMinuteUsageResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1221
|
+
#
|
1222
|
+
# * {Types::GetMinuteUsageResponse#estimated_minutes_remaining #estimated_minutes_remaining} => Integer
|
1223
|
+
# * {Types::GetMinuteUsageResponse#is_reserved_minutes_customer #is_reserved_minutes_customer} => Boolean
|
1224
|
+
# * {Types::GetMinuteUsageResponse#total_reserved_minute_allocation #total_reserved_minute_allocation} => Integer
|
1225
|
+
# * {Types::GetMinuteUsageResponse#total_scheduled_minutes #total_scheduled_minutes} => Integer
|
1226
|
+
# * {Types::GetMinuteUsageResponse#upcoming_minutes_scheduled #upcoming_minutes_scheduled} => Integer
|
1227
|
+
#
|
1228
|
+
# @example Request syntax with placeholder values
|
1229
|
+
#
|
1230
|
+
# resp = client.get_minute_usage({
|
1231
|
+
# month: 1, # required
|
1232
|
+
# year: 1, # required
|
1233
|
+
# })
|
1234
|
+
#
|
1235
|
+
# @example Response structure
|
1236
|
+
#
|
1237
|
+
# resp.estimated_minutes_remaining #=> Integer
|
1238
|
+
# resp.is_reserved_minutes_customer #=> Boolean
|
1239
|
+
# resp.total_reserved_minute_allocation #=> Integer
|
1240
|
+
# resp.total_scheduled_minutes #=> Integer
|
1241
|
+
# resp.upcoming_minutes_scheduled #=> Integer
|
1242
|
+
#
|
1243
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/GetMinuteUsage AWS API Documentation
|
1244
|
+
#
|
1245
|
+
# @overload get_minute_usage(params = {})
|
1246
|
+
# @param [Hash] params ({})
|
1247
|
+
def get_minute_usage(params = {}, options = {})
|
1248
|
+
req = build_request(:get_minute_usage, params)
|
1249
|
+
req.send_request(options)
|
1250
|
+
end
|
1251
|
+
|
1252
|
+
# Returns a satellite.
|
1253
|
+
#
|
1254
|
+
# @option params [required, String] :satellite_id
|
1255
|
+
# UUID of a satellite.
|
1256
|
+
#
|
1257
|
+
# @return [Types::GetSatelliteResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1258
|
+
#
|
1259
|
+
# * {Types::GetSatelliteResponse#date_created #date_created} => Time
|
1260
|
+
# * {Types::GetSatelliteResponse#last_updated #last_updated} => Time
|
1261
|
+
# * {Types::GetSatelliteResponse#norad_satellite_id #norad_satellite_id} => Integer
|
1262
|
+
# * {Types::GetSatelliteResponse#satellite_arn #satellite_arn} => String
|
1263
|
+
# * {Types::GetSatelliteResponse#satellite_id #satellite_id} => String
|
1264
|
+
# * {Types::GetSatelliteResponse#tags #tags} => Hash<String,String>
|
1265
|
+
#
|
1266
|
+
# @example Request syntax with placeholder values
|
1267
|
+
#
|
1268
|
+
# resp = client.get_satellite({
|
1269
|
+
# satellite_id: "String", # required
|
1270
|
+
# })
|
1271
|
+
#
|
1272
|
+
# @example Response structure
|
1273
|
+
#
|
1274
|
+
# resp.date_created #=> Time
|
1275
|
+
# resp.last_updated #=> Time
|
1276
|
+
# resp.norad_satellite_id #=> Integer
|
1277
|
+
# resp.satellite_arn #=> String
|
1278
|
+
# resp.satellite_id #=> String
|
1279
|
+
# resp.tags #=> Hash
|
1280
|
+
# resp.tags["String"] #=> String
|
1281
|
+
#
|
1282
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/GetSatellite AWS API Documentation
|
1283
|
+
#
|
1284
|
+
# @overload get_satellite(params = {})
|
1285
|
+
# @param [Hash] params ({})
|
1286
|
+
def get_satellite(params = {}, options = {})
|
1287
|
+
req = build_request(:get_satellite, params)
|
1288
|
+
req.send_request(options)
|
1289
|
+
end
|
1290
|
+
|
1291
|
+
# Returns a list of ground stations.
|
1292
|
+
#
|
1293
|
+
# @option params [Integer] :max_results
|
1294
|
+
# Maximum number of ground stations returned.
|
1295
|
+
#
|
1296
|
+
# @option params [String] :next_token
|
1297
|
+
# Next token that can be supplied in the next call to get the next page
|
1298
|
+
# of ground stations.
|
1299
|
+
#
|
1300
|
+
# @return [Types::ListGroundStationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1301
|
+
#
|
1302
|
+
# * {Types::ListGroundStationsResponse#ground_station_list #ground_station_list} => Array<Types::GroundStationData>
|
1303
|
+
# * {Types::ListGroundStationsResponse#next_token #next_token} => String
|
1304
|
+
#
|
1305
|
+
# @example Request syntax with placeholder values
|
1306
|
+
#
|
1307
|
+
# resp = client.list_ground_stations({
|
1308
|
+
# max_results: 1,
|
1309
|
+
# next_token: "String",
|
1310
|
+
# })
|
1311
|
+
#
|
1312
|
+
# @example Response structure
|
1313
|
+
#
|
1314
|
+
# resp.ground_station_list #=> Array
|
1315
|
+
# resp.ground_station_list[0].ground_station_id #=> String
|
1316
|
+
# resp.ground_station_list[0].ground_station_name #=> String
|
1317
|
+
# resp.ground_station_list[0].region #=> String
|
1318
|
+
# resp.next_token #=> String
|
1319
|
+
#
|
1320
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/ListGroundStations AWS API Documentation
|
1321
|
+
#
|
1322
|
+
# @overload list_ground_stations(params = {})
|
1323
|
+
# @param [Hash] params ({})
|
1324
|
+
def list_ground_stations(params = {}, options = {})
|
1325
|
+
req = build_request(:list_ground_stations, params)
|
1326
|
+
req.send_request(options)
|
1327
|
+
end
|
1328
|
+
|
1329
|
+
# Returns a list of satellites.
|
1330
|
+
#
|
1331
|
+
# @option params [Integer] :max_results
|
1332
|
+
# Maximum number of satellites returned.
|
1333
|
+
#
|
1334
|
+
# @option params [String] :next_token
|
1335
|
+
# Next token that can be supplied in the next call to get the next page
|
1336
|
+
# of satellites.
|
1337
|
+
#
|
1338
|
+
# @return [Types::ListSatellitesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1339
|
+
#
|
1340
|
+
# * {Types::ListSatellitesResponse#next_token #next_token} => String
|
1341
|
+
# * {Types::ListSatellitesResponse#satellites #satellites} => Array<Types::SatelliteListItem>
|
1342
|
+
#
|
1343
|
+
# @example Request syntax with placeholder values
|
1344
|
+
#
|
1345
|
+
# resp = client.list_satellites({
|
1346
|
+
# max_results: 1,
|
1347
|
+
# next_token: "String",
|
1348
|
+
# })
|
1349
|
+
#
|
1350
|
+
# @example Response structure
|
1351
|
+
#
|
1352
|
+
# resp.next_token #=> String
|
1353
|
+
# resp.satellites #=> Array
|
1354
|
+
# resp.satellites[0].norad_satellite_id #=> Integer
|
1355
|
+
# resp.satellites[0].satellite_arn #=> String
|
1356
|
+
# resp.satellites[0].satellite_id #=> String
|
1357
|
+
#
|
1358
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/ListSatellites AWS API Documentation
|
1359
|
+
#
|
1360
|
+
# @overload list_satellites(params = {})
|
1361
|
+
# @param [Hash] params ({})
|
1362
|
+
def list_satellites(params = {}, options = {})
|
1363
|
+
req = build_request(:list_satellites, params)
|
1364
|
+
req.send_request(options)
|
1365
|
+
end
|
1366
|
+
|
1367
|
+
# Returns a list of tags or a specified resource.
|
1368
|
+
#
|
1369
|
+
# @option params [required, String] :resource_arn
|
1370
|
+
# ARN of a resource.
|
1371
|
+
#
|
1372
|
+
# @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1373
|
+
#
|
1374
|
+
# * {Types::ListTagsForResourceResponse#tags #tags} => Hash<String,String>
|
1375
|
+
#
|
1376
|
+
# @example Request syntax with placeholder values
|
1377
|
+
#
|
1378
|
+
# resp = client.list_tags_for_resource({
|
1379
|
+
# resource_arn: "String", # required
|
1380
|
+
# })
|
1381
|
+
#
|
1382
|
+
# @example Response structure
|
1383
|
+
#
|
1384
|
+
# resp.tags #=> Hash
|
1385
|
+
# resp.tags["String"] #=> String
|
1386
|
+
#
|
1387
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/ListTagsForResource AWS API Documentation
|
1388
|
+
#
|
1389
|
+
# @overload list_tags_for_resource(params = {})
|
1390
|
+
# @param [Hash] params ({})
|
1391
|
+
def list_tags_for_resource(params = {}, options = {})
|
1392
|
+
req = build_request(:list_tags_for_resource, params)
|
1393
|
+
req.send_request(options)
|
1394
|
+
end
|
1395
|
+
|
1396
|
+
# Assigns a tag to a resource.
|
1397
|
+
#
|
1398
|
+
# @option params [required, String] :resource_arn
|
1399
|
+
# ARN of a resource tag.
|
1400
|
+
#
|
1401
|
+
# @option params [Hash<String,String>] :tags
|
1402
|
+
# Tags assigned to a resource.
|
1403
|
+
#
|
1404
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1405
|
+
#
|
1406
|
+
# @example Request syntax with placeholder values
|
1407
|
+
#
|
1408
|
+
# resp = client.tag_resource({
|
1409
|
+
# resource_arn: "String", # required
|
1410
|
+
# tags: {
|
1411
|
+
# "String" => "String",
|
1412
|
+
# },
|
1413
|
+
# })
|
1414
|
+
#
|
1415
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/TagResource AWS API Documentation
|
1416
|
+
#
|
1417
|
+
# @overload tag_resource(params = {})
|
1418
|
+
# @param [Hash] params ({})
|
1419
|
+
def tag_resource(params = {}, options = {})
|
1420
|
+
req = build_request(:tag_resource, params)
|
1421
|
+
req.send_request(options)
|
1422
|
+
end
|
1423
|
+
|
1424
|
+
# Deassigns a resource tag.
|
1425
|
+
#
|
1426
|
+
# @option params [required, String] :resource_arn
|
1427
|
+
# ARN of a resource.
|
1428
|
+
#
|
1429
|
+
# @option params [required, Array<String>] :tag_keys
|
1430
|
+
# Keys of a resource tag.
|
1431
|
+
#
|
1432
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1433
|
+
#
|
1434
|
+
# @example Request syntax with placeholder values
|
1435
|
+
#
|
1436
|
+
# resp = client.untag_resource({
|
1437
|
+
# resource_arn: "String", # required
|
1438
|
+
# tag_keys: ["String"], # required
|
1439
|
+
# })
|
1440
|
+
#
|
1441
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/UntagResource AWS API Documentation
|
1442
|
+
#
|
1443
|
+
# @overload untag_resource(params = {})
|
1444
|
+
# @param [Hash] params ({})
|
1445
|
+
def untag_resource(params = {}, options = {})
|
1446
|
+
req = build_request(:untag_resource, params)
|
1447
|
+
req.send_request(options)
|
1448
|
+
end
|
1449
|
+
|
1450
|
+
# @!endgroup
|
1451
|
+
|
1452
|
+
# @param params ({})
|
1453
|
+
# @api private
|
1454
|
+
def build_request(operation_name, params = {})
|
1455
|
+
handlers = @handlers.for(operation_name)
|
1456
|
+
context = Seahorse::Client::RequestContext.new(
|
1457
|
+
operation_name: operation_name,
|
1458
|
+
operation: config.api.operation(operation_name),
|
1459
|
+
client: self,
|
1460
|
+
params: params,
|
1461
|
+
config: config)
|
1462
|
+
context[:gem_name] = 'aws-sdk-groundstation'
|
1463
|
+
context[:gem_version] = '1.0.0'
|
1464
|
+
Seahorse::Client::Request.new(handlers, context)
|
1465
|
+
end
|
1466
|
+
|
1467
|
+
# @api private
|
1468
|
+
# @deprecated
|
1469
|
+
def waiter_names
|
1470
|
+
[]
|
1471
|
+
end
|
1472
|
+
|
1473
|
+
class << self
|
1474
|
+
|
1475
|
+
# @api private
|
1476
|
+
attr_reader :identifier
|
1477
|
+
|
1478
|
+
# @api private
|
1479
|
+
def errors_module
|
1480
|
+
Errors
|
1481
|
+
end
|
1482
|
+
|
1483
|
+
end
|
1484
|
+
end
|
1485
|
+
end
|