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.
440 441 442 |
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 440 def initialize(*args) super end |
Instance Method Details
#create_application_instance(params = {}) ⇒ Types::CreateApplicationInstanceResponse
Creates an application instance and deploys it to a device.
503 504 505 506 |
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 503 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.
547 548 549 550 |
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 547 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.
608 609 610 611 |
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 608 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.
650 651 652 653 |
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 650 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.
715 716 717 718 |
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 715 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.
743 744 745 746 |
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 743 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.
775 776 777 778 |
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 775 def delete_package(params = {}, = {}) req = build_request(:delete_package, params) req.send_request() end |
#deregister_package_version(params = {}) ⇒ Struct
Deregisters a package version.
813 814 815 816 |
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 813 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.
874 875 876 877 |
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 874 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.
917 918 919 920 |
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 917 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.
1009 1010 1011 1012 |
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 1009 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.
1053 1054 1055 1056 |
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 1053 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.
1120 1121 1122 1123 |
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 1120 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.
1174 1175 1176 1177 |
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 1174 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.
1223 1224 1225 1226 |
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 1223 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.
1282 1283 1284 1285 |
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 1282 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.
1340 1341 1342 1343 |
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 1340 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.
1385 1386 1387 1388 |
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 1385 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.
1433 1434 1435 1436 |
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 1433 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.
1496 1497 1498 1499 |
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 1496 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.
1567 1568 1569 1570 |
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 1567 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.
1613 1614 1615 1616 |
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 1613 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.
1657 1658 1659 1660 |
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 1657 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.
1725 1726 1727 1728 |
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 1725 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.
1769 1770 1771 1772 |
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 1769 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.
1812 1813 1814 1815 |
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 1812 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.
1841 1842 1843 1844 |
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 1841 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.
1918 1919 1920 1921 |
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 1918 def provision_device(params = {}, = {}) req = build_request(:provision_device, params) req.send_request() end |
#register_package_version(params = {}) ⇒ Struct
Registers a package version.
1956 1957 1958 1959 |
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 1956 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.
1978 1979 1980 1981 |
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 1978 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.
2015 2016 2017 2018 |
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 2015 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.
2043 2044 2045 2046 |
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 2043 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes tags from a resource.
2069 2070 2071 2072 |
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 2069 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.
2101 2102 2103 2104 |
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 2101 def (params = {}, = {}) req = build_request(:update_device_metadata, params) req.send_request() end |