aws-elixir

View Source AWS.Panorama (aws-elixir v1.0.4)

AWS Panorama

overview

 Overview

This is the AWS Panorama API Reference.

For an introduction to the service, see What is AWS Panorama? in the AWS Panorama Developer Guide.

Link to this section Summary

Functions

create_application_instance(client, input, options \\ [])

Creates an application instance and deploys it to a device.

create_job_for_devices(client, input, options \\ [])

Creates a job to run on a device.

create_node_from_template_job(client, input, options \\ [])

Creates a camera stream node.

create_package(client, input, options \\ [])

Creates a package and storage location in an Amazon S3 access point.

create_package_import_job(client, input, options \\ [])

Imports a node package.

delete_device(client, device_id, input, options \\ [])

Deletes a device.

delete_package(client, package_id, input, options \\ [])

Deletes a package.

deregister_package_version(client, package_id, package_version, patch_version, input, options \\ [])

Deregisters a package version.

describe_application_instance(client, application_instance_id, options \\ [])

Returns information about an application instance on a device.

describe_application_instance_details(client, application_instance_id, options \\ [])

Returns information about an application instance's configuration manifest.

describe_device(client, device_id, options \\ [])

Returns information about a device.

describe_device_job(client, job_id, options \\ [])

Returns information about a device job.

describe_node(client, node_id, owner_account \\ nil, options \\ [])

Returns information about a node.

describe_node_from_template_job(client, job_id, options \\ [])

Returns information about a job to create a camera stream node.

describe_package(client, package_id, options \\ [])

Returns information about a package.

describe_package_import_job(client, job_id, options \\ [])

Returns information about a package import job.

describe_package_version(client, package_id, package_version, owner_account \\ nil, patch_version \\ nil, options \\ [])

Returns information about a package version.

list_application_instance_dependencies(client, application_instance_id, max_results \\ nil, next_token \\ nil, options \\ [])

Returns a list of application instance dependencies.

list_application_instance_node_instances(client, application_instance_id, max_results \\ nil, next_token \\ nil, options \\ [])

Returns a list of application node instances.

list_application_instances(client, device_id \\ nil, max_results \\ nil, next_token \\ nil, status_filter \\ nil, options \\ [])

Returns a list of application instances.

list_devices(client, device_aggregated_status_filter \\ nil, max_results \\ nil, name_filter \\ nil, next_token \\ nil, sort_by \\ nil, sort_order \\ nil, options \\ [])

Returns a list of devices.

list_devices_jobs(client, device_id \\ nil, max_results \\ nil, next_token \\ nil, options \\ [])

Returns a list of jobs.

list_node_from_template_jobs(client, max_results \\ nil, next_token \\ nil, options \\ [])

Returns a list of camera stream node jobs.

list_nodes(client, category \\ nil, max_results \\ nil, next_token \\ nil, owner_account \\ nil, package_name \\ nil, package_version \\ nil, patch_version \\ nil, options \\ [])

Returns a list of nodes.

list_package_import_jobs(client, max_results \\ nil, next_token \\ nil, options \\ [])

Returns a list of package import jobs.

list_packages(client, max_results \\ nil, next_token \\ nil, options \\ [])

Returns a list of packages.

list_tags_for_resource(client, resource_arn, options \\ [])

Returns a list of tags for a resource.

metadata()
provision_device(client, input, options \\ [])

Creates a device and returns a configuration archive.

register_package_version(client, package_id, package_version, patch_version, input, options \\ [])

Registers a package version.

remove_application_instance(client, application_instance_id, input, options \\ [])

Removes an application instance.

signal_application_instance_node_instances(client, application_instance_id, input, options \\ [])

Signal camera nodes to stop or resume.

tag_resource(client, resource_arn, input, options \\ [])

Tags a resource.

untag_resource(client, resource_arn, input, options \\ [])

Removes tags from a resource.

update_device_metadata(client, device_id, input, options \\ [])

Updates a device's metadata.

Link to this section Functions

Link to this function

create_application_instance(client, input, options \\ [])

View Source

Creates an application instance and deploys it to a device.

Link to this function

create_job_for_devices(client, input, options \\ [])

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_node_from_template_job(client, input, options \\ [])

View Source

Creates a camera stream node.

Link to this function

create_package(client, input, options \\ [])

View Source

Creates a package and storage location in an Amazon S3 access point.

Link to this function

create_package_import_job(client, input, options \\ [])

View Source

Imports a node package.

Link to this function

delete_device(client, device_id, input, options \\ [])

View Source

Deletes a device.

Link to this function

delete_package(client, package_id, input, options \\ [])

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

deregister_package_version(client, package_id, package_version, patch_version, input, options \\ [])

View Source

Deregisters a package version.

Link to this function

describe_application_instance(client, application_instance_id, options \\ [])

View Source

Returns information about an application instance on a device.

Link to this function

describe_application_instance_details(client, application_instance_id, options \\ [])

View Source

Returns information about an application instance's configuration manifest.

Link to this function

describe_device(client, device_id, options \\ [])

View Source

Returns information about a device.

Link to this function

describe_device_job(client, job_id, options \\ [])

View Source

Returns information about a device job.

Link to this function

describe_node(client, node_id, owner_account \\ nil, options \\ [])

View Source

Returns information about a node.

Link to this function

describe_node_from_template_job(client, job_id, options \\ [])

View Source

Returns information about a job to create a camera stream node.

Link to this function

describe_package(client, package_id, options \\ [])

View Source

Returns information about a package.

Link to this function

describe_package_import_job(client, job_id, options \\ [])

View Source

Returns information about a package import job.

Link to this function

describe_package_version(client, package_id, package_version, owner_account \\ nil, patch_version \\ nil, options \\ [])

View Source

Returns information about a package version.

Link to this function

list_application_instance_dependencies(client, application_instance_id, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Returns a list of application instance dependencies.

Link to this function

list_application_instance_node_instances(client, application_instance_id, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Returns a list of application node instances.

Link to this function

list_application_instances(client, device_id \\ nil, max_results \\ nil, next_token \\ nil, status_filter \\ nil, options \\ [])

View Source

Returns a list of application instances.

Link to this function

list_devices(client, device_aggregated_status_filter \\ nil, max_results \\ nil, name_filter \\ nil, next_token \\ nil, sort_by \\ nil, sort_order \\ nil, options \\ [])

View Source

Returns a list of devices.

Link to this function

list_devices_jobs(client, device_id \\ nil, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Returns a list of jobs.

Link to this function

list_node_from_template_jobs(client, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Returns a list of camera stream node jobs.

Link to this function

list_nodes(client, category \\ nil, max_results \\ nil, next_token \\ nil, owner_account \\ nil, package_name \\ nil, package_version \\ nil, patch_version \\ nil, options \\ [])

View Source

Returns a list of nodes.

Link to this function

list_package_import_jobs(client, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Returns a list of package import jobs.

Link to this function

list_packages(client, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Returns a list of packages.

Link to this function

list_tags_for_resource(client, resource_arn, options \\ [])

View Source

Returns a list of tags for a resource.

Link to this function

metadata()

View Source
Link to this function

provision_device(client, input, options \\ [])

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

register_package_version(client, package_id, package_version, patch_version, input, options \\ [])

View Source

Registers a package version.

Link to this function

remove_application_instance(client, application_instance_id, input, options \\ [])

View Source

Removes an application instance.

Link to this function

signal_application_instance_node_instances(client, application_instance_id, input, options \\ [])

View Source

Signal camera nodes to stop or resume.

Link to this function

tag_resource(client, resource_arn, input, options \\ [])

View Source

Tags a resource.

Link to this function

untag_resource(client, resource_arn, input, options \\ [])

View Source

Removes tags from a resource.

Link to this function

update_device_metadata(client, device_id, input, options \\ [])

View Source

Updates a device's metadata.