Class: Aws::Panorama::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::Panorama::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb
Overview
An API client for Panorama. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::Panorama::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#create_application_instance(params = {}) ⇒ Types::CreateApplicationInstanceResponse
Creates an application instance and deploys it to a device.
-
#create_job_for_devices(params = {}) ⇒ Types::CreateJobForDevicesResponse
Creates a job to run on a device.
-
#create_node_from_template_job(params = {}) ⇒ Types::CreateNodeFromTemplateJobResponse
Creates a camera stream node.
-
#create_package(params = {}) ⇒ Types::CreatePackageResponse
Creates a package and storage location in an Amazon S3 access point.
-
#create_package_import_job(params = {}) ⇒ Types::CreatePackageImportJobResponse
Imports a node package.
-
#delete_device(params = {}) ⇒ Types::DeleteDeviceResponse
Deletes a device.
-
#delete_package(params = {}) ⇒ Struct
Deletes a package.
-
#deregister_package_version(params = {}) ⇒ Struct
Deregisters a package version.
-
#describe_application_instance(params = {}) ⇒ Types::DescribeApplicationInstanceResponse
Returns information about an application instance on a device.
-
#describe_application_instance_details(params = {}) ⇒ Types::DescribeApplicationInstanceDetailsResponse
Returns information about an application instance's configuration manifest.
-
#describe_device(params = {}) ⇒ Types::DescribeDeviceResponse
Returns information about a device.
-
#describe_device_job(params = {}) ⇒ Types::DescribeDeviceJobResponse
Returns information about a device job.
-
#describe_node(params = {}) ⇒ Types::DescribeNodeResponse
Returns information about a node.
-
#describe_node_from_template_job(params = {}) ⇒ Types::DescribeNodeFromTemplateJobResponse
Returns information about a job to create a camera stream node.
-
#describe_package(params = {}) ⇒ Types::DescribePackageResponse
Returns information about a package.
-
#describe_package_import_job(params = {}) ⇒ Types::DescribePackageImportJobResponse
Returns information about a package import job.
-
#describe_package_version(params = {}) ⇒ Types::DescribePackageVersionResponse
Returns information about a package version.
-
#list_application_instance_dependencies(params = {}) ⇒ Types::ListApplicationInstanceDependenciesResponse
Returns a list of application instance dependencies.
-
#list_application_instance_node_instances(params = {}) ⇒ Types::ListApplicationInstanceNodeInstancesResponse
Returns a list of application node instances.
-
#list_application_instances(params = {}) ⇒ Types::ListApplicationInstancesResponse
Returns a list of application instances.
-
#list_devices(params = {}) ⇒ Types::ListDevicesResponse
Returns a list of devices.
-
#list_devices_jobs(params = {}) ⇒ Types::ListDevicesJobsResponse
Returns a list of jobs.
-
#list_node_from_template_jobs(params = {}) ⇒ Types::ListNodeFromTemplateJobsResponse
Returns a list of camera stream node jobs.
-
#list_nodes(params = {}) ⇒ Types::ListNodesResponse
Returns a list of nodes.
-
#list_package_import_jobs(params = {}) ⇒ Types::ListPackageImportJobsResponse
Returns a list of package import jobs.
-
#list_packages(params = {}) ⇒ Types::ListPackagesResponse
Returns a list of packages.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Returns a list of tags for a resource.
-
#provision_device(params = {}) ⇒ Types::ProvisionDeviceResponse
Creates a device and returns a configuration archive.
-
#register_package_version(params = {}) ⇒ Struct
Registers a package version.
-
#remove_application_instance(params = {}) ⇒ Struct
Removes an application instance.
-
#signal_application_instance_node_instances(params = {}) ⇒ Types::SignalApplicationInstanceNodeInstancesResponse
Signal camera nodes to stop or resume.
-
#tag_resource(params = {}) ⇒ Struct
Tags a resource.
-
#untag_resource(params = {}) ⇒ Struct
Removes tags from a resource.
-
#update_device_metadata(params = {}) ⇒ Types::UpdateDeviceMetadataResponse
Updates a device's metadata.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
422 423 424 |
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 422 def initialize(*args) super end |
Instance Method Details
#create_application_instance(params = {}) ⇒ Types::CreateApplicationInstanceResponse
Creates an application instance and deploys it to a device.
485 486 487 488 |
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 485 def create_application_instance(params = {}, = {}) req = build_request(:create_application_instance, params) req.send_request() end |
#create_job_for_devices(params = {}) ⇒ Types::CreateJobForDevicesResponse
Creates a job to run on a device. A job can update a device's software or reboot it.
529 530 531 532 |
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 529 def create_job_for_devices(params = {}, = {}) req = build_request(:create_job_for_devices, params) req.send_request() end |
#create_node_from_template_job(params = {}) ⇒ Types::CreateNodeFromTemplateJobResponse
Creates a camera stream node.
590 591 592 593 |
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 590 def create_node_from_template_job(params = {}, = {}) req = build_request(:create_node_from_template_job, params) req.send_request() end |
#create_package(params = {}) ⇒ Types::CreatePackageResponse
Creates a package and storage location in an Amazon S3 access point.
632 633 634 635 |
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 632 def create_package(params = {}, = {}) req = build_request(:create_package, params) req.send_request() end |
#create_package_import_job(params = {}) ⇒ Types::CreatePackageImportJobResponse
Imports a node package.
697 698 699 700 |
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 697 def create_package_import_job(params = {}, = {}) req = build_request(:create_package_import_job, params) req.send_request() end |
#delete_device(params = {}) ⇒ Types::DeleteDeviceResponse
Deletes a device.
725 726 727 728 |
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 725 def delete_device(params = {}, = {}) req = build_request(:delete_device, params) req.send_request() end |
#delete_package(params = {}) ⇒ Struct
Deletes a package.
s3:DeleteObject
in
addition to permissions for the AWS Panorama API.
757 758 759 760 |
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 757 def delete_package(params = {}, = {}) req = build_request(:delete_package, params) req.send_request() end |
#deregister_package_version(params = {}) ⇒ Struct
Deregisters a package version.
795 796 797 798 |
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 795 def deregister_package_version(params = {}, = {}) req = build_request(:deregister_package_version, params) req.send_request() end |
#describe_application_instance(params = {}) ⇒ Types::DescribeApplicationInstanceResponse
Returns information about an application instance on a device.
856 857 858 859 |
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 856 def describe_application_instance(params = {}, = {}) req = build_request(:describe_application_instance, params) req.send_request() end |
#describe_application_instance_details(params = {}) ⇒ Types::DescribeApplicationInstanceDetailsResponse
Returns information about an application instance's configuration manifest.
899 900 901 902 |
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 899 def describe_application_instance_details(params = {}, = {}) req = build_request(:describe_application_instance_details, params) req.send_request() end |
#describe_device(params = {}) ⇒ Types::DescribeDeviceResponse
Returns information about a device.
991 992 993 994 |
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 991 def describe_device(params = {}, = {}) req = build_request(:describe_device, params) req.send_request() end |
#describe_device_job(params = {}) ⇒ Types::DescribeDeviceJobResponse
Returns information about a device job.
1035 1036 1037 1038 |
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 1035 def describe_device_job(params = {}, = {}) req = build_request(:describe_device_job, params) req.send_request() end |
#describe_node(params = {}) ⇒ Types::DescribeNodeResponse
Returns information about a node.
1102 1103 1104 1105 |
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 1102 def describe_node(params = {}, = {}) req = build_request(:describe_node, params) req.send_request() end |
#describe_node_from_template_job(params = {}) ⇒ Types::DescribeNodeFromTemplateJobResponse
Returns information about a job to create a camera stream node.
1156 1157 1158 1159 |
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 1156 def describe_node_from_template_job(params = {}, = {}) req = build_request(:describe_node_from_template_job, params) req.send_request() end |
#describe_package(params = {}) ⇒ Types::DescribePackageResponse
Returns information about a package.
1205 1206 1207 1208 |
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 1205 def describe_package(params = {}, = {}) req = build_request(:describe_package, params) req.send_request() end |
#describe_package_import_job(params = {}) ⇒ Types::DescribePackageImportJobResponse
Returns information about a package import job.
1264 1265 1266 1267 |
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 1264 def describe_package_import_job(params = {}, = {}) req = build_request(:describe_package_import_job, params) req.send_request() end |
#describe_package_version(params = {}) ⇒ Types::DescribePackageVersionResponse
Returns information about a package version.
1322 1323 1324 1325 |
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 1322 def describe_package_version(params = {}, = {}) req = build_request(:describe_package_version, params) req.send_request() end |
#list_application_instance_dependencies(params = {}) ⇒ Types::ListApplicationInstanceDependenciesResponse
Returns a list of application instance dependencies.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1367 1368 1369 1370 |
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 1367 def list_application_instance_dependencies(params = {}, = {}) req = build_request(:list_application_instance_dependencies, params) req.send_request() end |
#list_application_instance_node_instances(params = {}) ⇒ Types::ListApplicationInstanceNodeInstancesResponse
Returns a list of application node instances.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1415 1416 1417 1418 |
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 1415 def list_application_instance_node_instances(params = {}, = {}) req = build_request(:list_application_instance_node_instances, params) req.send_request() end |
#list_application_instances(params = {}) ⇒ Types::ListApplicationInstancesResponse
Returns a list of application instances.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1478 1479 1480 1481 |
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 1478 def list_application_instances(params = {}, = {}) req = build_request(:list_application_instances, params) req.send_request() end |
#list_devices(params = {}) ⇒ Types::ListDevicesResponse
Returns a list of devices.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1549 1550 1551 1552 |
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 1549 def list_devices(params = {}, = {}) req = build_request(:list_devices, params) req.send_request() end |
#list_devices_jobs(params = {}) ⇒ Types::ListDevicesJobsResponse
Returns a list of jobs.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1595 1596 1597 1598 |
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 1595 def list_devices_jobs(params = {}, = {}) req = build_request(:list_devices_jobs, params) req.send_request() end |
#list_node_from_template_jobs(params = {}) ⇒ Types::ListNodeFromTemplateJobsResponse
Returns a list of camera stream node jobs.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1639 1640 1641 1642 |
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 1639 def list_node_from_template_jobs(params = {}, = {}) req = build_request(:list_node_from_template_jobs, params) req.send_request() end |
#list_nodes(params = {}) ⇒ Types::ListNodesResponse
Returns a list of nodes.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1707 1708 1709 1710 |
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 1707 def list_nodes(params = {}, = {}) req = build_request(:list_nodes, params) req.send_request() end |
#list_package_import_jobs(params = {}) ⇒ Types::ListPackageImportJobsResponse
Returns a list of package import jobs.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1751 1752 1753 1754 |
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 1751 def list_package_import_jobs(params = {}, = {}) req = build_request(:list_package_import_jobs, params) req.send_request() end |
#list_packages(params = {}) ⇒ Types::ListPackagesResponse
Returns a list of packages.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1794 1795 1796 1797 |
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 1794 def list_packages(params = {}, = {}) req = build_request(:list_packages, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Returns a list of tags for a resource.
1823 1824 1825 1826 |
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 1823 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#provision_device(params = {}) ⇒ Types::ProvisionDeviceResponse
Creates a device and returns a configuration archive. The
configuration archive is a ZIP file that contains a provisioning
certificate that is valid for 5 minutes. Name the configuration
archive certificates-omni_device-name.zip
and transfer it to the
device within 5 minutes. Use the included USB storage device and
connect it to the USB 3.0 port next to the HDMI output.
1900 1901 1902 1903 |
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 1900 def provision_device(params = {}, = {}) req = build_request(:provision_device, params) req.send_request() end |
#register_package_version(params = {}) ⇒ Struct
Registers a package version.
1938 1939 1940 1941 |
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 1938 def register_package_version(params = {}, = {}) req = build_request(:register_package_version, params) req.send_request() end |
#remove_application_instance(params = {}) ⇒ Struct
Removes an application instance.
1960 1961 1962 1963 |
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 1960 def remove_application_instance(params = {}, = {}) req = build_request(:remove_application_instance, params) req.send_request() end |
#signal_application_instance_node_instances(params = {}) ⇒ Types::SignalApplicationInstanceNodeInstancesResponse
Signal camera nodes to stop or resume.
1997 1998 1999 2000 |
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 1997 def signal_application_instance_node_instances(params = {}, = {}) req = build_request(:signal_application_instance_node_instances, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Tags a resource.
2025 2026 2027 2028 |
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 2025 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes tags from a resource.
2051 2052 2053 2054 |
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 2051 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_device_metadata(params = {}) ⇒ Types::UpdateDeviceMetadataResponse
Updates a device's metadata.
2083 2084 2085 2086 |
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 2083 def (params = {}, = {}) req = build_request(:update_device_metadata, params) req.send_request() end |