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.
410 411 412 |
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 410 def initialize(*args) super end |
Instance Method Details
#create_application_instance(params = {}) ⇒ Types::CreateApplicationInstanceResponse
Creates an application instance and deploys it to a device.
473 474 475 476 |
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 473 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.
517 518 519 520 |
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 517 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.
578 579 580 581 |
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 578 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.
620 621 622 623 |
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 620 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.
685 686 687 688 |
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 685 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.
713 714 715 716 |
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 713 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.
745 746 747 748 |
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 745 def delete_package(params = {}, = {}) req = build_request(:delete_package, params) req.send_request() end |
#deregister_package_version(params = {}) ⇒ Struct
Deregisters a package version.
783 784 785 786 |
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 783 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.
844 845 846 847 |
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 844 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.
887 888 889 890 |
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 887 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.
979 980 981 982 |
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 979 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.
1023 1024 1025 1026 |
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 1023 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.
1090 1091 1092 1093 |
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 1090 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.
1144 1145 1146 1147 |
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 1144 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.
1193 1194 1195 1196 |
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 1193 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.
1252 1253 1254 1255 |
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 1252 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.
1310 1311 1312 1313 |
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 1310 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.
1355 1356 1357 1358 |
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 1355 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.
1403 1404 1405 1406 |
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 1403 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.
1466 1467 1468 1469 |
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 1466 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.
1537 1538 1539 1540 |
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 1537 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.
1583 1584 1585 1586 |
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 1583 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.
1627 1628 1629 1630 |
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 1627 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.
1695 1696 1697 1698 |
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 1695 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.
1739 1740 1741 1742 |
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 1739 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.
1782 1783 1784 1785 |
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 1782 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.
1811 1812 1813 1814 |
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 1811 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.
1888 1889 1890 1891 |
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 1888 def provision_device(params = {}, = {}) req = build_request(:provision_device, params) req.send_request() end |
#register_package_version(params = {}) ⇒ Struct
Registers a package version.
1926 1927 1928 1929 |
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 1926 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.
1948 1949 1950 1951 |
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 1948 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.
1985 1986 1987 1988 |
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 1985 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.
2013 2014 2015 2016 |
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 2013 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes tags from a resource.
2039 2040 2041 2042 |
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 2039 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.
2071 2072 2073 2074 |
# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/client.rb', line 2071 def (params = {}, = {}) req = build_request(:update_device_metadata, params) req.send_request() end |