aws-sdk-panorama 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,1916 @@
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/signature_v4.rb'
31
+ require 'aws-sdk-core/plugins/protocols/rest_json.rb'
32
+
33
+ Aws::Plugins::GlobalConfiguration.add_identifier(:panorama)
34
+
35
+ module Aws::Panorama
36
+ # An API client for Panorama. To construct a client, you need to configure a `:region` and `:credentials`.
37
+ #
38
+ # client = Aws::Panorama::Client.new(
39
+ # region: region_name,
40
+ # credentials: credentials,
41
+ # # ...
42
+ # )
43
+ #
44
+ # For details on configuring region and credentials see
45
+ # the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
46
+ #
47
+ # See {#initialize} for a full list of supported configuration options.
48
+ class Client < Seahorse::Client::Base
49
+
50
+ include Aws::ClientStubs
51
+
52
+ @identifier = :panorama
53
+
54
+ set_api(ClientApi::API)
55
+
56
+ add_plugin(Seahorse::Client::Plugins::ContentLength)
57
+ add_plugin(Aws::Plugins::CredentialsConfiguration)
58
+ add_plugin(Aws::Plugins::Logging)
59
+ add_plugin(Aws::Plugins::ParamConverter)
60
+ add_plugin(Aws::Plugins::ParamValidator)
61
+ add_plugin(Aws::Plugins::UserAgent)
62
+ add_plugin(Aws::Plugins::HelpfulSocketErrors)
63
+ add_plugin(Aws::Plugins::RetryErrors)
64
+ add_plugin(Aws::Plugins::GlobalConfiguration)
65
+ add_plugin(Aws::Plugins::RegionalEndpoint)
66
+ add_plugin(Aws::Plugins::EndpointDiscovery)
67
+ add_plugin(Aws::Plugins::EndpointPattern)
68
+ add_plugin(Aws::Plugins::ResponsePaging)
69
+ add_plugin(Aws::Plugins::StubResponses)
70
+ add_plugin(Aws::Plugins::IdempotencyToken)
71
+ add_plugin(Aws::Plugins::JsonvalueConverter)
72
+ add_plugin(Aws::Plugins::ClientMetricsPlugin)
73
+ add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
74
+ add_plugin(Aws::Plugins::TransferEncoding)
75
+ add_plugin(Aws::Plugins::HttpChecksum)
76
+ add_plugin(Aws::Plugins::SignatureV4)
77
+ add_plugin(Aws::Plugins::Protocols::RestJson)
78
+
79
+ # @overload initialize(options)
80
+ # @param [Hash] options
81
+ # @option options [required, Aws::CredentialProvider] :credentials
82
+ # Your AWS credentials. This can be an instance of any one of the
83
+ # following classes:
84
+ #
85
+ # * `Aws::Credentials` - Used for configuring static, non-refreshing
86
+ # credentials.
87
+ #
88
+ # * `Aws::SharedCredentials` - Used for loading static credentials from a
89
+ # shared file, such as `~/.aws/config`.
90
+ #
91
+ # * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
92
+ #
93
+ # * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to
94
+ # assume a role after providing credentials via the web.
95
+ #
96
+ # * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an
97
+ # access token generated from `aws login`.
98
+ #
99
+ # * `Aws::ProcessCredentials` - Used for loading credentials from a
100
+ # process that outputs to stdout.
101
+ #
102
+ # * `Aws::InstanceProfileCredentials` - Used for loading credentials
103
+ # from an EC2 IMDS on an EC2 instance.
104
+ #
105
+ # * `Aws::ECSCredentials` - Used for loading credentials from
106
+ # instances running in ECS.
107
+ #
108
+ # * `Aws::CognitoIdentityCredentials` - Used for loading credentials
109
+ # from the Cognito Identity service.
110
+ #
111
+ # When `:credentials` are not configured directly, the following
112
+ # locations will be searched for credentials:
113
+ #
114
+ # * `Aws.config[:credentials]`
115
+ # * The `:access_key_id`, `:secret_access_key`, and `:session_token` options.
116
+ # * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
117
+ # * `~/.aws/credentials`
118
+ # * `~/.aws/config`
119
+ # * EC2/ECS IMDS instance profile - When used by default, the timeouts
120
+ # are very aggressive. Construct and pass an instance of
121
+ # `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
122
+ # enable retries and extended timeouts.
123
+ #
124
+ # @option options [required, String] :region
125
+ # The AWS region to connect to. The configured `:region` is
126
+ # used to determine the service `:endpoint`. When not passed,
127
+ # a default `:region` is searched for in the following locations:
128
+ #
129
+ # * `Aws.config[:region]`
130
+ # * `ENV['AWS_REGION']`
131
+ # * `ENV['AMAZON_REGION']`
132
+ # * `ENV['AWS_DEFAULT_REGION']`
133
+ # * `~/.aws/credentials`
134
+ # * `~/.aws/config`
135
+ #
136
+ # @option options [String] :access_key_id
137
+ #
138
+ # @option options [Boolean] :active_endpoint_cache (false)
139
+ # When set to `true`, a thread polling for endpoints will be running in
140
+ # the background every 60 secs (default). Defaults to `false`.
141
+ #
142
+ # @option options [Boolean] :adaptive_retry_wait_to_fill (true)
143
+ # Used only in `adaptive` retry mode. When true, the request will sleep
144
+ # until there is sufficent client side capacity to retry the request.
145
+ # When false, the request will raise a `RetryCapacityNotAvailableError` and will
146
+ # not retry instead of sleeping.
147
+ #
148
+ # @option options [Boolean] :client_side_monitoring (false)
149
+ # When `true`, client-side metrics will be collected for all API requests from
150
+ # this client.
151
+ #
152
+ # @option options [String] :client_side_monitoring_client_id ("")
153
+ # Allows you to provide an identifier for this client which will be attached to
154
+ # all generated client side metrics. Defaults to an empty string.
155
+ #
156
+ # @option options [String] :client_side_monitoring_host ("127.0.0.1")
157
+ # Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client
158
+ # side monitoring agent is running on, where client metrics will be published via UDP.
159
+ #
160
+ # @option options [Integer] :client_side_monitoring_port (31000)
161
+ # Required for publishing client metrics. The port that the client side monitoring
162
+ # agent is running on, where client metrics will be published via UDP.
163
+ #
164
+ # @option options [Aws::ClientSideMonitoring::Publisher] :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher)
165
+ # Allows you to provide a custom client-side monitoring publisher class. By default,
166
+ # will use the Client Side Monitoring Agent Publisher.
167
+ #
168
+ # @option options [Boolean] :convert_params (true)
169
+ # When `true`, an attempt is made to coerce request parameters into
170
+ # the required types.
171
+ #
172
+ # @option options [Boolean] :correct_clock_skew (true)
173
+ # Used only in `standard` and adaptive retry modes. Specifies whether to apply
174
+ # a clock skew correction and retry requests with skewed client clocks.
175
+ #
176
+ # @option options [Boolean] :disable_host_prefix_injection (false)
177
+ # Set to true to disable SDK automatically adding host prefix
178
+ # to default service endpoint when available.
179
+ #
180
+ # @option options [String] :endpoint
181
+ # The client endpoint is normally constructed from the `:region`
182
+ # option. You should only configure an `:endpoint` when connecting
183
+ # to test or custom endpoints. This should be a valid HTTP(S) URI.
184
+ #
185
+ # @option options [Integer] :endpoint_cache_max_entries (1000)
186
+ # Used for the maximum size limit of the LRU cache storing endpoints data
187
+ # for endpoint discovery enabled operations. Defaults to 1000.
188
+ #
189
+ # @option options [Integer] :endpoint_cache_max_threads (10)
190
+ # Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.
191
+ #
192
+ # @option options [Integer] :endpoint_cache_poll_interval (60)
193
+ # When :endpoint_discovery and :active_endpoint_cache is enabled,
194
+ # Use this option to config the time interval in seconds for making
195
+ # requests fetching endpoints information. Defaults to 60 sec.
196
+ #
197
+ # @option options [Boolean] :endpoint_discovery (false)
198
+ # When set to `true`, endpoint discovery will be enabled for operations when available.
199
+ #
200
+ # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
201
+ # The log formatter.
202
+ #
203
+ # @option options [Symbol] :log_level (:info)
204
+ # The log level to send messages to the `:logger` at.
205
+ #
206
+ # @option options [Logger] :logger
207
+ # The Logger instance to send log messages to. If this option
208
+ # is not set, logging will be disabled.
209
+ #
210
+ # @option options [Integer] :max_attempts (3)
211
+ # An integer representing the maximum number attempts that will be made for
212
+ # a single request, including the initial attempt. For example,
213
+ # setting this value to 5 will result in a request being retried up to
214
+ # 4 times. Used in `standard` and `adaptive` retry modes.
215
+ #
216
+ # @option options [String] :profile ("default")
217
+ # Used when loading credentials from the shared credentials file
218
+ # at HOME/.aws/credentials. When not specified, 'default' is used.
219
+ #
220
+ # @option options [Proc] :retry_backoff
221
+ # A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
222
+ # This option is only used in the `legacy` retry mode.
223
+ #
224
+ # @option options [Float] :retry_base_delay (0.3)
225
+ # The base delay in seconds used by the default backoff function. This option
226
+ # is only used in the `legacy` retry mode.
227
+ #
228
+ # @option options [Symbol] :retry_jitter (:none)
229
+ # A delay randomiser function used by the default backoff function.
230
+ # Some predefined functions can be referenced by name - :none, :equal, :full,
231
+ # otherwise a Proc that takes and returns a number. This option is only used
232
+ # in the `legacy` retry mode.
233
+ #
234
+ # @see https://www.awsarchitectureblog.com/2015/03/backoff.html
235
+ #
236
+ # @option options [Integer] :retry_limit (3)
237
+ # The maximum number of times to retry failed requests. Only
238
+ # ~ 500 level server errors and certain ~ 400 level client errors
239
+ # are retried. Generally, these are throttling errors, data
240
+ # checksum errors, networking errors, timeout errors, auth errors,
241
+ # endpoint discovery, and errors from expired credentials.
242
+ # This option is only used in the `legacy` retry mode.
243
+ #
244
+ # @option options [Integer] :retry_max_delay (0)
245
+ # The maximum number of seconds to delay between retries (0 for no limit)
246
+ # used by the default backoff function. This option is only used in the
247
+ # `legacy` retry mode.
248
+ #
249
+ # @option options [String] :retry_mode ("legacy")
250
+ # Specifies which retry algorithm to use. Values are:
251
+ #
252
+ # * `legacy` - The pre-existing retry behavior. This is default value if
253
+ # no retry mode is provided.
254
+ #
255
+ # * `standard` - A standardized set of retry rules across the AWS SDKs.
256
+ # This includes support for retry quotas, which limit the number of
257
+ # unsuccessful retries a client can make.
258
+ #
259
+ # * `adaptive` - An experimental retry mode that includes all the
260
+ # functionality of `standard` mode along with automatic client side
261
+ # throttling. This is a provisional mode that may change behavior
262
+ # in the future.
263
+ #
264
+ #
265
+ # @option options [String] :secret_access_key
266
+ #
267
+ # @option options [String] :session_token
268
+ #
269
+ # @option options [Boolean] :stub_responses (false)
270
+ # Causes the client to return stubbed responses. By default
271
+ # fake responses are generated and returned. You can specify
272
+ # the response data to return or errors to raise by calling
273
+ # {ClientStubs#stub_responses}. See {ClientStubs} for more information.
274
+ #
275
+ # ** Please note ** When response stubbing is enabled, no HTTP
276
+ # requests are made, and retries are disabled.
277
+ #
278
+ # @option options [Boolean] :validate_params (true)
279
+ # When `true`, request parameters are validated before
280
+ # sending the request.
281
+ #
282
+ # @option options [URI::HTTP,String] :http_proxy A proxy to send
283
+ # requests through. Formatted like 'http://proxy.com:123'.
284
+ #
285
+ # @option options [Float] :http_open_timeout (15) The number of
286
+ # seconds to wait when opening a HTTP session before raising a
287
+ # `Timeout::Error`.
288
+ #
289
+ # @option options [Integer] :http_read_timeout (60) The default
290
+ # number of seconds to wait for response data. This value can
291
+ # safely be set per-request on the session.
292
+ #
293
+ # @option options [Float] :http_idle_timeout (5) The number of
294
+ # seconds a connection is allowed to sit idle before it is
295
+ # considered stale. Stale connections are closed and removed
296
+ # from the pool before making a request.
297
+ #
298
+ # @option options [Float] :http_continue_timeout (1) The number of
299
+ # seconds to wait for a 100-continue response before sending the
300
+ # request body. This option has no effect unless the request has
301
+ # "Expect" header set to "100-continue". Defaults to `nil` which
302
+ # disables this behaviour. This value can safely be set per
303
+ # request on the session.
304
+ #
305
+ # @option options [Boolean] :http_wire_trace (false) When `true`,
306
+ # HTTP debug output will be sent to the `:logger`.
307
+ #
308
+ # @option options [Boolean] :ssl_verify_peer (true) When `true`,
309
+ # SSL peer certificates are verified when establishing a
310
+ # connection.
311
+ #
312
+ # @option options [String] :ssl_ca_bundle Full path to the SSL
313
+ # certificate authority bundle file that should be used when
314
+ # verifying peer certificates. If you do not pass
315
+ # `:ssl_ca_bundle` or `:ssl_ca_directory` the the system default
316
+ # will be used if available.
317
+ #
318
+ # @option options [String] :ssl_ca_directory Full path of the
319
+ # directory that contains the unbundled SSL certificate
320
+ # authority files for verifying peer certificates. If you do
321
+ # not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the
322
+ # system default will be used if available.
323
+ #
324
+ def initialize(*args)
325
+ super
326
+ end
327
+
328
+ # @!group API Operations
329
+
330
+ # Creates an application instance and deploys it to a device.
331
+ #
332
+ # @option params [String] :name
333
+ # A name for the application instance.
334
+ #
335
+ # @option params [String] :description
336
+ # A description for the application instance.
337
+ #
338
+ # @option params [required, Types::ManifestPayload] :manifest_payload
339
+ # The application's manifest document.
340
+ #
341
+ # @option params [Types::ManifestOverridesPayload] :manifest_overrides_payload
342
+ # Setting overrides for the application manifest.
343
+ #
344
+ # @option params [String] :application_instance_id_to_replace
345
+ # The ID of an application instance to replace with the new instance.
346
+ #
347
+ # @option params [String] :runtime_role_arn
348
+ # The ARN of a runtime role for the application instance.
349
+ #
350
+ # @option params [required, String] :default_runtime_context_device
351
+ # A device's ID.
352
+ #
353
+ # @option params [Hash<String,String>] :tags
354
+ # Tags for the application instance.
355
+ #
356
+ # @return [Types::CreateApplicationInstanceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
357
+ #
358
+ # * {Types::CreateApplicationInstanceResponse#application_instance_id #application_instance_id} => String
359
+ #
360
+ # @example Request syntax with placeholder values
361
+ #
362
+ # resp = client.create_application_instance({
363
+ # name: "ApplicationInstanceName",
364
+ # description: "Description",
365
+ # manifest_payload: { # required
366
+ # payload_data: "ManifestPayloadData",
367
+ # },
368
+ # manifest_overrides_payload: {
369
+ # payload_data: "ManifestOverridesPayloadData",
370
+ # },
371
+ # application_instance_id_to_replace: "ApplicationInstanceId",
372
+ # runtime_role_arn: "RuntimeRoleArn",
373
+ # default_runtime_context_device: "DefaultRuntimeContextDevice", # required
374
+ # tags: {
375
+ # "TagKey" => "TagValue",
376
+ # },
377
+ # })
378
+ #
379
+ # @example Response structure
380
+ #
381
+ # resp.application_instance_id #=> String
382
+ #
383
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/CreateApplicationInstance AWS API Documentation
384
+ #
385
+ # @overload create_application_instance(params = {})
386
+ # @param [Hash] params ({})
387
+ def create_application_instance(params = {}, options = {})
388
+ req = build_request(:create_application_instance, params)
389
+ req.send_request(options)
390
+ end
391
+
392
+ # Creates a job to run on one or more devices.
393
+ #
394
+ # @option params [required, Array<String>] :device_ids
395
+ # IDs of target devices.
396
+ #
397
+ # @option params [required, Types::DeviceJobConfig] :device_job_config
398
+ # Configuration settings for the job.
399
+ #
400
+ # @option params [required, String] :job_type
401
+ # The type of job to run.
402
+ #
403
+ # @return [Types::CreateJobForDevicesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
404
+ #
405
+ # * {Types::CreateJobForDevicesResponse#jobs #jobs} => Array&lt;Types::Job&gt;
406
+ #
407
+ # @example Request syntax with placeholder values
408
+ #
409
+ # resp = client.create_job_for_devices({
410
+ # device_ids: ["DeviceId"], # required
411
+ # device_job_config: { # required
412
+ # ota_job_config: {
413
+ # image_version: "ImageVersion", # required
414
+ # },
415
+ # },
416
+ # job_type: "OTA", # required, accepts OTA
417
+ # })
418
+ #
419
+ # @example Response structure
420
+ #
421
+ # resp.jobs #=> Array
422
+ # resp.jobs[0].job_id #=> String
423
+ # resp.jobs[0].device_id #=> String
424
+ #
425
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/CreateJobForDevices AWS API Documentation
426
+ #
427
+ # @overload create_job_for_devices(params = {})
428
+ # @param [Hash] params ({})
429
+ def create_job_for_devices(params = {}, options = {})
430
+ req = build_request(:create_job_for_devices, params)
431
+ req.send_request(options)
432
+ end
433
+
434
+ # Creates a camera stream node.
435
+ #
436
+ # @option params [required, String] :template_type
437
+ # The type of node.
438
+ #
439
+ # @option params [required, String] :output_package_name
440
+ # An output package name for the node.
441
+ #
442
+ # @option params [required, String] :output_package_version
443
+ # An output package version for the node.
444
+ #
445
+ # @option params [required, String] :node_name
446
+ # A name for the node.
447
+ #
448
+ # @option params [String] :node_description
449
+ # A description for the node.
450
+ #
451
+ # @option params [required, Hash<String,String>] :template_parameters
452
+ # Template parameters for the node.
453
+ #
454
+ # @option params [Array<Types::JobResourceTags>] :job_tags
455
+ # Tags for the job.
456
+ #
457
+ # @return [Types::CreateNodeFromTemplateJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
458
+ #
459
+ # * {Types::CreateNodeFromTemplateJobResponse#job_id #job_id} => String
460
+ #
461
+ # @example Request syntax with placeholder values
462
+ #
463
+ # resp = client.create_node_from_template_job({
464
+ # template_type: "RTSP_CAMERA_STREAM", # required, accepts RTSP_CAMERA_STREAM
465
+ # output_package_name: "NodePackageName", # required
466
+ # output_package_version: "NodePackageVersion", # required
467
+ # node_name: "NodeName", # required
468
+ # node_description: "Description",
469
+ # template_parameters: { # required
470
+ # "TemplateKey" => "TemplateValue",
471
+ # },
472
+ # job_tags: [
473
+ # {
474
+ # resource_type: "PACKAGE", # required, accepts PACKAGE
475
+ # tags: { # required
476
+ # "TagKey" => "TagValue",
477
+ # },
478
+ # },
479
+ # ],
480
+ # })
481
+ #
482
+ # @example Response structure
483
+ #
484
+ # resp.job_id #=> String
485
+ #
486
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/CreateNodeFromTemplateJob AWS API Documentation
487
+ #
488
+ # @overload create_node_from_template_job(params = {})
489
+ # @param [Hash] params ({})
490
+ def create_node_from_template_job(params = {}, options = {})
491
+ req = build_request(:create_node_from_template_job, params)
492
+ req.send_request(options)
493
+ end
494
+
495
+ # Creates a package and storage location in an Amazon S3 access point.
496
+ #
497
+ # @option params [required, String] :package_name
498
+ # A name for the package.
499
+ #
500
+ # @option params [Hash<String,String>] :tags
501
+ # Tags for the package.
502
+ #
503
+ # @return [Types::CreatePackageResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
504
+ #
505
+ # * {Types::CreatePackageResponse#package_id #package_id} => String
506
+ # * {Types::CreatePackageResponse#arn #arn} => String
507
+ # * {Types::CreatePackageResponse#storage_location #storage_location} => Types::StorageLocation
508
+ #
509
+ # @example Request syntax with placeholder values
510
+ #
511
+ # resp = client.create_package({
512
+ # package_name: "NodePackageName", # required
513
+ # tags: {
514
+ # "TagKey" => "TagValue",
515
+ # },
516
+ # })
517
+ #
518
+ # @example Response structure
519
+ #
520
+ # resp.package_id #=> String
521
+ # resp.arn #=> String
522
+ # resp.storage_location.bucket #=> String
523
+ # resp.storage_location.repo_prefix_location #=> String
524
+ # resp.storage_location.generated_prefix_location #=> String
525
+ # resp.storage_location.binary_prefix_location #=> String
526
+ # resp.storage_location.manifest_prefix_location #=> String
527
+ #
528
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/CreatePackage AWS API Documentation
529
+ #
530
+ # @overload create_package(params = {})
531
+ # @param [Hash] params ({})
532
+ def create_package(params = {}, options = {})
533
+ req = build_request(:create_package, params)
534
+ req.send_request(options)
535
+ end
536
+
537
+ # Imports a node package.
538
+ #
539
+ # @option params [required, String] :job_type
540
+ # A job type for the package import job.
541
+ #
542
+ # @option params [required, Types::PackageImportJobInputConfig] :input_config
543
+ # An input config for the package import job.
544
+ #
545
+ # @option params [required, Types::PackageImportJobOutputConfig] :output_config
546
+ # An output config for the package import job.
547
+ #
548
+ # @option params [required, String] :client_token
549
+ # A client token for the package import job.
550
+ #
551
+ # @option params [Array<Types::JobResourceTags>] :job_tags
552
+ # Tags for the package import job.
553
+ #
554
+ # @return [Types::CreatePackageImportJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
555
+ #
556
+ # * {Types::CreatePackageImportJobResponse#job_id #job_id} => String
557
+ #
558
+ # @example Request syntax with placeholder values
559
+ #
560
+ # resp = client.create_package_import_job({
561
+ # job_type: "NODE_PACKAGE_VERSION", # required, accepts NODE_PACKAGE_VERSION
562
+ # input_config: { # required
563
+ # package_version_input_config: {
564
+ # s3_location: { # required
565
+ # region: "Region",
566
+ # bucket_name: "BucketName", # required
567
+ # object_key: "ObjectKey", # required
568
+ # },
569
+ # },
570
+ # },
571
+ # output_config: { # required
572
+ # package_version_output_config: {
573
+ # package_name: "NodePackageName", # required
574
+ # package_version: "NodePackageVersion", # required
575
+ # mark_latest: false,
576
+ # },
577
+ # },
578
+ # client_token: "ClientToken", # required
579
+ # job_tags: [
580
+ # {
581
+ # resource_type: "PACKAGE", # required, accepts PACKAGE
582
+ # tags: { # required
583
+ # "TagKey" => "TagValue",
584
+ # },
585
+ # },
586
+ # ],
587
+ # })
588
+ #
589
+ # @example Response structure
590
+ #
591
+ # resp.job_id #=> String
592
+ #
593
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/CreatePackageImportJob AWS API Documentation
594
+ #
595
+ # @overload create_package_import_job(params = {})
596
+ # @param [Hash] params ({})
597
+ def create_package_import_job(params = {}, options = {})
598
+ req = build_request(:create_package_import_job, params)
599
+ req.send_request(options)
600
+ end
601
+
602
+ # Deletes a device.
603
+ #
604
+ # @option params [required, String] :device_id
605
+ # The device's ID.
606
+ #
607
+ # @return [Types::DeleteDeviceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
608
+ #
609
+ # * {Types::DeleteDeviceResponse#device_id #device_id} => String
610
+ #
611
+ # @example Request syntax with placeholder values
612
+ #
613
+ # resp = client.delete_device({
614
+ # device_id: "DeviceId", # required
615
+ # })
616
+ #
617
+ # @example Response structure
618
+ #
619
+ # resp.device_id #=> String
620
+ #
621
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/DeleteDevice AWS API Documentation
622
+ #
623
+ # @overload delete_device(params = {})
624
+ # @param [Hash] params ({})
625
+ def delete_device(params = {}, options = {})
626
+ req = build_request(:delete_device, params)
627
+ req.send_request(options)
628
+ end
629
+
630
+ # Deletes a package.
631
+ #
632
+ # @option params [required, String] :package_id
633
+ # The package's ID.
634
+ #
635
+ # @option params [Boolean] :force_delete
636
+ # Delete the package even if it has artifacts stored in its access
637
+ # point. Deletes the package's artifacts from Amazon S3.
638
+ #
639
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
640
+ #
641
+ # @example Request syntax with placeholder values
642
+ #
643
+ # resp = client.delete_package({
644
+ # package_id: "NodePackageId", # required
645
+ # force_delete: false,
646
+ # })
647
+ #
648
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/DeletePackage AWS API Documentation
649
+ #
650
+ # @overload delete_package(params = {})
651
+ # @param [Hash] params ({})
652
+ def delete_package(params = {}, options = {})
653
+ req = build_request(:delete_package, params)
654
+ req.send_request(options)
655
+ end
656
+
657
+ # Deregisters a package version.
658
+ #
659
+ # @option params [String] :owner_account
660
+ # An owner account.
661
+ #
662
+ # @option params [required, String] :package_id
663
+ # A package ID.
664
+ #
665
+ # @option params [required, String] :package_version
666
+ # A package version.
667
+ #
668
+ # @option params [required, String] :patch_version
669
+ # A patch version.
670
+ #
671
+ # @option params [String] :updated_latest_patch_version
672
+ # If the version was marked latest, the new version to maker as latest.
673
+ #
674
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
675
+ #
676
+ # @example Request syntax with placeholder values
677
+ #
678
+ # resp = client.deregister_package_version({
679
+ # owner_account: "PackageOwnerAccount",
680
+ # package_id: "NodePackageId", # required
681
+ # package_version: "NodePackageVersion", # required
682
+ # patch_version: "NodePackagePatchVersion", # required
683
+ # updated_latest_patch_version: "NodePackagePatchVersion",
684
+ # })
685
+ #
686
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/DeregisterPackageVersion AWS API Documentation
687
+ #
688
+ # @overload deregister_package_version(params = {})
689
+ # @param [Hash] params ({})
690
+ def deregister_package_version(params = {}, options = {})
691
+ req = build_request(:deregister_package_version, params)
692
+ req.send_request(options)
693
+ end
694
+
695
+ # Returns information about an application instance on a device.
696
+ #
697
+ # @option params [required, String] :application_instance_id
698
+ # The application instance's ID.
699
+ #
700
+ # @return [Types::DescribeApplicationInstanceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
701
+ #
702
+ # * {Types::DescribeApplicationInstanceResponse#name #name} => String
703
+ # * {Types::DescribeApplicationInstanceResponse#description #description} => String
704
+ # * {Types::DescribeApplicationInstanceResponse#default_runtime_context_device #default_runtime_context_device} => String
705
+ # * {Types::DescribeApplicationInstanceResponse#default_runtime_context_device_name #default_runtime_context_device_name} => String
706
+ # * {Types::DescribeApplicationInstanceResponse#application_instance_id_to_replace #application_instance_id_to_replace} => String
707
+ # * {Types::DescribeApplicationInstanceResponse#runtime_role_arn #runtime_role_arn} => String
708
+ # * {Types::DescribeApplicationInstanceResponse#status #status} => String
709
+ # * {Types::DescribeApplicationInstanceResponse#health_status #health_status} => String
710
+ # * {Types::DescribeApplicationInstanceResponse#status_description #status_description} => String
711
+ # * {Types::DescribeApplicationInstanceResponse#created_time #created_time} => Time
712
+ # * {Types::DescribeApplicationInstanceResponse#last_updated_time #last_updated_time} => Time
713
+ # * {Types::DescribeApplicationInstanceResponse#application_instance_id #application_instance_id} => String
714
+ # * {Types::DescribeApplicationInstanceResponse#arn #arn} => String
715
+ # * {Types::DescribeApplicationInstanceResponse#tags #tags} => Hash&lt;String,String&gt;
716
+ #
717
+ # @example Request syntax with placeholder values
718
+ #
719
+ # resp = client.describe_application_instance({
720
+ # application_instance_id: "ApplicationInstanceId", # required
721
+ # })
722
+ #
723
+ # @example Response structure
724
+ #
725
+ # resp.name #=> String
726
+ # resp.description #=> String
727
+ # resp.default_runtime_context_device #=> String
728
+ # resp.default_runtime_context_device_name #=> String
729
+ # resp.application_instance_id_to_replace #=> String
730
+ # resp.runtime_role_arn #=> String
731
+ # resp.status #=> String, one of "DEPLOYMENT_PENDING", "DEPLOYMENT_REQUESTED", "DEPLOYMENT_IN_PROGRESS", "DEPLOYMENT_ERROR", "DEPLOYMENT_SUCCEEDED", "REMOVAL_PENDING", "REMOVAL_REQUESTED", "REMOVAL_IN_PROGRESS", "REMOVAL_FAILED", "REMOVAL_SUCCEEDED"
732
+ # resp.health_status #=> String, one of "RUNNING", "ERROR", "NOT_AVAILABLE"
733
+ # resp.status_description #=> String
734
+ # resp.created_time #=> Time
735
+ # resp.last_updated_time #=> Time
736
+ # resp.application_instance_id #=> String
737
+ # resp.arn #=> String
738
+ # resp.tags #=> Hash
739
+ # resp.tags["TagKey"] #=> String
740
+ #
741
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/DescribeApplicationInstance AWS API Documentation
742
+ #
743
+ # @overload describe_application_instance(params = {})
744
+ # @param [Hash] params ({})
745
+ def describe_application_instance(params = {}, options = {})
746
+ req = build_request(:describe_application_instance, params)
747
+ req.send_request(options)
748
+ end
749
+
750
+ # Returns information about an application instance's configuration
751
+ # manifest.
752
+ #
753
+ # @option params [required, String] :application_instance_id
754
+ # The application instance's ID.
755
+ #
756
+ # @return [Types::DescribeApplicationInstanceDetailsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
757
+ #
758
+ # * {Types::DescribeApplicationInstanceDetailsResponse#name #name} => String
759
+ # * {Types::DescribeApplicationInstanceDetailsResponse#description #description} => String
760
+ # * {Types::DescribeApplicationInstanceDetailsResponse#default_runtime_context_device #default_runtime_context_device} => String
761
+ # * {Types::DescribeApplicationInstanceDetailsResponse#manifest_payload #manifest_payload} => Types::ManifestPayload
762
+ # * {Types::DescribeApplicationInstanceDetailsResponse#manifest_overrides_payload #manifest_overrides_payload} => Types::ManifestOverridesPayload
763
+ # * {Types::DescribeApplicationInstanceDetailsResponse#application_instance_id_to_replace #application_instance_id_to_replace} => String
764
+ # * {Types::DescribeApplicationInstanceDetailsResponse#created_time #created_time} => Time
765
+ # * {Types::DescribeApplicationInstanceDetailsResponse#application_instance_id #application_instance_id} => String
766
+ #
767
+ # @example Request syntax with placeholder values
768
+ #
769
+ # resp = client.describe_application_instance_details({
770
+ # application_instance_id: "ApplicationInstanceId", # required
771
+ # })
772
+ #
773
+ # @example Response structure
774
+ #
775
+ # resp.name #=> String
776
+ # resp.description #=> String
777
+ # resp.default_runtime_context_device #=> String
778
+ # resp.manifest_payload.payload_data #=> String
779
+ # resp.manifest_overrides_payload.payload_data #=> String
780
+ # resp.application_instance_id_to_replace #=> String
781
+ # resp.created_time #=> Time
782
+ # resp.application_instance_id #=> String
783
+ #
784
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/DescribeApplicationInstanceDetails AWS API Documentation
785
+ #
786
+ # @overload describe_application_instance_details(params = {})
787
+ # @param [Hash] params ({})
788
+ def describe_application_instance_details(params = {}, options = {})
789
+ req = build_request(:describe_application_instance_details, params)
790
+ req.send_request(options)
791
+ end
792
+
793
+ # Returns information about a device.
794
+ #
795
+ # @option params [required, String] :device_id
796
+ # The device's ID.
797
+ #
798
+ # @return [Types::DescribeDeviceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
799
+ #
800
+ # * {Types::DescribeDeviceResponse#device_id #device_id} => String
801
+ # * {Types::DescribeDeviceResponse#name #name} => String
802
+ # * {Types::DescribeDeviceResponse#arn #arn} => String
803
+ # * {Types::DescribeDeviceResponse#description #description} => String
804
+ # * {Types::DescribeDeviceResponse#type #type} => String
805
+ # * {Types::DescribeDeviceResponse#device_connection_status #device_connection_status} => String
806
+ # * {Types::DescribeDeviceResponse#created_time #created_time} => Time
807
+ # * {Types::DescribeDeviceResponse#provisioning_status #provisioning_status} => String
808
+ # * {Types::DescribeDeviceResponse#latest_software #latest_software} => String
809
+ # * {Types::DescribeDeviceResponse#current_software #current_software} => String
810
+ # * {Types::DescribeDeviceResponse#serial_number #serial_number} => String
811
+ # * {Types::DescribeDeviceResponse#tags #tags} => Hash&lt;String,String&gt;
812
+ # * {Types::DescribeDeviceResponse#networking_configuration #networking_configuration} => Types::NetworkPayload
813
+ # * {Types::DescribeDeviceResponse#current_networking_status #current_networking_status} => Types::NetworkStatus
814
+ # * {Types::DescribeDeviceResponse#lease_expiration_time #lease_expiration_time} => Time
815
+ #
816
+ # @example Request syntax with placeholder values
817
+ #
818
+ # resp = client.describe_device({
819
+ # device_id: "DeviceId", # required
820
+ # })
821
+ #
822
+ # @example Response structure
823
+ #
824
+ # resp.device_id #=> String
825
+ # resp.name #=> String
826
+ # resp.arn #=> String
827
+ # resp.description #=> String
828
+ # resp.type #=> String, one of "PANORAMA_APPLIANCE_DEVELOPER_KIT", "PANORAMA_APPLIANCE"
829
+ # resp.device_connection_status #=> String, one of "ONLINE", "OFFLINE", "AWAITING_CREDENTIALS", "NOT_AVAILABLE", "ERROR"
830
+ # resp.created_time #=> Time
831
+ # resp.provisioning_status #=> String, one of "AWAITING_PROVISIONING", "PENDING", "SUCCEEDED", "FAILED", "ERROR", "DELETING"
832
+ # resp.latest_software #=> String
833
+ # resp.current_software #=> String
834
+ # resp.serial_number #=> String
835
+ # resp.tags #=> Hash
836
+ # resp.tags["TagKey"] #=> String
837
+ # resp.networking_configuration.ethernet_0.connection_type #=> String, one of "STATIC_IP", "DHCP"
838
+ # resp.networking_configuration.ethernet_0.static_ip_connection_info.ip_address #=> String
839
+ # resp.networking_configuration.ethernet_0.static_ip_connection_info.mask #=> String
840
+ # resp.networking_configuration.ethernet_0.static_ip_connection_info.dns #=> Array
841
+ # resp.networking_configuration.ethernet_0.static_ip_connection_info.dns[0] #=> String
842
+ # resp.networking_configuration.ethernet_0.static_ip_connection_info.default_gateway #=> String
843
+ # resp.networking_configuration.ethernet_1.connection_type #=> String, one of "STATIC_IP", "DHCP"
844
+ # resp.networking_configuration.ethernet_1.static_ip_connection_info.ip_address #=> String
845
+ # resp.networking_configuration.ethernet_1.static_ip_connection_info.mask #=> String
846
+ # resp.networking_configuration.ethernet_1.static_ip_connection_info.dns #=> Array
847
+ # resp.networking_configuration.ethernet_1.static_ip_connection_info.dns[0] #=> String
848
+ # resp.networking_configuration.ethernet_1.static_ip_connection_info.default_gateway #=> String
849
+ # resp.current_networking_status.ethernet_0_status.ip_address #=> String
850
+ # resp.current_networking_status.ethernet_0_status.connection_status #=> String, one of "CONNECTED", "NOT_CONNECTED"
851
+ # resp.current_networking_status.ethernet_0_status.hw_address #=> String
852
+ # resp.current_networking_status.ethernet_1_status.ip_address #=> String
853
+ # resp.current_networking_status.ethernet_1_status.connection_status #=> String, one of "CONNECTED", "NOT_CONNECTED"
854
+ # resp.current_networking_status.ethernet_1_status.hw_address #=> String
855
+ # resp.lease_expiration_time #=> Time
856
+ #
857
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/DescribeDevice AWS API Documentation
858
+ #
859
+ # @overload describe_device(params = {})
860
+ # @param [Hash] params ({})
861
+ def describe_device(params = {}, options = {})
862
+ req = build_request(:describe_device, params)
863
+ req.send_request(options)
864
+ end
865
+
866
+ # Returns information about a device job.
867
+ #
868
+ # @option params [required, String] :job_id
869
+ # The job's ID.
870
+ #
871
+ # @return [Types::DescribeDeviceJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
872
+ #
873
+ # * {Types::DescribeDeviceJobResponse#job_id #job_id} => String
874
+ # * {Types::DescribeDeviceJobResponse#device_id #device_id} => String
875
+ # * {Types::DescribeDeviceJobResponse#device_arn #device_arn} => String
876
+ # * {Types::DescribeDeviceJobResponse#device_name #device_name} => String
877
+ # * {Types::DescribeDeviceJobResponse#device_type #device_type} => String
878
+ # * {Types::DescribeDeviceJobResponse#image_version #image_version} => String
879
+ # * {Types::DescribeDeviceJobResponse#status #status} => String
880
+ # * {Types::DescribeDeviceJobResponse#created_time #created_time} => Time
881
+ #
882
+ # @example Request syntax with placeholder values
883
+ #
884
+ # resp = client.describe_device_job({
885
+ # job_id: "JobId", # required
886
+ # })
887
+ #
888
+ # @example Response structure
889
+ #
890
+ # resp.job_id #=> String
891
+ # resp.device_id #=> String
892
+ # resp.device_arn #=> String
893
+ # resp.device_name #=> String
894
+ # resp.device_type #=> String, one of "PANORAMA_APPLIANCE_DEVELOPER_KIT", "PANORAMA_APPLIANCE"
895
+ # resp.image_version #=> String
896
+ # resp.status #=> String, one of "PENDING", "IN_PROGRESS", "VERIFYING", "REBOOTING", "DOWNLOADING", "COMPLETED", "FAILED"
897
+ # resp.created_time #=> Time
898
+ #
899
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/DescribeDeviceJob AWS API Documentation
900
+ #
901
+ # @overload describe_device_job(params = {})
902
+ # @param [Hash] params ({})
903
+ def describe_device_job(params = {}, options = {})
904
+ req = build_request(:describe_device_job, params)
905
+ req.send_request(options)
906
+ end
907
+
908
+ # Returns information about a node.
909
+ #
910
+ # @option params [required, String] :node_id
911
+ # The node's ID.
912
+ #
913
+ # @option params [String] :owner_account
914
+ # The account ID of the node's owner.
915
+ #
916
+ # @return [Types::DescribeNodeResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
917
+ #
918
+ # * {Types::DescribeNodeResponse#node_id #node_id} => String
919
+ # * {Types::DescribeNodeResponse#name #name} => String
920
+ # * {Types::DescribeNodeResponse#category #category} => String
921
+ # * {Types::DescribeNodeResponse#owner_account #owner_account} => String
922
+ # * {Types::DescribeNodeResponse#package_name #package_name} => String
923
+ # * {Types::DescribeNodeResponse#package_id #package_id} => String
924
+ # * {Types::DescribeNodeResponse#package_arn #package_arn} => String
925
+ # * {Types::DescribeNodeResponse#package_version #package_version} => String
926
+ # * {Types::DescribeNodeResponse#patch_version #patch_version} => String
927
+ # * {Types::DescribeNodeResponse#node_interface #node_interface} => Types::NodeInterface
928
+ # * {Types::DescribeNodeResponse#asset_name #asset_name} => String
929
+ # * {Types::DescribeNodeResponse#description #description} => String
930
+ # * {Types::DescribeNodeResponse#created_time #created_time} => Time
931
+ # * {Types::DescribeNodeResponse#last_updated_time #last_updated_time} => Time
932
+ #
933
+ # @example Request syntax with placeholder values
934
+ #
935
+ # resp = client.describe_node({
936
+ # node_id: "NodeId", # required
937
+ # owner_account: "PackageOwnerAccount",
938
+ # })
939
+ #
940
+ # @example Response structure
941
+ #
942
+ # resp.node_id #=> String
943
+ # resp.name #=> String
944
+ # resp.category #=> String, one of "BUSINESS_LOGIC", "ML_MODEL", "MEDIA_SOURCE", "MEDIA_SINK"
945
+ # resp.owner_account #=> String
946
+ # resp.package_name #=> String
947
+ # resp.package_id #=> String
948
+ # resp.package_arn #=> String
949
+ # resp.package_version #=> String
950
+ # resp.patch_version #=> String
951
+ # resp.node_interface.inputs #=> Array
952
+ # resp.node_interface.inputs[0].name #=> String
953
+ # resp.node_interface.inputs[0].description #=> String
954
+ # resp.node_interface.inputs[0].type #=> String, one of "BOOLEAN", "STRING", "INT32", "FLOAT32", "MEDIA"
955
+ # resp.node_interface.inputs[0].default_value #=> String
956
+ # resp.node_interface.inputs[0].max_connections #=> Integer
957
+ # resp.node_interface.outputs #=> Array
958
+ # resp.node_interface.outputs[0].name #=> String
959
+ # resp.node_interface.outputs[0].description #=> String
960
+ # resp.node_interface.outputs[0].type #=> String, one of "BOOLEAN", "STRING", "INT32", "FLOAT32", "MEDIA"
961
+ # resp.asset_name #=> String
962
+ # resp.description #=> String
963
+ # resp.created_time #=> Time
964
+ # resp.last_updated_time #=> Time
965
+ #
966
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/DescribeNode AWS API Documentation
967
+ #
968
+ # @overload describe_node(params = {})
969
+ # @param [Hash] params ({})
970
+ def describe_node(params = {}, options = {})
971
+ req = build_request(:describe_node, params)
972
+ req.send_request(options)
973
+ end
974
+
975
+ # Returns information about a job to create a camera stream node.
976
+ #
977
+ # @option params [required, String] :job_id
978
+ # The job's ID.
979
+ #
980
+ # @return [Types::DescribeNodeFromTemplateJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
981
+ #
982
+ # * {Types::DescribeNodeFromTemplateJobResponse#job_id #job_id} => String
983
+ # * {Types::DescribeNodeFromTemplateJobResponse#status #status} => String
984
+ # * {Types::DescribeNodeFromTemplateJobResponse#status_message #status_message} => String
985
+ # * {Types::DescribeNodeFromTemplateJobResponse#created_time #created_time} => Time
986
+ # * {Types::DescribeNodeFromTemplateJobResponse#last_updated_time #last_updated_time} => Time
987
+ # * {Types::DescribeNodeFromTemplateJobResponse#output_package_name #output_package_name} => String
988
+ # * {Types::DescribeNodeFromTemplateJobResponse#output_package_version #output_package_version} => String
989
+ # * {Types::DescribeNodeFromTemplateJobResponse#node_name #node_name} => String
990
+ # * {Types::DescribeNodeFromTemplateJobResponse#node_description #node_description} => String
991
+ # * {Types::DescribeNodeFromTemplateJobResponse#template_type #template_type} => String
992
+ # * {Types::DescribeNodeFromTemplateJobResponse#template_parameters #template_parameters} => Hash&lt;String,String&gt;
993
+ # * {Types::DescribeNodeFromTemplateJobResponse#job_tags #job_tags} => Array&lt;Types::JobResourceTags&gt;
994
+ #
995
+ # @example Request syntax with placeholder values
996
+ #
997
+ # resp = client.describe_node_from_template_job({
998
+ # job_id: "JobId", # required
999
+ # })
1000
+ #
1001
+ # @example Response structure
1002
+ #
1003
+ # resp.job_id #=> String
1004
+ # resp.status #=> String, one of "PENDING", "SUCCEEDED", "FAILED"
1005
+ # resp.status_message #=> String
1006
+ # resp.created_time #=> Time
1007
+ # resp.last_updated_time #=> Time
1008
+ # resp.output_package_name #=> String
1009
+ # resp.output_package_version #=> String
1010
+ # resp.node_name #=> String
1011
+ # resp.node_description #=> String
1012
+ # resp.template_type #=> String, one of "RTSP_CAMERA_STREAM"
1013
+ # resp.template_parameters #=> Hash
1014
+ # resp.template_parameters["TemplateKey"] #=> String
1015
+ # resp.job_tags #=> Array
1016
+ # resp.job_tags[0].resource_type #=> String, one of "PACKAGE"
1017
+ # resp.job_tags[0].tags #=> Hash
1018
+ # resp.job_tags[0].tags["TagKey"] #=> String
1019
+ #
1020
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/DescribeNodeFromTemplateJob AWS API Documentation
1021
+ #
1022
+ # @overload describe_node_from_template_job(params = {})
1023
+ # @param [Hash] params ({})
1024
+ def describe_node_from_template_job(params = {}, options = {})
1025
+ req = build_request(:describe_node_from_template_job, params)
1026
+ req.send_request(options)
1027
+ end
1028
+
1029
+ # Returns information about a package.
1030
+ #
1031
+ # @option params [required, String] :package_id
1032
+ # The package's ID.
1033
+ #
1034
+ # @return [Types::DescribePackageResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1035
+ #
1036
+ # * {Types::DescribePackageResponse#package_id #package_id} => String
1037
+ # * {Types::DescribePackageResponse#package_name #package_name} => String
1038
+ # * {Types::DescribePackageResponse#arn #arn} => String
1039
+ # * {Types::DescribePackageResponse#storage_location #storage_location} => Types::StorageLocation
1040
+ # * {Types::DescribePackageResponse#read_access_principal_arns #read_access_principal_arns} => Array&lt;String&gt;
1041
+ # * {Types::DescribePackageResponse#write_access_principal_arns #write_access_principal_arns} => Array&lt;String&gt;
1042
+ # * {Types::DescribePackageResponse#created_time #created_time} => Time
1043
+ # * {Types::DescribePackageResponse#tags #tags} => Hash&lt;String,String&gt;
1044
+ #
1045
+ # @example Request syntax with placeholder values
1046
+ #
1047
+ # resp = client.describe_package({
1048
+ # package_id: "NodePackageId", # required
1049
+ # })
1050
+ #
1051
+ # @example Response structure
1052
+ #
1053
+ # resp.package_id #=> String
1054
+ # resp.package_name #=> String
1055
+ # resp.arn #=> String
1056
+ # resp.storage_location.bucket #=> String
1057
+ # resp.storage_location.repo_prefix_location #=> String
1058
+ # resp.storage_location.generated_prefix_location #=> String
1059
+ # resp.storage_location.binary_prefix_location #=> String
1060
+ # resp.storage_location.manifest_prefix_location #=> String
1061
+ # resp.read_access_principal_arns #=> Array
1062
+ # resp.read_access_principal_arns[0] #=> String
1063
+ # resp.write_access_principal_arns #=> Array
1064
+ # resp.write_access_principal_arns[0] #=> String
1065
+ # resp.created_time #=> Time
1066
+ # resp.tags #=> Hash
1067
+ # resp.tags["TagKey"] #=> String
1068
+ #
1069
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/DescribePackage AWS API Documentation
1070
+ #
1071
+ # @overload describe_package(params = {})
1072
+ # @param [Hash] params ({})
1073
+ def describe_package(params = {}, options = {})
1074
+ req = build_request(:describe_package, params)
1075
+ req.send_request(options)
1076
+ end
1077
+
1078
+ # Returns information about a package import job.
1079
+ #
1080
+ # @option params [required, String] :job_id
1081
+ # The job's ID.
1082
+ #
1083
+ # @return [Types::DescribePackageImportJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1084
+ #
1085
+ # * {Types::DescribePackageImportJobResponse#job_id #job_id} => String
1086
+ # * {Types::DescribePackageImportJobResponse#client_token #client_token} => String
1087
+ # * {Types::DescribePackageImportJobResponse#job_type #job_type} => String
1088
+ # * {Types::DescribePackageImportJobResponse#input_config #input_config} => Types::PackageImportJobInputConfig
1089
+ # * {Types::DescribePackageImportJobResponse#output_config #output_config} => Types::PackageImportJobOutputConfig
1090
+ # * {Types::DescribePackageImportJobResponse#output #output} => Types::PackageImportJobOutput
1091
+ # * {Types::DescribePackageImportJobResponse#created_time #created_time} => Time
1092
+ # * {Types::DescribePackageImportJobResponse#last_updated_time #last_updated_time} => Time
1093
+ # * {Types::DescribePackageImportJobResponse#status #status} => String
1094
+ # * {Types::DescribePackageImportJobResponse#status_message #status_message} => String
1095
+ # * {Types::DescribePackageImportJobResponse#job_tags #job_tags} => Array&lt;Types::JobResourceTags&gt;
1096
+ #
1097
+ # @example Request syntax with placeholder values
1098
+ #
1099
+ # resp = client.describe_package_import_job({
1100
+ # job_id: "JobId", # required
1101
+ # })
1102
+ #
1103
+ # @example Response structure
1104
+ #
1105
+ # resp.job_id #=> String
1106
+ # resp.client_token #=> String
1107
+ # resp.job_type #=> String, one of "NODE_PACKAGE_VERSION"
1108
+ # resp.input_config.package_version_input_config.s3_location.region #=> String
1109
+ # resp.input_config.package_version_input_config.s3_location.bucket_name #=> String
1110
+ # resp.input_config.package_version_input_config.s3_location.object_key #=> String
1111
+ # resp.output_config.package_version_output_config.package_name #=> String
1112
+ # resp.output_config.package_version_output_config.package_version #=> String
1113
+ # resp.output_config.package_version_output_config.mark_latest #=> Boolean
1114
+ # resp.output.package_id #=> String
1115
+ # resp.output.package_version #=> String
1116
+ # resp.output.patch_version #=> String
1117
+ # resp.output.output_s3_location.bucket_name #=> String
1118
+ # resp.output.output_s3_location.object_key #=> String
1119
+ # resp.created_time #=> Time
1120
+ # resp.last_updated_time #=> Time
1121
+ # resp.status #=> String, one of "PENDING", "SUCCEEDED", "FAILED"
1122
+ # resp.status_message #=> String
1123
+ # resp.job_tags #=> Array
1124
+ # resp.job_tags[0].resource_type #=> String, one of "PACKAGE"
1125
+ # resp.job_tags[0].tags #=> Hash
1126
+ # resp.job_tags[0].tags["TagKey"] #=> String
1127
+ #
1128
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/DescribePackageImportJob AWS API Documentation
1129
+ #
1130
+ # @overload describe_package_import_job(params = {})
1131
+ # @param [Hash] params ({})
1132
+ def describe_package_import_job(params = {}, options = {})
1133
+ req = build_request(:describe_package_import_job, params)
1134
+ req.send_request(options)
1135
+ end
1136
+
1137
+ # Returns information about a package version.
1138
+ #
1139
+ # @option params [String] :owner_account
1140
+ # The version's owner account.
1141
+ #
1142
+ # @option params [required, String] :package_id
1143
+ # The version's ID.
1144
+ #
1145
+ # @option params [required, String] :package_version
1146
+ # The version's version.
1147
+ #
1148
+ # @option params [String] :patch_version
1149
+ # The version's patch version.
1150
+ #
1151
+ # @return [Types::DescribePackageVersionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1152
+ #
1153
+ # * {Types::DescribePackageVersionResponse#owner_account #owner_account} => String
1154
+ # * {Types::DescribePackageVersionResponse#package_id #package_id} => String
1155
+ # * {Types::DescribePackageVersionResponse#package_arn #package_arn} => String
1156
+ # * {Types::DescribePackageVersionResponse#package_name #package_name} => String
1157
+ # * {Types::DescribePackageVersionResponse#package_version #package_version} => String
1158
+ # * {Types::DescribePackageVersionResponse#patch_version #patch_version} => String
1159
+ # * {Types::DescribePackageVersionResponse#is_latest_patch #is_latest_patch} => Boolean
1160
+ # * {Types::DescribePackageVersionResponse#status #status} => String
1161
+ # * {Types::DescribePackageVersionResponse#status_description #status_description} => String
1162
+ # * {Types::DescribePackageVersionResponse#registered_time #registered_time} => Time
1163
+ #
1164
+ # @example Request syntax with placeholder values
1165
+ #
1166
+ # resp = client.describe_package_version({
1167
+ # owner_account: "PackageOwnerAccount",
1168
+ # package_id: "NodePackageId", # required
1169
+ # package_version: "NodePackageVersion", # required
1170
+ # patch_version: "NodePackagePatchVersion",
1171
+ # })
1172
+ #
1173
+ # @example Response structure
1174
+ #
1175
+ # resp.owner_account #=> String
1176
+ # resp.package_id #=> String
1177
+ # resp.package_arn #=> String
1178
+ # resp.package_name #=> String
1179
+ # resp.package_version #=> String
1180
+ # resp.patch_version #=> String
1181
+ # resp.is_latest_patch #=> Boolean
1182
+ # resp.status #=> String, one of "REGISTER_PENDING", "REGISTER_COMPLETED", "FAILED", "DELETING"
1183
+ # resp.status_description #=> String
1184
+ # resp.registered_time #=> Time
1185
+ #
1186
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/DescribePackageVersion AWS API Documentation
1187
+ #
1188
+ # @overload describe_package_version(params = {})
1189
+ # @param [Hash] params ({})
1190
+ def describe_package_version(params = {}, options = {})
1191
+ req = build_request(:describe_package_version, params)
1192
+ req.send_request(options)
1193
+ end
1194
+
1195
+ # Returns a list of application instance dependencies.
1196
+ #
1197
+ # @option params [required, String] :application_instance_id
1198
+ # The application instance's ID.
1199
+ #
1200
+ # @option params [Integer] :max_results
1201
+ # The maximum number of application instance dependencies to return in
1202
+ # one page of results.
1203
+ #
1204
+ # @option params [String] :next_token
1205
+ # Specify the pagination token from a previous request to retrieve the
1206
+ # next page of results.
1207
+ #
1208
+ # @return [Types::ListApplicationInstanceDependenciesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1209
+ #
1210
+ # * {Types::ListApplicationInstanceDependenciesResponse#package_objects #package_objects} => Array&lt;Types::PackageObject&gt;
1211
+ # * {Types::ListApplicationInstanceDependenciesResponse#next_token #next_token} => String
1212
+ #
1213
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1214
+ #
1215
+ # @example Request syntax with placeholder values
1216
+ #
1217
+ # resp = client.list_application_instance_dependencies({
1218
+ # application_instance_id: "ApplicationInstanceId", # required
1219
+ # max_results: 1,
1220
+ # next_token: "NextToken",
1221
+ # })
1222
+ #
1223
+ # @example Response structure
1224
+ #
1225
+ # resp.package_objects #=> Array
1226
+ # resp.package_objects[0].name #=> String
1227
+ # resp.package_objects[0].package_version #=> String
1228
+ # resp.package_objects[0].patch_version #=> String
1229
+ # resp.next_token #=> String
1230
+ #
1231
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/ListApplicationInstanceDependencies AWS API Documentation
1232
+ #
1233
+ # @overload list_application_instance_dependencies(params = {})
1234
+ # @param [Hash] params ({})
1235
+ def list_application_instance_dependencies(params = {}, options = {})
1236
+ req = build_request(:list_application_instance_dependencies, params)
1237
+ req.send_request(options)
1238
+ end
1239
+
1240
+ # Returns a list of application node instances.
1241
+ #
1242
+ # @option params [required, String] :application_instance_id
1243
+ # The node instances' application instance ID.
1244
+ #
1245
+ # @option params [Integer] :max_results
1246
+ # The maximum number of node instances to return in one page of results.
1247
+ #
1248
+ # @option params [String] :next_token
1249
+ # Specify the pagination token from a previous request to retrieve the
1250
+ # next page of results.
1251
+ #
1252
+ # @return [Types::ListApplicationInstanceNodeInstancesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1253
+ #
1254
+ # * {Types::ListApplicationInstanceNodeInstancesResponse#node_instances #node_instances} => Array&lt;Types::NodeInstance&gt;
1255
+ # * {Types::ListApplicationInstanceNodeInstancesResponse#next_token #next_token} => String
1256
+ #
1257
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1258
+ #
1259
+ # @example Request syntax with placeholder values
1260
+ #
1261
+ # resp = client.list_application_instance_node_instances({
1262
+ # application_instance_id: "ApplicationInstanceId", # required
1263
+ # max_results: 1,
1264
+ # next_token: "NextToken",
1265
+ # })
1266
+ #
1267
+ # @example Response structure
1268
+ #
1269
+ # resp.node_instances #=> Array
1270
+ # resp.node_instances[0].node_instance_id #=> String
1271
+ # resp.node_instances[0].node_id #=> String
1272
+ # resp.node_instances[0].package_name #=> String
1273
+ # resp.node_instances[0].package_version #=> String
1274
+ # resp.node_instances[0].package_patch_version #=> String
1275
+ # resp.node_instances[0].node_name #=> String
1276
+ # resp.node_instances[0].current_status #=> String, one of "RUNNING", "ERROR", "NOT_AVAILABLE"
1277
+ # resp.next_token #=> String
1278
+ #
1279
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/ListApplicationInstanceNodeInstances AWS API Documentation
1280
+ #
1281
+ # @overload list_application_instance_node_instances(params = {})
1282
+ # @param [Hash] params ({})
1283
+ def list_application_instance_node_instances(params = {}, options = {})
1284
+ req = build_request(:list_application_instance_node_instances, params)
1285
+ req.send_request(options)
1286
+ end
1287
+
1288
+ # Returns a list of application instances.
1289
+ #
1290
+ # @option params [String] :device_id
1291
+ # The application instances' device ID.
1292
+ #
1293
+ # @option params [String] :status_filter
1294
+ # Only include instances with a specific status.
1295
+ #
1296
+ # @option params [Integer] :max_results
1297
+ # The maximum number of application instances to return in one page of
1298
+ # results.
1299
+ #
1300
+ # @option params [String] :next_token
1301
+ # Specify the pagination token from a previous request to retrieve the
1302
+ # next page of results.
1303
+ #
1304
+ # @return [Types::ListApplicationInstancesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1305
+ #
1306
+ # * {Types::ListApplicationInstancesResponse#application_instances #application_instances} => Array&lt;Types::ApplicationInstance&gt;
1307
+ # * {Types::ListApplicationInstancesResponse#next_token #next_token} => String
1308
+ #
1309
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1310
+ #
1311
+ # @example Request syntax with placeholder values
1312
+ #
1313
+ # resp = client.list_application_instances({
1314
+ # device_id: "DeviceId",
1315
+ # status_filter: "DEPLOYMENT_SUCCEEDED", # accepts DEPLOYMENT_SUCCEEDED, DEPLOYMENT_ERROR, REMOVAL_SUCCEEDED, REMOVAL_FAILED, PROCESSING_DEPLOYMENT, PROCESSING_REMOVAL
1316
+ # max_results: 1,
1317
+ # next_token: "NextToken",
1318
+ # })
1319
+ #
1320
+ # @example Response structure
1321
+ #
1322
+ # resp.application_instances #=> Array
1323
+ # resp.application_instances[0].name #=> String
1324
+ # resp.application_instances[0].application_instance_id #=> String
1325
+ # resp.application_instances[0].default_runtime_context_device #=> String
1326
+ # resp.application_instances[0].default_runtime_context_device_name #=> String
1327
+ # resp.application_instances[0].description #=> String
1328
+ # resp.application_instances[0].status #=> String, one of "DEPLOYMENT_PENDING", "DEPLOYMENT_REQUESTED", "DEPLOYMENT_IN_PROGRESS", "DEPLOYMENT_ERROR", "DEPLOYMENT_SUCCEEDED", "REMOVAL_PENDING", "REMOVAL_REQUESTED", "REMOVAL_IN_PROGRESS", "REMOVAL_FAILED", "REMOVAL_SUCCEEDED"
1329
+ # resp.application_instances[0].health_status #=> String, one of "RUNNING", "ERROR", "NOT_AVAILABLE"
1330
+ # resp.application_instances[0].status_description #=> String
1331
+ # resp.application_instances[0].created_time #=> Time
1332
+ # resp.application_instances[0].arn #=> String
1333
+ # resp.application_instances[0].tags #=> Hash
1334
+ # resp.application_instances[0].tags["TagKey"] #=> String
1335
+ # resp.next_token #=> String
1336
+ #
1337
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/ListApplicationInstances AWS API Documentation
1338
+ #
1339
+ # @overload list_application_instances(params = {})
1340
+ # @param [Hash] params ({})
1341
+ def list_application_instances(params = {}, options = {})
1342
+ req = build_request(:list_application_instances, params)
1343
+ req.send_request(options)
1344
+ end
1345
+
1346
+ # Returns a list of devices.
1347
+ #
1348
+ # @option params [String] :next_token
1349
+ # Specify the pagination token from a previous request to retrieve the
1350
+ # next page of results.
1351
+ #
1352
+ # @option params [Integer] :max_results
1353
+ # The maximum number of devices to return in one page of results.
1354
+ #
1355
+ # @return [Types::ListDevicesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1356
+ #
1357
+ # * {Types::ListDevicesResponse#devices #devices} => Array&lt;Types::Device&gt;
1358
+ # * {Types::ListDevicesResponse#next_token #next_token} => String
1359
+ #
1360
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1361
+ #
1362
+ # @example Request syntax with placeholder values
1363
+ #
1364
+ # resp = client.list_devices({
1365
+ # next_token: "NextToken",
1366
+ # max_results: 1,
1367
+ # })
1368
+ #
1369
+ # @example Response structure
1370
+ #
1371
+ # resp.devices #=> Array
1372
+ # resp.devices[0].device_id #=> String
1373
+ # resp.devices[0].name #=> String
1374
+ # resp.devices[0].created_time #=> Time
1375
+ # resp.devices[0].provisioning_status #=> String, one of "AWAITING_PROVISIONING", "PENDING", "SUCCEEDED", "FAILED", "ERROR", "DELETING"
1376
+ # resp.devices[0].last_updated_time #=> Time
1377
+ # resp.devices[0].lease_expiration_time #=> Time
1378
+ # resp.next_token #=> String
1379
+ #
1380
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/ListDevices AWS API Documentation
1381
+ #
1382
+ # @overload list_devices(params = {})
1383
+ # @param [Hash] params ({})
1384
+ def list_devices(params = {}, options = {})
1385
+ req = build_request(:list_devices, params)
1386
+ req.send_request(options)
1387
+ end
1388
+
1389
+ # Returns a list of jobs.
1390
+ #
1391
+ # @option params [String] :device_id
1392
+ # Filter results by the job's target device ID.
1393
+ #
1394
+ # @option params [String] :next_token
1395
+ # Specify the pagination token from a previous request to retrieve the
1396
+ # next page of results.
1397
+ #
1398
+ # @option params [Integer] :max_results
1399
+ # The maximum number of device jobs to return in one page of results.
1400
+ #
1401
+ # @return [Types::ListDevicesJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1402
+ #
1403
+ # * {Types::ListDevicesJobsResponse#device_jobs #device_jobs} => Array&lt;Types::DeviceJob&gt;
1404
+ # * {Types::ListDevicesJobsResponse#next_token #next_token} => String
1405
+ #
1406
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1407
+ #
1408
+ # @example Request syntax with placeholder values
1409
+ #
1410
+ # resp = client.list_devices_jobs({
1411
+ # device_id: "DeviceId",
1412
+ # next_token: "NextToken",
1413
+ # max_results: 1,
1414
+ # })
1415
+ #
1416
+ # @example Response structure
1417
+ #
1418
+ # resp.device_jobs #=> Array
1419
+ # resp.device_jobs[0].device_name #=> String
1420
+ # resp.device_jobs[0].device_id #=> String
1421
+ # resp.device_jobs[0].job_id #=> String
1422
+ # resp.device_jobs[0].created_time #=> Time
1423
+ # resp.next_token #=> String
1424
+ #
1425
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/ListDevicesJobs AWS API Documentation
1426
+ #
1427
+ # @overload list_devices_jobs(params = {})
1428
+ # @param [Hash] params ({})
1429
+ def list_devices_jobs(params = {}, options = {})
1430
+ req = build_request(:list_devices_jobs, params)
1431
+ req.send_request(options)
1432
+ end
1433
+
1434
+ # Returns a list of camera stream node jobs.
1435
+ #
1436
+ # @option params [String] :next_token
1437
+ # Specify the pagination token from a previous request to retrieve the
1438
+ # next page of results.
1439
+ #
1440
+ # @option params [Integer] :max_results
1441
+ # The maximum number of node from template jobs to return in one page of
1442
+ # results.
1443
+ #
1444
+ # @return [Types::ListNodeFromTemplateJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1445
+ #
1446
+ # * {Types::ListNodeFromTemplateJobsResponse#node_from_template_jobs #node_from_template_jobs} => Array&lt;Types::NodeFromTemplateJob&gt;
1447
+ # * {Types::ListNodeFromTemplateJobsResponse#next_token #next_token} => String
1448
+ #
1449
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1450
+ #
1451
+ # @example Request syntax with placeholder values
1452
+ #
1453
+ # resp = client.list_node_from_template_jobs({
1454
+ # next_token: "NextToken",
1455
+ # max_results: 1,
1456
+ # })
1457
+ #
1458
+ # @example Response structure
1459
+ #
1460
+ # resp.node_from_template_jobs #=> Array
1461
+ # resp.node_from_template_jobs[0].job_id #=> String
1462
+ # resp.node_from_template_jobs[0].template_type #=> String, one of "RTSP_CAMERA_STREAM"
1463
+ # resp.node_from_template_jobs[0].status #=> String, one of "PENDING", "SUCCEEDED", "FAILED"
1464
+ # resp.node_from_template_jobs[0].status_message #=> String
1465
+ # resp.node_from_template_jobs[0].created_time #=> Time
1466
+ # resp.node_from_template_jobs[0].node_name #=> String
1467
+ # resp.next_token #=> String
1468
+ #
1469
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/ListNodeFromTemplateJobs AWS API Documentation
1470
+ #
1471
+ # @overload list_node_from_template_jobs(params = {})
1472
+ # @param [Hash] params ({})
1473
+ def list_node_from_template_jobs(params = {}, options = {})
1474
+ req = build_request(:list_node_from_template_jobs, params)
1475
+ req.send_request(options)
1476
+ end
1477
+
1478
+ # Returns a list of nodes.
1479
+ #
1480
+ # @option params [String] :category
1481
+ # Search for nodes by category.
1482
+ #
1483
+ # @option params [String] :owner_account
1484
+ # Search for nodes by the account ID of the nodes' owner.
1485
+ #
1486
+ # @option params [String] :package_name
1487
+ # Search for nodes by name.
1488
+ #
1489
+ # @option params [String] :package_version
1490
+ # Search for nodes by version.
1491
+ #
1492
+ # @option params [String] :patch_version
1493
+ # Search for nodes by patch version.
1494
+ #
1495
+ # @option params [String] :next_token
1496
+ # Specify the pagination token from a previous request to retrieve the
1497
+ # next page of results.
1498
+ #
1499
+ # @option params [Integer] :max_results
1500
+ # The maximum number of nodes to return in one page of results.
1501
+ #
1502
+ # @return [Types::ListNodesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1503
+ #
1504
+ # * {Types::ListNodesResponse#nodes #nodes} => Array&lt;Types::Node&gt;
1505
+ # * {Types::ListNodesResponse#next_token #next_token} => String
1506
+ #
1507
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1508
+ #
1509
+ # @example Request syntax with placeholder values
1510
+ #
1511
+ # resp = client.list_nodes({
1512
+ # category: "BUSINESS_LOGIC", # accepts BUSINESS_LOGIC, ML_MODEL, MEDIA_SOURCE, MEDIA_SINK
1513
+ # owner_account: "PackageOwnerAccount",
1514
+ # package_name: "NodePackageName",
1515
+ # package_version: "NodePackageVersion",
1516
+ # patch_version: "NodePackagePatchVersion",
1517
+ # next_token: "Token",
1518
+ # max_results: 1,
1519
+ # })
1520
+ #
1521
+ # @example Response structure
1522
+ #
1523
+ # resp.nodes #=> Array
1524
+ # resp.nodes[0].node_id #=> String
1525
+ # resp.nodes[0].name #=> String
1526
+ # resp.nodes[0].category #=> String, one of "BUSINESS_LOGIC", "ML_MODEL", "MEDIA_SOURCE", "MEDIA_SINK"
1527
+ # resp.nodes[0].owner_account #=> String
1528
+ # resp.nodes[0].package_name #=> String
1529
+ # resp.nodes[0].package_id #=> String
1530
+ # resp.nodes[0].package_arn #=> String
1531
+ # resp.nodes[0].package_version #=> String
1532
+ # resp.nodes[0].patch_version #=> String
1533
+ # resp.nodes[0].description #=> String
1534
+ # resp.nodes[0].created_time #=> Time
1535
+ # resp.next_token #=> String
1536
+ #
1537
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/ListNodes AWS API Documentation
1538
+ #
1539
+ # @overload list_nodes(params = {})
1540
+ # @param [Hash] params ({})
1541
+ def list_nodes(params = {}, options = {})
1542
+ req = build_request(:list_nodes, params)
1543
+ req.send_request(options)
1544
+ end
1545
+
1546
+ # Returns a list of package import jobs.
1547
+ #
1548
+ # @option params [String] :next_token
1549
+ # Specify the pagination token from a previous request to retrieve the
1550
+ # next page of results.
1551
+ #
1552
+ # @option params [Integer] :max_results
1553
+ # The maximum number of package import jobs to return in one page of
1554
+ # results.
1555
+ #
1556
+ # @return [Types::ListPackageImportJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1557
+ #
1558
+ # * {Types::ListPackageImportJobsResponse#package_import_jobs #package_import_jobs} => Array&lt;Types::PackageImportJob&gt;
1559
+ # * {Types::ListPackageImportJobsResponse#next_token #next_token} => String
1560
+ #
1561
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1562
+ #
1563
+ # @example Request syntax with placeholder values
1564
+ #
1565
+ # resp = client.list_package_import_jobs({
1566
+ # next_token: "NextToken",
1567
+ # max_results: 1,
1568
+ # })
1569
+ #
1570
+ # @example Response structure
1571
+ #
1572
+ # resp.package_import_jobs #=> Array
1573
+ # resp.package_import_jobs[0].job_id #=> String
1574
+ # resp.package_import_jobs[0].job_type #=> String, one of "NODE_PACKAGE_VERSION"
1575
+ # resp.package_import_jobs[0].status #=> String, one of "PENDING", "SUCCEEDED", "FAILED"
1576
+ # resp.package_import_jobs[0].status_message #=> String
1577
+ # resp.package_import_jobs[0].created_time #=> Time
1578
+ # resp.package_import_jobs[0].last_updated_time #=> Time
1579
+ # resp.next_token #=> String
1580
+ #
1581
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/ListPackageImportJobs AWS API Documentation
1582
+ #
1583
+ # @overload list_package_import_jobs(params = {})
1584
+ # @param [Hash] params ({})
1585
+ def list_package_import_jobs(params = {}, options = {})
1586
+ req = build_request(:list_package_import_jobs, params)
1587
+ req.send_request(options)
1588
+ end
1589
+
1590
+ # Returns a list of packages.
1591
+ #
1592
+ # @option params [Integer] :max_results
1593
+ # The maximum number of packages to return in one page of results.
1594
+ #
1595
+ # @option params [String] :next_token
1596
+ # Specify the pagination token from a previous request to retrieve the
1597
+ # next page of results.
1598
+ #
1599
+ # @return [Types::ListPackagesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1600
+ #
1601
+ # * {Types::ListPackagesResponse#packages #packages} => Array&lt;Types::PackageListItem&gt;
1602
+ # * {Types::ListPackagesResponse#next_token #next_token} => String
1603
+ #
1604
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1605
+ #
1606
+ # @example Request syntax with placeholder values
1607
+ #
1608
+ # resp = client.list_packages({
1609
+ # max_results: 1,
1610
+ # next_token: "Token",
1611
+ # })
1612
+ #
1613
+ # @example Response structure
1614
+ #
1615
+ # resp.packages #=> Array
1616
+ # resp.packages[0].package_id #=> String
1617
+ # resp.packages[0].package_name #=> String
1618
+ # resp.packages[0].arn #=> String
1619
+ # resp.packages[0].created_time #=> Time
1620
+ # resp.packages[0].tags #=> Hash
1621
+ # resp.packages[0].tags["TagKey"] #=> String
1622
+ # resp.next_token #=> String
1623
+ #
1624
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/ListPackages AWS API Documentation
1625
+ #
1626
+ # @overload list_packages(params = {})
1627
+ # @param [Hash] params ({})
1628
+ def list_packages(params = {}, options = {})
1629
+ req = build_request(:list_packages, params)
1630
+ req.send_request(options)
1631
+ end
1632
+
1633
+ # Returns a list of tags for a resource.
1634
+ #
1635
+ # @option params [required, String] :resource_arn
1636
+ # The resource's ARN.
1637
+ #
1638
+ # @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1639
+ #
1640
+ # * {Types::ListTagsForResourceResponse#tags #tags} => Hash&lt;String,String&gt;
1641
+ #
1642
+ # @example Request syntax with placeholder values
1643
+ #
1644
+ # resp = client.list_tags_for_resource({
1645
+ # resource_arn: "ResourceArn", # required
1646
+ # })
1647
+ #
1648
+ # @example Response structure
1649
+ #
1650
+ # resp.tags #=> Hash
1651
+ # resp.tags["TagKey"] #=> String
1652
+ #
1653
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/ListTagsForResource AWS API Documentation
1654
+ #
1655
+ # @overload list_tags_for_resource(params = {})
1656
+ # @param [Hash] params ({})
1657
+ def list_tags_for_resource(params = {}, options = {})
1658
+ req = build_request(:list_tags_for_resource, params)
1659
+ req.send_request(options)
1660
+ end
1661
+
1662
+ # Creates a device and returns a configuration archive. The
1663
+ # configuration archive is a ZIP file that contains a provisioning
1664
+ # certificate that is valid for 5 minutes. Transfer the configuration
1665
+ # archive to the device with the included USB storage device within 5
1666
+ # minutes.
1667
+ #
1668
+ # @option params [required, String] :name
1669
+ # A name for the device.
1670
+ #
1671
+ # @option params [String] :description
1672
+ # A description for the device.
1673
+ #
1674
+ # @option params [Hash<String,String>] :tags
1675
+ # Tags for the device.
1676
+ #
1677
+ # @option params [Types::NetworkPayload] :networking_configuration
1678
+ # A networking configuration for the device.
1679
+ #
1680
+ # @return [Types::ProvisionDeviceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1681
+ #
1682
+ # * {Types::ProvisionDeviceResponse#device_id #device_id} => String
1683
+ # * {Types::ProvisionDeviceResponse#arn #arn} => String
1684
+ # * {Types::ProvisionDeviceResponse#status #status} => String
1685
+ # * {Types::ProvisionDeviceResponse#certificates #certificates} => String
1686
+ # * {Types::ProvisionDeviceResponse#iot_thing_name #iot_thing_name} => String
1687
+ #
1688
+ # @example Request syntax with placeholder values
1689
+ #
1690
+ # resp = client.provision_device({
1691
+ # name: "DeviceName", # required
1692
+ # description: "Description",
1693
+ # tags: {
1694
+ # "TagKey" => "TagValue",
1695
+ # },
1696
+ # networking_configuration: {
1697
+ # ethernet_0: {
1698
+ # connection_type: "STATIC_IP", # required, accepts STATIC_IP, DHCP
1699
+ # static_ip_connection_info: {
1700
+ # ip_address: "IpAddress", # required
1701
+ # mask: "Mask", # required
1702
+ # dns: ["Dns"], # required
1703
+ # default_gateway: "DefaultGateway", # required
1704
+ # },
1705
+ # },
1706
+ # ethernet_1: {
1707
+ # connection_type: "STATIC_IP", # required, accepts STATIC_IP, DHCP
1708
+ # static_ip_connection_info: {
1709
+ # ip_address: "IpAddress", # required
1710
+ # mask: "Mask", # required
1711
+ # dns: ["Dns"], # required
1712
+ # default_gateway: "DefaultGateway", # required
1713
+ # },
1714
+ # },
1715
+ # },
1716
+ # })
1717
+ #
1718
+ # @example Response structure
1719
+ #
1720
+ # resp.device_id #=> String
1721
+ # resp.arn #=> String
1722
+ # resp.status #=> String, one of "AWAITING_PROVISIONING", "PENDING", "SUCCEEDED", "FAILED", "ERROR", "DELETING"
1723
+ # resp.certificates #=> String
1724
+ # resp.iot_thing_name #=> String
1725
+ #
1726
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/ProvisionDevice AWS API Documentation
1727
+ #
1728
+ # @overload provision_device(params = {})
1729
+ # @param [Hash] params ({})
1730
+ def provision_device(params = {}, options = {})
1731
+ req = build_request(:provision_device, params)
1732
+ req.send_request(options)
1733
+ end
1734
+
1735
+ # Registers a package version.
1736
+ #
1737
+ # @option params [String] :owner_account
1738
+ # An owner account.
1739
+ #
1740
+ # @option params [required, String] :package_id
1741
+ # A package ID.
1742
+ #
1743
+ # @option params [required, String] :package_version
1744
+ # A package version.
1745
+ #
1746
+ # @option params [required, String] :patch_version
1747
+ # A patch version.
1748
+ #
1749
+ # @option params [Boolean] :mark_latest
1750
+ # Whether to mark the new version as the latest version.
1751
+ #
1752
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1753
+ #
1754
+ # @example Request syntax with placeholder values
1755
+ #
1756
+ # resp = client.register_package_version({
1757
+ # owner_account: "PackageOwnerAccount",
1758
+ # package_id: "NodePackageId", # required
1759
+ # package_version: "NodePackageVersion", # required
1760
+ # patch_version: "NodePackagePatchVersion", # required
1761
+ # mark_latest: false,
1762
+ # })
1763
+ #
1764
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/RegisterPackageVersion AWS API Documentation
1765
+ #
1766
+ # @overload register_package_version(params = {})
1767
+ # @param [Hash] params ({})
1768
+ def register_package_version(params = {}, options = {})
1769
+ req = build_request(:register_package_version, params)
1770
+ req.send_request(options)
1771
+ end
1772
+
1773
+ # Removes an application instance.
1774
+ #
1775
+ # @option params [required, String] :application_instance_id
1776
+ # An application instance ID.
1777
+ #
1778
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1779
+ #
1780
+ # @example Request syntax with placeholder values
1781
+ #
1782
+ # resp = client.remove_application_instance({
1783
+ # application_instance_id: "ApplicationInstanceId", # required
1784
+ # })
1785
+ #
1786
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/RemoveApplicationInstance AWS API Documentation
1787
+ #
1788
+ # @overload remove_application_instance(params = {})
1789
+ # @param [Hash] params ({})
1790
+ def remove_application_instance(params = {}, options = {})
1791
+ req = build_request(:remove_application_instance, params)
1792
+ req.send_request(options)
1793
+ end
1794
+
1795
+ # Tags a resource.
1796
+ #
1797
+ # @option params [required, String] :resource_arn
1798
+ # The resource's ARN.
1799
+ #
1800
+ # @option params [required, Hash<String,String>] :tags
1801
+ # Tags for the resource.
1802
+ #
1803
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1804
+ #
1805
+ # @example Request syntax with placeholder values
1806
+ #
1807
+ # resp = client.tag_resource({
1808
+ # resource_arn: "ResourceArn", # required
1809
+ # tags: { # required
1810
+ # "TagKey" => "TagValue",
1811
+ # },
1812
+ # })
1813
+ #
1814
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/TagResource AWS API Documentation
1815
+ #
1816
+ # @overload tag_resource(params = {})
1817
+ # @param [Hash] params ({})
1818
+ def tag_resource(params = {}, options = {})
1819
+ req = build_request(:tag_resource, params)
1820
+ req.send_request(options)
1821
+ end
1822
+
1823
+ # Removes tags from a resource.
1824
+ #
1825
+ # @option params [required, String] :resource_arn
1826
+ # The resource's ARN.
1827
+ #
1828
+ # @option params [required, Array<String>] :tag_keys
1829
+ # Tag keys to remove.
1830
+ #
1831
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1832
+ #
1833
+ # @example Request syntax with placeholder values
1834
+ #
1835
+ # resp = client.untag_resource({
1836
+ # resource_arn: "ResourceArn", # required
1837
+ # tag_keys: ["TagKey"], # required
1838
+ # })
1839
+ #
1840
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/UntagResource AWS API Documentation
1841
+ #
1842
+ # @overload untag_resource(params = {})
1843
+ # @param [Hash] params ({})
1844
+ def untag_resource(params = {}, options = {})
1845
+ req = build_request(:untag_resource, params)
1846
+ req.send_request(options)
1847
+ end
1848
+
1849
+ # Updates a device's metadata.
1850
+ #
1851
+ # @option params [required, String] :device_id
1852
+ # The device's ID.
1853
+ #
1854
+ # @option params [String] :description
1855
+ # A description for the device.
1856
+ #
1857
+ # @return [Types::UpdateDeviceMetadataResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1858
+ #
1859
+ # * {Types::UpdateDeviceMetadataResponse#device_id #device_id} => String
1860
+ #
1861
+ # @example Request syntax with placeholder values
1862
+ #
1863
+ # resp = client.update_device_metadata({
1864
+ # device_id: "DeviceId", # required
1865
+ # description: "Description",
1866
+ # })
1867
+ #
1868
+ # @example Response structure
1869
+ #
1870
+ # resp.device_id #=> String
1871
+ #
1872
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/UpdateDeviceMetadata AWS API Documentation
1873
+ #
1874
+ # @overload update_device_metadata(params = {})
1875
+ # @param [Hash] params ({})
1876
+ def update_device_metadata(params = {}, options = {})
1877
+ req = build_request(:update_device_metadata, params)
1878
+ req.send_request(options)
1879
+ end
1880
+
1881
+ # @!endgroup
1882
+
1883
+ # @param params ({})
1884
+ # @api private
1885
+ def build_request(operation_name, params = {})
1886
+ handlers = @handlers.for(operation_name)
1887
+ context = Seahorse::Client::RequestContext.new(
1888
+ operation_name: operation_name,
1889
+ operation: config.api.operation(operation_name),
1890
+ client: self,
1891
+ params: params,
1892
+ config: config)
1893
+ context[:gem_name] = 'aws-sdk-panorama'
1894
+ context[:gem_version] = '1.0.0'
1895
+ Seahorse::Client::Request.new(handlers, context)
1896
+ end
1897
+
1898
+ # @api private
1899
+ # @deprecated
1900
+ def waiter_names
1901
+ []
1902
+ end
1903
+
1904
+ class << self
1905
+
1906
+ # @api private
1907
+ attr_reader :identifier
1908
+
1909
+ # @api private
1910
+ def errors_module
1911
+ Errors
1912
+ end
1913
+
1914
+ end
1915
+ end
1916
+ end