aws-sdk-tnb 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-tnb/client.rb +1973 -0
- data/lib/aws-sdk-tnb/client_api.rb +1172 -0
- data/lib/aws-sdk-tnb/customizations.rb +0 -0
- data/lib/aws-sdk-tnb/endpoint_parameters.rb +66 -0
- data/lib/aws-sdk-tnb/endpoint_provider.rb +54 -0
- data/lib/aws-sdk-tnb/endpoints.rb +477 -0
- data/lib/aws-sdk-tnb/errors.rb +134 -0
- data/lib/aws-sdk-tnb/plugins/endpoints.rb +134 -0
- data/lib/aws-sdk-tnb/resource.rb +26 -0
- data/lib/aws-sdk-tnb/types.rb +2397 -0
- data/lib/aws-sdk-tnb.rb +57 -0
- metadata +94 -0
@@ -0,0 +1,1973 @@
|
|
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/sign.rb'
|
34
|
+
require 'aws-sdk-core/plugins/protocols/rest_json.rb'
|
35
|
+
|
36
|
+
Aws::Plugins::GlobalConfiguration.add_identifier(:tnb)
|
37
|
+
|
38
|
+
module Aws::Tnb
|
39
|
+
# An API client for Tnb. To construct a client, you need to configure a `:region` and `:credentials`.
|
40
|
+
#
|
41
|
+
# client = Aws::Tnb::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 = :tnb
|
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::Sign)
|
83
|
+
add_plugin(Aws::Plugins::Protocols::RestJson)
|
84
|
+
add_plugin(Aws::Tnb::Plugins::Endpoints)
|
85
|
+
|
86
|
+
# @overload initialize(options)
|
87
|
+
# @param [Hash] options
|
88
|
+
# @option options [required, Aws::CredentialProvider] :credentials
|
89
|
+
# Your AWS credentials. This can be an instance of any one of the
|
90
|
+
# following classes:
|
91
|
+
#
|
92
|
+
# * `Aws::Credentials` - Used for configuring static, non-refreshing
|
93
|
+
# credentials.
|
94
|
+
#
|
95
|
+
# * `Aws::SharedCredentials` - Used for loading static credentials from a
|
96
|
+
# shared file, such as `~/.aws/config`.
|
97
|
+
#
|
98
|
+
# * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
|
99
|
+
#
|
100
|
+
# * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to
|
101
|
+
# assume a role after providing credentials via the web.
|
102
|
+
#
|
103
|
+
# * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an
|
104
|
+
# access token generated from `aws login`.
|
105
|
+
#
|
106
|
+
# * `Aws::ProcessCredentials` - Used for loading credentials from a
|
107
|
+
# process that outputs to stdout.
|
108
|
+
#
|
109
|
+
# * `Aws::InstanceProfileCredentials` - Used for loading credentials
|
110
|
+
# from an EC2 IMDS on an EC2 instance.
|
111
|
+
#
|
112
|
+
# * `Aws::ECSCredentials` - Used for loading credentials from
|
113
|
+
# instances running in ECS.
|
114
|
+
#
|
115
|
+
# * `Aws::CognitoIdentityCredentials` - Used for loading credentials
|
116
|
+
# from the Cognito Identity service.
|
117
|
+
#
|
118
|
+
# When `:credentials` are not configured directly, the following
|
119
|
+
# locations will be searched for credentials:
|
120
|
+
#
|
121
|
+
# * `Aws.config[:credentials]`
|
122
|
+
# * The `:access_key_id`, `:secret_access_key`, and `:session_token` options.
|
123
|
+
# * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
|
124
|
+
# * `~/.aws/credentials`
|
125
|
+
# * `~/.aws/config`
|
126
|
+
# * EC2/ECS IMDS instance profile - When used by default, the timeouts
|
127
|
+
# are very aggressive. Construct and pass an instance of
|
128
|
+
# `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
|
129
|
+
# enable retries and extended timeouts. Instance profile credential
|
130
|
+
# fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED']
|
131
|
+
# to true.
|
132
|
+
#
|
133
|
+
# @option options [required, String] :region
|
134
|
+
# The AWS region to connect to. The configured `:region` is
|
135
|
+
# used to determine the service `:endpoint`. When not passed,
|
136
|
+
# a default `:region` is searched for in the following locations:
|
137
|
+
#
|
138
|
+
# * `Aws.config[:region]`
|
139
|
+
# * `ENV['AWS_REGION']`
|
140
|
+
# * `ENV['AMAZON_REGION']`
|
141
|
+
# * `ENV['AWS_DEFAULT_REGION']`
|
142
|
+
# * `~/.aws/credentials`
|
143
|
+
# * `~/.aws/config`
|
144
|
+
#
|
145
|
+
# @option options [String] :access_key_id
|
146
|
+
#
|
147
|
+
# @option options [Boolean] :active_endpoint_cache (false)
|
148
|
+
# When set to `true`, a thread polling for endpoints will be running in
|
149
|
+
# the background every 60 secs (default). Defaults to `false`.
|
150
|
+
#
|
151
|
+
# @option options [Boolean] :adaptive_retry_wait_to_fill (true)
|
152
|
+
# Used only in `adaptive` retry mode. When true, the request will sleep
|
153
|
+
# until there is sufficent client side capacity to retry the request.
|
154
|
+
# When false, the request will raise a `RetryCapacityNotAvailableError` and will
|
155
|
+
# not retry instead of sleeping.
|
156
|
+
#
|
157
|
+
# @option options [Boolean] :client_side_monitoring (false)
|
158
|
+
# When `true`, client-side metrics will be collected for all API requests from
|
159
|
+
# this client.
|
160
|
+
#
|
161
|
+
# @option options [String] :client_side_monitoring_client_id ("")
|
162
|
+
# Allows you to provide an identifier for this client which will be attached to
|
163
|
+
# all generated client side metrics. Defaults to an empty string.
|
164
|
+
#
|
165
|
+
# @option options [String] :client_side_monitoring_host ("127.0.0.1")
|
166
|
+
# Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client
|
167
|
+
# side monitoring agent is running on, where client metrics will be published via UDP.
|
168
|
+
#
|
169
|
+
# @option options [Integer] :client_side_monitoring_port (31000)
|
170
|
+
# Required for publishing client metrics. The port that the client side monitoring
|
171
|
+
# agent is running on, where client metrics will be published via UDP.
|
172
|
+
#
|
173
|
+
# @option options [Aws::ClientSideMonitoring::Publisher] :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher)
|
174
|
+
# Allows you to provide a custom client-side monitoring publisher class. By default,
|
175
|
+
# will use the Client Side Monitoring Agent Publisher.
|
176
|
+
#
|
177
|
+
# @option options [Boolean] :convert_params (true)
|
178
|
+
# When `true`, an attempt is made to coerce request parameters into
|
179
|
+
# the required types.
|
180
|
+
#
|
181
|
+
# @option options [Boolean] :correct_clock_skew (true)
|
182
|
+
# Used only in `standard` and adaptive retry modes. Specifies whether to apply
|
183
|
+
# a clock skew correction and retry requests with skewed client clocks.
|
184
|
+
#
|
185
|
+
# @option options [String] :defaults_mode ("legacy")
|
186
|
+
# See {Aws::DefaultsModeConfiguration} for a list of the
|
187
|
+
# accepted modes and the configuration defaults that are included.
|
188
|
+
#
|
189
|
+
# @option options [Boolean] :disable_host_prefix_injection (false)
|
190
|
+
# Set to true to disable SDK automatically adding host prefix
|
191
|
+
# to default service endpoint when available.
|
192
|
+
#
|
193
|
+
# @option options [String] :endpoint
|
194
|
+
# The client endpoint is normally constructed from the `:region`
|
195
|
+
# option. You should only configure an `:endpoint` when connecting
|
196
|
+
# to test or custom endpoints. This should be a valid HTTP(S) URI.
|
197
|
+
#
|
198
|
+
# @option options [Integer] :endpoint_cache_max_entries (1000)
|
199
|
+
# Used for the maximum size limit of the LRU cache storing endpoints data
|
200
|
+
# for endpoint discovery enabled operations. Defaults to 1000.
|
201
|
+
#
|
202
|
+
# @option options [Integer] :endpoint_cache_max_threads (10)
|
203
|
+
# Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.
|
204
|
+
#
|
205
|
+
# @option options [Integer] :endpoint_cache_poll_interval (60)
|
206
|
+
# When :endpoint_discovery and :active_endpoint_cache is enabled,
|
207
|
+
# Use this option to config the time interval in seconds for making
|
208
|
+
# requests fetching endpoints information. Defaults to 60 sec.
|
209
|
+
#
|
210
|
+
# @option options [Boolean] :endpoint_discovery (false)
|
211
|
+
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
212
|
+
#
|
213
|
+
# @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
|
214
|
+
# The log formatter.
|
215
|
+
#
|
216
|
+
# @option options [Symbol] :log_level (:info)
|
217
|
+
# The log level to send messages to the `:logger` at.
|
218
|
+
#
|
219
|
+
# @option options [Logger] :logger
|
220
|
+
# The Logger instance to send log messages to. If this option
|
221
|
+
# is not set, logging will be disabled.
|
222
|
+
#
|
223
|
+
# @option options [Integer] :max_attempts (3)
|
224
|
+
# An integer representing the maximum number attempts that will be made for
|
225
|
+
# a single request, including the initial attempt. For example,
|
226
|
+
# setting this value to 5 will result in a request being retried up to
|
227
|
+
# 4 times. Used in `standard` and `adaptive` retry modes.
|
228
|
+
#
|
229
|
+
# @option options [String] :profile ("default")
|
230
|
+
# Used when loading credentials from the shared credentials file
|
231
|
+
# at HOME/.aws/credentials. When not specified, 'default' is used.
|
232
|
+
#
|
233
|
+
# @option options [Proc] :retry_backoff
|
234
|
+
# A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
|
235
|
+
# This option is only used in the `legacy` retry mode.
|
236
|
+
#
|
237
|
+
# @option options [Float] :retry_base_delay (0.3)
|
238
|
+
# The base delay in seconds used by the default backoff function. This option
|
239
|
+
# is only used in the `legacy` retry mode.
|
240
|
+
#
|
241
|
+
# @option options [Symbol] :retry_jitter (:none)
|
242
|
+
# A delay randomiser function used by the default backoff function.
|
243
|
+
# Some predefined functions can be referenced by name - :none, :equal, :full,
|
244
|
+
# otherwise a Proc that takes and returns a number. This option is only used
|
245
|
+
# in the `legacy` retry mode.
|
246
|
+
#
|
247
|
+
# @see https://www.awsarchitectureblog.com/2015/03/backoff.html
|
248
|
+
#
|
249
|
+
# @option options [Integer] :retry_limit (3)
|
250
|
+
# The maximum number of times to retry failed requests. Only
|
251
|
+
# ~ 500 level server errors and certain ~ 400 level client errors
|
252
|
+
# are retried. Generally, these are throttling errors, data
|
253
|
+
# checksum errors, networking errors, timeout errors, auth errors,
|
254
|
+
# endpoint discovery, and errors from expired credentials.
|
255
|
+
# This option is only used in the `legacy` retry mode.
|
256
|
+
#
|
257
|
+
# @option options [Integer] :retry_max_delay (0)
|
258
|
+
# The maximum number of seconds to delay between retries (0 for no limit)
|
259
|
+
# used by the default backoff function. This option is only used in the
|
260
|
+
# `legacy` retry mode.
|
261
|
+
#
|
262
|
+
# @option options [String] :retry_mode ("legacy")
|
263
|
+
# Specifies which retry algorithm to use. Values are:
|
264
|
+
#
|
265
|
+
# * `legacy` - The pre-existing retry behavior. This is default value if
|
266
|
+
# no retry mode is provided.
|
267
|
+
#
|
268
|
+
# * `standard` - A standardized set of retry rules across the AWS SDKs.
|
269
|
+
# This includes support for retry quotas, which limit the number of
|
270
|
+
# unsuccessful retries a client can make.
|
271
|
+
#
|
272
|
+
# * `adaptive` - An experimental retry mode that includes all the
|
273
|
+
# functionality of `standard` mode along with automatic client side
|
274
|
+
# throttling. This is a provisional mode that may change behavior
|
275
|
+
# in the future.
|
276
|
+
#
|
277
|
+
#
|
278
|
+
# @option options [String] :secret_access_key
|
279
|
+
#
|
280
|
+
# @option options [String] :session_token
|
281
|
+
#
|
282
|
+
# @option options [Boolean] :stub_responses (false)
|
283
|
+
# Causes the client to return stubbed responses. By default
|
284
|
+
# fake responses are generated and returned. You can specify
|
285
|
+
# the response data to return or errors to raise by calling
|
286
|
+
# {ClientStubs#stub_responses}. See {ClientStubs} for more information.
|
287
|
+
#
|
288
|
+
# ** Please note ** When response stubbing is enabled, no HTTP
|
289
|
+
# requests are made, and retries are disabled.
|
290
|
+
#
|
291
|
+
# @option options [Aws::TokenProvider] :token_provider
|
292
|
+
# A Bearer Token Provider. This can be an instance of any one of the
|
293
|
+
# following classes:
|
294
|
+
#
|
295
|
+
# * `Aws::StaticTokenProvider` - Used for configuring static, non-refreshing
|
296
|
+
# tokens.
|
297
|
+
#
|
298
|
+
# * `Aws::SSOTokenProvider` - Used for loading tokens from AWS SSO using an
|
299
|
+
# access token generated from `aws login`.
|
300
|
+
#
|
301
|
+
# When `:token_provider` is not configured directly, the `Aws::TokenProviderChain`
|
302
|
+
# will be used to search for tokens configured for your profile in shared configuration files.
|
303
|
+
#
|
304
|
+
# @option options [Boolean] :use_dualstack_endpoint
|
305
|
+
# When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
|
306
|
+
# will be used if available.
|
307
|
+
#
|
308
|
+
# @option options [Boolean] :use_fips_endpoint
|
309
|
+
# When set to `true`, fips compatible endpoints will be used if available.
|
310
|
+
# When a `fips` region is used, the region is normalized and this config
|
311
|
+
# is set to `true`.
|
312
|
+
#
|
313
|
+
# @option options [Boolean] :validate_params (true)
|
314
|
+
# When `true`, request parameters are validated before
|
315
|
+
# sending the request.
|
316
|
+
#
|
317
|
+
# @option options [Aws::Tnb::EndpointProvider] :endpoint_provider
|
318
|
+
# The endpoint provider used to resolve endpoints. Any object that responds to `#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::Tnb::EndpointParameters`
|
319
|
+
#
|
320
|
+
# @option options [URI::HTTP,String] :http_proxy A proxy to send
|
321
|
+
# requests through. Formatted like 'http://proxy.com:123'.
|
322
|
+
#
|
323
|
+
# @option options [Float] :http_open_timeout (15) The number of
|
324
|
+
# seconds to wait when opening a HTTP session before raising a
|
325
|
+
# `Timeout::Error`.
|
326
|
+
#
|
327
|
+
# @option options [Float] :http_read_timeout (60) The default
|
328
|
+
# number of seconds to wait for response data. This value can
|
329
|
+
# safely be set per-request on the session.
|
330
|
+
#
|
331
|
+
# @option options [Float] :http_idle_timeout (5) The number of
|
332
|
+
# seconds a connection is allowed to sit idle before it is
|
333
|
+
# considered stale. Stale connections are closed and removed
|
334
|
+
# from the pool before making a request.
|
335
|
+
#
|
336
|
+
# @option options [Float] :http_continue_timeout (1) The number of
|
337
|
+
# seconds to wait for a 100-continue response before sending the
|
338
|
+
# request body. This option has no effect unless the request has
|
339
|
+
# "Expect" header set to "100-continue". Defaults to `nil` which
|
340
|
+
# disables this behaviour. This value can safely be set per
|
341
|
+
# request on the session.
|
342
|
+
#
|
343
|
+
# @option options [Float] :ssl_timeout (nil) Sets the SSL timeout
|
344
|
+
# in seconds.
|
345
|
+
#
|
346
|
+
# @option options [Boolean] :http_wire_trace (false) When `true`,
|
347
|
+
# HTTP debug output will be sent to the `:logger`.
|
348
|
+
#
|
349
|
+
# @option options [Boolean] :ssl_verify_peer (true) When `true`,
|
350
|
+
# SSL peer certificates are verified when establishing a
|
351
|
+
# connection.
|
352
|
+
#
|
353
|
+
# @option options [String] :ssl_ca_bundle Full path to the SSL
|
354
|
+
# certificate authority bundle file that should be used when
|
355
|
+
# verifying peer certificates. If you do not pass
|
356
|
+
# `:ssl_ca_bundle` or `:ssl_ca_directory` the the system default
|
357
|
+
# will be used if available.
|
358
|
+
#
|
359
|
+
# @option options [String] :ssl_ca_directory Full path of the
|
360
|
+
# directory that contains the unbundled SSL certificate
|
361
|
+
# authority files for verifying peer certificates. If you do
|
362
|
+
# not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the
|
363
|
+
# system default will be used if available.
|
364
|
+
#
|
365
|
+
def initialize(*args)
|
366
|
+
super
|
367
|
+
end
|
368
|
+
|
369
|
+
# @!group API Operations
|
370
|
+
|
371
|
+
# Cancels a network operation.
|
372
|
+
#
|
373
|
+
# A network operation is any operation that is done to your network,
|
374
|
+
# such as network instance instantiation or termination.
|
375
|
+
#
|
376
|
+
# @option params [required, String] :ns_lcm_op_occ_id
|
377
|
+
# The ID of a network operation occurrence.
|
378
|
+
#
|
379
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
380
|
+
#
|
381
|
+
# @example Request syntax with placeholder values
|
382
|
+
#
|
383
|
+
# resp = client.cancel_sol_network_operation({
|
384
|
+
# ns_lcm_op_occ_id: "NsLcmOpOccId", # required
|
385
|
+
# })
|
386
|
+
#
|
387
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/tnb-2008-10-21/CancelSolNetworkOperation AWS API Documentation
|
388
|
+
#
|
389
|
+
# @overload cancel_sol_network_operation(params = {})
|
390
|
+
# @param [Hash] params ({})
|
391
|
+
def cancel_sol_network_operation(params = {}, options = {})
|
392
|
+
req = build_request(:cancel_sol_network_operation, params)
|
393
|
+
req.send_request(options)
|
394
|
+
end
|
395
|
+
|
396
|
+
# Creates a function package.
|
397
|
+
#
|
398
|
+
# A function package is a .zip file in CSAR (Cloud Service Archive)
|
399
|
+
# format that contains a network function (an ETSI standard
|
400
|
+
# telecommunication application) and function package descriptor that
|
401
|
+
# uses the TOSCA standard to describe how the network functions should
|
402
|
+
# run on your network. For more information, see [Function packages][1]
|
403
|
+
# in the *Amazon Web Services Telco Network Builder User Guide*.
|
404
|
+
#
|
405
|
+
# Creating a function package is the first step for creating a network
|
406
|
+
# in AWS TNB. This request creates an empty container with an ID. The
|
407
|
+
# next step is to upload the actual CSAR zip file into that empty
|
408
|
+
# container. To upload function package content, see
|
409
|
+
# [PutSolFunctionPackageContent][2].
|
410
|
+
#
|
411
|
+
#
|
412
|
+
#
|
413
|
+
# [1]: https://docs.aws.amazon.com/tnb/latest/ug/function-packages.html
|
414
|
+
# [2]: https://docs.aws.amazon.com/TNB/latest/APIReference/API_PutSolFunctionPackageContent.html
|
415
|
+
#
|
416
|
+
# @option params [Hash<String,String>] :tags
|
417
|
+
# A tag is a label that you assign to an Amazon Web Services resource.
|
418
|
+
# Each tag consists of a key and an optional value. You can use tags to
|
419
|
+
# search and filter your resources or track your Amazon Web Services
|
420
|
+
# costs.
|
421
|
+
#
|
422
|
+
# @return [Types::CreateSolFunctionPackageOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
423
|
+
#
|
424
|
+
# * {Types::CreateSolFunctionPackageOutput#arn #arn} => String
|
425
|
+
# * {Types::CreateSolFunctionPackageOutput#id #id} => String
|
426
|
+
# * {Types::CreateSolFunctionPackageOutput#onboarding_state #onboarding_state} => String
|
427
|
+
# * {Types::CreateSolFunctionPackageOutput#operational_state #operational_state} => String
|
428
|
+
# * {Types::CreateSolFunctionPackageOutput#tags #tags} => Hash<String,String>
|
429
|
+
# * {Types::CreateSolFunctionPackageOutput#usage_state #usage_state} => String
|
430
|
+
#
|
431
|
+
# @example Request syntax with placeholder values
|
432
|
+
#
|
433
|
+
# resp = client.create_sol_function_package({
|
434
|
+
# tags: {
|
435
|
+
# "TagKey" => "TagValue",
|
436
|
+
# },
|
437
|
+
# })
|
438
|
+
#
|
439
|
+
# @example Response structure
|
440
|
+
#
|
441
|
+
# resp.arn #=> String
|
442
|
+
# resp.id #=> String
|
443
|
+
# resp.onboarding_state #=> String, one of "CREATED", "ONBOARDED", "ERROR"
|
444
|
+
# resp.operational_state #=> String, one of "ENABLED", "DISABLED"
|
445
|
+
# resp.tags #=> Hash
|
446
|
+
# resp.tags["TagKey"] #=> String
|
447
|
+
# resp.usage_state #=> String, one of "IN_USE", "NOT_IN_USE"
|
448
|
+
#
|
449
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/tnb-2008-10-21/CreateSolFunctionPackage AWS API Documentation
|
450
|
+
#
|
451
|
+
# @overload create_sol_function_package(params = {})
|
452
|
+
# @param [Hash] params ({})
|
453
|
+
def create_sol_function_package(params = {}, options = {})
|
454
|
+
req = build_request(:create_sol_function_package, params)
|
455
|
+
req.send_request(options)
|
456
|
+
end
|
457
|
+
|
458
|
+
# Creates a network instance.
|
459
|
+
#
|
460
|
+
# A network instance is a single network created in Amazon Web Services
|
461
|
+
# TNB that can be deployed and on which life-cycle operations (like
|
462
|
+
# terminate, update, and delete) can be performed. Creating a network
|
463
|
+
# instance is the third step after creating a network package. For more
|
464
|
+
# information about network instances, [Network instances][1] in the
|
465
|
+
# *Amazon Web Services Telco Network Builder User Guide*.
|
466
|
+
#
|
467
|
+
# Once you create a network instance, you can instantiate it. To
|
468
|
+
# instantiate a network, see [InstantiateSolNetworkInstance][2].
|
469
|
+
#
|
470
|
+
#
|
471
|
+
#
|
472
|
+
# [1]: https://docs.aws.amazon.com/tnb/latest/ug/network-instances.html
|
473
|
+
# [2]: https://docs.aws.amazon.com/TNB/latest/APIReference/API_InstantiateSolNetworkInstance.html
|
474
|
+
#
|
475
|
+
# @option params [String] :ns_description
|
476
|
+
# Network instance description.
|
477
|
+
#
|
478
|
+
# @option params [required, String] :ns_name
|
479
|
+
# Network instance name.
|
480
|
+
#
|
481
|
+
# @option params [required, String] :nsd_info_id
|
482
|
+
# ID for network service descriptor.
|
483
|
+
#
|
484
|
+
# @option params [Hash<String,String>] :tags
|
485
|
+
# A tag is a label that you assign to an Amazon Web Services resource.
|
486
|
+
# Each tag consists of a key and an optional value. You can use tags to
|
487
|
+
# search and filter your resources or track your Amazon Web Services
|
488
|
+
# costs.
|
489
|
+
#
|
490
|
+
# @return [Types::CreateSolNetworkInstanceOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
491
|
+
#
|
492
|
+
# * {Types::CreateSolNetworkInstanceOutput#arn #arn} => String
|
493
|
+
# * {Types::CreateSolNetworkInstanceOutput#id #id} => String
|
494
|
+
# * {Types::CreateSolNetworkInstanceOutput#ns_instance_name #ns_instance_name} => String
|
495
|
+
# * {Types::CreateSolNetworkInstanceOutput#nsd_info_id #nsd_info_id} => String
|
496
|
+
# * {Types::CreateSolNetworkInstanceOutput#tags #tags} => Hash<String,String>
|
497
|
+
#
|
498
|
+
# @example Request syntax with placeholder values
|
499
|
+
#
|
500
|
+
# resp = client.create_sol_network_instance({
|
501
|
+
# ns_description: "CreateSolNetworkInstanceInputNsDescriptionString",
|
502
|
+
# ns_name: "CreateSolNetworkInstanceInputNsNameString", # required
|
503
|
+
# nsd_info_id: "NsdInfoId", # required
|
504
|
+
# tags: {
|
505
|
+
# "TagKey" => "TagValue",
|
506
|
+
# },
|
507
|
+
# })
|
508
|
+
#
|
509
|
+
# @example Response structure
|
510
|
+
#
|
511
|
+
# resp.arn #=> String
|
512
|
+
# resp.id #=> String
|
513
|
+
# resp.ns_instance_name #=> String
|
514
|
+
# resp.nsd_info_id #=> String
|
515
|
+
# resp.tags #=> Hash
|
516
|
+
# resp.tags["TagKey"] #=> String
|
517
|
+
#
|
518
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/tnb-2008-10-21/CreateSolNetworkInstance AWS API Documentation
|
519
|
+
#
|
520
|
+
# @overload create_sol_network_instance(params = {})
|
521
|
+
# @param [Hash] params ({})
|
522
|
+
def create_sol_network_instance(params = {}, options = {})
|
523
|
+
req = build_request(:create_sol_network_instance, params)
|
524
|
+
req.send_request(options)
|
525
|
+
end
|
526
|
+
|
527
|
+
# Creates a network package.
|
528
|
+
#
|
529
|
+
# A network package is a .zip file in CSAR (Cloud Service Archive)
|
530
|
+
# format defines the function packages you want to deploy and the Amazon
|
531
|
+
# Web Services infrastructure you want to deploy them on. For more
|
532
|
+
# information, see [Network instances][1] in the *Amazon Web Services
|
533
|
+
# Telco Network Builder User Guide*.
|
534
|
+
#
|
535
|
+
# A network package consists of a network service descriptor (NSD) file
|
536
|
+
# (required) and any additional files (optional), such as scripts
|
537
|
+
# specific to your needs. For example, if you have multiple function
|
538
|
+
# packages in your network package, you can use the NSD to define which
|
539
|
+
# network functions should run in certain VPCs, subnets, or EKS
|
540
|
+
# clusters.
|
541
|
+
#
|
542
|
+
# This request creates an empty network package container with an ID.
|
543
|
+
# Once you create a network package, you can upload the network package
|
544
|
+
# content using [PutSolNetworkPackageContent][2].
|
545
|
+
#
|
546
|
+
#
|
547
|
+
#
|
548
|
+
# [1]: https://docs.aws.amazon.com/tnb/latest/ug/network-instances.html
|
549
|
+
# [2]: https://docs.aws.amazon.com/TNB/latest/APIReference/API_PutSolNetworkPackageContent.html
|
550
|
+
#
|
551
|
+
# @option params [Hash<String,String>] :tags
|
552
|
+
# A tag is a label that you assign to an Amazon Web Services resource.
|
553
|
+
# Each tag consists of a key and an optional value. You can use tags to
|
554
|
+
# search and filter your resources or track your Amazon Web Services
|
555
|
+
# costs.
|
556
|
+
#
|
557
|
+
# @return [Types::CreateSolNetworkPackageOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
558
|
+
#
|
559
|
+
# * {Types::CreateSolNetworkPackageOutput#arn #arn} => String
|
560
|
+
# * {Types::CreateSolNetworkPackageOutput#id #id} => String
|
561
|
+
# * {Types::CreateSolNetworkPackageOutput#nsd_onboarding_state #nsd_onboarding_state} => String
|
562
|
+
# * {Types::CreateSolNetworkPackageOutput#nsd_operational_state #nsd_operational_state} => String
|
563
|
+
# * {Types::CreateSolNetworkPackageOutput#nsd_usage_state #nsd_usage_state} => String
|
564
|
+
# * {Types::CreateSolNetworkPackageOutput#tags #tags} => Hash<String,String>
|
565
|
+
#
|
566
|
+
# @example Request syntax with placeholder values
|
567
|
+
#
|
568
|
+
# resp = client.create_sol_network_package({
|
569
|
+
# tags: {
|
570
|
+
# "TagKey" => "TagValue",
|
571
|
+
# },
|
572
|
+
# })
|
573
|
+
#
|
574
|
+
# @example Response structure
|
575
|
+
#
|
576
|
+
# resp.arn #=> String
|
577
|
+
# resp.id #=> String
|
578
|
+
# resp.nsd_onboarding_state #=> String, one of "CREATED", "ONBOARDED", "ERROR"
|
579
|
+
# resp.nsd_operational_state #=> String, one of "ENABLED", "DISABLED"
|
580
|
+
# resp.nsd_usage_state #=> String, one of "IN_USE", "NOT_IN_USE"
|
581
|
+
# resp.tags #=> Hash
|
582
|
+
# resp.tags["TagKey"] #=> String
|
583
|
+
#
|
584
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/tnb-2008-10-21/CreateSolNetworkPackage AWS API Documentation
|
585
|
+
#
|
586
|
+
# @overload create_sol_network_package(params = {})
|
587
|
+
# @param [Hash] params ({})
|
588
|
+
def create_sol_network_package(params = {}, options = {})
|
589
|
+
req = build_request(:create_sol_network_package, params)
|
590
|
+
req.send_request(options)
|
591
|
+
end
|
592
|
+
|
593
|
+
# Deletes a function package.
|
594
|
+
#
|
595
|
+
# A function package is a .zip file in CSAR (Cloud Service Archive)
|
596
|
+
# format that contains a network function (an ETSI standard
|
597
|
+
# telecommunication application) and function package descriptor that
|
598
|
+
# uses the TOSCA standard to describe how the network functions should
|
599
|
+
# run on your network.
|
600
|
+
#
|
601
|
+
# To delete a function package, the package must be in a disabled state.
|
602
|
+
# To disable a function package, see [UpdateSolFunctionPackage][1].
|
603
|
+
#
|
604
|
+
#
|
605
|
+
#
|
606
|
+
# [1]: https://docs.aws.amazon.com/TNB/latest/APIReference/API_UpdateSolFunctionPackage.html
|
607
|
+
#
|
608
|
+
# @option params [required, String] :vnf_pkg_id
|
609
|
+
# ID of the function package.
|
610
|
+
#
|
611
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
612
|
+
#
|
613
|
+
# @example Request syntax with placeholder values
|
614
|
+
#
|
615
|
+
# resp = client.delete_sol_function_package({
|
616
|
+
# vnf_pkg_id: "VnfPkgId", # required
|
617
|
+
# })
|
618
|
+
#
|
619
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/tnb-2008-10-21/DeleteSolFunctionPackage AWS API Documentation
|
620
|
+
#
|
621
|
+
# @overload delete_sol_function_package(params = {})
|
622
|
+
# @param [Hash] params ({})
|
623
|
+
def delete_sol_function_package(params = {}, options = {})
|
624
|
+
req = build_request(:delete_sol_function_package, params)
|
625
|
+
req.send_request(options)
|
626
|
+
end
|
627
|
+
|
628
|
+
# Deletes a network instance.
|
629
|
+
#
|
630
|
+
# A network instance is a single network created in Amazon Web Services
|
631
|
+
# TNB that can be deployed and on which life-cycle operations (like
|
632
|
+
# terminate, update, and delete) can be performed.
|
633
|
+
#
|
634
|
+
# To delete a network instance, the instance must be in a stopped or
|
635
|
+
# terminated state. To terminate a network instance, see
|
636
|
+
# [TerminateSolNetworkInstance][1].
|
637
|
+
#
|
638
|
+
#
|
639
|
+
#
|
640
|
+
# [1]: https://docs.aws.amazon.com/TNB/latest/APIReference/API_TerminateSolNetworkInstance.html
|
641
|
+
#
|
642
|
+
# @option params [required, String] :ns_instance_id
|
643
|
+
# Network instance ID.
|
644
|
+
#
|
645
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
646
|
+
#
|
647
|
+
# @example Request syntax with placeholder values
|
648
|
+
#
|
649
|
+
# resp = client.delete_sol_network_instance({
|
650
|
+
# ns_instance_id: "NsInstanceId", # required
|
651
|
+
# })
|
652
|
+
#
|
653
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/tnb-2008-10-21/DeleteSolNetworkInstance AWS API Documentation
|
654
|
+
#
|
655
|
+
# @overload delete_sol_network_instance(params = {})
|
656
|
+
# @param [Hash] params ({})
|
657
|
+
def delete_sol_network_instance(params = {}, options = {})
|
658
|
+
req = build_request(:delete_sol_network_instance, params)
|
659
|
+
req.send_request(options)
|
660
|
+
end
|
661
|
+
|
662
|
+
# Deletes network package.
|
663
|
+
#
|
664
|
+
# A network package is a .zip file in CSAR (Cloud Service Archive)
|
665
|
+
# format defines the function packages you want to deploy and the Amazon
|
666
|
+
# Web Services infrastructure you want to deploy them on.
|
667
|
+
#
|
668
|
+
# To delete a network package, the package must be in a disable state.
|
669
|
+
# To disable a network package, see [UpdateSolNetworkPackage][1].
|
670
|
+
#
|
671
|
+
#
|
672
|
+
#
|
673
|
+
# [1]: https://docs.aws.amazon.com/TNB/latest/APIReference/API_UpdateSolNetworkPackage.html
|
674
|
+
#
|
675
|
+
# @option params [required, String] :nsd_info_id
|
676
|
+
# ID of the network service descriptor in the network package.
|
677
|
+
#
|
678
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
679
|
+
#
|
680
|
+
# @example Request syntax with placeholder values
|
681
|
+
#
|
682
|
+
# resp = client.delete_sol_network_package({
|
683
|
+
# nsd_info_id: "NsdInfoId", # required
|
684
|
+
# })
|
685
|
+
#
|
686
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/tnb-2008-10-21/DeleteSolNetworkPackage AWS API Documentation
|
687
|
+
#
|
688
|
+
# @overload delete_sol_network_package(params = {})
|
689
|
+
# @param [Hash] params ({})
|
690
|
+
def delete_sol_network_package(params = {}, options = {})
|
691
|
+
req = build_request(:delete_sol_network_package, params)
|
692
|
+
req.send_request(options)
|
693
|
+
end
|
694
|
+
|
695
|
+
# Gets the details of a network function instance, including the
|
696
|
+
# instantation state and metadata from the function package descriptor
|
697
|
+
# in the network function package.
|
698
|
+
#
|
699
|
+
# A network function instance is a function in a function package .
|
700
|
+
#
|
701
|
+
# @option params [required, String] :vnf_instance_id
|
702
|
+
# ID of the network function.
|
703
|
+
#
|
704
|
+
# @return [Types::GetSolFunctionInstanceOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
705
|
+
#
|
706
|
+
# * {Types::GetSolFunctionInstanceOutput#arn #arn} => String
|
707
|
+
# * {Types::GetSolFunctionInstanceOutput#id #id} => String
|
708
|
+
# * {Types::GetSolFunctionInstanceOutput#instantiated_vnf_info #instantiated_vnf_info} => Types::GetSolVnfInfo
|
709
|
+
# * {Types::GetSolFunctionInstanceOutput#instantiation_state #instantiation_state} => String
|
710
|
+
# * {Types::GetSolFunctionInstanceOutput#metadata #metadata} => Types::GetSolFunctionInstanceMetadata
|
711
|
+
# * {Types::GetSolFunctionInstanceOutput#ns_instance_id #ns_instance_id} => String
|
712
|
+
# * {Types::GetSolFunctionInstanceOutput#tags #tags} => Hash<String,String>
|
713
|
+
# * {Types::GetSolFunctionInstanceOutput#vnf_pkg_id #vnf_pkg_id} => String
|
714
|
+
# * {Types::GetSolFunctionInstanceOutput#vnf_product_name #vnf_product_name} => String
|
715
|
+
# * {Types::GetSolFunctionInstanceOutput#vnf_provider #vnf_provider} => String
|
716
|
+
# * {Types::GetSolFunctionInstanceOutput#vnfd_id #vnfd_id} => String
|
717
|
+
# * {Types::GetSolFunctionInstanceOutput#vnfd_version #vnfd_version} => String
|
718
|
+
#
|
719
|
+
# @example Request syntax with placeholder values
|
720
|
+
#
|
721
|
+
# resp = client.get_sol_function_instance({
|
722
|
+
# vnf_instance_id: "VnfInstanceId", # required
|
723
|
+
# })
|
724
|
+
#
|
725
|
+
# @example Response structure
|
726
|
+
#
|
727
|
+
# resp.arn #=> String
|
728
|
+
# resp.id #=> String
|
729
|
+
# resp.instantiated_vnf_info.vnf_state #=> String, one of "STARTED", "STOPPED"
|
730
|
+
# resp.instantiated_vnf_info.vnfc_resource_info #=> Array
|
731
|
+
# resp.instantiated_vnf_info.vnfc_resource_info[0].metadata.cluster #=> String
|
732
|
+
# resp.instantiated_vnf_info.vnfc_resource_info[0].metadata.helm_chart #=> String
|
733
|
+
# resp.instantiated_vnf_info.vnfc_resource_info[0].metadata.node_group #=> String
|
734
|
+
# resp.instantiation_state #=> String, one of "INSTANTIATED", "NOT_INSTANTIATED"
|
735
|
+
# resp.metadata.created_at #=> Time
|
736
|
+
# resp.metadata.last_modified #=> Time
|
737
|
+
# resp.ns_instance_id #=> String
|
738
|
+
# resp.tags #=> Hash
|
739
|
+
# resp.tags["TagKey"] #=> String
|
740
|
+
# resp.vnf_pkg_id #=> String
|
741
|
+
# resp.vnf_product_name #=> String
|
742
|
+
# resp.vnf_provider #=> String
|
743
|
+
# resp.vnfd_id #=> String
|
744
|
+
# resp.vnfd_version #=> String
|
745
|
+
#
|
746
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/tnb-2008-10-21/GetSolFunctionInstance AWS API Documentation
|
747
|
+
#
|
748
|
+
# @overload get_sol_function_instance(params = {})
|
749
|
+
# @param [Hash] params ({})
|
750
|
+
def get_sol_function_instance(params = {}, options = {})
|
751
|
+
req = build_request(:get_sol_function_instance, params)
|
752
|
+
req.send_request(options)
|
753
|
+
end
|
754
|
+
|
755
|
+
# Gets the details of an individual function package, such as the
|
756
|
+
# operational state and whether the package is in use.
|
757
|
+
#
|
758
|
+
# A function package is a .zip file in CSAR (Cloud Service Archive)
|
759
|
+
# format that contains a network function (an ETSI standard
|
760
|
+
# telecommunication application) and function package descriptor that
|
761
|
+
# uses the TOSCA standard to describe how the network functions should
|
762
|
+
# run on your network..
|
763
|
+
#
|
764
|
+
# @option params [required, String] :vnf_pkg_id
|
765
|
+
# ID of the function package.
|
766
|
+
#
|
767
|
+
# @return [Types::GetSolFunctionPackageOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
768
|
+
#
|
769
|
+
# * {Types::GetSolFunctionPackageOutput#arn #arn} => String
|
770
|
+
# * {Types::GetSolFunctionPackageOutput#id #id} => String
|
771
|
+
# * {Types::GetSolFunctionPackageOutput#metadata #metadata} => Types::GetSolFunctionPackageMetadata
|
772
|
+
# * {Types::GetSolFunctionPackageOutput#onboarding_state #onboarding_state} => String
|
773
|
+
# * {Types::GetSolFunctionPackageOutput#operational_state #operational_state} => String
|
774
|
+
# * {Types::GetSolFunctionPackageOutput#tags #tags} => Hash<String,String>
|
775
|
+
# * {Types::GetSolFunctionPackageOutput#usage_state #usage_state} => String
|
776
|
+
# * {Types::GetSolFunctionPackageOutput#vnf_product_name #vnf_product_name} => String
|
777
|
+
# * {Types::GetSolFunctionPackageOutput#vnf_provider #vnf_provider} => String
|
778
|
+
# * {Types::GetSolFunctionPackageOutput#vnfd_id #vnfd_id} => String
|
779
|
+
# * {Types::GetSolFunctionPackageOutput#vnfd_version #vnfd_version} => String
|
780
|
+
#
|
781
|
+
# @example Request syntax with placeholder values
|
782
|
+
#
|
783
|
+
# resp = client.get_sol_function_package({
|
784
|
+
# vnf_pkg_id: "VnfPkgId", # required
|
785
|
+
# })
|
786
|
+
#
|
787
|
+
# @example Response structure
|
788
|
+
#
|
789
|
+
# resp.arn #=> String
|
790
|
+
# resp.id #=> String
|
791
|
+
# resp.metadata.created_at #=> Time
|
792
|
+
# resp.metadata.last_modified #=> Time
|
793
|
+
# resp.metadata.vnfd.overrides #=> Array
|
794
|
+
# resp.metadata.vnfd.overrides[0].default_value #=> String
|
795
|
+
# resp.metadata.vnfd.overrides[0].name #=> String
|
796
|
+
# resp.onboarding_state #=> String, one of "CREATED", "ONBOARDED", "ERROR"
|
797
|
+
# resp.operational_state #=> String, one of "ENABLED", "DISABLED"
|
798
|
+
# resp.tags #=> Hash
|
799
|
+
# resp.tags["TagKey"] #=> String
|
800
|
+
# resp.usage_state #=> String, one of "IN_USE", "NOT_IN_USE"
|
801
|
+
# resp.vnf_product_name #=> String
|
802
|
+
# resp.vnf_provider #=> String
|
803
|
+
# resp.vnfd_id #=> String
|
804
|
+
# resp.vnfd_version #=> String
|
805
|
+
#
|
806
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/tnb-2008-10-21/GetSolFunctionPackage AWS API Documentation
|
807
|
+
#
|
808
|
+
# @overload get_sol_function_package(params = {})
|
809
|
+
# @param [Hash] params ({})
|
810
|
+
def get_sol_function_package(params = {}, options = {})
|
811
|
+
req = build_request(:get_sol_function_package, params)
|
812
|
+
req.send_request(options)
|
813
|
+
end
|
814
|
+
|
815
|
+
# Gets the contents of a function package.
|
816
|
+
#
|
817
|
+
# A function package is a .zip file in CSAR (Cloud Service Archive)
|
818
|
+
# format that contains a network function (an ETSI standard
|
819
|
+
# telecommunication application) and function package descriptor that
|
820
|
+
# uses the TOSCA standard to describe how the network functions should
|
821
|
+
# run on your network.
|
822
|
+
#
|
823
|
+
# @option params [required, String] :accept
|
824
|
+
# The format of the package that you want to download from the function
|
825
|
+
# packages.
|
826
|
+
#
|
827
|
+
# @option params [required, String] :vnf_pkg_id
|
828
|
+
# ID of the function package.
|
829
|
+
#
|
830
|
+
# @return [Types::GetSolFunctionPackageContentOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
831
|
+
#
|
832
|
+
# * {Types::GetSolFunctionPackageContentOutput#content_type #content_type} => String
|
833
|
+
# * {Types::GetSolFunctionPackageContentOutput#package_content #package_content} => String
|
834
|
+
#
|
835
|
+
# @example Request syntax with placeholder values
|
836
|
+
#
|
837
|
+
# resp = client.get_sol_function_package_content({
|
838
|
+
# accept: "application/zip", # required, accepts application/zip
|
839
|
+
# vnf_pkg_id: "VnfPkgId", # required
|
840
|
+
# })
|
841
|
+
#
|
842
|
+
# @example Response structure
|
843
|
+
#
|
844
|
+
# resp.content_type #=> String, one of "application/zip"
|
845
|
+
# resp.package_content #=> String
|
846
|
+
#
|
847
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/tnb-2008-10-21/GetSolFunctionPackageContent AWS API Documentation
|
848
|
+
#
|
849
|
+
# @overload get_sol_function_package_content(params = {})
|
850
|
+
# @param [Hash] params ({})
|
851
|
+
def get_sol_function_package_content(params = {}, options = {})
|
852
|
+
req = build_request(:get_sol_function_package_content, params)
|
853
|
+
req.send_request(options)
|
854
|
+
end
|
855
|
+
|
856
|
+
# Gets a function package descriptor in a function package.
|
857
|
+
#
|
858
|
+
# A function package descriptor is a .yaml file in a function package
|
859
|
+
# that uses the TOSCA standard to describe how the network function in
|
860
|
+
# the function package should run on your network.
|
861
|
+
#
|
862
|
+
# A function package is a .zip file in CSAR (Cloud Service Archive)
|
863
|
+
# format that contains a network function (an ETSI standard
|
864
|
+
# telecommunication application) and function package descriptor that
|
865
|
+
# uses the TOSCA standard to describe how the network functions should
|
866
|
+
# run on your network.
|
867
|
+
#
|
868
|
+
# @option params [required, String] :accept
|
869
|
+
# Indicates which content types, expressed as MIME types, the client is
|
870
|
+
# able to understand.
|
871
|
+
#
|
872
|
+
# @option params [required, String] :vnf_pkg_id
|
873
|
+
# ID of the function package.
|
874
|
+
#
|
875
|
+
# @return [Types::GetSolFunctionPackageDescriptorOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
876
|
+
#
|
877
|
+
# * {Types::GetSolFunctionPackageDescriptorOutput#content_type #content_type} => String
|
878
|
+
# * {Types::GetSolFunctionPackageDescriptorOutput#vnfd #vnfd} => String
|
879
|
+
#
|
880
|
+
# @example Request syntax with placeholder values
|
881
|
+
#
|
882
|
+
# resp = client.get_sol_function_package_descriptor({
|
883
|
+
# accept: "text/plain", # required, accepts text/plain
|
884
|
+
# vnf_pkg_id: "VnfPkgId", # required
|
885
|
+
# })
|
886
|
+
#
|
887
|
+
# @example Response structure
|
888
|
+
#
|
889
|
+
# resp.content_type #=> String, one of "text/plain"
|
890
|
+
# resp.vnfd #=> String
|
891
|
+
#
|
892
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/tnb-2008-10-21/GetSolFunctionPackageDescriptor AWS API Documentation
|
893
|
+
#
|
894
|
+
# @overload get_sol_function_package_descriptor(params = {})
|
895
|
+
# @param [Hash] params ({})
|
896
|
+
def get_sol_function_package_descriptor(params = {}, options = {})
|
897
|
+
req = build_request(:get_sol_function_package_descriptor, params)
|
898
|
+
req.send_request(options)
|
899
|
+
end
|
900
|
+
|
901
|
+
# Gets the details of the network instance.
|
902
|
+
#
|
903
|
+
# A network instance is a single network created in Amazon Web Services
|
904
|
+
# TNB that can be deployed and on which life-cycle operations (like
|
905
|
+
# terminate, update, and delete) can be performed.
|
906
|
+
#
|
907
|
+
# @option params [required, String] :ns_instance_id
|
908
|
+
# ID of the network instance.
|
909
|
+
#
|
910
|
+
# @return [Types::GetSolNetworkInstanceOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
911
|
+
#
|
912
|
+
# * {Types::GetSolNetworkInstanceOutput#arn #arn} => String
|
913
|
+
# * {Types::GetSolNetworkInstanceOutput#id #id} => String
|
914
|
+
# * {Types::GetSolNetworkInstanceOutput#lcm_op_info #lcm_op_info} => Types::LcmOperationInfo
|
915
|
+
# * {Types::GetSolNetworkInstanceOutput#metadata #metadata} => Types::GetSolNetworkInstanceMetadata
|
916
|
+
# * {Types::GetSolNetworkInstanceOutput#ns_instance_description #ns_instance_description} => String
|
917
|
+
# * {Types::GetSolNetworkInstanceOutput#ns_instance_name #ns_instance_name} => String
|
918
|
+
# * {Types::GetSolNetworkInstanceOutput#ns_state #ns_state} => String
|
919
|
+
# * {Types::GetSolNetworkInstanceOutput#nsd_id #nsd_id} => String
|
920
|
+
# * {Types::GetSolNetworkInstanceOutput#nsd_info_id #nsd_info_id} => String
|
921
|
+
# * {Types::GetSolNetworkInstanceOutput#tags #tags} => Hash<String,String>
|
922
|
+
#
|
923
|
+
# @example Request syntax with placeholder values
|
924
|
+
#
|
925
|
+
# resp = client.get_sol_network_instance({
|
926
|
+
# ns_instance_id: "NsInstanceId", # required
|
927
|
+
# })
|
928
|
+
#
|
929
|
+
# @example Response structure
|
930
|
+
#
|
931
|
+
# resp.arn #=> String
|
932
|
+
# resp.id #=> String
|
933
|
+
# resp.lcm_op_info.ns_lcm_op_occ_id #=> String
|
934
|
+
# resp.metadata.created_at #=> Time
|
935
|
+
# resp.metadata.last_modified #=> Time
|
936
|
+
# resp.ns_instance_description #=> String
|
937
|
+
# resp.ns_instance_name #=> String
|
938
|
+
# resp.ns_state #=> String, one of "INSTANTIATED", "NOT_INSTANTIATED", "IMPAIRED", "STOPPED", "DELETED", "INSTANTIATE_IN_PROGRESS", "UPDATE_IN_PROGRESS", "TERMINATE_IN_PROGRESS"
|
939
|
+
# resp.nsd_id #=> String
|
940
|
+
# resp.nsd_info_id #=> String
|
941
|
+
# resp.tags #=> Hash
|
942
|
+
# resp.tags["TagKey"] #=> String
|
943
|
+
#
|
944
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/tnb-2008-10-21/GetSolNetworkInstance AWS API Documentation
|
945
|
+
#
|
946
|
+
# @overload get_sol_network_instance(params = {})
|
947
|
+
# @param [Hash] params ({})
|
948
|
+
def get_sol_network_instance(params = {}, options = {})
|
949
|
+
req = build_request(:get_sol_network_instance, params)
|
950
|
+
req.send_request(options)
|
951
|
+
end
|
952
|
+
|
953
|
+
# Gets the details of a network operation, including the tasks involved
|
954
|
+
# in the network operation and the status of the tasks.
|
955
|
+
#
|
956
|
+
# A network operation is any operation that is done to your network,
|
957
|
+
# such as network instance instantiation or termination.
|
958
|
+
#
|
959
|
+
# @option params [required, String] :ns_lcm_op_occ_id
|
960
|
+
# The identifier of the operation occurrence.
|
961
|
+
#
|
962
|
+
# @return [Types::GetSolNetworkOperationOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
963
|
+
#
|
964
|
+
# * {Types::GetSolNetworkOperationOutput#arn #arn} => String
|
965
|
+
# * {Types::GetSolNetworkOperationOutput#error #error} => Types::ProblemDetails
|
966
|
+
# * {Types::GetSolNetworkOperationOutput#id #id} => String
|
967
|
+
# * {Types::GetSolNetworkOperationOutput#lcm_operation_type #lcm_operation_type} => String
|
968
|
+
# * {Types::GetSolNetworkOperationOutput#metadata #metadata} => Types::GetSolNetworkOperationMetadata
|
969
|
+
# * {Types::GetSolNetworkOperationOutput#ns_instance_id #ns_instance_id} => String
|
970
|
+
# * {Types::GetSolNetworkOperationOutput#operation_state #operation_state} => String
|
971
|
+
# * {Types::GetSolNetworkOperationOutput#tags #tags} => Hash<String,String>
|
972
|
+
# * {Types::GetSolNetworkOperationOutput#tasks #tasks} => Array<Types::GetSolNetworkOperationTaskDetails>
|
973
|
+
#
|
974
|
+
# @example Request syntax with placeholder values
|
975
|
+
#
|
976
|
+
# resp = client.get_sol_network_operation({
|
977
|
+
# ns_lcm_op_occ_id: "NsLcmOpOccId", # required
|
978
|
+
# })
|
979
|
+
#
|
980
|
+
# @example Response structure
|
981
|
+
#
|
982
|
+
# resp.arn #=> String
|
983
|
+
# resp.error.detail #=> String
|
984
|
+
# resp.error.title #=> String
|
985
|
+
# resp.id #=> String
|
986
|
+
# resp.lcm_operation_type #=> String, one of "INSTANTIATE", "UPDATE", "TERMINATE"
|
987
|
+
# resp.metadata.created_at #=> Time
|
988
|
+
# resp.metadata.last_modified #=> Time
|
989
|
+
# resp.ns_instance_id #=> String
|
990
|
+
# resp.operation_state #=> String, one of "PROCESSING", "COMPLETED", "FAILED", "CANCELLING", "CANCELLED"
|
991
|
+
# resp.tags #=> Hash
|
992
|
+
# resp.tags["TagKey"] #=> String
|
993
|
+
# resp.tasks #=> Array
|
994
|
+
# resp.tasks[0].task_context #=> Hash
|
995
|
+
# resp.tasks[0].task_context["String"] #=> String
|
996
|
+
# resp.tasks[0].task_end_time #=> Time
|
997
|
+
# resp.tasks[0].task_error_details.cause #=> String
|
998
|
+
# resp.tasks[0].task_error_details.details #=> String
|
999
|
+
# resp.tasks[0].task_name #=> String
|
1000
|
+
# resp.tasks[0].task_start_time #=> Time
|
1001
|
+
# resp.tasks[0].task_status #=> String, one of "SCHEDULED", "STARTED", "IN_PROGRESS", "COMPLETED", "ERROR", "SKIPPED", "CANCELLED"
|
1002
|
+
#
|
1003
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/tnb-2008-10-21/GetSolNetworkOperation AWS API Documentation
|
1004
|
+
#
|
1005
|
+
# @overload get_sol_network_operation(params = {})
|
1006
|
+
# @param [Hash] params ({})
|
1007
|
+
def get_sol_network_operation(params = {}, options = {})
|
1008
|
+
req = build_request(:get_sol_network_operation, params)
|
1009
|
+
req.send_request(options)
|
1010
|
+
end
|
1011
|
+
|
1012
|
+
# Gets the details of a network package.
|
1013
|
+
#
|
1014
|
+
# A network package is a .zip file in CSAR (Cloud Service Archive)
|
1015
|
+
# format defines the function packages you want to deploy and the Amazon
|
1016
|
+
# Web Services infrastructure you want to deploy them on.
|
1017
|
+
#
|
1018
|
+
# @option params [required, String] :nsd_info_id
|
1019
|
+
# ID of the network service descriptor in the network package.
|
1020
|
+
#
|
1021
|
+
# @return [Types::GetSolNetworkPackageOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1022
|
+
#
|
1023
|
+
# * {Types::GetSolNetworkPackageOutput#arn #arn} => String
|
1024
|
+
# * {Types::GetSolNetworkPackageOutput#id #id} => String
|
1025
|
+
# * {Types::GetSolNetworkPackageOutput#metadata #metadata} => Types::GetSolNetworkPackageMetadata
|
1026
|
+
# * {Types::GetSolNetworkPackageOutput#nsd_id #nsd_id} => String
|
1027
|
+
# * {Types::GetSolNetworkPackageOutput#nsd_name #nsd_name} => String
|
1028
|
+
# * {Types::GetSolNetworkPackageOutput#nsd_onboarding_state #nsd_onboarding_state} => String
|
1029
|
+
# * {Types::GetSolNetworkPackageOutput#nsd_operational_state #nsd_operational_state} => String
|
1030
|
+
# * {Types::GetSolNetworkPackageOutput#nsd_usage_state #nsd_usage_state} => String
|
1031
|
+
# * {Types::GetSolNetworkPackageOutput#nsd_version #nsd_version} => String
|
1032
|
+
# * {Types::GetSolNetworkPackageOutput#tags #tags} => Hash<String,String>
|
1033
|
+
# * {Types::GetSolNetworkPackageOutput#vnf_pkg_ids #vnf_pkg_ids} => Array<String>
|
1034
|
+
#
|
1035
|
+
# @example Request syntax with placeholder values
|
1036
|
+
#
|
1037
|
+
# resp = client.get_sol_network_package({
|
1038
|
+
# nsd_info_id: "NsdInfoId", # required
|
1039
|
+
# })
|
1040
|
+
#
|
1041
|
+
# @example Response structure
|
1042
|
+
#
|
1043
|
+
# resp.arn #=> String
|
1044
|
+
# resp.id #=> String
|
1045
|
+
# resp.metadata.created_at #=> Time
|
1046
|
+
# resp.metadata.last_modified #=> Time
|
1047
|
+
# resp.metadata.nsd.overrides #=> Array
|
1048
|
+
# resp.metadata.nsd.overrides[0].default_value #=> String
|
1049
|
+
# resp.metadata.nsd.overrides[0].name #=> String
|
1050
|
+
# resp.nsd_id #=> String
|
1051
|
+
# resp.nsd_name #=> String
|
1052
|
+
# resp.nsd_onboarding_state #=> String, one of "CREATED", "ONBOARDED", "ERROR"
|
1053
|
+
# resp.nsd_operational_state #=> String, one of "ENABLED", "DISABLED"
|
1054
|
+
# resp.nsd_usage_state #=> String, one of "IN_USE", "NOT_IN_USE"
|
1055
|
+
# resp.nsd_version #=> String
|
1056
|
+
# resp.tags #=> Hash
|
1057
|
+
# resp.tags["TagKey"] #=> String
|
1058
|
+
# resp.vnf_pkg_ids #=> Array
|
1059
|
+
# resp.vnf_pkg_ids[0] #=> String
|
1060
|
+
#
|
1061
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/tnb-2008-10-21/GetSolNetworkPackage AWS API Documentation
|
1062
|
+
#
|
1063
|
+
# @overload get_sol_network_package(params = {})
|
1064
|
+
# @param [Hash] params ({})
|
1065
|
+
def get_sol_network_package(params = {}, options = {})
|
1066
|
+
req = build_request(:get_sol_network_package, params)
|
1067
|
+
req.send_request(options)
|
1068
|
+
end
|
1069
|
+
|
1070
|
+
# Gets the contents of a network package.
|
1071
|
+
#
|
1072
|
+
# A network package is a .zip file in CSAR (Cloud Service Archive)
|
1073
|
+
# format defines the function packages you want to deploy and the Amazon
|
1074
|
+
# Web Services infrastructure you want to deploy them on.
|
1075
|
+
#
|
1076
|
+
# @option params [required, String] :accept
|
1077
|
+
# The format of the package you want to download from the network
|
1078
|
+
# package.
|
1079
|
+
#
|
1080
|
+
# @option params [required, String] :nsd_info_id
|
1081
|
+
# ID of the network service descriptor in the network package.
|
1082
|
+
#
|
1083
|
+
# @return [Types::GetSolNetworkPackageContentOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1084
|
+
#
|
1085
|
+
# * {Types::GetSolNetworkPackageContentOutput#content_type #content_type} => String
|
1086
|
+
# * {Types::GetSolNetworkPackageContentOutput#nsd_content #nsd_content} => String
|
1087
|
+
#
|
1088
|
+
# @example Request syntax with placeholder values
|
1089
|
+
#
|
1090
|
+
# resp = client.get_sol_network_package_content({
|
1091
|
+
# accept: "application/zip", # required, accepts application/zip
|
1092
|
+
# nsd_info_id: "NsdInfoId", # required
|
1093
|
+
# })
|
1094
|
+
#
|
1095
|
+
# @example Response structure
|
1096
|
+
#
|
1097
|
+
# resp.content_type #=> String, one of "application/zip"
|
1098
|
+
# resp.nsd_content #=> String
|
1099
|
+
#
|
1100
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/tnb-2008-10-21/GetSolNetworkPackageContent AWS API Documentation
|
1101
|
+
#
|
1102
|
+
# @overload get_sol_network_package_content(params = {})
|
1103
|
+
# @param [Hash] params ({})
|
1104
|
+
def get_sol_network_package_content(params = {}, options = {})
|
1105
|
+
req = build_request(:get_sol_network_package_content, params)
|
1106
|
+
req.send_request(options)
|
1107
|
+
end
|
1108
|
+
|
1109
|
+
# Gets the content of the network service descriptor.
|
1110
|
+
#
|
1111
|
+
# A network service descriptor is a .yaml file in a network package that
|
1112
|
+
# uses the TOSCA standard to describe the network functions you want to
|
1113
|
+
# deploy and the Amazon Web Services infrastructure you want to deploy
|
1114
|
+
# the network functions on.
|
1115
|
+
#
|
1116
|
+
# @option params [required, String] :nsd_info_id
|
1117
|
+
# ID of the network service descriptor in the network package.
|
1118
|
+
#
|
1119
|
+
# @return [Types::GetSolNetworkPackageDescriptorOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1120
|
+
#
|
1121
|
+
# * {Types::GetSolNetworkPackageDescriptorOutput#content_type #content_type} => String
|
1122
|
+
# * {Types::GetSolNetworkPackageDescriptorOutput#nsd #nsd} => String
|
1123
|
+
#
|
1124
|
+
# @example Request syntax with placeholder values
|
1125
|
+
#
|
1126
|
+
# resp = client.get_sol_network_package_descriptor({
|
1127
|
+
# nsd_info_id: "NsdInfoId", # required
|
1128
|
+
# })
|
1129
|
+
#
|
1130
|
+
# @example Response structure
|
1131
|
+
#
|
1132
|
+
# resp.content_type #=> String, one of "text/plain"
|
1133
|
+
# resp.nsd #=> String
|
1134
|
+
#
|
1135
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/tnb-2008-10-21/GetSolNetworkPackageDescriptor AWS API Documentation
|
1136
|
+
#
|
1137
|
+
# @overload get_sol_network_package_descriptor(params = {})
|
1138
|
+
# @param [Hash] params ({})
|
1139
|
+
def get_sol_network_package_descriptor(params = {}, options = {})
|
1140
|
+
req = build_request(:get_sol_network_package_descriptor, params)
|
1141
|
+
req.send_request(options)
|
1142
|
+
end
|
1143
|
+
|
1144
|
+
# Instantiates a network instance.
|
1145
|
+
#
|
1146
|
+
# A network instance is a single network created in Amazon Web Services
|
1147
|
+
# TNB that can be deployed and on which life-cycle operations (like
|
1148
|
+
# terminate, update, and delete) can be performed.
|
1149
|
+
#
|
1150
|
+
# Before you can instantiate a network instance, you have to create a
|
1151
|
+
# network instance. For more information, see
|
1152
|
+
# [CreateSolNetworkInstance][1].
|
1153
|
+
#
|
1154
|
+
#
|
1155
|
+
#
|
1156
|
+
# [1]: https://docs.aws.amazon.com/TNB/latest/APIReference/API_CreateSolNetworkInstance.html
|
1157
|
+
#
|
1158
|
+
# @option params [Hash,Array,String,Numeric,Boolean] :additional_params_for_ns
|
1159
|
+
# Provides values for the configurable properties.
|
1160
|
+
#
|
1161
|
+
# Document type used to carry open content
|
1162
|
+
# (Hash,Array,String,Numeric,Boolean). A document type value is
|
1163
|
+
# serialized using the same format as its surroundings and requires no
|
1164
|
+
# additional encoding or escaping.
|
1165
|
+
#
|
1166
|
+
# @option params [Boolean] :dry_run
|
1167
|
+
# A check for whether you have the required permissions for the action
|
1168
|
+
# without actually making the request and provides an error response. If
|
1169
|
+
# you have the required permissions, the error response is
|
1170
|
+
# `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`.
|
1171
|
+
#
|
1172
|
+
# @option params [required, String] :ns_instance_id
|
1173
|
+
# ID of the network instance.
|
1174
|
+
#
|
1175
|
+
# @return [Types::InstantiateSolNetworkInstanceOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1176
|
+
#
|
1177
|
+
# * {Types::InstantiateSolNetworkInstanceOutput#ns_lcm_op_occ_id #ns_lcm_op_occ_id} => String
|
1178
|
+
#
|
1179
|
+
# @example Request syntax with placeholder values
|
1180
|
+
#
|
1181
|
+
# resp = client.instantiate_sol_network_instance({
|
1182
|
+
# additional_params_for_ns: {
|
1183
|
+
# },
|
1184
|
+
# dry_run: false,
|
1185
|
+
# ns_instance_id: "NsInstanceId", # required
|
1186
|
+
# })
|
1187
|
+
#
|
1188
|
+
# @example Response structure
|
1189
|
+
#
|
1190
|
+
# resp.ns_lcm_op_occ_id #=> String
|
1191
|
+
#
|
1192
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/tnb-2008-10-21/InstantiateSolNetworkInstance AWS API Documentation
|
1193
|
+
#
|
1194
|
+
# @overload instantiate_sol_network_instance(params = {})
|
1195
|
+
# @param [Hash] params ({})
|
1196
|
+
def instantiate_sol_network_instance(params = {}, options = {})
|
1197
|
+
req = build_request(:instantiate_sol_network_instance, params)
|
1198
|
+
req.send_request(options)
|
1199
|
+
end
|
1200
|
+
|
1201
|
+
# Lists network function instances.
|
1202
|
+
#
|
1203
|
+
# A network function instance is a function in a function package .
|
1204
|
+
#
|
1205
|
+
# @option params [Integer] :max_results
|
1206
|
+
# The maximum number of results to include in the response.
|
1207
|
+
#
|
1208
|
+
# @option params [String] :next_token
|
1209
|
+
# The token for the next page of results.
|
1210
|
+
#
|
1211
|
+
# @return [Types::ListSolFunctionInstancesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1212
|
+
#
|
1213
|
+
# * {Types::ListSolFunctionInstancesOutput#function_instances #function_instances} => Array<Types::ListSolFunctionInstanceInfo>
|
1214
|
+
# * {Types::ListSolFunctionInstancesOutput#next_token #next_token} => String
|
1215
|
+
#
|
1216
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1217
|
+
#
|
1218
|
+
# @example Request syntax with placeholder values
|
1219
|
+
#
|
1220
|
+
# resp = client.list_sol_function_instances({
|
1221
|
+
# max_results: 1,
|
1222
|
+
# next_token: "PaginationToken",
|
1223
|
+
# })
|
1224
|
+
#
|
1225
|
+
# @example Response structure
|
1226
|
+
#
|
1227
|
+
# resp.function_instances #=> Array
|
1228
|
+
# resp.function_instances[0].arn #=> String
|
1229
|
+
# resp.function_instances[0].id #=> String
|
1230
|
+
# resp.function_instances[0].instantiated_vnf_info.vnf_state #=> String, one of "STARTED", "STOPPED"
|
1231
|
+
# resp.function_instances[0].instantiation_state #=> String, one of "INSTANTIATED", "NOT_INSTANTIATED"
|
1232
|
+
# resp.function_instances[0].metadata.created_at #=> Time
|
1233
|
+
# resp.function_instances[0].metadata.last_modified #=> Time
|
1234
|
+
# resp.function_instances[0].ns_instance_id #=> String
|
1235
|
+
# resp.function_instances[0].vnf_pkg_id #=> String
|
1236
|
+
# resp.function_instances[0].vnf_pkg_name #=> String
|
1237
|
+
# resp.next_token #=> String
|
1238
|
+
#
|
1239
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/tnb-2008-10-21/ListSolFunctionInstances AWS API Documentation
|
1240
|
+
#
|
1241
|
+
# @overload list_sol_function_instances(params = {})
|
1242
|
+
# @param [Hash] params ({})
|
1243
|
+
def list_sol_function_instances(params = {}, options = {})
|
1244
|
+
req = build_request(:list_sol_function_instances, params)
|
1245
|
+
req.send_request(options)
|
1246
|
+
end
|
1247
|
+
|
1248
|
+
# Lists information about function packages.
|
1249
|
+
#
|
1250
|
+
# A function package is a .zip file in CSAR (Cloud Service Archive)
|
1251
|
+
# format that contains a network function (an ETSI standard
|
1252
|
+
# telecommunication application) and function package descriptor that
|
1253
|
+
# uses the TOSCA standard to describe how the network functions should
|
1254
|
+
# run on your network.
|
1255
|
+
#
|
1256
|
+
# @option params [Integer] :max_results
|
1257
|
+
# The maximum number of results to include in the response.
|
1258
|
+
#
|
1259
|
+
# @option params [String] :next_token
|
1260
|
+
# The token for the next page of results.
|
1261
|
+
#
|
1262
|
+
# @return [Types::ListSolFunctionPackagesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1263
|
+
#
|
1264
|
+
# * {Types::ListSolFunctionPackagesOutput#function_packages #function_packages} => Array<Types::ListSolFunctionPackageInfo>
|
1265
|
+
# * {Types::ListSolFunctionPackagesOutput#next_token #next_token} => String
|
1266
|
+
#
|
1267
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1268
|
+
#
|
1269
|
+
# @example Request syntax with placeholder values
|
1270
|
+
#
|
1271
|
+
# resp = client.list_sol_function_packages({
|
1272
|
+
# max_results: 1,
|
1273
|
+
# next_token: "PaginationToken",
|
1274
|
+
# })
|
1275
|
+
#
|
1276
|
+
# @example Response structure
|
1277
|
+
#
|
1278
|
+
# resp.function_packages #=> Array
|
1279
|
+
# resp.function_packages[0].arn #=> String
|
1280
|
+
# resp.function_packages[0].id #=> String
|
1281
|
+
# resp.function_packages[0].metadata.created_at #=> Time
|
1282
|
+
# resp.function_packages[0].metadata.last_modified #=> Time
|
1283
|
+
# resp.function_packages[0].onboarding_state #=> String, one of "CREATED", "ONBOARDED", "ERROR"
|
1284
|
+
# resp.function_packages[0].operational_state #=> String, one of "ENABLED", "DISABLED"
|
1285
|
+
# resp.function_packages[0].usage_state #=> String, one of "IN_USE", "NOT_IN_USE"
|
1286
|
+
# resp.function_packages[0].vnf_product_name #=> String
|
1287
|
+
# resp.function_packages[0].vnf_provider #=> String
|
1288
|
+
# resp.function_packages[0].vnfd_id #=> String
|
1289
|
+
# resp.function_packages[0].vnfd_version #=> String
|
1290
|
+
# resp.next_token #=> String
|
1291
|
+
#
|
1292
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/tnb-2008-10-21/ListSolFunctionPackages AWS API Documentation
|
1293
|
+
#
|
1294
|
+
# @overload list_sol_function_packages(params = {})
|
1295
|
+
# @param [Hash] params ({})
|
1296
|
+
def list_sol_function_packages(params = {}, options = {})
|
1297
|
+
req = build_request(:list_sol_function_packages, params)
|
1298
|
+
req.send_request(options)
|
1299
|
+
end
|
1300
|
+
|
1301
|
+
# Lists your network instances.
|
1302
|
+
#
|
1303
|
+
# A network instance is a single network created in Amazon Web Services
|
1304
|
+
# TNB that can be deployed and on which life-cycle operations (like
|
1305
|
+
# terminate, update, and delete) can be performed.
|
1306
|
+
#
|
1307
|
+
# @option params [Integer] :max_results
|
1308
|
+
# The maximum number of results to include in the response.
|
1309
|
+
#
|
1310
|
+
# @option params [String] :next_token
|
1311
|
+
# The token for the next page of results.
|
1312
|
+
#
|
1313
|
+
# @return [Types::ListSolNetworkInstancesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1314
|
+
#
|
1315
|
+
# * {Types::ListSolNetworkInstancesOutput#network_instances #network_instances} => Array<Types::ListSolNetworkInstanceInfo>
|
1316
|
+
# * {Types::ListSolNetworkInstancesOutput#next_token #next_token} => String
|
1317
|
+
#
|
1318
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1319
|
+
#
|
1320
|
+
# @example Request syntax with placeholder values
|
1321
|
+
#
|
1322
|
+
# resp = client.list_sol_network_instances({
|
1323
|
+
# max_results: 1,
|
1324
|
+
# next_token: "PaginationToken",
|
1325
|
+
# })
|
1326
|
+
#
|
1327
|
+
# @example Response structure
|
1328
|
+
#
|
1329
|
+
# resp.network_instances #=> Array
|
1330
|
+
# resp.network_instances[0].arn #=> String
|
1331
|
+
# resp.network_instances[0].id #=> String
|
1332
|
+
# resp.network_instances[0].metadata.created_at #=> Time
|
1333
|
+
# resp.network_instances[0].metadata.last_modified #=> Time
|
1334
|
+
# resp.network_instances[0].ns_instance_description #=> String
|
1335
|
+
# resp.network_instances[0].ns_instance_name #=> String
|
1336
|
+
# resp.network_instances[0].ns_state #=> String, one of "INSTANTIATED", "NOT_INSTANTIATED", "IMPAIRED", "STOPPED", "DELETED", "INSTANTIATE_IN_PROGRESS", "UPDATE_IN_PROGRESS", "TERMINATE_IN_PROGRESS"
|
1337
|
+
# resp.network_instances[0].nsd_id #=> String
|
1338
|
+
# resp.network_instances[0].nsd_info_id #=> String
|
1339
|
+
# resp.next_token #=> String
|
1340
|
+
#
|
1341
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/tnb-2008-10-21/ListSolNetworkInstances AWS API Documentation
|
1342
|
+
#
|
1343
|
+
# @overload list_sol_network_instances(params = {})
|
1344
|
+
# @param [Hash] params ({})
|
1345
|
+
def list_sol_network_instances(params = {}, options = {})
|
1346
|
+
req = build_request(:list_sol_network_instances, params)
|
1347
|
+
req.send_request(options)
|
1348
|
+
end
|
1349
|
+
|
1350
|
+
# Lists details for a network operation, including when the operation
|
1351
|
+
# started and the status of the operation.
|
1352
|
+
#
|
1353
|
+
# A network operation is any operation that is done to your network,
|
1354
|
+
# such as network instance instantiation or termination.
|
1355
|
+
#
|
1356
|
+
# @option params [Integer] :max_results
|
1357
|
+
# The maximum number of results to include in the response.
|
1358
|
+
#
|
1359
|
+
# @option params [String] :next_token
|
1360
|
+
# The token for the next page of results.
|
1361
|
+
#
|
1362
|
+
# @return [Types::ListSolNetworkOperationsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1363
|
+
#
|
1364
|
+
# * {Types::ListSolNetworkOperationsOutput#network_operations #network_operations} => Array<Types::ListSolNetworkOperationsInfo>
|
1365
|
+
# * {Types::ListSolNetworkOperationsOutput#next_token #next_token} => String
|
1366
|
+
#
|
1367
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1368
|
+
#
|
1369
|
+
# @example Request syntax with placeholder values
|
1370
|
+
#
|
1371
|
+
# resp = client.list_sol_network_operations({
|
1372
|
+
# max_results: 1,
|
1373
|
+
# next_token: "PaginationToken",
|
1374
|
+
# })
|
1375
|
+
#
|
1376
|
+
# @example Response structure
|
1377
|
+
#
|
1378
|
+
# resp.network_operations #=> Array
|
1379
|
+
# resp.network_operations[0].arn #=> String
|
1380
|
+
# resp.network_operations[0].error.detail #=> String
|
1381
|
+
# resp.network_operations[0].error.title #=> String
|
1382
|
+
# resp.network_operations[0].id #=> String
|
1383
|
+
# resp.network_operations[0].lcm_operation_type #=> String, one of "INSTANTIATE", "UPDATE", "TERMINATE"
|
1384
|
+
# resp.network_operations[0].metadata.created_at #=> Time
|
1385
|
+
# resp.network_operations[0].metadata.last_modified #=> Time
|
1386
|
+
# resp.network_operations[0].ns_instance_id #=> String
|
1387
|
+
# resp.network_operations[0].operation_state #=> String, one of "PROCESSING", "COMPLETED", "FAILED", "CANCELLING", "CANCELLED"
|
1388
|
+
# resp.next_token #=> String
|
1389
|
+
#
|
1390
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/tnb-2008-10-21/ListSolNetworkOperations AWS API Documentation
|
1391
|
+
#
|
1392
|
+
# @overload list_sol_network_operations(params = {})
|
1393
|
+
# @param [Hash] params ({})
|
1394
|
+
def list_sol_network_operations(params = {}, options = {})
|
1395
|
+
req = build_request(:list_sol_network_operations, params)
|
1396
|
+
req.send_request(options)
|
1397
|
+
end
|
1398
|
+
|
1399
|
+
# Lists network packages.
|
1400
|
+
#
|
1401
|
+
# A network package is a .zip file in CSAR (Cloud Service Archive)
|
1402
|
+
# format defines the function packages you want to deploy and the Amazon
|
1403
|
+
# Web Services infrastructure you want to deploy them on.
|
1404
|
+
#
|
1405
|
+
# @option params [Integer] :max_results
|
1406
|
+
# The maximum number of results to include in the response.
|
1407
|
+
#
|
1408
|
+
# @option params [String] :next_token
|
1409
|
+
# The token for the next page of results.
|
1410
|
+
#
|
1411
|
+
# @return [Types::ListSolNetworkPackagesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1412
|
+
#
|
1413
|
+
# * {Types::ListSolNetworkPackagesOutput#network_packages #network_packages} => Array<Types::ListSolNetworkPackageInfo>
|
1414
|
+
# * {Types::ListSolNetworkPackagesOutput#next_token #next_token} => String
|
1415
|
+
#
|
1416
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1417
|
+
#
|
1418
|
+
# @example Request syntax with placeholder values
|
1419
|
+
#
|
1420
|
+
# resp = client.list_sol_network_packages({
|
1421
|
+
# max_results: 1,
|
1422
|
+
# next_token: "PaginationToken",
|
1423
|
+
# })
|
1424
|
+
#
|
1425
|
+
# @example Response structure
|
1426
|
+
#
|
1427
|
+
# resp.network_packages #=> Array
|
1428
|
+
# resp.network_packages[0].arn #=> String
|
1429
|
+
# resp.network_packages[0].id #=> String
|
1430
|
+
# resp.network_packages[0].metadata.created_at #=> Time
|
1431
|
+
# resp.network_packages[0].metadata.last_modified #=> Time
|
1432
|
+
# resp.network_packages[0].nsd_designer #=> String
|
1433
|
+
# resp.network_packages[0].nsd_id #=> String
|
1434
|
+
# resp.network_packages[0].nsd_invariant_id #=> String
|
1435
|
+
# resp.network_packages[0].nsd_name #=> String
|
1436
|
+
# resp.network_packages[0].nsd_onboarding_state #=> String, one of "CREATED", "ONBOARDED", "ERROR"
|
1437
|
+
# resp.network_packages[0].nsd_operational_state #=> String, one of "ENABLED", "DISABLED"
|
1438
|
+
# resp.network_packages[0].nsd_usage_state #=> String, one of "IN_USE", "NOT_IN_USE"
|
1439
|
+
# resp.network_packages[0].nsd_version #=> String
|
1440
|
+
# resp.network_packages[0].vnf_pkg_ids #=> Array
|
1441
|
+
# resp.network_packages[0].vnf_pkg_ids[0] #=> String
|
1442
|
+
# resp.next_token #=> String
|
1443
|
+
#
|
1444
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/tnb-2008-10-21/ListSolNetworkPackages AWS API Documentation
|
1445
|
+
#
|
1446
|
+
# @overload list_sol_network_packages(params = {})
|
1447
|
+
# @param [Hash] params ({})
|
1448
|
+
def list_sol_network_packages(params = {}, options = {})
|
1449
|
+
req = build_request(:list_sol_network_packages, params)
|
1450
|
+
req.send_request(options)
|
1451
|
+
end
|
1452
|
+
|
1453
|
+
# Lists tags for AWS TNB resources.
|
1454
|
+
#
|
1455
|
+
# @option params [required, String] :resource_arn
|
1456
|
+
# Resource ARN.
|
1457
|
+
#
|
1458
|
+
# @return [Types::ListTagsForResourceOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1459
|
+
#
|
1460
|
+
# * {Types::ListTagsForResourceOutput#tags #tags} => Hash<String,String>
|
1461
|
+
#
|
1462
|
+
# @example Request syntax with placeholder values
|
1463
|
+
#
|
1464
|
+
# resp = client.list_tags_for_resource({
|
1465
|
+
# resource_arn: "TNBResourceArn", # required
|
1466
|
+
# })
|
1467
|
+
#
|
1468
|
+
# @example Response structure
|
1469
|
+
#
|
1470
|
+
# resp.tags #=> Hash
|
1471
|
+
# resp.tags["TagKey"] #=> String
|
1472
|
+
#
|
1473
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/tnb-2008-10-21/ListTagsForResource AWS API Documentation
|
1474
|
+
#
|
1475
|
+
# @overload list_tags_for_resource(params = {})
|
1476
|
+
# @param [Hash] params ({})
|
1477
|
+
def list_tags_for_resource(params = {}, options = {})
|
1478
|
+
req = build_request(:list_tags_for_resource, params)
|
1479
|
+
req.send_request(options)
|
1480
|
+
end
|
1481
|
+
|
1482
|
+
# Uploads the contents of a function package.
|
1483
|
+
#
|
1484
|
+
# A function package is a .zip file in CSAR (Cloud Service Archive)
|
1485
|
+
# format that contains a network function (an ETSI standard
|
1486
|
+
# telecommunication application) and function package descriptor that
|
1487
|
+
# uses the TOSCA standard to describe how the network functions should
|
1488
|
+
# run on your network.
|
1489
|
+
#
|
1490
|
+
# @option params [String] :content_type
|
1491
|
+
# Function package content type.
|
1492
|
+
#
|
1493
|
+
# @option params [required, String, StringIO, File] :file
|
1494
|
+
# Function package file.
|
1495
|
+
#
|
1496
|
+
# @option params [required, String] :vnf_pkg_id
|
1497
|
+
# Function package ID.
|
1498
|
+
#
|
1499
|
+
# @return [Types::PutSolFunctionPackageContentOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1500
|
+
#
|
1501
|
+
# * {Types::PutSolFunctionPackageContentOutput#id #id} => String
|
1502
|
+
# * {Types::PutSolFunctionPackageContentOutput#metadata #metadata} => Types::PutSolFunctionPackageContentMetadata
|
1503
|
+
# * {Types::PutSolFunctionPackageContentOutput#vnf_product_name #vnf_product_name} => String
|
1504
|
+
# * {Types::PutSolFunctionPackageContentOutput#vnf_provider #vnf_provider} => String
|
1505
|
+
# * {Types::PutSolFunctionPackageContentOutput#vnfd_id #vnfd_id} => String
|
1506
|
+
# * {Types::PutSolFunctionPackageContentOutput#vnfd_version #vnfd_version} => String
|
1507
|
+
#
|
1508
|
+
# @example Request syntax with placeholder values
|
1509
|
+
#
|
1510
|
+
# resp = client.put_sol_function_package_content({
|
1511
|
+
# content_type: "application/zip", # accepts application/zip
|
1512
|
+
# file: "data", # required
|
1513
|
+
# vnf_pkg_id: "VnfPkgId", # required
|
1514
|
+
# })
|
1515
|
+
#
|
1516
|
+
# @example Response structure
|
1517
|
+
#
|
1518
|
+
# resp.id #=> String
|
1519
|
+
# resp.metadata.vnfd.overrides #=> Array
|
1520
|
+
# resp.metadata.vnfd.overrides[0].default_value #=> String
|
1521
|
+
# resp.metadata.vnfd.overrides[0].name #=> String
|
1522
|
+
# resp.vnf_product_name #=> String
|
1523
|
+
# resp.vnf_provider #=> String
|
1524
|
+
# resp.vnfd_id #=> String
|
1525
|
+
# resp.vnfd_version #=> String
|
1526
|
+
#
|
1527
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/tnb-2008-10-21/PutSolFunctionPackageContent AWS API Documentation
|
1528
|
+
#
|
1529
|
+
# @overload put_sol_function_package_content(params = {})
|
1530
|
+
# @param [Hash] params ({})
|
1531
|
+
def put_sol_function_package_content(params = {}, options = {})
|
1532
|
+
req = build_request(:put_sol_function_package_content, params)
|
1533
|
+
req.send_request(options)
|
1534
|
+
end
|
1535
|
+
|
1536
|
+
# Uploads the contents of a network package.
|
1537
|
+
#
|
1538
|
+
# A network package is a .zip file in CSAR (Cloud Service Archive)
|
1539
|
+
# format defines the function packages you want to deploy and the Amazon
|
1540
|
+
# Web Services infrastructure you want to deploy them on.
|
1541
|
+
#
|
1542
|
+
# @option params [String] :content_type
|
1543
|
+
# Network package content type.
|
1544
|
+
#
|
1545
|
+
# @option params [required, String, StringIO, File] :file
|
1546
|
+
# Network package file.
|
1547
|
+
#
|
1548
|
+
# @option params [required, String] :nsd_info_id
|
1549
|
+
# Network service descriptor info ID.
|
1550
|
+
#
|
1551
|
+
# @return [Types::PutSolNetworkPackageContentOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1552
|
+
#
|
1553
|
+
# * {Types::PutSolNetworkPackageContentOutput#arn #arn} => String
|
1554
|
+
# * {Types::PutSolNetworkPackageContentOutput#id #id} => String
|
1555
|
+
# * {Types::PutSolNetworkPackageContentOutput#metadata #metadata} => Types::PutSolNetworkPackageContentMetadata
|
1556
|
+
# * {Types::PutSolNetworkPackageContentOutput#nsd_id #nsd_id} => String
|
1557
|
+
# * {Types::PutSolNetworkPackageContentOutput#nsd_name #nsd_name} => String
|
1558
|
+
# * {Types::PutSolNetworkPackageContentOutput#nsd_version #nsd_version} => String
|
1559
|
+
# * {Types::PutSolNetworkPackageContentOutput#vnf_pkg_ids #vnf_pkg_ids} => Array<String>
|
1560
|
+
#
|
1561
|
+
# @example Request syntax with placeholder values
|
1562
|
+
#
|
1563
|
+
# resp = client.put_sol_network_package_content({
|
1564
|
+
# content_type: "application/zip", # accepts application/zip
|
1565
|
+
# file: "data", # required
|
1566
|
+
# nsd_info_id: "NsdInfoId", # required
|
1567
|
+
# })
|
1568
|
+
#
|
1569
|
+
# @example Response structure
|
1570
|
+
#
|
1571
|
+
# resp.arn #=> String
|
1572
|
+
# resp.id #=> String
|
1573
|
+
# resp.metadata.nsd.overrides #=> Array
|
1574
|
+
# resp.metadata.nsd.overrides[0].default_value #=> String
|
1575
|
+
# resp.metadata.nsd.overrides[0].name #=> String
|
1576
|
+
# resp.nsd_id #=> String
|
1577
|
+
# resp.nsd_name #=> String
|
1578
|
+
# resp.nsd_version #=> String
|
1579
|
+
# resp.vnf_pkg_ids #=> Array
|
1580
|
+
# resp.vnf_pkg_ids[0] #=> String
|
1581
|
+
#
|
1582
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/tnb-2008-10-21/PutSolNetworkPackageContent AWS API Documentation
|
1583
|
+
#
|
1584
|
+
# @overload put_sol_network_package_content(params = {})
|
1585
|
+
# @param [Hash] params ({})
|
1586
|
+
def put_sol_network_package_content(params = {}, options = {})
|
1587
|
+
req = build_request(:put_sol_network_package_content, params)
|
1588
|
+
req.send_request(options)
|
1589
|
+
end
|
1590
|
+
|
1591
|
+
# Tags an AWS TNB resource.
|
1592
|
+
#
|
1593
|
+
# A tag is a label that you assign to an Amazon Web Services resource.
|
1594
|
+
# Each tag consists of a key and an optional value. You can use tags to
|
1595
|
+
# search and filter your resources or track your Amazon Web Services
|
1596
|
+
# costs.
|
1597
|
+
#
|
1598
|
+
# @option params [required, String] :resource_arn
|
1599
|
+
# Resource ARN.
|
1600
|
+
#
|
1601
|
+
# @option params [required, Hash<String,String>] :tags
|
1602
|
+
# A tag is a label that you assign to an Amazon Web Services resource.
|
1603
|
+
# Each tag consists of a key and an optional value. You can use tags to
|
1604
|
+
# search and filter your resources or track your Amazon Web Services
|
1605
|
+
# costs.
|
1606
|
+
#
|
1607
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1608
|
+
#
|
1609
|
+
# @example Request syntax with placeholder values
|
1610
|
+
#
|
1611
|
+
# resp = client.tag_resource({
|
1612
|
+
# resource_arn: "TNBResourceArn", # required
|
1613
|
+
# tags: { # required
|
1614
|
+
# "TagKey" => "TagValue",
|
1615
|
+
# },
|
1616
|
+
# })
|
1617
|
+
#
|
1618
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/tnb-2008-10-21/TagResource AWS API Documentation
|
1619
|
+
#
|
1620
|
+
# @overload tag_resource(params = {})
|
1621
|
+
# @param [Hash] params ({})
|
1622
|
+
def tag_resource(params = {}, options = {})
|
1623
|
+
req = build_request(:tag_resource, params)
|
1624
|
+
req.send_request(options)
|
1625
|
+
end
|
1626
|
+
|
1627
|
+
# Terminates a network instance.
|
1628
|
+
#
|
1629
|
+
# A network instance is a single network created in Amazon Web Services
|
1630
|
+
# TNB that can be deployed and on which life-cycle operations (like
|
1631
|
+
# terminate, update, and delete) can be performed.
|
1632
|
+
#
|
1633
|
+
# You must terminate a network instance before you can delete it.
|
1634
|
+
#
|
1635
|
+
# @option params [required, String] :ns_instance_id
|
1636
|
+
# ID of the network instance.
|
1637
|
+
#
|
1638
|
+
# @return [Types::TerminateSolNetworkInstanceOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1639
|
+
#
|
1640
|
+
# * {Types::TerminateSolNetworkInstanceOutput#ns_lcm_op_occ_id #ns_lcm_op_occ_id} => String
|
1641
|
+
#
|
1642
|
+
# @example Request syntax with placeholder values
|
1643
|
+
#
|
1644
|
+
# resp = client.terminate_sol_network_instance({
|
1645
|
+
# ns_instance_id: "NsInstanceId", # required
|
1646
|
+
# })
|
1647
|
+
#
|
1648
|
+
# @example Response structure
|
1649
|
+
#
|
1650
|
+
# resp.ns_lcm_op_occ_id #=> String
|
1651
|
+
#
|
1652
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/tnb-2008-10-21/TerminateSolNetworkInstance AWS API Documentation
|
1653
|
+
#
|
1654
|
+
# @overload terminate_sol_network_instance(params = {})
|
1655
|
+
# @param [Hash] params ({})
|
1656
|
+
def terminate_sol_network_instance(params = {}, options = {})
|
1657
|
+
req = build_request(:terminate_sol_network_instance, params)
|
1658
|
+
req.send_request(options)
|
1659
|
+
end
|
1660
|
+
|
1661
|
+
# Untags an AWS TNB resource.
|
1662
|
+
#
|
1663
|
+
# A tag is a label that you assign to an Amazon Web Services resource.
|
1664
|
+
# Each tag consists of a key and an optional value. You can use tags to
|
1665
|
+
# search and filter your resources or track your Amazon Web Services
|
1666
|
+
# costs.
|
1667
|
+
#
|
1668
|
+
# @option params [required, String] :resource_arn
|
1669
|
+
# Resource ARN.
|
1670
|
+
#
|
1671
|
+
# @option params [required, Array<String>] :tag_keys
|
1672
|
+
# Tag keys.
|
1673
|
+
#
|
1674
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1675
|
+
#
|
1676
|
+
# @example Request syntax with placeholder values
|
1677
|
+
#
|
1678
|
+
# resp = client.untag_resource({
|
1679
|
+
# resource_arn: "TNBResourceArn", # required
|
1680
|
+
# tag_keys: ["TagKey"], # required
|
1681
|
+
# })
|
1682
|
+
#
|
1683
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/tnb-2008-10-21/UntagResource AWS API Documentation
|
1684
|
+
#
|
1685
|
+
# @overload untag_resource(params = {})
|
1686
|
+
# @param [Hash] params ({})
|
1687
|
+
def untag_resource(params = {}, options = {})
|
1688
|
+
req = build_request(:untag_resource, params)
|
1689
|
+
req.send_request(options)
|
1690
|
+
end
|
1691
|
+
|
1692
|
+
# Updates the operational state of function package.
|
1693
|
+
#
|
1694
|
+
# A function package is a .zip file in CSAR (Cloud Service Archive)
|
1695
|
+
# format that contains a network function (an ETSI standard
|
1696
|
+
# telecommunication application) and function package descriptor that
|
1697
|
+
# uses the TOSCA standard to describe how the network functions should
|
1698
|
+
# run on your network.
|
1699
|
+
#
|
1700
|
+
# @option params [required, String] :operational_state
|
1701
|
+
# Operational state of the function package.
|
1702
|
+
#
|
1703
|
+
# @option params [required, String] :vnf_pkg_id
|
1704
|
+
# ID of the function package.
|
1705
|
+
#
|
1706
|
+
# @return [Types::UpdateSolFunctionPackageOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1707
|
+
#
|
1708
|
+
# * {Types::UpdateSolFunctionPackageOutput#operational_state #operational_state} => String
|
1709
|
+
#
|
1710
|
+
# @example Request syntax with placeholder values
|
1711
|
+
#
|
1712
|
+
# resp = client.update_sol_function_package({
|
1713
|
+
# operational_state: "ENABLED", # required, accepts ENABLED, DISABLED
|
1714
|
+
# vnf_pkg_id: "VnfPkgId", # required
|
1715
|
+
# })
|
1716
|
+
#
|
1717
|
+
# @example Response structure
|
1718
|
+
#
|
1719
|
+
# resp.operational_state #=> String, one of "ENABLED", "DISABLED"
|
1720
|
+
#
|
1721
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/tnb-2008-10-21/UpdateSolFunctionPackage AWS API Documentation
|
1722
|
+
#
|
1723
|
+
# @overload update_sol_function_package(params = {})
|
1724
|
+
# @param [Hash] params ({})
|
1725
|
+
def update_sol_function_package(params = {}, options = {})
|
1726
|
+
req = build_request(:update_sol_function_package, params)
|
1727
|
+
req.send_request(options)
|
1728
|
+
end
|
1729
|
+
|
1730
|
+
# Update a network instance.
|
1731
|
+
#
|
1732
|
+
# A network instance is a single network created in Amazon Web Services
|
1733
|
+
# TNB that can be deployed and on which life-cycle operations (like
|
1734
|
+
# terminate, update, and delete) can be performed.
|
1735
|
+
#
|
1736
|
+
# @option params [Types::UpdateSolNetworkModify] :modify_vnf_info_data
|
1737
|
+
# Identifies the network function information parameters and/or the
|
1738
|
+
# configurable properties of the network function to be modified.
|
1739
|
+
#
|
1740
|
+
# @option params [required, String] :ns_instance_id
|
1741
|
+
# ID of the network instance.
|
1742
|
+
#
|
1743
|
+
# @option params [required, String] :update_type
|
1744
|
+
# The type of update.
|
1745
|
+
#
|
1746
|
+
# @return [Types::UpdateSolNetworkInstanceOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1747
|
+
#
|
1748
|
+
# * {Types::UpdateSolNetworkInstanceOutput#ns_lcm_op_occ_id #ns_lcm_op_occ_id} => String
|
1749
|
+
#
|
1750
|
+
# @example Request syntax with placeholder values
|
1751
|
+
#
|
1752
|
+
# resp = client.update_sol_network_instance({
|
1753
|
+
# modify_vnf_info_data: {
|
1754
|
+
# vnf_configurable_properties: { # required
|
1755
|
+
# },
|
1756
|
+
# vnf_instance_id: "VnfInstanceId", # required
|
1757
|
+
# },
|
1758
|
+
# ns_instance_id: "NsInstanceId", # required
|
1759
|
+
# update_type: "MODIFY_VNF_INFORMATION", # required, accepts MODIFY_VNF_INFORMATION
|
1760
|
+
# })
|
1761
|
+
#
|
1762
|
+
# @example Response structure
|
1763
|
+
#
|
1764
|
+
# resp.ns_lcm_op_occ_id #=> String
|
1765
|
+
#
|
1766
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/tnb-2008-10-21/UpdateSolNetworkInstance AWS API Documentation
|
1767
|
+
#
|
1768
|
+
# @overload update_sol_network_instance(params = {})
|
1769
|
+
# @param [Hash] params ({})
|
1770
|
+
def update_sol_network_instance(params = {}, options = {})
|
1771
|
+
req = build_request(:update_sol_network_instance, params)
|
1772
|
+
req.send_request(options)
|
1773
|
+
end
|
1774
|
+
|
1775
|
+
# Updates the operational state of a network package.
|
1776
|
+
#
|
1777
|
+
# A network package is a .zip file in CSAR (Cloud Service Archive)
|
1778
|
+
# format defines the function packages you want to deploy and the Amazon
|
1779
|
+
# Web Services infrastructure you want to deploy them on.
|
1780
|
+
#
|
1781
|
+
# A network service descriptor is a .yaml file in a network package that
|
1782
|
+
# uses the TOSCA standard to describe the network functions you want to
|
1783
|
+
# deploy and the Amazon Web Services infrastructure you want to deploy
|
1784
|
+
# the network functions on.
|
1785
|
+
#
|
1786
|
+
# @option params [required, String] :nsd_info_id
|
1787
|
+
# ID of the network service descriptor in the network package.
|
1788
|
+
#
|
1789
|
+
# @option params [required, String] :nsd_operational_state
|
1790
|
+
# Operational state of the network service descriptor in the network
|
1791
|
+
# package.
|
1792
|
+
#
|
1793
|
+
# @return [Types::UpdateSolNetworkPackageOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1794
|
+
#
|
1795
|
+
# * {Types::UpdateSolNetworkPackageOutput#nsd_operational_state #nsd_operational_state} => String
|
1796
|
+
#
|
1797
|
+
# @example Request syntax with placeholder values
|
1798
|
+
#
|
1799
|
+
# resp = client.update_sol_network_package({
|
1800
|
+
# nsd_info_id: "NsdInfoId", # required
|
1801
|
+
# nsd_operational_state: "ENABLED", # required, accepts ENABLED, DISABLED
|
1802
|
+
# })
|
1803
|
+
#
|
1804
|
+
# @example Response structure
|
1805
|
+
#
|
1806
|
+
# resp.nsd_operational_state #=> String, one of "ENABLED", "DISABLED"
|
1807
|
+
#
|
1808
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/tnb-2008-10-21/UpdateSolNetworkPackage AWS API Documentation
|
1809
|
+
#
|
1810
|
+
# @overload update_sol_network_package(params = {})
|
1811
|
+
# @param [Hash] params ({})
|
1812
|
+
def update_sol_network_package(params = {}, options = {})
|
1813
|
+
req = build_request(:update_sol_network_package, params)
|
1814
|
+
req.send_request(options)
|
1815
|
+
end
|
1816
|
+
|
1817
|
+
# Validates function package content. This can be used as a dry run
|
1818
|
+
# before uploading function package content with
|
1819
|
+
# [PutSolFunctionPackageContent][1].
|
1820
|
+
#
|
1821
|
+
# A function package is a .zip file in CSAR (Cloud Service Archive)
|
1822
|
+
# format that contains a network function (an ETSI standard
|
1823
|
+
# telecommunication application) and function package descriptor that
|
1824
|
+
# uses the TOSCA standard to describe how the network functions should
|
1825
|
+
# run on your network.
|
1826
|
+
#
|
1827
|
+
#
|
1828
|
+
#
|
1829
|
+
# [1]: https://docs.aws.amazon.com/TNB/latest/APIReference/API_PutSolFunctionPackageContent.html
|
1830
|
+
#
|
1831
|
+
# @option params [String] :content_type
|
1832
|
+
# Function package content type.
|
1833
|
+
#
|
1834
|
+
# @option params [required, String, StringIO, File] :file
|
1835
|
+
# Function package file.
|
1836
|
+
#
|
1837
|
+
# @option params [required, String] :vnf_pkg_id
|
1838
|
+
# Function package ID.
|
1839
|
+
#
|
1840
|
+
# @return [Types::ValidateSolFunctionPackageContentOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1841
|
+
#
|
1842
|
+
# * {Types::ValidateSolFunctionPackageContentOutput#id #id} => String
|
1843
|
+
# * {Types::ValidateSolFunctionPackageContentOutput#metadata #metadata} => Types::ValidateSolFunctionPackageContentMetadata
|
1844
|
+
# * {Types::ValidateSolFunctionPackageContentOutput#vnf_product_name #vnf_product_name} => String
|
1845
|
+
# * {Types::ValidateSolFunctionPackageContentOutput#vnf_provider #vnf_provider} => String
|
1846
|
+
# * {Types::ValidateSolFunctionPackageContentOutput#vnfd_id #vnfd_id} => String
|
1847
|
+
# * {Types::ValidateSolFunctionPackageContentOutput#vnfd_version #vnfd_version} => String
|
1848
|
+
#
|
1849
|
+
# @example Request syntax with placeholder values
|
1850
|
+
#
|
1851
|
+
# resp = client.validate_sol_function_package_content({
|
1852
|
+
# content_type: "application/zip", # accepts application/zip
|
1853
|
+
# file: "data", # required
|
1854
|
+
# vnf_pkg_id: "VnfPkgId", # required
|
1855
|
+
# })
|
1856
|
+
#
|
1857
|
+
# @example Response structure
|
1858
|
+
#
|
1859
|
+
# resp.id #=> String
|
1860
|
+
# resp.metadata.vnfd.overrides #=> Array
|
1861
|
+
# resp.metadata.vnfd.overrides[0].default_value #=> String
|
1862
|
+
# resp.metadata.vnfd.overrides[0].name #=> String
|
1863
|
+
# resp.vnf_product_name #=> String
|
1864
|
+
# resp.vnf_provider #=> String
|
1865
|
+
# resp.vnfd_id #=> String
|
1866
|
+
# resp.vnfd_version #=> String
|
1867
|
+
#
|
1868
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/tnb-2008-10-21/ValidateSolFunctionPackageContent AWS API Documentation
|
1869
|
+
#
|
1870
|
+
# @overload validate_sol_function_package_content(params = {})
|
1871
|
+
# @param [Hash] params ({})
|
1872
|
+
def validate_sol_function_package_content(params = {}, options = {})
|
1873
|
+
req = build_request(:validate_sol_function_package_content, params)
|
1874
|
+
req.send_request(options)
|
1875
|
+
end
|
1876
|
+
|
1877
|
+
# Validates network package content. This can be used as a dry run
|
1878
|
+
# before uploading network package content with
|
1879
|
+
# [PutSolNetworkPackageContent][1].
|
1880
|
+
#
|
1881
|
+
# A network package is a .zip file in CSAR (Cloud Service Archive)
|
1882
|
+
# format defines the function packages you want to deploy and the Amazon
|
1883
|
+
# Web Services infrastructure you want to deploy them on.
|
1884
|
+
#
|
1885
|
+
#
|
1886
|
+
#
|
1887
|
+
# [1]: https://docs.aws.amazon.com/TNB/latest/APIReference/API_PutSolNetworkPackageContent.html
|
1888
|
+
#
|
1889
|
+
# @option params [String] :content_type
|
1890
|
+
# Network package content type.
|
1891
|
+
#
|
1892
|
+
# @option params [required, String, StringIO, File] :file
|
1893
|
+
# Network package file.
|
1894
|
+
#
|
1895
|
+
# @option params [required, String] :nsd_info_id
|
1896
|
+
# Network service descriptor file.
|
1897
|
+
#
|
1898
|
+
# @return [Types::ValidateSolNetworkPackageContentOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1899
|
+
#
|
1900
|
+
# * {Types::ValidateSolNetworkPackageContentOutput#arn #arn} => String
|
1901
|
+
# * {Types::ValidateSolNetworkPackageContentOutput#id #id} => String
|
1902
|
+
# * {Types::ValidateSolNetworkPackageContentOutput#metadata #metadata} => Types::ValidateSolNetworkPackageContentMetadata
|
1903
|
+
# * {Types::ValidateSolNetworkPackageContentOutput#nsd_id #nsd_id} => String
|
1904
|
+
# * {Types::ValidateSolNetworkPackageContentOutput#nsd_name #nsd_name} => String
|
1905
|
+
# * {Types::ValidateSolNetworkPackageContentOutput#nsd_version #nsd_version} => String
|
1906
|
+
# * {Types::ValidateSolNetworkPackageContentOutput#vnf_pkg_ids #vnf_pkg_ids} => Array<String>
|
1907
|
+
#
|
1908
|
+
# @example Request syntax with placeholder values
|
1909
|
+
#
|
1910
|
+
# resp = client.validate_sol_network_package_content({
|
1911
|
+
# content_type: "application/zip", # accepts application/zip
|
1912
|
+
# file: "data", # required
|
1913
|
+
# nsd_info_id: "NsdInfoId", # required
|
1914
|
+
# })
|
1915
|
+
#
|
1916
|
+
# @example Response structure
|
1917
|
+
#
|
1918
|
+
# resp.arn #=> String
|
1919
|
+
# resp.id #=> String
|
1920
|
+
# resp.metadata.nsd.overrides #=> Array
|
1921
|
+
# resp.metadata.nsd.overrides[0].default_value #=> String
|
1922
|
+
# resp.metadata.nsd.overrides[0].name #=> String
|
1923
|
+
# resp.nsd_id #=> String
|
1924
|
+
# resp.nsd_name #=> String
|
1925
|
+
# resp.nsd_version #=> String
|
1926
|
+
# resp.vnf_pkg_ids #=> Array
|
1927
|
+
# resp.vnf_pkg_ids[0] #=> String
|
1928
|
+
#
|
1929
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/tnb-2008-10-21/ValidateSolNetworkPackageContent AWS API Documentation
|
1930
|
+
#
|
1931
|
+
# @overload validate_sol_network_package_content(params = {})
|
1932
|
+
# @param [Hash] params ({})
|
1933
|
+
def validate_sol_network_package_content(params = {}, options = {})
|
1934
|
+
req = build_request(:validate_sol_network_package_content, params)
|
1935
|
+
req.send_request(options)
|
1936
|
+
end
|
1937
|
+
|
1938
|
+
# @!endgroup
|
1939
|
+
|
1940
|
+
# @param params ({})
|
1941
|
+
# @api private
|
1942
|
+
def build_request(operation_name, params = {})
|
1943
|
+
handlers = @handlers.for(operation_name)
|
1944
|
+
context = Seahorse::Client::RequestContext.new(
|
1945
|
+
operation_name: operation_name,
|
1946
|
+
operation: config.api.operation(operation_name),
|
1947
|
+
client: self,
|
1948
|
+
params: params,
|
1949
|
+
config: config)
|
1950
|
+
context[:gem_name] = 'aws-sdk-tnb'
|
1951
|
+
context[:gem_version] = '1.0.0'
|
1952
|
+
Seahorse::Client::Request.new(handlers, context)
|
1953
|
+
end
|
1954
|
+
|
1955
|
+
# @api private
|
1956
|
+
# @deprecated
|
1957
|
+
def waiter_names
|
1958
|
+
[]
|
1959
|
+
end
|
1960
|
+
|
1961
|
+
class << self
|
1962
|
+
|
1963
|
+
# @api private
|
1964
|
+
attr_reader :identifier
|
1965
|
+
|
1966
|
+
# @api private
|
1967
|
+
def errors_module
|
1968
|
+
Errors
|
1969
|
+
end
|
1970
|
+
|
1971
|
+
end
|
1972
|
+
end
|
1973
|
+
end
|