aws
v1.0.4

View Source aws_panorama (aws v1.0.4)

AWS Panorama

Overview

This is the AWS Panorama API Reference.

For an introduction to the service, see What is AWS Panorama?: https://docs.aws.amazon.com/panorama/latest/dev/panorama-welcome.html in the AWS Panorama Developer Guide.

Summary

Functions

create_application_instance(Client, Input)
Creates an application instance and deploys it to a device.
create_application_instance(Client, Input0, Options0)
create_job_for_devices(Client, Input)

Creates a job to run on a device.

create_job_for_devices(Client, Input0, Options0)
create_node_from_template_job(Client, Input)
Creates a camera stream node.
create_node_from_template_job(Client, Input0, Options0)
create_package(Client, Input)
Creates a package and storage location in an Amazon S3 access point.
create_package(Client, Input0, Options0)
create_package_import_job(Client, Input)
Imports a node package.
create_package_import_job(Client, Input0, Options0)
delete_device(Client, DeviceId, Input)
Deletes a device.
delete_device(Client, DeviceId, Input0, Options0)
delete_package(Client, PackageId, Input)

Deletes a package.

delete_package(Client, PackageId, Input0, Options0)
deregister_package_version(Client, PackageId, PackageVersion, PatchVersion, Input)
Deregisters a package version.
deregister_package_version(Client, PackageId, PackageVersion, PatchVersion, Input0, Options0)
describe_application_instance(Client, ApplicationInstanceId)
Returns information about an application instance on a device.
describe_application_instance(Client, ApplicationInstanceId, QueryMap, HeadersMap)
describe_application_instance(Client, ApplicationInstanceId, QueryMap, HeadersMap, Options0)
describe_application_instance_details(Client, ApplicationInstanceId)
Returns information about an application instance's configuration manifest.
describe_application_instance_details(Client, ApplicationInstanceId, QueryMap, HeadersMap)
describe_application_instance_details(Client, ApplicationInstanceId, QueryMap, HeadersMap, Options0)
describe_device(Client, DeviceId)
Returns information about a device.
describe_device(Client, DeviceId, QueryMap, HeadersMap)
describe_device(Client, DeviceId, QueryMap, HeadersMap, Options0)
describe_device_job(Client, JobId)
Returns information about a device job.
describe_device_job(Client, JobId, QueryMap, HeadersMap)
describe_device_job(Client, JobId, QueryMap, HeadersMap, Options0)
describe_node(Client, NodeId)
Returns information about a node.
describe_node(Client, NodeId, QueryMap, HeadersMap)
describe_node(Client, NodeId, QueryMap, HeadersMap, Options0)
describe_node_from_template_job(Client, JobId)
Returns information about a job to create a camera stream node.
describe_node_from_template_job(Client, JobId, QueryMap, HeadersMap)
describe_node_from_template_job(Client, JobId, QueryMap, HeadersMap, Options0)
describe_package(Client, PackageId)
Returns information about a package.
describe_package(Client, PackageId, QueryMap, HeadersMap)
describe_package(Client, PackageId, QueryMap, HeadersMap, Options0)
describe_package_import_job(Client, JobId)
Returns information about a package import job.
describe_package_import_job(Client, JobId, QueryMap, HeadersMap)
describe_package_import_job(Client, JobId, QueryMap, HeadersMap, Options0)
describe_package_version(Client, PackageId, PackageVersion)
Returns information about a package version.
describe_package_version(Client, PackageId, PackageVersion, QueryMap, HeadersMap)
describe_package_version(Client, PackageId, PackageVersion, QueryMap, HeadersMap, Options0)
list_application_instance_dependencies(Client, ApplicationInstanceId)
Returns a list of application instance dependencies.
list_application_instance_dependencies(Client, ApplicationInstanceId, QueryMap, HeadersMap)
list_application_instance_dependencies(Client, ApplicationInstanceId, QueryMap, HeadersMap, Options0)
list_application_instance_node_instances(Client, ApplicationInstanceId)
Returns a list of application node instances.
list_application_instance_node_instances(Client, ApplicationInstanceId, QueryMap, HeadersMap)
list_application_instance_node_instances(Client, ApplicationInstanceId, QueryMap, HeadersMap, Options0)
list_application_instances(Client)
Returns a list of application instances.
list_application_instances(Client, QueryMap, HeadersMap)
list_application_instances(Client, QueryMap, HeadersMap, Options0)
list_devices(Client)
Returns a list of devices.
list_devices(Client, QueryMap, HeadersMap)
list_devices(Client, QueryMap, HeadersMap, Options0)
list_devices_jobs(Client)
Returns a list of jobs.
list_devices_jobs(Client, QueryMap, HeadersMap)
list_devices_jobs(Client, QueryMap, HeadersMap, Options0)
list_node_from_template_jobs(Client)
Returns a list of camera stream node jobs.
list_node_from_template_jobs(Client, QueryMap, HeadersMap)
list_node_from_template_jobs(Client, QueryMap, HeadersMap, Options0)
list_nodes(Client)
Returns a list of nodes.
list_nodes(Client, QueryMap, HeadersMap)
list_nodes(Client, QueryMap, HeadersMap, Options0)
list_package_import_jobs(Client)
Returns a list of package import jobs.
list_package_import_jobs(Client, QueryMap, HeadersMap)
list_package_import_jobs(Client, QueryMap, HeadersMap, Options0)
list_packages(Client)
Returns a list of packages.
list_packages(Client, QueryMap, HeadersMap)
list_packages(Client, QueryMap, HeadersMap, Options0)
list_tags_for_resource(Client, ResourceArn)
Returns a list of tags for a resource.
list_tags_for_resource(Client, ResourceArn, QueryMap, HeadersMap)
list_tags_for_resource(Client, ResourceArn, QueryMap, HeadersMap, Options0)
provision_device(Client, Input)

Creates a device and returns a configuration archive.

provision_device(Client, Input0, Options0)
register_package_version(Client, PackageId, PackageVersion, PatchVersion, Input)
Registers a package version.
register_package_version(Client, PackageId, PackageVersion, PatchVersion, Input0, Options0)
remove_application_instance(Client, ApplicationInstanceId, Input)
Removes an application instance.
remove_application_instance(Client, ApplicationInstanceId, Input0, Options0)
signal_application_instance_node_instances(Client, ApplicationInstanceId, Input)
Signal camera nodes to stop or resume.
signal_application_instance_node_instances(Client, ApplicationInstanceId, Input0, Options0)
tag_resource(Client, ResourceArn, Input)
Tags a resource.
tag_resource(Client, ResourceArn, Input0, Options0)
untag_resource(Client, ResourceArn, Input)
Removes tags from a resource.
untag_resource(Client, ResourceArn, Input0, Options0)
update_device_metadata(Client, DeviceId, Input)
Updates a device's metadata.
update_device_metadata(Client, DeviceId, Input0, Options0)

Functions

Link to this function

create_application_instance(Client, Input)

View Source
Creates an application instance and deploys it to a device.
Link to this function

create_application_instance(Client, Input0, Options0)

View Source
Link to this function

create_job_for_devices(Client, Input)

View Source

Creates a job to run on a device.

A job can update a device's software or reboot it.
Link to this function

create_job_for_devices(Client, Input0, Options0)

View Source
Link to this function

create_node_from_template_job(Client, Input)

View Source
Creates a camera stream node.
Link to this function

create_node_from_template_job(Client, Input0, Options0)

View Source
Link to this function

create_package(Client, Input)

View Source
Creates a package and storage location in an Amazon S3 access point.
Link to this function

create_package(Client, Input0, Options0)

View Source
Link to this function

create_package_import_job(Client, Input)

View Source
Imports a node package.
Link to this function

create_package_import_job(Client, Input0, Options0)

View Source
Link to this function

delete_device(Client, DeviceId, Input)

View Source
Deletes a device.
Link to this function

delete_device(Client, DeviceId, Input0, Options0)

View Source
Link to this function

delete_package(Client, PackageId, Input)

View Source

Deletes a package.

To delete a package, you need permission to call s3:DeleteObject in addition to permissions for the AWS Panorama API.
Link to this function

delete_package(Client, PackageId, Input0, Options0)

View Source
Link to this function

deregister_package_version(Client, PackageId, PackageVersion, PatchVersion, Input)

View Source
Deregisters a package version.
Link to this function

deregister_package_version(Client, PackageId, PackageVersion, PatchVersion, Input0, Options0)

View Source
Link to this function

describe_application_instance(Client, ApplicationInstanceId)

View Source
Returns information about an application instance on a device.
Link to this function

describe_application_instance(Client, ApplicationInstanceId, QueryMap, HeadersMap)

View Source
Link to this function

describe_application_instance(Client, ApplicationInstanceId, QueryMap, HeadersMap, Options0)

View Source
Link to this function

describe_application_instance_details(Client, ApplicationInstanceId)

View Source
Returns information about an application instance's configuration manifest.
Link to this function

describe_application_instance_details(Client, ApplicationInstanceId, QueryMap, HeadersMap)

View Source
Link to this function

describe_application_instance_details(Client, ApplicationInstanceId, QueryMap, HeadersMap, Options0)

View Source
Link to this function

describe_device(Client, DeviceId)

View Source
Returns information about a device.
Link to this function

describe_device(Client, DeviceId, QueryMap, HeadersMap)

View Source
Link to this function

describe_device(Client, DeviceId, QueryMap, HeadersMap, Options0)

View Source
Link to this function

describe_device_job(Client, JobId)

View Source
Returns information about a device job.
Link to this function

describe_device_job(Client, JobId, QueryMap, HeadersMap)

View Source
Link to this function

describe_device_job(Client, JobId, QueryMap, HeadersMap, Options0)

View Source
Link to this function

describe_node(Client, NodeId)

View Source
Returns information about a node.
Link to this function

describe_node(Client, NodeId, QueryMap, HeadersMap)

View Source
Link to this function

describe_node(Client, NodeId, QueryMap, HeadersMap, Options0)

View Source
Link to this function

describe_node_from_template_job(Client, JobId)

View Source
Returns information about a job to create a camera stream node.
Link to this function

describe_node_from_template_job(Client, JobId, QueryMap, HeadersMap)

View Source
Link to this function

describe_node_from_template_job(Client, JobId, QueryMap, HeadersMap, Options0)

View Source
Link to this function

describe_package(Client, PackageId)

View Source
Returns information about a package.
Link to this function

describe_package(Client, PackageId, QueryMap, HeadersMap)

View Source
Link to this function

describe_package(Client, PackageId, QueryMap, HeadersMap, Options0)

View Source
Link to this function

describe_package_import_job(Client, JobId)

View Source
Returns information about a package import job.
Link to this function

describe_package_import_job(Client, JobId, QueryMap, HeadersMap)

View Source
Link to this function

describe_package_import_job(Client, JobId, QueryMap, HeadersMap, Options0)

View Source
Link to this function

describe_package_version(Client, PackageId, PackageVersion)

View Source
Returns information about a package version.
Link to this function

describe_package_version(Client, PackageId, PackageVersion, QueryMap, HeadersMap)

View Source
Link to this function

describe_package_version(Client, PackageId, PackageVersion, QueryMap, HeadersMap, Options0)

View Source
Link to this function

list_application_instance_dependencies(Client, ApplicationInstanceId)

View Source
Returns a list of application instance dependencies.
Link to this function

list_application_instance_dependencies(Client, ApplicationInstanceId, QueryMap, HeadersMap)

View Source
Link to this function

list_application_instance_dependencies(Client, ApplicationInstanceId, QueryMap, HeadersMap, Options0)

View Source
Link to this function

list_application_instance_node_instances(Client, ApplicationInstanceId)

View Source
Returns a list of application node instances.
Link to this function

list_application_instance_node_instances(Client, ApplicationInstanceId, QueryMap, HeadersMap)

View Source
Link to this function

list_application_instance_node_instances(Client, ApplicationInstanceId, QueryMap, HeadersMap, Options0)

View Source
Link to this function

list_application_instances(Client)

View Source
Returns a list of application instances.
Link to this function

list_application_instances(Client, QueryMap, HeadersMap)

View Source
Link to this function

list_application_instances(Client, QueryMap, HeadersMap, Options0)

View Source
Link to this function

list_devices(Client)

View Source
Returns a list of devices.
Link to this function

list_devices(Client, QueryMap, HeadersMap)

View Source
Link to this function

list_devices(Client, QueryMap, HeadersMap, Options0)

View Source
Link to this function

list_devices_jobs(Client)

View Source
Returns a list of jobs.
Link to this function

list_devices_jobs(Client, QueryMap, HeadersMap)

View Source
Link to this function

list_devices_jobs(Client, QueryMap, HeadersMap, Options0)

View Source
Link to this function

list_node_from_template_jobs(Client)

View Source
Returns a list of camera stream node jobs.
Link to this function

list_node_from_template_jobs(Client, QueryMap, HeadersMap)

View Source
Link to this function

list_node_from_template_jobs(Client, QueryMap, HeadersMap, Options0)

View Source
Link to this function

list_nodes(Client)

View Source
Returns a list of nodes.
Link to this function

list_nodes(Client, QueryMap, HeadersMap)

View Source
Link to this function

list_nodes(Client, QueryMap, HeadersMap, Options0)

View Source
Link to this function

list_package_import_jobs(Client)

View Source
Returns a list of package import jobs.
Link to this function

list_package_import_jobs(Client, QueryMap, HeadersMap)

View Source
Link to this function

list_package_import_jobs(Client, QueryMap, HeadersMap, Options0)

View Source
Link to this function

list_packages(Client)

View Source
Returns a list of packages.
Link to this function

list_packages(Client, QueryMap, HeadersMap)

View Source
Link to this function

list_packages(Client, QueryMap, HeadersMap, Options0)

View Source
Link to this function

list_tags_for_resource(Client, ResourceArn)

View Source
Returns a list of tags for a resource.
Link to this function

list_tags_for_resource(Client, ResourceArn, QueryMap, HeadersMap)

View Source
Link to this function

list_tags_for_resource(Client, ResourceArn, QueryMap, HeadersMap, Options0)

View Source
Link to this function

provision_device(Client, Input)

View Source

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.
Link to this function

provision_device(Client, Input0, Options0)

View Source
Link to this function

register_package_version(Client, PackageId, PackageVersion, PatchVersion, Input)

View Source
Registers a package version.
Link to this function

register_package_version(Client, PackageId, PackageVersion, PatchVersion, Input0, Options0)

View Source
Link to this function

remove_application_instance(Client, ApplicationInstanceId, Input)

View Source
Removes an application instance.
Link to this function

remove_application_instance(Client, ApplicationInstanceId, Input0, Options0)

View Source
Link to this function

signal_application_instance_node_instances(Client, ApplicationInstanceId, Input)

View Source
Signal camera nodes to stop or resume.
Link to this function

signal_application_instance_node_instances(Client, ApplicationInstanceId, Input0, Options0)

View Source
Link to this function

tag_resource(Client, ResourceArn, Input)

View Source
Tags a resource.
Link to this function

tag_resource(Client, ResourceArn, Input0, Options0)

View Source
Link to this function

untag_resource(Client, ResourceArn, Input)

View Source
Removes tags from a resource.
Link to this function

untag_resource(Client, ResourceArn, Input0, Options0)

View Source
Link to this function

update_device_metadata(Client, DeviceId, Input)

View Source
Updates a device's metadata.
Link to this function

update_device_metadata(Client, DeviceId, Input0, Options0)

View Source