aws-sdk-privatenetworks 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/CHANGELOG.md +8 -0
- data/LICENSE.txt +202 -0
- data/VERSION +1 -0
- data/lib/aws-sdk-privatenetworks/client.rb +1857 -0
- data/lib/aws-sdk-privatenetworks/client_api.rb +840 -0
- data/lib/aws-sdk-privatenetworks/customizations.rb +0 -0
- data/lib/aws-sdk-privatenetworks/errors.rb +171 -0
- data/lib/aws-sdk-privatenetworks/resource.rb +26 -0
- data/lib/aws-sdk-privatenetworks/types.rb +1903 -0
- data/lib/aws-sdk-privatenetworks.rb +53 -0
- metadata +90 -0
@@ -0,0 +1,1857 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# WARNING ABOUT GENERATED CODE
|
4
|
+
#
|
5
|
+
# This file is generated. See the contributing guide for more information:
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
|
+
#
|
8
|
+
# WARNING ABOUT GENERATED CODE
|
9
|
+
|
10
|
+
require 'seahorse/client/plugins/content_length.rb'
|
11
|
+
require 'aws-sdk-core/plugins/credentials_configuration.rb'
|
12
|
+
require 'aws-sdk-core/plugins/logging.rb'
|
13
|
+
require 'aws-sdk-core/plugins/param_converter.rb'
|
14
|
+
require 'aws-sdk-core/plugins/param_validator.rb'
|
15
|
+
require 'aws-sdk-core/plugins/user_agent.rb'
|
16
|
+
require 'aws-sdk-core/plugins/helpful_socket_errors.rb'
|
17
|
+
require 'aws-sdk-core/plugins/retry_errors.rb'
|
18
|
+
require 'aws-sdk-core/plugins/global_configuration.rb'
|
19
|
+
require 'aws-sdk-core/plugins/regional_endpoint.rb'
|
20
|
+
require 'aws-sdk-core/plugins/endpoint_discovery.rb'
|
21
|
+
require 'aws-sdk-core/plugins/endpoint_pattern.rb'
|
22
|
+
require 'aws-sdk-core/plugins/response_paging.rb'
|
23
|
+
require 'aws-sdk-core/plugins/stub_responses.rb'
|
24
|
+
require 'aws-sdk-core/plugins/idempotency_token.rb'
|
25
|
+
require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
|
26
|
+
require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
|
27
|
+
require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
|
28
|
+
require 'aws-sdk-core/plugins/transfer_encoding.rb'
|
29
|
+
require 'aws-sdk-core/plugins/http_checksum.rb'
|
30
|
+
require 'aws-sdk-core/plugins/checksum_algorithm.rb'
|
31
|
+
require 'aws-sdk-core/plugins/defaults_mode.rb'
|
32
|
+
require 'aws-sdk-core/plugins/recursion_detection.rb'
|
33
|
+
require 'aws-sdk-core/plugins/signature_v4.rb'
|
34
|
+
require 'aws-sdk-core/plugins/protocols/rest_json.rb'
|
35
|
+
|
36
|
+
Aws::Plugins::GlobalConfiguration.add_identifier(:privatenetworks)
|
37
|
+
|
38
|
+
module Aws::PrivateNetworks
|
39
|
+
# An API client for PrivateNetworks. To construct a client, you need to configure a `:region` and `:credentials`.
|
40
|
+
#
|
41
|
+
# client = Aws::PrivateNetworks::Client.new(
|
42
|
+
# region: region_name,
|
43
|
+
# credentials: credentials,
|
44
|
+
# # ...
|
45
|
+
# )
|
46
|
+
#
|
47
|
+
# For details on configuring region and credentials see
|
48
|
+
# the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
|
49
|
+
#
|
50
|
+
# See {#initialize} for a full list of supported configuration options.
|
51
|
+
class Client < Seahorse::Client::Base
|
52
|
+
|
53
|
+
include Aws::ClientStubs
|
54
|
+
|
55
|
+
@identifier = :privatenetworks
|
56
|
+
|
57
|
+
set_api(ClientApi::API)
|
58
|
+
|
59
|
+
add_plugin(Seahorse::Client::Plugins::ContentLength)
|
60
|
+
add_plugin(Aws::Plugins::CredentialsConfiguration)
|
61
|
+
add_plugin(Aws::Plugins::Logging)
|
62
|
+
add_plugin(Aws::Plugins::ParamConverter)
|
63
|
+
add_plugin(Aws::Plugins::ParamValidator)
|
64
|
+
add_plugin(Aws::Plugins::UserAgent)
|
65
|
+
add_plugin(Aws::Plugins::HelpfulSocketErrors)
|
66
|
+
add_plugin(Aws::Plugins::RetryErrors)
|
67
|
+
add_plugin(Aws::Plugins::GlobalConfiguration)
|
68
|
+
add_plugin(Aws::Plugins::RegionalEndpoint)
|
69
|
+
add_plugin(Aws::Plugins::EndpointDiscovery)
|
70
|
+
add_plugin(Aws::Plugins::EndpointPattern)
|
71
|
+
add_plugin(Aws::Plugins::ResponsePaging)
|
72
|
+
add_plugin(Aws::Plugins::StubResponses)
|
73
|
+
add_plugin(Aws::Plugins::IdempotencyToken)
|
74
|
+
add_plugin(Aws::Plugins::JsonvalueConverter)
|
75
|
+
add_plugin(Aws::Plugins::ClientMetricsPlugin)
|
76
|
+
add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
|
77
|
+
add_plugin(Aws::Plugins::TransferEncoding)
|
78
|
+
add_plugin(Aws::Plugins::HttpChecksum)
|
79
|
+
add_plugin(Aws::Plugins::ChecksumAlgorithm)
|
80
|
+
add_plugin(Aws::Plugins::DefaultsMode)
|
81
|
+
add_plugin(Aws::Plugins::RecursionDetection)
|
82
|
+
add_plugin(Aws::Plugins::SignatureV4)
|
83
|
+
add_plugin(Aws::Plugins::Protocols::RestJson)
|
84
|
+
|
85
|
+
# @overload initialize(options)
|
86
|
+
# @param [Hash] options
|
87
|
+
# @option options [required, Aws::CredentialProvider] :credentials
|
88
|
+
# Your AWS credentials. This can be an instance of any one of the
|
89
|
+
# following classes:
|
90
|
+
#
|
91
|
+
# * `Aws::Credentials` - Used for configuring static, non-refreshing
|
92
|
+
# credentials.
|
93
|
+
#
|
94
|
+
# * `Aws::SharedCredentials` - Used for loading static credentials from a
|
95
|
+
# shared file, such as `~/.aws/config`.
|
96
|
+
#
|
97
|
+
# * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
|
98
|
+
#
|
99
|
+
# * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to
|
100
|
+
# assume a role after providing credentials via the web.
|
101
|
+
#
|
102
|
+
# * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an
|
103
|
+
# access token generated from `aws login`.
|
104
|
+
#
|
105
|
+
# * `Aws::ProcessCredentials` - Used for loading credentials from a
|
106
|
+
# process that outputs to stdout.
|
107
|
+
#
|
108
|
+
# * `Aws::InstanceProfileCredentials` - Used for loading credentials
|
109
|
+
# from an EC2 IMDS on an EC2 instance.
|
110
|
+
#
|
111
|
+
# * `Aws::ECSCredentials` - Used for loading credentials from
|
112
|
+
# instances running in ECS.
|
113
|
+
#
|
114
|
+
# * `Aws::CognitoIdentityCredentials` - Used for loading credentials
|
115
|
+
# from the Cognito Identity service.
|
116
|
+
#
|
117
|
+
# When `:credentials` are not configured directly, the following
|
118
|
+
# locations will be searched for credentials:
|
119
|
+
#
|
120
|
+
# * `Aws.config[:credentials]`
|
121
|
+
# * The `:access_key_id`, `:secret_access_key`, and `:session_token` options.
|
122
|
+
# * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
|
123
|
+
# * `~/.aws/credentials`
|
124
|
+
# * `~/.aws/config`
|
125
|
+
# * EC2/ECS IMDS instance profile - When used by default, the timeouts
|
126
|
+
# are very aggressive. Construct and pass an instance of
|
127
|
+
# `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
|
128
|
+
# enable retries and extended timeouts. Instance profile credential
|
129
|
+
# fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED']
|
130
|
+
# to true.
|
131
|
+
#
|
132
|
+
# @option options [required, String] :region
|
133
|
+
# The AWS region to connect to. The configured `:region` is
|
134
|
+
# used to determine the service `:endpoint`. When not passed,
|
135
|
+
# a default `:region` is searched for in the following locations:
|
136
|
+
#
|
137
|
+
# * `Aws.config[:region]`
|
138
|
+
# * `ENV['AWS_REGION']`
|
139
|
+
# * `ENV['AMAZON_REGION']`
|
140
|
+
# * `ENV['AWS_DEFAULT_REGION']`
|
141
|
+
# * `~/.aws/credentials`
|
142
|
+
# * `~/.aws/config`
|
143
|
+
#
|
144
|
+
# @option options [String] :access_key_id
|
145
|
+
#
|
146
|
+
# @option options [Boolean] :active_endpoint_cache (false)
|
147
|
+
# When set to `true`, a thread polling for endpoints will be running in
|
148
|
+
# the background every 60 secs (default). Defaults to `false`.
|
149
|
+
#
|
150
|
+
# @option options [Boolean] :adaptive_retry_wait_to_fill (true)
|
151
|
+
# Used only in `adaptive` retry mode. When true, the request will sleep
|
152
|
+
# until there is sufficent client side capacity to retry the request.
|
153
|
+
# When false, the request will raise a `RetryCapacityNotAvailableError` and will
|
154
|
+
# not retry instead of sleeping.
|
155
|
+
#
|
156
|
+
# @option options [Boolean] :client_side_monitoring (false)
|
157
|
+
# When `true`, client-side metrics will be collected for all API requests from
|
158
|
+
# this client.
|
159
|
+
#
|
160
|
+
# @option options [String] :client_side_monitoring_client_id ("")
|
161
|
+
# Allows you to provide an identifier for this client which will be attached to
|
162
|
+
# all generated client side metrics. Defaults to an empty string.
|
163
|
+
#
|
164
|
+
# @option options [String] :client_side_monitoring_host ("127.0.0.1")
|
165
|
+
# Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client
|
166
|
+
# side monitoring agent is running on, where client metrics will be published via UDP.
|
167
|
+
#
|
168
|
+
# @option options [Integer] :client_side_monitoring_port (31000)
|
169
|
+
# Required for publishing client metrics. The port that the client side monitoring
|
170
|
+
# agent is running on, where client metrics will be published via UDP.
|
171
|
+
#
|
172
|
+
# @option options [Aws::ClientSideMonitoring::Publisher] :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher)
|
173
|
+
# Allows you to provide a custom client-side monitoring publisher class. By default,
|
174
|
+
# will use the Client Side Monitoring Agent Publisher.
|
175
|
+
#
|
176
|
+
# @option options [Boolean] :convert_params (true)
|
177
|
+
# When `true`, an attempt is made to coerce request parameters into
|
178
|
+
# the required types.
|
179
|
+
#
|
180
|
+
# @option options [Boolean] :correct_clock_skew (true)
|
181
|
+
# Used only in `standard` and adaptive retry modes. Specifies whether to apply
|
182
|
+
# a clock skew correction and retry requests with skewed client clocks.
|
183
|
+
#
|
184
|
+
# @option options [String] :defaults_mode ("legacy")
|
185
|
+
# See {Aws::DefaultsModeConfiguration} for a list of the
|
186
|
+
# accepted modes and the configuration defaults that are included.
|
187
|
+
#
|
188
|
+
# @option options [Boolean] :disable_host_prefix_injection (false)
|
189
|
+
# Set to true to disable SDK automatically adding host prefix
|
190
|
+
# to default service endpoint when available.
|
191
|
+
#
|
192
|
+
# @option options [String] :endpoint
|
193
|
+
# The client endpoint is normally constructed from the `:region`
|
194
|
+
# option. You should only configure an `:endpoint` when connecting
|
195
|
+
# to test or custom endpoints. This should be a valid HTTP(S) URI.
|
196
|
+
#
|
197
|
+
# @option options [Integer] :endpoint_cache_max_entries (1000)
|
198
|
+
# Used for the maximum size limit of the LRU cache storing endpoints data
|
199
|
+
# for endpoint discovery enabled operations. Defaults to 1000.
|
200
|
+
#
|
201
|
+
# @option options [Integer] :endpoint_cache_max_threads (10)
|
202
|
+
# Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.
|
203
|
+
#
|
204
|
+
# @option options [Integer] :endpoint_cache_poll_interval (60)
|
205
|
+
# When :endpoint_discovery and :active_endpoint_cache is enabled,
|
206
|
+
# Use this option to config the time interval in seconds for making
|
207
|
+
# requests fetching endpoints information. Defaults to 60 sec.
|
208
|
+
#
|
209
|
+
# @option options [Boolean] :endpoint_discovery (false)
|
210
|
+
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
211
|
+
#
|
212
|
+
# @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
|
213
|
+
# The log formatter.
|
214
|
+
#
|
215
|
+
# @option options [Symbol] :log_level (:info)
|
216
|
+
# The log level to send messages to the `:logger` at.
|
217
|
+
#
|
218
|
+
# @option options [Logger] :logger
|
219
|
+
# The Logger instance to send log messages to. If this option
|
220
|
+
# is not set, logging will be disabled.
|
221
|
+
#
|
222
|
+
# @option options [Integer] :max_attempts (3)
|
223
|
+
# An integer representing the maximum number attempts that will be made for
|
224
|
+
# a single request, including the initial attempt. For example,
|
225
|
+
# setting this value to 5 will result in a request being retried up to
|
226
|
+
# 4 times. Used in `standard` and `adaptive` retry modes.
|
227
|
+
#
|
228
|
+
# @option options [String] :profile ("default")
|
229
|
+
# Used when loading credentials from the shared credentials file
|
230
|
+
# at HOME/.aws/credentials. When not specified, 'default' is used.
|
231
|
+
#
|
232
|
+
# @option options [Proc] :retry_backoff
|
233
|
+
# A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
|
234
|
+
# This option is only used in the `legacy` retry mode.
|
235
|
+
#
|
236
|
+
# @option options [Float] :retry_base_delay (0.3)
|
237
|
+
# The base delay in seconds used by the default backoff function. This option
|
238
|
+
# is only used in the `legacy` retry mode.
|
239
|
+
#
|
240
|
+
# @option options [Symbol] :retry_jitter (:none)
|
241
|
+
# A delay randomiser function used by the default backoff function.
|
242
|
+
# Some predefined functions can be referenced by name - :none, :equal, :full,
|
243
|
+
# otherwise a Proc that takes and returns a number. This option is only used
|
244
|
+
# in the `legacy` retry mode.
|
245
|
+
#
|
246
|
+
# @see https://www.awsarchitectureblog.com/2015/03/backoff.html
|
247
|
+
#
|
248
|
+
# @option options [Integer] :retry_limit (3)
|
249
|
+
# The maximum number of times to retry failed requests. Only
|
250
|
+
# ~ 500 level server errors and certain ~ 400 level client errors
|
251
|
+
# are retried. Generally, these are throttling errors, data
|
252
|
+
# checksum errors, networking errors, timeout errors, auth errors,
|
253
|
+
# endpoint discovery, and errors from expired credentials.
|
254
|
+
# This option is only used in the `legacy` retry mode.
|
255
|
+
#
|
256
|
+
# @option options [Integer] :retry_max_delay (0)
|
257
|
+
# The maximum number of seconds to delay between retries (0 for no limit)
|
258
|
+
# used by the default backoff function. This option is only used in the
|
259
|
+
# `legacy` retry mode.
|
260
|
+
#
|
261
|
+
# @option options [String] :retry_mode ("legacy")
|
262
|
+
# Specifies which retry algorithm to use. Values are:
|
263
|
+
#
|
264
|
+
# * `legacy` - The pre-existing retry behavior. This is default value if
|
265
|
+
# no retry mode is provided.
|
266
|
+
#
|
267
|
+
# * `standard` - A standardized set of retry rules across the AWS SDKs.
|
268
|
+
# This includes support for retry quotas, which limit the number of
|
269
|
+
# unsuccessful retries a client can make.
|
270
|
+
#
|
271
|
+
# * `adaptive` - An experimental retry mode that includes all the
|
272
|
+
# functionality of `standard` mode along with automatic client side
|
273
|
+
# throttling. This is a provisional mode that may change behavior
|
274
|
+
# in the future.
|
275
|
+
#
|
276
|
+
#
|
277
|
+
# @option options [String] :secret_access_key
|
278
|
+
#
|
279
|
+
# @option options [String] :session_token
|
280
|
+
#
|
281
|
+
# @option options [Boolean] :stub_responses (false)
|
282
|
+
# Causes the client to return stubbed responses. By default
|
283
|
+
# fake responses are generated and returned. You can specify
|
284
|
+
# the response data to return or errors to raise by calling
|
285
|
+
# {ClientStubs#stub_responses}. See {ClientStubs} for more information.
|
286
|
+
#
|
287
|
+
# ** Please note ** When response stubbing is enabled, no HTTP
|
288
|
+
# requests are made, and retries are disabled.
|
289
|
+
#
|
290
|
+
# @option options [Boolean] :use_dualstack_endpoint
|
291
|
+
# When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
|
292
|
+
# will be used if available.
|
293
|
+
#
|
294
|
+
# @option options [Boolean] :use_fips_endpoint
|
295
|
+
# When set to `true`, fips compatible endpoints will be used if available.
|
296
|
+
# When a `fips` region is used, the region is normalized and this config
|
297
|
+
# is set to `true`.
|
298
|
+
#
|
299
|
+
# @option options [Boolean] :validate_params (true)
|
300
|
+
# When `true`, request parameters are validated before
|
301
|
+
# sending the request.
|
302
|
+
#
|
303
|
+
# @option options [URI::HTTP,String] :http_proxy A proxy to send
|
304
|
+
# requests through. Formatted like 'http://proxy.com:123'.
|
305
|
+
#
|
306
|
+
# @option options [Float] :http_open_timeout (15) The number of
|
307
|
+
# seconds to wait when opening a HTTP session before raising a
|
308
|
+
# `Timeout::Error`.
|
309
|
+
#
|
310
|
+
# @option options [Float] :http_read_timeout (60) The default
|
311
|
+
# number of seconds to wait for response data. This value can
|
312
|
+
# safely be set per-request on the session.
|
313
|
+
#
|
314
|
+
# @option options [Float] :http_idle_timeout (5) The number of
|
315
|
+
# seconds a connection is allowed to sit idle before it is
|
316
|
+
# considered stale. Stale connections are closed and removed
|
317
|
+
# from the pool before making a request.
|
318
|
+
#
|
319
|
+
# @option options [Float] :http_continue_timeout (1) The number of
|
320
|
+
# seconds to wait for a 100-continue response before sending the
|
321
|
+
# request body. This option has no effect unless the request has
|
322
|
+
# "Expect" header set to "100-continue". Defaults to `nil` which
|
323
|
+
# disables this behaviour. This value can safely be set per
|
324
|
+
# request on the session.
|
325
|
+
#
|
326
|
+
# @option options [Float] :ssl_timeout (nil) Sets the SSL timeout
|
327
|
+
# in seconds.
|
328
|
+
#
|
329
|
+
# @option options [Boolean] :http_wire_trace (false) When `true`,
|
330
|
+
# HTTP debug output will be sent to the `:logger`.
|
331
|
+
#
|
332
|
+
# @option options [Boolean] :ssl_verify_peer (true) When `true`,
|
333
|
+
# SSL peer certificates are verified when establishing a
|
334
|
+
# connection.
|
335
|
+
#
|
336
|
+
# @option options [String] :ssl_ca_bundle Full path to the SSL
|
337
|
+
# certificate authority bundle file that should be used when
|
338
|
+
# verifying peer certificates. If you do not pass
|
339
|
+
# `:ssl_ca_bundle` or `:ssl_ca_directory` the the system default
|
340
|
+
# will be used if available.
|
341
|
+
#
|
342
|
+
# @option options [String] :ssl_ca_directory Full path of the
|
343
|
+
# directory that contains the unbundled SSL certificate
|
344
|
+
# authority files for verifying peer certificates. If you do
|
345
|
+
# not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the
|
346
|
+
# system default will be used if available.
|
347
|
+
#
|
348
|
+
def initialize(*args)
|
349
|
+
super
|
350
|
+
end
|
351
|
+
|
352
|
+
# @!group API Operations
|
353
|
+
|
354
|
+
# Acknowledges that the specified network order was received.
|
355
|
+
#
|
356
|
+
# @option params [required, String] :order_arn
|
357
|
+
# The Amazon Resource Name (ARN) of the order.
|
358
|
+
#
|
359
|
+
# @return [Types::AcknowledgeOrderReceiptResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
360
|
+
#
|
361
|
+
# * {Types::AcknowledgeOrderReceiptResponse#order #order} => Types::Order
|
362
|
+
#
|
363
|
+
# @example Request syntax with placeholder values
|
364
|
+
#
|
365
|
+
# resp = client.acknowledge_order_receipt({
|
366
|
+
# order_arn: "Arn", # required
|
367
|
+
# })
|
368
|
+
#
|
369
|
+
# @example Response structure
|
370
|
+
#
|
371
|
+
# resp.order.acknowledgment_status #=> String, one of "ACKNOWLEDGING", "ACKNOWLEDGED", "UNACKNOWLEDGED"
|
372
|
+
# resp.order.created_at #=> Time
|
373
|
+
# resp.order.network_arn #=> String
|
374
|
+
# resp.order.network_site_arn #=> String
|
375
|
+
# resp.order.order_arn #=> String
|
376
|
+
# resp.order.shipping_address.city #=> String
|
377
|
+
# resp.order.shipping_address.company #=> String
|
378
|
+
# resp.order.shipping_address.country #=> String
|
379
|
+
# resp.order.shipping_address.name #=> String
|
380
|
+
# resp.order.shipping_address.phone_number #=> String
|
381
|
+
# resp.order.shipping_address.postal_code #=> String
|
382
|
+
# resp.order.shipping_address.state_or_province #=> String
|
383
|
+
# resp.order.shipping_address.street1 #=> String
|
384
|
+
# resp.order.shipping_address.street2 #=> String
|
385
|
+
# resp.order.shipping_address.street3 #=> String
|
386
|
+
# resp.order.tracking_information #=> Array
|
387
|
+
# resp.order.tracking_information[0].tracking_number #=> String
|
388
|
+
#
|
389
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/privatenetworks-2021-12-03/AcknowledgeOrderReceipt AWS API Documentation
|
390
|
+
#
|
391
|
+
# @overload acknowledge_order_receipt(params = {})
|
392
|
+
# @param [Hash] params ({})
|
393
|
+
def acknowledge_order_receipt(params = {}, options = {})
|
394
|
+
req = build_request(:acknowledge_order_receipt, params)
|
395
|
+
req.send_request(options)
|
396
|
+
end
|
397
|
+
|
398
|
+
# Activates the specified device identifier.
|
399
|
+
#
|
400
|
+
# @option params [String] :client_token
|
401
|
+
# Unique, case-sensitive identifier that you provide to ensure the
|
402
|
+
# idempotency of the request. For more information, see [How to ensure
|
403
|
+
# idempotency][1].
|
404
|
+
#
|
405
|
+
#
|
406
|
+
#
|
407
|
+
# [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Run_Instance_Idempotency.html
|
408
|
+
#
|
409
|
+
# @option params [required, String] :device_identifier_arn
|
410
|
+
# The Amazon Resource Name (ARN) of the device identifier.
|
411
|
+
#
|
412
|
+
# @return [Types::ActivateDeviceIdentifierResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
413
|
+
#
|
414
|
+
# * {Types::ActivateDeviceIdentifierResponse#device_identifier #device_identifier} => Types::DeviceIdentifier
|
415
|
+
# * {Types::ActivateDeviceIdentifierResponse#tags #tags} => Hash<String,String>
|
416
|
+
#
|
417
|
+
# @example Request syntax with placeholder values
|
418
|
+
#
|
419
|
+
# resp = client.activate_device_identifier({
|
420
|
+
# client_token: "ClientToken",
|
421
|
+
# device_identifier_arn: "Arn", # required
|
422
|
+
# })
|
423
|
+
#
|
424
|
+
# @example Response structure
|
425
|
+
#
|
426
|
+
# resp.device_identifier.created_at #=> Time
|
427
|
+
# resp.device_identifier.device_identifier_arn #=> String
|
428
|
+
# resp.device_identifier.iccid #=> String
|
429
|
+
# resp.device_identifier.imsi #=> String
|
430
|
+
# resp.device_identifier.network_arn #=> String
|
431
|
+
# resp.device_identifier.order_arn #=> String
|
432
|
+
# resp.device_identifier.status #=> String, one of "ACTIVE", "INACTIVE"
|
433
|
+
# resp.device_identifier.traffic_group_arn #=> String
|
434
|
+
# resp.device_identifier.vendor #=> String
|
435
|
+
# resp.tags #=> Hash
|
436
|
+
# resp.tags["TagKey"] #=> String
|
437
|
+
#
|
438
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/privatenetworks-2021-12-03/ActivateDeviceIdentifier AWS API Documentation
|
439
|
+
#
|
440
|
+
# @overload activate_device_identifier(params = {})
|
441
|
+
# @param [Hash] params ({})
|
442
|
+
def activate_device_identifier(params = {}, options = {})
|
443
|
+
req = build_request(:activate_device_identifier, params)
|
444
|
+
req.send_request(options)
|
445
|
+
end
|
446
|
+
|
447
|
+
# Activates the specified network site.
|
448
|
+
#
|
449
|
+
# @option params [String] :client_token
|
450
|
+
# Unique, case-sensitive identifier that you provide to ensure the
|
451
|
+
# idempotency of the request. For more information, see [How to ensure
|
452
|
+
# idempotency][1].
|
453
|
+
#
|
454
|
+
#
|
455
|
+
#
|
456
|
+
# [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Run_Instance_Idempotency.html
|
457
|
+
#
|
458
|
+
# @option params [required, String] :network_site_arn
|
459
|
+
# The Amazon Resource Name (ARN) of the network site.
|
460
|
+
#
|
461
|
+
# @option params [required, Types::Address] :shipping_address
|
462
|
+
# The shipping address of the network site.
|
463
|
+
#
|
464
|
+
# @return [Types::ActivateNetworkSiteResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
465
|
+
#
|
466
|
+
# * {Types::ActivateNetworkSiteResponse#network_site #network_site} => Types::NetworkSite
|
467
|
+
#
|
468
|
+
# @example Request syntax with placeholder values
|
469
|
+
#
|
470
|
+
# resp = client.activate_network_site({
|
471
|
+
# client_token: "ClientToken",
|
472
|
+
# network_site_arn: "Arn", # required
|
473
|
+
# shipping_address: { # required
|
474
|
+
# city: "AddressContent", # required
|
475
|
+
# company: "AddressContent",
|
476
|
+
# country: "AddressContent", # required
|
477
|
+
# name: "AddressContent", # required
|
478
|
+
# phone_number: "AddressContent",
|
479
|
+
# postal_code: "AddressContent", # required
|
480
|
+
# state_or_province: "AddressContent", # required
|
481
|
+
# street1: "AddressContent", # required
|
482
|
+
# street2: "AddressContent",
|
483
|
+
# street3: "AddressContent",
|
484
|
+
# },
|
485
|
+
# })
|
486
|
+
#
|
487
|
+
# @example Response structure
|
488
|
+
#
|
489
|
+
# resp.network_site.availability_zone #=> String
|
490
|
+
# resp.network_site.availability_zone_id #=> String
|
491
|
+
# resp.network_site.created_at #=> Time
|
492
|
+
# resp.network_site.current_plan.options #=> Array
|
493
|
+
# resp.network_site.current_plan.options[0].name #=> String
|
494
|
+
# resp.network_site.current_plan.options[0].value #=> String
|
495
|
+
# resp.network_site.current_plan.resource_definitions #=> Array
|
496
|
+
# resp.network_site.current_plan.resource_definitions[0].count #=> Integer
|
497
|
+
# resp.network_site.current_plan.resource_definitions[0].options #=> Array
|
498
|
+
# resp.network_site.current_plan.resource_definitions[0].options[0].name #=> String
|
499
|
+
# resp.network_site.current_plan.resource_definitions[0].options[0].value #=> String
|
500
|
+
# resp.network_site.current_plan.resource_definitions[0].type #=> String, one of "RADIO_UNIT", "DEVICE_IDENTIFIER"
|
501
|
+
# resp.network_site.description #=> String
|
502
|
+
# resp.network_site.network_arn #=> String
|
503
|
+
# resp.network_site.network_site_arn #=> String
|
504
|
+
# resp.network_site.network_site_name #=> String
|
505
|
+
# resp.network_site.pending_plan.options #=> Array
|
506
|
+
# resp.network_site.pending_plan.options[0].name #=> String
|
507
|
+
# resp.network_site.pending_plan.options[0].value #=> String
|
508
|
+
# resp.network_site.pending_plan.resource_definitions #=> Array
|
509
|
+
# resp.network_site.pending_plan.resource_definitions[0].count #=> Integer
|
510
|
+
# resp.network_site.pending_plan.resource_definitions[0].options #=> Array
|
511
|
+
# resp.network_site.pending_plan.resource_definitions[0].options[0].name #=> String
|
512
|
+
# resp.network_site.pending_plan.resource_definitions[0].options[0].value #=> String
|
513
|
+
# resp.network_site.pending_plan.resource_definitions[0].type #=> String, one of "RADIO_UNIT", "DEVICE_IDENTIFIER"
|
514
|
+
# resp.network_site.status #=> String, one of "CREATED", "PROVISIONING", "AVAILABLE", "DEPROVISIONING", "DELETED"
|
515
|
+
# resp.network_site.status_reason #=> String
|
516
|
+
#
|
517
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/privatenetworks-2021-12-03/ActivateNetworkSite AWS API Documentation
|
518
|
+
#
|
519
|
+
# @overload activate_network_site(params = {})
|
520
|
+
# @param [Hash] params ({})
|
521
|
+
def activate_network_site(params = {}, options = {})
|
522
|
+
req = build_request(:activate_network_site, params)
|
523
|
+
req.send_request(options)
|
524
|
+
end
|
525
|
+
|
526
|
+
# Configures the specified network resource.
|
527
|
+
#
|
528
|
+
# Use this action to specify the geographic position of the hardware.
|
529
|
+
# You must provide Certified Professional Installer (CPI) credentials in
|
530
|
+
# the request so that we can obtain spectrum grants. For more
|
531
|
+
# information, see [Radio units][1] in the *Amazon Web Services Private
|
532
|
+
# 5G User Guide*.
|
533
|
+
#
|
534
|
+
#
|
535
|
+
#
|
536
|
+
# [1]: https://docs.aws.amazon.com/private-networks/latest/userguide/radio-units.html
|
537
|
+
#
|
538
|
+
# @option params [required, String] :access_point_arn
|
539
|
+
# The Amazon Resource Name (ARN) of the network resource.
|
540
|
+
#
|
541
|
+
# @option params [String] :cpi_secret_key
|
542
|
+
# A Base64 encoded string of the CPI certificate associated with the CPI
|
543
|
+
# user who is certifying the coordinates of the network resource.
|
544
|
+
#
|
545
|
+
# @option params [String] :cpi_user_id
|
546
|
+
# The CPI user ID of the CPI user who is certifying the coordinates of
|
547
|
+
# the network resource.
|
548
|
+
#
|
549
|
+
# @option params [String] :cpi_user_password
|
550
|
+
# The CPI password associated with the CPI certificate in
|
551
|
+
# `cpiSecretKey`.
|
552
|
+
#
|
553
|
+
# @option params [String] :cpi_username
|
554
|
+
# The CPI user name of the CPI user who is certifying the coordinates of
|
555
|
+
# the radio unit.
|
556
|
+
#
|
557
|
+
# @option params [Types::Position] :position
|
558
|
+
# The position of the network resource.
|
559
|
+
#
|
560
|
+
# @return [Types::ConfigureAccessPointResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
561
|
+
#
|
562
|
+
# * {Types::ConfigureAccessPointResponse#access_point #access_point} => Types::NetworkResource
|
563
|
+
#
|
564
|
+
# @example Request syntax with placeholder values
|
565
|
+
#
|
566
|
+
# resp = client.configure_access_point({
|
567
|
+
# access_point_arn: "Arn", # required
|
568
|
+
# cpi_secret_key: "ConfigureAccessPointRequestCpiSecretKeyString",
|
569
|
+
# cpi_user_id: "ConfigureAccessPointRequestCpiUserIdString",
|
570
|
+
# cpi_user_password: "ConfigureAccessPointRequestCpiUserPasswordString",
|
571
|
+
# cpi_username: "ConfigureAccessPointRequestCpiUsernameString",
|
572
|
+
# position: {
|
573
|
+
# elevation: 1.0,
|
574
|
+
# elevation_reference: "AGL", # accepts AGL, AMSL
|
575
|
+
# elevation_unit: "FEET", # accepts FEET
|
576
|
+
# latitude: 1.0,
|
577
|
+
# longitude: 1.0,
|
578
|
+
# },
|
579
|
+
# })
|
580
|
+
#
|
581
|
+
# @example Response structure
|
582
|
+
#
|
583
|
+
# resp.access_point.attributes #=> Array
|
584
|
+
# resp.access_point.attributes[0].name #=> String
|
585
|
+
# resp.access_point.attributes[0].value #=> String
|
586
|
+
# resp.access_point.created_at #=> Time
|
587
|
+
# resp.access_point.description #=> String
|
588
|
+
# resp.access_point.health #=> String, one of "INITIAL", "HEALTHY", "UNHEALTHY"
|
589
|
+
# resp.access_point.model #=> String
|
590
|
+
# resp.access_point.network_arn #=> String
|
591
|
+
# resp.access_point.network_resource_arn #=> String
|
592
|
+
# resp.access_point.network_site_arn #=> String
|
593
|
+
# resp.access_point.order_arn #=> String
|
594
|
+
# resp.access_point.position.elevation #=> Float
|
595
|
+
# resp.access_point.position.elevation_reference #=> String, one of "AGL", "AMSL"
|
596
|
+
# resp.access_point.position.elevation_unit #=> String, one of "FEET"
|
597
|
+
# resp.access_point.position.latitude #=> Float
|
598
|
+
# resp.access_point.position.longitude #=> Float
|
599
|
+
# resp.access_point.serial_number #=> String
|
600
|
+
# resp.access_point.status #=> String, one of "PENDING", "SHIPPED", "PROVISIONING", "PROVISIONED", "AVAILABLE", "DELETING", "PENDING_RETURN", "DELETED"
|
601
|
+
# resp.access_point.status_reason #=> String
|
602
|
+
# resp.access_point.type #=> String, one of "RADIO_UNIT"
|
603
|
+
# resp.access_point.vendor #=> String
|
604
|
+
#
|
605
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/privatenetworks-2021-12-03/ConfigureAccessPoint AWS API Documentation
|
606
|
+
#
|
607
|
+
# @overload configure_access_point(params = {})
|
608
|
+
# @param [Hash] params ({})
|
609
|
+
def configure_access_point(params = {}, options = {})
|
610
|
+
req = build_request(:configure_access_point, params)
|
611
|
+
req.send_request(options)
|
612
|
+
end
|
613
|
+
|
614
|
+
# Creates a network.
|
615
|
+
#
|
616
|
+
# @option params [String] :client_token
|
617
|
+
# Unique, case-sensitive identifier that you provide to ensure the
|
618
|
+
# idempotency of the request. For more information, see [How to ensure
|
619
|
+
# idempotency][1].
|
620
|
+
#
|
621
|
+
#
|
622
|
+
#
|
623
|
+
# [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Run_Instance_Idempotency.html
|
624
|
+
#
|
625
|
+
# @option params [String] :description
|
626
|
+
# The description of the network.
|
627
|
+
#
|
628
|
+
# @option params [required, String] :network_name
|
629
|
+
# The name of the network. You can't change the name after you create
|
630
|
+
# the network.
|
631
|
+
#
|
632
|
+
# @option params [Hash<String,String>] :tags
|
633
|
+
# The tags to apply to the network.
|
634
|
+
#
|
635
|
+
# @return [Types::CreateNetworkResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
636
|
+
#
|
637
|
+
# * {Types::CreateNetworkResponse#network #network} => Types::Network
|
638
|
+
# * {Types::CreateNetworkResponse#tags #tags} => Hash<String,String>
|
639
|
+
#
|
640
|
+
# @example Request syntax with placeholder values
|
641
|
+
#
|
642
|
+
# resp = client.create_network({
|
643
|
+
# client_token: "ClientToken",
|
644
|
+
# description: "Description",
|
645
|
+
# network_name: "Name", # required
|
646
|
+
# tags: {
|
647
|
+
# "TagKey" => "TagValue",
|
648
|
+
# },
|
649
|
+
# })
|
650
|
+
#
|
651
|
+
# @example Response structure
|
652
|
+
#
|
653
|
+
# resp.network.created_at #=> Time
|
654
|
+
# resp.network.description #=> String
|
655
|
+
# resp.network.network_arn #=> String
|
656
|
+
# resp.network.network_name #=> String
|
657
|
+
# resp.network.status #=> String, one of "CREATED", "PROVISIONING", "AVAILABLE", "DEPROVISIONING", "DELETED"
|
658
|
+
# resp.network.status_reason #=> String
|
659
|
+
# resp.tags #=> Hash
|
660
|
+
# resp.tags["TagKey"] #=> String
|
661
|
+
#
|
662
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/privatenetworks-2021-12-03/CreateNetwork AWS API Documentation
|
663
|
+
#
|
664
|
+
# @overload create_network(params = {})
|
665
|
+
# @param [Hash] params ({})
|
666
|
+
def create_network(params = {}, options = {})
|
667
|
+
req = build_request(:create_network, params)
|
668
|
+
req.send_request(options)
|
669
|
+
end
|
670
|
+
|
671
|
+
# Creates a network site.
|
672
|
+
#
|
673
|
+
# @option params [String] :availability_zone
|
674
|
+
# The Availability Zone that is the parent of this site. You can't
|
675
|
+
# change the Availability Zone after you create the site.
|
676
|
+
#
|
677
|
+
# @option params [String] :availability_zone_id
|
678
|
+
# The ID of the Availability Zone that is the parent of this site. You
|
679
|
+
# can't change the Availability Zone after you create the site.
|
680
|
+
#
|
681
|
+
# @option params [String] :client_token
|
682
|
+
# Unique, case-sensitive identifier that you provide to ensure the
|
683
|
+
# idempotency of the request. For more information, see [How to ensure
|
684
|
+
# idempotency][1].
|
685
|
+
#
|
686
|
+
#
|
687
|
+
#
|
688
|
+
# [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Run_Instance_Idempotency.html
|
689
|
+
#
|
690
|
+
# @option params [String] :description
|
691
|
+
# The description of the site.
|
692
|
+
#
|
693
|
+
# @option params [required, String] :network_arn
|
694
|
+
# The Amazon Resource Name (ARN) of the network.
|
695
|
+
#
|
696
|
+
# @option params [required, String] :network_site_name
|
697
|
+
# The name of the site. You can't change the name after you create the
|
698
|
+
# site.
|
699
|
+
#
|
700
|
+
# @option params [Types::SitePlan] :pending_plan
|
701
|
+
# Information about the pending plan for this site.
|
702
|
+
#
|
703
|
+
# @option params [Hash<String,String>] :tags
|
704
|
+
# The tags to apply to the network site.
|
705
|
+
#
|
706
|
+
# @return [Types::CreateNetworkSiteResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
707
|
+
#
|
708
|
+
# * {Types::CreateNetworkSiteResponse#network_site #network_site} => Types::NetworkSite
|
709
|
+
# * {Types::CreateNetworkSiteResponse#tags #tags} => Hash<String,String>
|
710
|
+
#
|
711
|
+
# @example Request syntax with placeholder values
|
712
|
+
#
|
713
|
+
# resp = client.create_network_site({
|
714
|
+
# availability_zone: "String",
|
715
|
+
# availability_zone_id: "String",
|
716
|
+
# client_token: "ClientToken",
|
717
|
+
# description: "Description",
|
718
|
+
# network_arn: "Arn", # required
|
719
|
+
# network_site_name: "Name", # required
|
720
|
+
# pending_plan: {
|
721
|
+
# options: [
|
722
|
+
# {
|
723
|
+
# name: "String", # required
|
724
|
+
# value: "String",
|
725
|
+
# },
|
726
|
+
# ],
|
727
|
+
# resource_definitions: [
|
728
|
+
# {
|
729
|
+
# count: 1, # required
|
730
|
+
# options: [
|
731
|
+
# {
|
732
|
+
# name: "String", # required
|
733
|
+
# value: "String",
|
734
|
+
# },
|
735
|
+
# ],
|
736
|
+
# type: "RADIO_UNIT", # required, accepts RADIO_UNIT, DEVICE_IDENTIFIER
|
737
|
+
# },
|
738
|
+
# ],
|
739
|
+
# },
|
740
|
+
# tags: {
|
741
|
+
# "TagKey" => "TagValue",
|
742
|
+
# },
|
743
|
+
# })
|
744
|
+
#
|
745
|
+
# @example Response structure
|
746
|
+
#
|
747
|
+
# resp.network_site.availability_zone #=> String
|
748
|
+
# resp.network_site.availability_zone_id #=> String
|
749
|
+
# resp.network_site.created_at #=> Time
|
750
|
+
# resp.network_site.current_plan.options #=> Array
|
751
|
+
# resp.network_site.current_plan.options[0].name #=> String
|
752
|
+
# resp.network_site.current_plan.options[0].value #=> String
|
753
|
+
# resp.network_site.current_plan.resource_definitions #=> Array
|
754
|
+
# resp.network_site.current_plan.resource_definitions[0].count #=> Integer
|
755
|
+
# resp.network_site.current_plan.resource_definitions[0].options #=> Array
|
756
|
+
# resp.network_site.current_plan.resource_definitions[0].options[0].name #=> String
|
757
|
+
# resp.network_site.current_plan.resource_definitions[0].options[0].value #=> String
|
758
|
+
# resp.network_site.current_plan.resource_definitions[0].type #=> String, one of "RADIO_UNIT", "DEVICE_IDENTIFIER"
|
759
|
+
# resp.network_site.description #=> String
|
760
|
+
# resp.network_site.network_arn #=> String
|
761
|
+
# resp.network_site.network_site_arn #=> String
|
762
|
+
# resp.network_site.network_site_name #=> String
|
763
|
+
# resp.network_site.pending_plan.options #=> Array
|
764
|
+
# resp.network_site.pending_plan.options[0].name #=> String
|
765
|
+
# resp.network_site.pending_plan.options[0].value #=> String
|
766
|
+
# resp.network_site.pending_plan.resource_definitions #=> Array
|
767
|
+
# resp.network_site.pending_plan.resource_definitions[0].count #=> Integer
|
768
|
+
# resp.network_site.pending_plan.resource_definitions[0].options #=> Array
|
769
|
+
# resp.network_site.pending_plan.resource_definitions[0].options[0].name #=> String
|
770
|
+
# resp.network_site.pending_plan.resource_definitions[0].options[0].value #=> String
|
771
|
+
# resp.network_site.pending_plan.resource_definitions[0].type #=> String, one of "RADIO_UNIT", "DEVICE_IDENTIFIER"
|
772
|
+
# resp.network_site.status #=> String, one of "CREATED", "PROVISIONING", "AVAILABLE", "DEPROVISIONING", "DELETED"
|
773
|
+
# resp.network_site.status_reason #=> String
|
774
|
+
# resp.tags #=> Hash
|
775
|
+
# resp.tags["TagKey"] #=> String
|
776
|
+
#
|
777
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/privatenetworks-2021-12-03/CreateNetworkSite AWS API Documentation
|
778
|
+
#
|
779
|
+
# @overload create_network_site(params = {})
|
780
|
+
# @param [Hash] params ({})
|
781
|
+
def create_network_site(params = {}, options = {})
|
782
|
+
req = build_request(:create_network_site, params)
|
783
|
+
req.send_request(options)
|
784
|
+
end
|
785
|
+
|
786
|
+
# Deactivates the specified device identifier.
|
787
|
+
#
|
788
|
+
# @option params [String] :client_token
|
789
|
+
# Unique, case-sensitive identifier that you provide to ensure the
|
790
|
+
# idempotency of the request. For more information, see [How to ensure
|
791
|
+
# idempotency][1].
|
792
|
+
#
|
793
|
+
#
|
794
|
+
#
|
795
|
+
# [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Run_Instance_Idempotency.html
|
796
|
+
#
|
797
|
+
# @option params [required, String] :device_identifier_arn
|
798
|
+
# The Amazon Resource Name (ARN) of the device identifier.
|
799
|
+
#
|
800
|
+
# @return [Types::DeactivateDeviceIdentifierResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
801
|
+
#
|
802
|
+
# * {Types::DeactivateDeviceIdentifierResponse#device_identifier #device_identifier} => Types::DeviceIdentifier
|
803
|
+
#
|
804
|
+
# @example Request syntax with placeholder values
|
805
|
+
#
|
806
|
+
# resp = client.deactivate_device_identifier({
|
807
|
+
# client_token: "ClientToken",
|
808
|
+
# device_identifier_arn: "Arn", # required
|
809
|
+
# })
|
810
|
+
#
|
811
|
+
# @example Response structure
|
812
|
+
#
|
813
|
+
# resp.device_identifier.created_at #=> Time
|
814
|
+
# resp.device_identifier.device_identifier_arn #=> String
|
815
|
+
# resp.device_identifier.iccid #=> String
|
816
|
+
# resp.device_identifier.imsi #=> String
|
817
|
+
# resp.device_identifier.network_arn #=> String
|
818
|
+
# resp.device_identifier.order_arn #=> String
|
819
|
+
# resp.device_identifier.status #=> String, one of "ACTIVE", "INACTIVE"
|
820
|
+
# resp.device_identifier.traffic_group_arn #=> String
|
821
|
+
# resp.device_identifier.vendor #=> String
|
822
|
+
#
|
823
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/privatenetworks-2021-12-03/DeactivateDeviceIdentifier AWS API Documentation
|
824
|
+
#
|
825
|
+
# @overload deactivate_device_identifier(params = {})
|
826
|
+
# @param [Hash] params ({})
|
827
|
+
def deactivate_device_identifier(params = {}, options = {})
|
828
|
+
req = build_request(:deactivate_device_identifier, params)
|
829
|
+
req.send_request(options)
|
830
|
+
end
|
831
|
+
|
832
|
+
# Deletes the specified network. You must delete network sites before
|
833
|
+
# you delete the network. For more information, see
|
834
|
+
# [DeleteNetworkSite][1] in the *API Reference for Amazon Web Services
|
835
|
+
# Private 5G*.
|
836
|
+
#
|
837
|
+
#
|
838
|
+
#
|
839
|
+
# [1]: https://docs.aws.amazon.com/private-networks/latest/APIReference/API_DeleteNetworkSite.html
|
840
|
+
#
|
841
|
+
# @option params [String] :client_token
|
842
|
+
# Unique, case-sensitive identifier that you provide to ensure the
|
843
|
+
# idempotency of the request. For more information, see [How to ensure
|
844
|
+
# idempotency][1].
|
845
|
+
#
|
846
|
+
#
|
847
|
+
#
|
848
|
+
# [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Run_Instance_Idempotency.html
|
849
|
+
#
|
850
|
+
# @option params [required, String] :network_arn
|
851
|
+
# The Amazon Resource Name (ARN) of the network.
|
852
|
+
#
|
853
|
+
# @return [Types::DeleteNetworkResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
854
|
+
#
|
855
|
+
# * {Types::DeleteNetworkResponse#network #network} => Types::Network
|
856
|
+
#
|
857
|
+
# @example Request syntax with placeholder values
|
858
|
+
#
|
859
|
+
# resp = client.delete_network({
|
860
|
+
# client_token: "ClientToken",
|
861
|
+
# network_arn: "Arn", # required
|
862
|
+
# })
|
863
|
+
#
|
864
|
+
# @example Response structure
|
865
|
+
#
|
866
|
+
# resp.network.created_at #=> Time
|
867
|
+
# resp.network.description #=> String
|
868
|
+
# resp.network.network_arn #=> String
|
869
|
+
# resp.network.network_name #=> String
|
870
|
+
# resp.network.status #=> String, one of "CREATED", "PROVISIONING", "AVAILABLE", "DEPROVISIONING", "DELETED"
|
871
|
+
# resp.network.status_reason #=> String
|
872
|
+
#
|
873
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/privatenetworks-2021-12-03/DeleteNetwork AWS API Documentation
|
874
|
+
#
|
875
|
+
# @overload delete_network(params = {})
|
876
|
+
# @param [Hash] params ({})
|
877
|
+
def delete_network(params = {}, options = {})
|
878
|
+
req = build_request(:delete_network, params)
|
879
|
+
req.send_request(options)
|
880
|
+
end
|
881
|
+
|
882
|
+
# Deletes the specified network site. Return the hardware after you
|
883
|
+
# delete the network site. You are responsible for minimum charges. For
|
884
|
+
# more information, see [Hardware returns][1] in the *Amazon Web
|
885
|
+
# Services Private 5G User Guide*.
|
886
|
+
#
|
887
|
+
#
|
888
|
+
#
|
889
|
+
# [1]: https://docs.aws.amazon.com/private-networks/latest/userguide/hardware-maintenance.html
|
890
|
+
#
|
891
|
+
# @option params [String] :client_token
|
892
|
+
# Unique, case-sensitive identifier that you provide to ensure the
|
893
|
+
# idempotency of the request. For more information, see [How to ensure
|
894
|
+
# idempotency][1].
|
895
|
+
#
|
896
|
+
#
|
897
|
+
#
|
898
|
+
# [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Run_Instance_Idempotency.html
|
899
|
+
#
|
900
|
+
# @option params [required, String] :network_site_arn
|
901
|
+
# The Amazon Resource Name (ARN) of the network site.
|
902
|
+
#
|
903
|
+
# @return [Types::DeleteNetworkSiteResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
904
|
+
#
|
905
|
+
# * {Types::DeleteNetworkSiteResponse#network_site #network_site} => Types::NetworkSite
|
906
|
+
#
|
907
|
+
# @example Request syntax with placeholder values
|
908
|
+
#
|
909
|
+
# resp = client.delete_network_site({
|
910
|
+
# client_token: "ClientToken",
|
911
|
+
# network_site_arn: "Arn", # required
|
912
|
+
# })
|
913
|
+
#
|
914
|
+
# @example Response structure
|
915
|
+
#
|
916
|
+
# resp.network_site.availability_zone #=> String
|
917
|
+
# resp.network_site.availability_zone_id #=> String
|
918
|
+
# resp.network_site.created_at #=> Time
|
919
|
+
# resp.network_site.current_plan.options #=> Array
|
920
|
+
# resp.network_site.current_plan.options[0].name #=> String
|
921
|
+
# resp.network_site.current_plan.options[0].value #=> String
|
922
|
+
# resp.network_site.current_plan.resource_definitions #=> Array
|
923
|
+
# resp.network_site.current_plan.resource_definitions[0].count #=> Integer
|
924
|
+
# resp.network_site.current_plan.resource_definitions[0].options #=> Array
|
925
|
+
# resp.network_site.current_plan.resource_definitions[0].options[0].name #=> String
|
926
|
+
# resp.network_site.current_plan.resource_definitions[0].options[0].value #=> String
|
927
|
+
# resp.network_site.current_plan.resource_definitions[0].type #=> String, one of "RADIO_UNIT", "DEVICE_IDENTIFIER"
|
928
|
+
# resp.network_site.description #=> String
|
929
|
+
# resp.network_site.network_arn #=> String
|
930
|
+
# resp.network_site.network_site_arn #=> String
|
931
|
+
# resp.network_site.network_site_name #=> String
|
932
|
+
# resp.network_site.pending_plan.options #=> Array
|
933
|
+
# resp.network_site.pending_plan.options[0].name #=> String
|
934
|
+
# resp.network_site.pending_plan.options[0].value #=> String
|
935
|
+
# resp.network_site.pending_plan.resource_definitions #=> Array
|
936
|
+
# resp.network_site.pending_plan.resource_definitions[0].count #=> Integer
|
937
|
+
# resp.network_site.pending_plan.resource_definitions[0].options #=> Array
|
938
|
+
# resp.network_site.pending_plan.resource_definitions[0].options[0].name #=> String
|
939
|
+
# resp.network_site.pending_plan.resource_definitions[0].options[0].value #=> String
|
940
|
+
# resp.network_site.pending_plan.resource_definitions[0].type #=> String, one of "RADIO_UNIT", "DEVICE_IDENTIFIER"
|
941
|
+
# resp.network_site.status #=> String, one of "CREATED", "PROVISIONING", "AVAILABLE", "DEPROVISIONING", "DELETED"
|
942
|
+
# resp.network_site.status_reason #=> String
|
943
|
+
#
|
944
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/privatenetworks-2021-12-03/DeleteNetworkSite AWS API Documentation
|
945
|
+
#
|
946
|
+
# @overload delete_network_site(params = {})
|
947
|
+
# @param [Hash] params ({})
|
948
|
+
def delete_network_site(params = {}, options = {})
|
949
|
+
req = build_request(:delete_network_site, params)
|
950
|
+
req.send_request(options)
|
951
|
+
end
|
952
|
+
|
953
|
+
# Gets the specified device identifier.
|
954
|
+
#
|
955
|
+
# @option params [required, String] :device_identifier_arn
|
956
|
+
# The Amazon Resource Name (ARN) of the device identifier.
|
957
|
+
#
|
958
|
+
# @return [Types::GetDeviceIdentifierResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
959
|
+
#
|
960
|
+
# * {Types::GetDeviceIdentifierResponse#device_identifier #device_identifier} => Types::DeviceIdentifier
|
961
|
+
# * {Types::GetDeviceIdentifierResponse#tags #tags} => Hash<String,String>
|
962
|
+
#
|
963
|
+
# @example Request syntax with placeholder values
|
964
|
+
#
|
965
|
+
# resp = client.get_device_identifier({
|
966
|
+
# device_identifier_arn: "Arn", # required
|
967
|
+
# })
|
968
|
+
#
|
969
|
+
# @example Response structure
|
970
|
+
#
|
971
|
+
# resp.device_identifier.created_at #=> Time
|
972
|
+
# resp.device_identifier.device_identifier_arn #=> String
|
973
|
+
# resp.device_identifier.iccid #=> String
|
974
|
+
# resp.device_identifier.imsi #=> String
|
975
|
+
# resp.device_identifier.network_arn #=> String
|
976
|
+
# resp.device_identifier.order_arn #=> String
|
977
|
+
# resp.device_identifier.status #=> String, one of "ACTIVE", "INACTIVE"
|
978
|
+
# resp.device_identifier.traffic_group_arn #=> String
|
979
|
+
# resp.device_identifier.vendor #=> String
|
980
|
+
# resp.tags #=> Hash
|
981
|
+
# resp.tags["TagKey"] #=> String
|
982
|
+
#
|
983
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/privatenetworks-2021-12-03/GetDeviceIdentifier AWS API Documentation
|
984
|
+
#
|
985
|
+
# @overload get_device_identifier(params = {})
|
986
|
+
# @param [Hash] params ({})
|
987
|
+
def get_device_identifier(params = {}, options = {})
|
988
|
+
req = build_request(:get_device_identifier, params)
|
989
|
+
req.send_request(options)
|
990
|
+
end
|
991
|
+
|
992
|
+
# Gets the specified network.
|
993
|
+
#
|
994
|
+
# @option params [required, String] :network_arn
|
995
|
+
# The Amazon Resource Name (ARN) of the network.
|
996
|
+
#
|
997
|
+
# @return [Types::GetNetworkResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
998
|
+
#
|
999
|
+
# * {Types::GetNetworkResponse#network #network} => Types::Network
|
1000
|
+
# * {Types::GetNetworkResponse#tags #tags} => Hash<String,String>
|
1001
|
+
#
|
1002
|
+
# @example Request syntax with placeholder values
|
1003
|
+
#
|
1004
|
+
# resp = client.get_network({
|
1005
|
+
# network_arn: "Arn", # required
|
1006
|
+
# })
|
1007
|
+
#
|
1008
|
+
# @example Response structure
|
1009
|
+
#
|
1010
|
+
# resp.network.created_at #=> Time
|
1011
|
+
# resp.network.description #=> String
|
1012
|
+
# resp.network.network_arn #=> String
|
1013
|
+
# resp.network.network_name #=> String
|
1014
|
+
# resp.network.status #=> String, one of "CREATED", "PROVISIONING", "AVAILABLE", "DEPROVISIONING", "DELETED"
|
1015
|
+
# resp.network.status_reason #=> String
|
1016
|
+
# resp.tags #=> Hash
|
1017
|
+
# resp.tags["TagKey"] #=> String
|
1018
|
+
#
|
1019
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/privatenetworks-2021-12-03/GetNetwork AWS API Documentation
|
1020
|
+
#
|
1021
|
+
# @overload get_network(params = {})
|
1022
|
+
# @param [Hash] params ({})
|
1023
|
+
def get_network(params = {}, options = {})
|
1024
|
+
req = build_request(:get_network, params)
|
1025
|
+
req.send_request(options)
|
1026
|
+
end
|
1027
|
+
|
1028
|
+
# Gets the specified network resource.
|
1029
|
+
#
|
1030
|
+
# @option params [required, String] :network_resource_arn
|
1031
|
+
# The Amazon Resource Name (ARN) of the network resource.
|
1032
|
+
#
|
1033
|
+
# @return [Types::GetNetworkResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1034
|
+
#
|
1035
|
+
# * {Types::GetNetworkResourceResponse#network_resource #network_resource} => Types::NetworkResource
|
1036
|
+
# * {Types::GetNetworkResourceResponse#tags #tags} => Hash<String,String>
|
1037
|
+
#
|
1038
|
+
# @example Request syntax with placeholder values
|
1039
|
+
#
|
1040
|
+
# resp = client.get_network_resource({
|
1041
|
+
# network_resource_arn: "Arn", # required
|
1042
|
+
# })
|
1043
|
+
#
|
1044
|
+
# @example Response structure
|
1045
|
+
#
|
1046
|
+
# resp.network_resource.attributes #=> Array
|
1047
|
+
# resp.network_resource.attributes[0].name #=> String
|
1048
|
+
# resp.network_resource.attributes[0].value #=> String
|
1049
|
+
# resp.network_resource.created_at #=> Time
|
1050
|
+
# resp.network_resource.description #=> String
|
1051
|
+
# resp.network_resource.health #=> String, one of "INITIAL", "HEALTHY", "UNHEALTHY"
|
1052
|
+
# resp.network_resource.model #=> String
|
1053
|
+
# resp.network_resource.network_arn #=> String
|
1054
|
+
# resp.network_resource.network_resource_arn #=> String
|
1055
|
+
# resp.network_resource.network_site_arn #=> String
|
1056
|
+
# resp.network_resource.order_arn #=> String
|
1057
|
+
# resp.network_resource.position.elevation #=> Float
|
1058
|
+
# resp.network_resource.position.elevation_reference #=> String, one of "AGL", "AMSL"
|
1059
|
+
# resp.network_resource.position.elevation_unit #=> String, one of "FEET"
|
1060
|
+
# resp.network_resource.position.latitude #=> Float
|
1061
|
+
# resp.network_resource.position.longitude #=> Float
|
1062
|
+
# resp.network_resource.serial_number #=> String
|
1063
|
+
# resp.network_resource.status #=> String, one of "PENDING", "SHIPPED", "PROVISIONING", "PROVISIONED", "AVAILABLE", "DELETING", "PENDING_RETURN", "DELETED"
|
1064
|
+
# resp.network_resource.status_reason #=> String
|
1065
|
+
# resp.network_resource.type #=> String, one of "RADIO_UNIT"
|
1066
|
+
# resp.network_resource.vendor #=> String
|
1067
|
+
# resp.tags #=> Hash
|
1068
|
+
# resp.tags["TagKey"] #=> String
|
1069
|
+
#
|
1070
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/privatenetworks-2021-12-03/GetNetworkResource AWS API Documentation
|
1071
|
+
#
|
1072
|
+
# @overload get_network_resource(params = {})
|
1073
|
+
# @param [Hash] params ({})
|
1074
|
+
def get_network_resource(params = {}, options = {})
|
1075
|
+
req = build_request(:get_network_resource, params)
|
1076
|
+
req.send_request(options)
|
1077
|
+
end
|
1078
|
+
|
1079
|
+
# Gets the specified network site.
|
1080
|
+
#
|
1081
|
+
# @option params [required, String] :network_site_arn
|
1082
|
+
# The Amazon Resource Name (ARN) of the network site.
|
1083
|
+
#
|
1084
|
+
# @return [Types::GetNetworkSiteResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1085
|
+
#
|
1086
|
+
# * {Types::GetNetworkSiteResponse#network_site #network_site} => Types::NetworkSite
|
1087
|
+
# * {Types::GetNetworkSiteResponse#tags #tags} => Hash<String,String>
|
1088
|
+
#
|
1089
|
+
# @example Request syntax with placeholder values
|
1090
|
+
#
|
1091
|
+
# resp = client.get_network_site({
|
1092
|
+
# network_site_arn: "Arn", # required
|
1093
|
+
# })
|
1094
|
+
#
|
1095
|
+
# @example Response structure
|
1096
|
+
#
|
1097
|
+
# resp.network_site.availability_zone #=> String
|
1098
|
+
# resp.network_site.availability_zone_id #=> String
|
1099
|
+
# resp.network_site.created_at #=> Time
|
1100
|
+
# resp.network_site.current_plan.options #=> Array
|
1101
|
+
# resp.network_site.current_plan.options[0].name #=> String
|
1102
|
+
# resp.network_site.current_plan.options[0].value #=> String
|
1103
|
+
# resp.network_site.current_plan.resource_definitions #=> Array
|
1104
|
+
# resp.network_site.current_plan.resource_definitions[0].count #=> Integer
|
1105
|
+
# resp.network_site.current_plan.resource_definitions[0].options #=> Array
|
1106
|
+
# resp.network_site.current_plan.resource_definitions[0].options[0].name #=> String
|
1107
|
+
# resp.network_site.current_plan.resource_definitions[0].options[0].value #=> String
|
1108
|
+
# resp.network_site.current_plan.resource_definitions[0].type #=> String, one of "RADIO_UNIT", "DEVICE_IDENTIFIER"
|
1109
|
+
# resp.network_site.description #=> String
|
1110
|
+
# resp.network_site.network_arn #=> String
|
1111
|
+
# resp.network_site.network_site_arn #=> String
|
1112
|
+
# resp.network_site.network_site_name #=> String
|
1113
|
+
# resp.network_site.pending_plan.options #=> Array
|
1114
|
+
# resp.network_site.pending_plan.options[0].name #=> String
|
1115
|
+
# resp.network_site.pending_plan.options[0].value #=> String
|
1116
|
+
# resp.network_site.pending_plan.resource_definitions #=> Array
|
1117
|
+
# resp.network_site.pending_plan.resource_definitions[0].count #=> Integer
|
1118
|
+
# resp.network_site.pending_plan.resource_definitions[0].options #=> Array
|
1119
|
+
# resp.network_site.pending_plan.resource_definitions[0].options[0].name #=> String
|
1120
|
+
# resp.network_site.pending_plan.resource_definitions[0].options[0].value #=> String
|
1121
|
+
# resp.network_site.pending_plan.resource_definitions[0].type #=> String, one of "RADIO_UNIT", "DEVICE_IDENTIFIER"
|
1122
|
+
# resp.network_site.status #=> String, one of "CREATED", "PROVISIONING", "AVAILABLE", "DEPROVISIONING", "DELETED"
|
1123
|
+
# resp.network_site.status_reason #=> String
|
1124
|
+
# resp.tags #=> Hash
|
1125
|
+
# resp.tags["TagKey"] #=> String
|
1126
|
+
#
|
1127
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/privatenetworks-2021-12-03/GetNetworkSite AWS API Documentation
|
1128
|
+
#
|
1129
|
+
# @overload get_network_site(params = {})
|
1130
|
+
# @param [Hash] params ({})
|
1131
|
+
def get_network_site(params = {}, options = {})
|
1132
|
+
req = build_request(:get_network_site, params)
|
1133
|
+
req.send_request(options)
|
1134
|
+
end
|
1135
|
+
|
1136
|
+
# Gets the specified order.
|
1137
|
+
#
|
1138
|
+
# @option params [required, String] :order_arn
|
1139
|
+
# The Amazon Resource Name (ARN) of the order.
|
1140
|
+
#
|
1141
|
+
# @return [Types::GetOrderResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1142
|
+
#
|
1143
|
+
# * {Types::GetOrderResponse#order #order} => Types::Order
|
1144
|
+
# * {Types::GetOrderResponse#tags #tags} => Hash<String,String>
|
1145
|
+
#
|
1146
|
+
# @example Request syntax with placeholder values
|
1147
|
+
#
|
1148
|
+
# resp = client.get_order({
|
1149
|
+
# order_arn: "Arn", # required
|
1150
|
+
# })
|
1151
|
+
#
|
1152
|
+
# @example Response structure
|
1153
|
+
#
|
1154
|
+
# resp.order.acknowledgment_status #=> String, one of "ACKNOWLEDGING", "ACKNOWLEDGED", "UNACKNOWLEDGED"
|
1155
|
+
# resp.order.created_at #=> Time
|
1156
|
+
# resp.order.network_arn #=> String
|
1157
|
+
# resp.order.network_site_arn #=> String
|
1158
|
+
# resp.order.order_arn #=> String
|
1159
|
+
# resp.order.shipping_address.city #=> String
|
1160
|
+
# resp.order.shipping_address.company #=> String
|
1161
|
+
# resp.order.shipping_address.country #=> String
|
1162
|
+
# resp.order.shipping_address.name #=> String
|
1163
|
+
# resp.order.shipping_address.phone_number #=> String
|
1164
|
+
# resp.order.shipping_address.postal_code #=> String
|
1165
|
+
# resp.order.shipping_address.state_or_province #=> String
|
1166
|
+
# resp.order.shipping_address.street1 #=> String
|
1167
|
+
# resp.order.shipping_address.street2 #=> String
|
1168
|
+
# resp.order.shipping_address.street3 #=> String
|
1169
|
+
# resp.order.tracking_information #=> Array
|
1170
|
+
# resp.order.tracking_information[0].tracking_number #=> String
|
1171
|
+
# resp.tags #=> Hash
|
1172
|
+
# resp.tags["TagKey"] #=> String
|
1173
|
+
#
|
1174
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/privatenetworks-2021-12-03/GetOrder AWS API Documentation
|
1175
|
+
#
|
1176
|
+
# @overload get_order(params = {})
|
1177
|
+
# @param [Hash] params ({})
|
1178
|
+
def get_order(params = {}, options = {})
|
1179
|
+
req = build_request(:get_order, params)
|
1180
|
+
req.send_request(options)
|
1181
|
+
end
|
1182
|
+
|
1183
|
+
# Lists device identifiers. Add filters to your request to return a more
|
1184
|
+
# specific list of results. Use filters to match the Amazon Resource
|
1185
|
+
# Name (ARN) of an order, the status of device identifiers, or the ARN
|
1186
|
+
# of the traffic group.
|
1187
|
+
#
|
1188
|
+
# <p>If you specify multiple filters, filters are joined with an OR, and the request
|
1189
|
+
#
|
1190
|
+
# returns results that match all of the specified filters.
|
1191
|
+
#
|
1192
|
+
# </p>
|
1193
|
+
#
|
1194
|
+
# @option params [Hash<String,Array>] :filters
|
1195
|
+
# The filters.
|
1196
|
+
#
|
1197
|
+
# * `ORDER` - The Amazon Resource Name (ARN) of the order.
|
1198
|
+
#
|
1199
|
+
# * `STATUS` - The status (`ACTIVE` \| `INACTIVE`).
|
1200
|
+
#
|
1201
|
+
# * `TRAFFIC_GROUP` - The Amazon Resource Name (ARN) of the traffic
|
1202
|
+
# group.
|
1203
|
+
#
|
1204
|
+
# Filter values are case sensitive. If you specify multiple values for a
|
1205
|
+
# filter, the values are joined with an `OR`, and the request returns
|
1206
|
+
# all results that match any of the specified values.
|
1207
|
+
#
|
1208
|
+
# @option params [Integer] :max_results
|
1209
|
+
# The maximum number of results to return.
|
1210
|
+
#
|
1211
|
+
# @option params [required, String] :network_arn
|
1212
|
+
# The Amazon Resource Name (ARN) of the network.
|
1213
|
+
#
|
1214
|
+
# @option params [String] :start_token
|
1215
|
+
# The token for the next page of results.
|
1216
|
+
#
|
1217
|
+
# @return [Types::ListDeviceIdentifiersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1218
|
+
#
|
1219
|
+
# * {Types::ListDeviceIdentifiersResponse#device_identifiers #device_identifiers} => Array<Types::DeviceIdentifier>
|
1220
|
+
# * {Types::ListDeviceIdentifiersResponse#next_token #next_token} => String
|
1221
|
+
#
|
1222
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1223
|
+
#
|
1224
|
+
# @example Request syntax with placeholder values
|
1225
|
+
#
|
1226
|
+
# resp = client.list_device_identifiers({
|
1227
|
+
# filters: {
|
1228
|
+
# "STATUS" => ["String"],
|
1229
|
+
# },
|
1230
|
+
# max_results: 1,
|
1231
|
+
# network_arn: "Arn", # required
|
1232
|
+
# start_token: "PaginationToken",
|
1233
|
+
# })
|
1234
|
+
#
|
1235
|
+
# @example Response structure
|
1236
|
+
#
|
1237
|
+
# resp.device_identifiers #=> Array
|
1238
|
+
# resp.device_identifiers[0].created_at #=> Time
|
1239
|
+
# resp.device_identifiers[0].device_identifier_arn #=> String
|
1240
|
+
# resp.device_identifiers[0].iccid #=> String
|
1241
|
+
# resp.device_identifiers[0].imsi #=> String
|
1242
|
+
# resp.device_identifiers[0].network_arn #=> String
|
1243
|
+
# resp.device_identifiers[0].order_arn #=> String
|
1244
|
+
# resp.device_identifiers[0].status #=> String, one of "ACTIVE", "INACTIVE"
|
1245
|
+
# resp.device_identifiers[0].traffic_group_arn #=> String
|
1246
|
+
# resp.device_identifiers[0].vendor #=> String
|
1247
|
+
# resp.next_token #=> String
|
1248
|
+
#
|
1249
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/privatenetworks-2021-12-03/ListDeviceIdentifiers AWS API Documentation
|
1250
|
+
#
|
1251
|
+
# @overload list_device_identifiers(params = {})
|
1252
|
+
# @param [Hash] params ({})
|
1253
|
+
def list_device_identifiers(params = {}, options = {})
|
1254
|
+
req = build_request(:list_device_identifiers, params)
|
1255
|
+
req.send_request(options)
|
1256
|
+
end
|
1257
|
+
|
1258
|
+
# Lists network resources. Add filters to your request to return a more
|
1259
|
+
# specific list of results. Use filters to match the Amazon Resource
|
1260
|
+
# Name (ARN) of an order or the status of network resources.
|
1261
|
+
#
|
1262
|
+
# If you specify multiple filters, filters are joined with an OR, and
|
1263
|
+
# the request returns results that match all of the specified filters.
|
1264
|
+
#
|
1265
|
+
# @option params [Hash<String,Array>] :filters
|
1266
|
+
# The filters.
|
1267
|
+
#
|
1268
|
+
# * `ORDER` - The Amazon Resource Name (ARN) of the order.
|
1269
|
+
#
|
1270
|
+
# * `STATUS` - The status (`AVAILABLE` \| `DELETED` \| `DELETING` \|
|
1271
|
+
# `PENDING` \| `PENDING_RETURN` \| `PROVISIONING` \| `SHIPPED`).
|
1272
|
+
#
|
1273
|
+
# Filter values are case sensitive. If you specify multiple values for a
|
1274
|
+
# filter, the values are joined with an `OR`, and the request returns
|
1275
|
+
# all results that match any of the specified values.
|
1276
|
+
#
|
1277
|
+
# @option params [Integer] :max_results
|
1278
|
+
# The maximum number of results to return.
|
1279
|
+
#
|
1280
|
+
# @option params [required, String] :network_arn
|
1281
|
+
# The Amazon Resource Name (ARN) of the network.
|
1282
|
+
#
|
1283
|
+
# @option params [String] :start_token
|
1284
|
+
# The token for the next page of results.
|
1285
|
+
#
|
1286
|
+
# @return [Types::ListNetworkResourcesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1287
|
+
#
|
1288
|
+
# * {Types::ListNetworkResourcesResponse#network_resources #network_resources} => Array<Types::NetworkResource>
|
1289
|
+
# * {Types::ListNetworkResourcesResponse#next_token #next_token} => String
|
1290
|
+
#
|
1291
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1292
|
+
#
|
1293
|
+
# @example Request syntax with placeholder values
|
1294
|
+
#
|
1295
|
+
# resp = client.list_network_resources({
|
1296
|
+
# filters: {
|
1297
|
+
# "ORDER" => ["String"],
|
1298
|
+
# },
|
1299
|
+
# max_results: 1,
|
1300
|
+
# network_arn: "Arn", # required
|
1301
|
+
# start_token: "PaginationToken",
|
1302
|
+
# })
|
1303
|
+
#
|
1304
|
+
# @example Response structure
|
1305
|
+
#
|
1306
|
+
# resp.network_resources #=> Array
|
1307
|
+
# resp.network_resources[0].attributes #=> Array
|
1308
|
+
# resp.network_resources[0].attributes[0].name #=> String
|
1309
|
+
# resp.network_resources[0].attributes[0].value #=> String
|
1310
|
+
# resp.network_resources[0].created_at #=> Time
|
1311
|
+
# resp.network_resources[0].description #=> String
|
1312
|
+
# resp.network_resources[0].health #=> String, one of "INITIAL", "HEALTHY", "UNHEALTHY"
|
1313
|
+
# resp.network_resources[0].model #=> String
|
1314
|
+
# resp.network_resources[0].network_arn #=> String
|
1315
|
+
# resp.network_resources[0].network_resource_arn #=> String
|
1316
|
+
# resp.network_resources[0].network_site_arn #=> String
|
1317
|
+
# resp.network_resources[0].order_arn #=> String
|
1318
|
+
# resp.network_resources[0].position.elevation #=> Float
|
1319
|
+
# resp.network_resources[0].position.elevation_reference #=> String, one of "AGL", "AMSL"
|
1320
|
+
# resp.network_resources[0].position.elevation_unit #=> String, one of "FEET"
|
1321
|
+
# resp.network_resources[0].position.latitude #=> Float
|
1322
|
+
# resp.network_resources[0].position.longitude #=> Float
|
1323
|
+
# resp.network_resources[0].serial_number #=> String
|
1324
|
+
# resp.network_resources[0].status #=> String, one of "PENDING", "SHIPPED", "PROVISIONING", "PROVISIONED", "AVAILABLE", "DELETING", "PENDING_RETURN", "DELETED"
|
1325
|
+
# resp.network_resources[0].status_reason #=> String
|
1326
|
+
# resp.network_resources[0].type #=> String, one of "RADIO_UNIT"
|
1327
|
+
# resp.network_resources[0].vendor #=> String
|
1328
|
+
# resp.next_token #=> String
|
1329
|
+
#
|
1330
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/privatenetworks-2021-12-03/ListNetworkResources AWS API Documentation
|
1331
|
+
#
|
1332
|
+
# @overload list_network_resources(params = {})
|
1333
|
+
# @param [Hash] params ({})
|
1334
|
+
def list_network_resources(params = {}, options = {})
|
1335
|
+
req = build_request(:list_network_resources, params)
|
1336
|
+
req.send_request(options)
|
1337
|
+
end
|
1338
|
+
|
1339
|
+
# Lists network sites. Add filters to your request to return a more
|
1340
|
+
# specific list of results. Use filters to match the status of the
|
1341
|
+
# network site.
|
1342
|
+
#
|
1343
|
+
# @option params [Hash<String,Array>] :filters
|
1344
|
+
# The filters. Add filters to your request to return a more specific
|
1345
|
+
# list of results. Use filters to match the status of the network sites.
|
1346
|
+
#
|
1347
|
+
# * `STATUS` - The status (`AVAILABLE` \| `CREATED` \| `DELETED` \|
|
1348
|
+
# `DEPROVISIONING` \| `PROVISIONING`).
|
1349
|
+
#
|
1350
|
+
# ^
|
1351
|
+
#
|
1352
|
+
# Filter values are case sensitive. If you specify multiple values for a
|
1353
|
+
# filter, the values are joined with an `OR`, and the request returns
|
1354
|
+
# all results that match any of the specified values.
|
1355
|
+
#
|
1356
|
+
# @option params [Integer] :max_results
|
1357
|
+
# The maximum number of results to return.
|
1358
|
+
#
|
1359
|
+
# @option params [required, String] :network_arn
|
1360
|
+
# The Amazon Resource Name (ARN) of the network.
|
1361
|
+
#
|
1362
|
+
# @option params [String] :start_token
|
1363
|
+
# The token for the next page of results.
|
1364
|
+
#
|
1365
|
+
# @return [Types::ListNetworkSitesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1366
|
+
#
|
1367
|
+
# * {Types::ListNetworkSitesResponse#network_sites #network_sites} => Array<Types::NetworkSite>
|
1368
|
+
# * {Types::ListNetworkSitesResponse#next_token #next_token} => String
|
1369
|
+
#
|
1370
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1371
|
+
#
|
1372
|
+
# @example Request syntax with placeholder values
|
1373
|
+
#
|
1374
|
+
# resp = client.list_network_sites({
|
1375
|
+
# filters: {
|
1376
|
+
# "STATUS" => ["String"],
|
1377
|
+
# },
|
1378
|
+
# max_results: 1,
|
1379
|
+
# network_arn: "Arn", # required
|
1380
|
+
# start_token: "PaginationToken",
|
1381
|
+
# })
|
1382
|
+
#
|
1383
|
+
# @example Response structure
|
1384
|
+
#
|
1385
|
+
# resp.network_sites #=> Array
|
1386
|
+
# resp.network_sites[0].availability_zone #=> String
|
1387
|
+
# resp.network_sites[0].availability_zone_id #=> String
|
1388
|
+
# resp.network_sites[0].created_at #=> Time
|
1389
|
+
# resp.network_sites[0].current_plan.options #=> Array
|
1390
|
+
# resp.network_sites[0].current_plan.options[0].name #=> String
|
1391
|
+
# resp.network_sites[0].current_plan.options[0].value #=> String
|
1392
|
+
# resp.network_sites[0].current_plan.resource_definitions #=> Array
|
1393
|
+
# resp.network_sites[0].current_plan.resource_definitions[0].count #=> Integer
|
1394
|
+
# resp.network_sites[0].current_plan.resource_definitions[0].options #=> Array
|
1395
|
+
# resp.network_sites[0].current_plan.resource_definitions[0].options[0].name #=> String
|
1396
|
+
# resp.network_sites[0].current_plan.resource_definitions[0].options[0].value #=> String
|
1397
|
+
# resp.network_sites[0].current_plan.resource_definitions[0].type #=> String, one of "RADIO_UNIT", "DEVICE_IDENTIFIER"
|
1398
|
+
# resp.network_sites[0].description #=> String
|
1399
|
+
# resp.network_sites[0].network_arn #=> String
|
1400
|
+
# resp.network_sites[0].network_site_arn #=> String
|
1401
|
+
# resp.network_sites[0].network_site_name #=> String
|
1402
|
+
# resp.network_sites[0].pending_plan.options #=> Array
|
1403
|
+
# resp.network_sites[0].pending_plan.options[0].name #=> String
|
1404
|
+
# resp.network_sites[0].pending_plan.options[0].value #=> String
|
1405
|
+
# resp.network_sites[0].pending_plan.resource_definitions #=> Array
|
1406
|
+
# resp.network_sites[0].pending_plan.resource_definitions[0].count #=> Integer
|
1407
|
+
# resp.network_sites[0].pending_plan.resource_definitions[0].options #=> Array
|
1408
|
+
# resp.network_sites[0].pending_plan.resource_definitions[0].options[0].name #=> String
|
1409
|
+
# resp.network_sites[0].pending_plan.resource_definitions[0].options[0].value #=> String
|
1410
|
+
# resp.network_sites[0].pending_plan.resource_definitions[0].type #=> String, one of "RADIO_UNIT", "DEVICE_IDENTIFIER"
|
1411
|
+
# resp.network_sites[0].status #=> String, one of "CREATED", "PROVISIONING", "AVAILABLE", "DEPROVISIONING", "DELETED"
|
1412
|
+
# resp.network_sites[0].status_reason #=> String
|
1413
|
+
# resp.next_token #=> String
|
1414
|
+
#
|
1415
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/privatenetworks-2021-12-03/ListNetworkSites AWS API Documentation
|
1416
|
+
#
|
1417
|
+
# @overload list_network_sites(params = {})
|
1418
|
+
# @param [Hash] params ({})
|
1419
|
+
def list_network_sites(params = {}, options = {})
|
1420
|
+
req = build_request(:list_network_sites, params)
|
1421
|
+
req.send_request(options)
|
1422
|
+
end
|
1423
|
+
|
1424
|
+
# Lists networks. Add filters to your request to return a more specific
|
1425
|
+
# list of results. Use filters to match the status of the network.
|
1426
|
+
#
|
1427
|
+
# @option params [Hash<String,Array>] :filters
|
1428
|
+
# The filters.
|
1429
|
+
#
|
1430
|
+
# * `STATUS` - The status (`AVAILABLE` \| `CREATED` \| `DELETED` \|
|
1431
|
+
# `DEPROVISIONING` \| `PROVISIONING`).
|
1432
|
+
#
|
1433
|
+
# ^
|
1434
|
+
#
|
1435
|
+
# Filter values are case sensitive. If you specify multiple values for a
|
1436
|
+
# filter, the values are joined with an `OR`, and the request returns
|
1437
|
+
# all results that match any of the specified values.
|
1438
|
+
#
|
1439
|
+
# @option params [Integer] :max_results
|
1440
|
+
# The maximum number of results to return.
|
1441
|
+
#
|
1442
|
+
# @option params [String] :start_token
|
1443
|
+
# The token for the next page of results.
|
1444
|
+
#
|
1445
|
+
# @return [Types::ListNetworksResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1446
|
+
#
|
1447
|
+
# * {Types::ListNetworksResponse#networks #networks} => Array<Types::Network>
|
1448
|
+
# * {Types::ListNetworksResponse#next_token #next_token} => String
|
1449
|
+
#
|
1450
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1451
|
+
#
|
1452
|
+
# @example Request syntax with placeholder values
|
1453
|
+
#
|
1454
|
+
# resp = client.list_networks({
|
1455
|
+
# filters: {
|
1456
|
+
# "STATUS" => ["String"],
|
1457
|
+
# },
|
1458
|
+
# max_results: 1,
|
1459
|
+
# start_token: "PaginationToken",
|
1460
|
+
# })
|
1461
|
+
#
|
1462
|
+
# @example Response structure
|
1463
|
+
#
|
1464
|
+
# resp.networks #=> Array
|
1465
|
+
# resp.networks[0].created_at #=> Time
|
1466
|
+
# resp.networks[0].description #=> String
|
1467
|
+
# resp.networks[0].network_arn #=> String
|
1468
|
+
# resp.networks[0].network_name #=> String
|
1469
|
+
# resp.networks[0].status #=> String, one of "CREATED", "PROVISIONING", "AVAILABLE", "DEPROVISIONING", "DELETED"
|
1470
|
+
# resp.networks[0].status_reason #=> String
|
1471
|
+
# resp.next_token #=> String
|
1472
|
+
#
|
1473
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/privatenetworks-2021-12-03/ListNetworks AWS API Documentation
|
1474
|
+
#
|
1475
|
+
# @overload list_networks(params = {})
|
1476
|
+
# @param [Hash] params ({})
|
1477
|
+
def list_networks(params = {}, options = {})
|
1478
|
+
req = build_request(:list_networks, params)
|
1479
|
+
req.send_request(options)
|
1480
|
+
end
|
1481
|
+
|
1482
|
+
# Lists orders. Add filters to your request to return a more specific
|
1483
|
+
# list of results. Use filters to match the Amazon Resource Name (ARN)
|
1484
|
+
# of the network site or the status of the order.
|
1485
|
+
#
|
1486
|
+
# If you specify multiple filters, filters are joined with an OR, and
|
1487
|
+
# the request returns results that match all of the specified filters.
|
1488
|
+
#
|
1489
|
+
# @option params [Hash<String,Array>] :filters
|
1490
|
+
# The filters.
|
1491
|
+
#
|
1492
|
+
# * `NETWORK_SITE` - The Amazon Resource Name (ARN) of the network site.
|
1493
|
+
#
|
1494
|
+
# * `STATUS` - The status (`ACKNOWLEDGING` \| `ACKNOWLEDGED` \|
|
1495
|
+
# `UNACKNOWLEDGED`).
|
1496
|
+
#
|
1497
|
+
# Filter values are case sensitive. If you specify multiple values for a
|
1498
|
+
# filter, the values are joined with an `OR`, and the request returns
|
1499
|
+
# all results that match any of the specified values.
|
1500
|
+
#
|
1501
|
+
# @option params [Integer] :max_results
|
1502
|
+
# The maximum number of results to return.
|
1503
|
+
#
|
1504
|
+
# @option params [required, String] :network_arn
|
1505
|
+
# The Amazon Resource Name (ARN) of the network.
|
1506
|
+
#
|
1507
|
+
# @option params [String] :start_token
|
1508
|
+
# The token for the next page of results.
|
1509
|
+
#
|
1510
|
+
# @return [Types::ListOrdersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1511
|
+
#
|
1512
|
+
# * {Types::ListOrdersResponse#next_token #next_token} => String
|
1513
|
+
# * {Types::ListOrdersResponse#orders #orders} => Array<Types::Order>
|
1514
|
+
#
|
1515
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1516
|
+
#
|
1517
|
+
# @example Request syntax with placeholder values
|
1518
|
+
#
|
1519
|
+
# resp = client.list_orders({
|
1520
|
+
# filters: {
|
1521
|
+
# "STATUS" => ["String"],
|
1522
|
+
# },
|
1523
|
+
# max_results: 1,
|
1524
|
+
# network_arn: "Arn", # required
|
1525
|
+
# start_token: "PaginationToken",
|
1526
|
+
# })
|
1527
|
+
#
|
1528
|
+
# @example Response structure
|
1529
|
+
#
|
1530
|
+
# resp.next_token #=> String
|
1531
|
+
# resp.orders #=> Array
|
1532
|
+
# resp.orders[0].acknowledgment_status #=> String, one of "ACKNOWLEDGING", "ACKNOWLEDGED", "UNACKNOWLEDGED"
|
1533
|
+
# resp.orders[0].created_at #=> Time
|
1534
|
+
# resp.orders[0].network_arn #=> String
|
1535
|
+
# resp.orders[0].network_site_arn #=> String
|
1536
|
+
# resp.orders[0].order_arn #=> String
|
1537
|
+
# resp.orders[0].shipping_address.city #=> String
|
1538
|
+
# resp.orders[0].shipping_address.company #=> String
|
1539
|
+
# resp.orders[0].shipping_address.country #=> String
|
1540
|
+
# resp.orders[0].shipping_address.name #=> String
|
1541
|
+
# resp.orders[0].shipping_address.phone_number #=> String
|
1542
|
+
# resp.orders[0].shipping_address.postal_code #=> String
|
1543
|
+
# resp.orders[0].shipping_address.state_or_province #=> String
|
1544
|
+
# resp.orders[0].shipping_address.street1 #=> String
|
1545
|
+
# resp.orders[0].shipping_address.street2 #=> String
|
1546
|
+
# resp.orders[0].shipping_address.street3 #=> String
|
1547
|
+
# resp.orders[0].tracking_information #=> Array
|
1548
|
+
# resp.orders[0].tracking_information[0].tracking_number #=> String
|
1549
|
+
#
|
1550
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/privatenetworks-2021-12-03/ListOrders AWS API Documentation
|
1551
|
+
#
|
1552
|
+
# @overload list_orders(params = {})
|
1553
|
+
# @param [Hash] params ({})
|
1554
|
+
def list_orders(params = {}, options = {})
|
1555
|
+
req = build_request(:list_orders, params)
|
1556
|
+
req.send_request(options)
|
1557
|
+
end
|
1558
|
+
|
1559
|
+
# Lists the tags for the specified resource.
|
1560
|
+
#
|
1561
|
+
# @option params [required, String] :resource_arn
|
1562
|
+
# The Amazon Resource Name (ARN) of the resource.
|
1563
|
+
#
|
1564
|
+
# @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1565
|
+
#
|
1566
|
+
# * {Types::ListTagsForResourceResponse#tags #tags} => Hash<String,String>
|
1567
|
+
#
|
1568
|
+
# @example Request syntax with placeholder values
|
1569
|
+
#
|
1570
|
+
# resp = client.list_tags_for_resource({
|
1571
|
+
# resource_arn: "Arn", # required
|
1572
|
+
# })
|
1573
|
+
#
|
1574
|
+
# @example Response structure
|
1575
|
+
#
|
1576
|
+
# resp.tags #=> Hash
|
1577
|
+
# resp.tags["TagKey"] #=> String
|
1578
|
+
#
|
1579
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/privatenetworks-2021-12-03/ListTagsForResource AWS API Documentation
|
1580
|
+
#
|
1581
|
+
# @overload list_tags_for_resource(params = {})
|
1582
|
+
# @param [Hash] params ({})
|
1583
|
+
def list_tags_for_resource(params = {}, options = {})
|
1584
|
+
req = build_request(:list_tags_for_resource, params)
|
1585
|
+
req.send_request(options)
|
1586
|
+
end
|
1587
|
+
|
1588
|
+
# Checks the health of the service.
|
1589
|
+
#
|
1590
|
+
# @return [Types::PingResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1591
|
+
#
|
1592
|
+
# * {Types::PingResponse#status #status} => String
|
1593
|
+
#
|
1594
|
+
# @example Response structure
|
1595
|
+
#
|
1596
|
+
# resp.status #=> String
|
1597
|
+
#
|
1598
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/privatenetworks-2021-12-03/Ping AWS API Documentation
|
1599
|
+
#
|
1600
|
+
# @overload ping(params = {})
|
1601
|
+
# @param [Hash] params ({})
|
1602
|
+
def ping(params = {}, options = {})
|
1603
|
+
req = build_request(:ping, params)
|
1604
|
+
req.send_request(options)
|
1605
|
+
end
|
1606
|
+
|
1607
|
+
# Adds tags to the specified resource.
|
1608
|
+
#
|
1609
|
+
# @option params [required, String] :resource_arn
|
1610
|
+
# The Amazon Resource Name (ARN) of the resource.
|
1611
|
+
#
|
1612
|
+
# @option params [required, Hash<String,String>] :tags
|
1613
|
+
# The tags to add to the resource.
|
1614
|
+
#
|
1615
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1616
|
+
#
|
1617
|
+
# @example Request syntax with placeholder values
|
1618
|
+
#
|
1619
|
+
# resp = client.tag_resource({
|
1620
|
+
# resource_arn: "Arn", # required
|
1621
|
+
# tags: { # required
|
1622
|
+
# "TagKey" => "TagValue",
|
1623
|
+
# },
|
1624
|
+
# })
|
1625
|
+
#
|
1626
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/privatenetworks-2021-12-03/TagResource AWS API Documentation
|
1627
|
+
#
|
1628
|
+
# @overload tag_resource(params = {})
|
1629
|
+
# @param [Hash] params ({})
|
1630
|
+
def tag_resource(params = {}, options = {})
|
1631
|
+
req = build_request(:tag_resource, params)
|
1632
|
+
req.send_request(options)
|
1633
|
+
end
|
1634
|
+
|
1635
|
+
# Removes tags from the specified resource.
|
1636
|
+
#
|
1637
|
+
# @option params [required, String] :resource_arn
|
1638
|
+
# The Amazon Resource Name (ARN) of the resource.
|
1639
|
+
#
|
1640
|
+
# @option params [required, Array<String>] :tag_keys
|
1641
|
+
# The tag keys.
|
1642
|
+
#
|
1643
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1644
|
+
#
|
1645
|
+
# @example Request syntax with placeholder values
|
1646
|
+
#
|
1647
|
+
# resp = client.untag_resource({
|
1648
|
+
# resource_arn: "Arn", # required
|
1649
|
+
# tag_keys: ["TagKey"], # required
|
1650
|
+
# })
|
1651
|
+
#
|
1652
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/privatenetworks-2021-12-03/UntagResource AWS API Documentation
|
1653
|
+
#
|
1654
|
+
# @overload untag_resource(params = {})
|
1655
|
+
# @param [Hash] params ({})
|
1656
|
+
def untag_resource(params = {}, options = {})
|
1657
|
+
req = build_request(:untag_resource, params)
|
1658
|
+
req.send_request(options)
|
1659
|
+
end
|
1660
|
+
|
1661
|
+
# Updates the specified network site.
|
1662
|
+
#
|
1663
|
+
# @option params [String] :client_token
|
1664
|
+
# Unique, case-sensitive identifier that you provide to ensure the
|
1665
|
+
# idempotency of the request. For more information, see [How to ensure
|
1666
|
+
# idempotency][1].
|
1667
|
+
#
|
1668
|
+
#
|
1669
|
+
#
|
1670
|
+
# [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Run_Instance_Idempotency.html
|
1671
|
+
#
|
1672
|
+
# @option params [String] :description
|
1673
|
+
# The description.
|
1674
|
+
#
|
1675
|
+
# @option params [required, String] :network_site_arn
|
1676
|
+
# The Amazon Resource Name (ARN) of the network site.
|
1677
|
+
#
|
1678
|
+
# @return [Types::UpdateNetworkSiteResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1679
|
+
#
|
1680
|
+
# * {Types::UpdateNetworkSiteResponse#network_site #network_site} => Types::NetworkSite
|
1681
|
+
# * {Types::UpdateNetworkSiteResponse#tags #tags} => Hash<String,String>
|
1682
|
+
#
|
1683
|
+
# @example Request syntax with placeholder values
|
1684
|
+
#
|
1685
|
+
# resp = client.update_network_site({
|
1686
|
+
# client_token: "ClientToken",
|
1687
|
+
# description: "Description",
|
1688
|
+
# network_site_arn: "Arn", # required
|
1689
|
+
# })
|
1690
|
+
#
|
1691
|
+
# @example Response structure
|
1692
|
+
#
|
1693
|
+
# resp.network_site.availability_zone #=> String
|
1694
|
+
# resp.network_site.availability_zone_id #=> String
|
1695
|
+
# resp.network_site.created_at #=> Time
|
1696
|
+
# resp.network_site.current_plan.options #=> Array
|
1697
|
+
# resp.network_site.current_plan.options[0].name #=> String
|
1698
|
+
# resp.network_site.current_plan.options[0].value #=> String
|
1699
|
+
# resp.network_site.current_plan.resource_definitions #=> Array
|
1700
|
+
# resp.network_site.current_plan.resource_definitions[0].count #=> Integer
|
1701
|
+
# resp.network_site.current_plan.resource_definitions[0].options #=> Array
|
1702
|
+
# resp.network_site.current_plan.resource_definitions[0].options[0].name #=> String
|
1703
|
+
# resp.network_site.current_plan.resource_definitions[0].options[0].value #=> String
|
1704
|
+
# resp.network_site.current_plan.resource_definitions[0].type #=> String, one of "RADIO_UNIT", "DEVICE_IDENTIFIER"
|
1705
|
+
# resp.network_site.description #=> String
|
1706
|
+
# resp.network_site.network_arn #=> String
|
1707
|
+
# resp.network_site.network_site_arn #=> String
|
1708
|
+
# resp.network_site.network_site_name #=> String
|
1709
|
+
# resp.network_site.pending_plan.options #=> Array
|
1710
|
+
# resp.network_site.pending_plan.options[0].name #=> String
|
1711
|
+
# resp.network_site.pending_plan.options[0].value #=> String
|
1712
|
+
# resp.network_site.pending_plan.resource_definitions #=> Array
|
1713
|
+
# resp.network_site.pending_plan.resource_definitions[0].count #=> Integer
|
1714
|
+
# resp.network_site.pending_plan.resource_definitions[0].options #=> Array
|
1715
|
+
# resp.network_site.pending_plan.resource_definitions[0].options[0].name #=> String
|
1716
|
+
# resp.network_site.pending_plan.resource_definitions[0].options[0].value #=> String
|
1717
|
+
# resp.network_site.pending_plan.resource_definitions[0].type #=> String, one of "RADIO_UNIT", "DEVICE_IDENTIFIER"
|
1718
|
+
# resp.network_site.status #=> String, one of "CREATED", "PROVISIONING", "AVAILABLE", "DEPROVISIONING", "DELETED"
|
1719
|
+
# resp.network_site.status_reason #=> String
|
1720
|
+
# resp.tags #=> Hash
|
1721
|
+
# resp.tags["TagKey"] #=> String
|
1722
|
+
#
|
1723
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/privatenetworks-2021-12-03/UpdateNetworkSite AWS API Documentation
|
1724
|
+
#
|
1725
|
+
# @overload update_network_site(params = {})
|
1726
|
+
# @param [Hash] params ({})
|
1727
|
+
def update_network_site(params = {}, options = {})
|
1728
|
+
req = build_request(:update_network_site, params)
|
1729
|
+
req.send_request(options)
|
1730
|
+
end
|
1731
|
+
|
1732
|
+
# Updates the specified network site plan.
|
1733
|
+
#
|
1734
|
+
# @option params [String] :client_token
|
1735
|
+
# Unique, case-sensitive identifier that you provide to ensure the
|
1736
|
+
# idempotency of the request. For more information, see [How to ensure
|
1737
|
+
# idempotency][1].
|
1738
|
+
#
|
1739
|
+
#
|
1740
|
+
#
|
1741
|
+
# [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Run_Instance_Idempotency.html
|
1742
|
+
#
|
1743
|
+
# @option params [required, String] :network_site_arn
|
1744
|
+
# The Amazon Resource Name (ARN) of the network site.
|
1745
|
+
#
|
1746
|
+
# @option params [required, Types::SitePlan] :pending_plan
|
1747
|
+
# The pending plan.
|
1748
|
+
#
|
1749
|
+
# @return [Types::UpdateNetworkSiteResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1750
|
+
#
|
1751
|
+
# * {Types::UpdateNetworkSiteResponse#network_site #network_site} => Types::NetworkSite
|
1752
|
+
# * {Types::UpdateNetworkSiteResponse#tags #tags} => Hash<String,String>
|
1753
|
+
#
|
1754
|
+
# @example Request syntax with placeholder values
|
1755
|
+
#
|
1756
|
+
# resp = client.update_network_site_plan({
|
1757
|
+
# client_token: "ClientToken",
|
1758
|
+
# network_site_arn: "Arn", # required
|
1759
|
+
# pending_plan: { # required
|
1760
|
+
# options: [
|
1761
|
+
# {
|
1762
|
+
# name: "String", # required
|
1763
|
+
# value: "String",
|
1764
|
+
# },
|
1765
|
+
# ],
|
1766
|
+
# resource_definitions: [
|
1767
|
+
# {
|
1768
|
+
# count: 1, # required
|
1769
|
+
# options: [
|
1770
|
+
# {
|
1771
|
+
# name: "String", # required
|
1772
|
+
# value: "String",
|
1773
|
+
# },
|
1774
|
+
# ],
|
1775
|
+
# type: "RADIO_UNIT", # required, accepts RADIO_UNIT, DEVICE_IDENTIFIER
|
1776
|
+
# },
|
1777
|
+
# ],
|
1778
|
+
# },
|
1779
|
+
# })
|
1780
|
+
#
|
1781
|
+
# @example Response structure
|
1782
|
+
#
|
1783
|
+
# resp.network_site.availability_zone #=> String
|
1784
|
+
# resp.network_site.availability_zone_id #=> String
|
1785
|
+
# resp.network_site.created_at #=> Time
|
1786
|
+
# resp.network_site.current_plan.options #=> Array
|
1787
|
+
# resp.network_site.current_plan.options[0].name #=> String
|
1788
|
+
# resp.network_site.current_plan.options[0].value #=> String
|
1789
|
+
# resp.network_site.current_plan.resource_definitions #=> Array
|
1790
|
+
# resp.network_site.current_plan.resource_definitions[0].count #=> Integer
|
1791
|
+
# resp.network_site.current_plan.resource_definitions[0].options #=> Array
|
1792
|
+
# resp.network_site.current_plan.resource_definitions[0].options[0].name #=> String
|
1793
|
+
# resp.network_site.current_plan.resource_definitions[0].options[0].value #=> String
|
1794
|
+
# resp.network_site.current_plan.resource_definitions[0].type #=> String, one of "RADIO_UNIT", "DEVICE_IDENTIFIER"
|
1795
|
+
# resp.network_site.description #=> String
|
1796
|
+
# resp.network_site.network_arn #=> String
|
1797
|
+
# resp.network_site.network_site_arn #=> String
|
1798
|
+
# resp.network_site.network_site_name #=> String
|
1799
|
+
# resp.network_site.pending_plan.options #=> Array
|
1800
|
+
# resp.network_site.pending_plan.options[0].name #=> String
|
1801
|
+
# resp.network_site.pending_plan.options[0].value #=> String
|
1802
|
+
# resp.network_site.pending_plan.resource_definitions #=> Array
|
1803
|
+
# resp.network_site.pending_plan.resource_definitions[0].count #=> Integer
|
1804
|
+
# resp.network_site.pending_plan.resource_definitions[0].options #=> Array
|
1805
|
+
# resp.network_site.pending_plan.resource_definitions[0].options[0].name #=> String
|
1806
|
+
# resp.network_site.pending_plan.resource_definitions[0].options[0].value #=> String
|
1807
|
+
# resp.network_site.pending_plan.resource_definitions[0].type #=> String, one of "RADIO_UNIT", "DEVICE_IDENTIFIER"
|
1808
|
+
# resp.network_site.status #=> String, one of "CREATED", "PROVISIONING", "AVAILABLE", "DEPROVISIONING", "DELETED"
|
1809
|
+
# resp.network_site.status_reason #=> String
|
1810
|
+
# resp.tags #=> Hash
|
1811
|
+
# resp.tags["TagKey"] #=> String
|
1812
|
+
#
|
1813
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/privatenetworks-2021-12-03/UpdateNetworkSitePlan AWS API Documentation
|
1814
|
+
#
|
1815
|
+
# @overload update_network_site_plan(params = {})
|
1816
|
+
# @param [Hash] params ({})
|
1817
|
+
def update_network_site_plan(params = {}, options = {})
|
1818
|
+
req = build_request(:update_network_site_plan, params)
|
1819
|
+
req.send_request(options)
|
1820
|
+
end
|
1821
|
+
|
1822
|
+
# @!endgroup
|
1823
|
+
|
1824
|
+
# @param params ({})
|
1825
|
+
# @api private
|
1826
|
+
def build_request(operation_name, params = {})
|
1827
|
+
handlers = @handlers.for(operation_name)
|
1828
|
+
context = Seahorse::Client::RequestContext.new(
|
1829
|
+
operation_name: operation_name,
|
1830
|
+
operation: config.api.operation(operation_name),
|
1831
|
+
client: self,
|
1832
|
+
params: params,
|
1833
|
+
config: config)
|
1834
|
+
context[:gem_name] = 'aws-sdk-privatenetworks'
|
1835
|
+
context[:gem_version] = '1.0.0'
|
1836
|
+
Seahorse::Client::Request.new(handlers, context)
|
1837
|
+
end
|
1838
|
+
|
1839
|
+
# @api private
|
1840
|
+
# @deprecated
|
1841
|
+
def waiter_names
|
1842
|
+
[]
|
1843
|
+
end
|
1844
|
+
|
1845
|
+
class << self
|
1846
|
+
|
1847
|
+
# @api private
|
1848
|
+
attr_reader :identifier
|
1849
|
+
|
1850
|
+
# @api private
|
1851
|
+
def errors_module
|
1852
|
+
Errors
|
1853
|
+
end
|
1854
|
+
|
1855
|
+
end
|
1856
|
+
end
|
1857
|
+
end
|