PanoramaClient

AWS Panorama

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.

Installation

NPM
npm install @aws-sdk/client-panorama
Yarn
yarn add @aws-sdk/client-panorama
pnpm
pnpm add @aws-sdk/client-panorama

PanoramaClient Operations

Command
Summary
CreateApplicationInstanceCommand

Creates an application instance and deploys it to a device.

CreateJobForDevicesCommand

Creates a job to run on a device. A job can update a device's software or reboot it.

CreateNodeFromTemplateJobCommand

Creates a camera stream node.

CreatePackageCommand

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

CreatePackageImportJobCommand

Imports a node package.

DeleteDeviceCommand

Deletes a device.

DeletePackageCommand

Deletes a package.

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

DeregisterPackageVersionCommand

Deregisters a package version.

DescribeApplicationInstanceCommand

Returns information about an application instance on a device.

DescribeApplicationInstanceDetailsCommand

Returns information about an application instance's configuration manifest.

DescribeDeviceCommand

Returns information about a device.

DescribeDeviceJobCommand

Returns information about a device job.

DescribeNodeCommand

Returns information about a node.

DescribeNodeFromTemplateJobCommand

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

DescribePackageCommand

Returns information about a package.

DescribePackageImportJobCommand

Returns information about a package import job.

DescribePackageVersionCommand

Returns information about a package version.

ListApplicationInstanceDependenciesCommand

Returns a list of application instance dependencies.

ListApplicationInstanceNodeInstancesCommand

Returns a list of application node instances.

ListApplicationInstancesCommand

Returns a list of application instances.

ListDevicesCommand

Returns a list of devices.

ListDevicesJobsCommand

Returns a list of jobs.

ListNodeFromTemplateJobsCommand

Returns a list of camera stream node jobs.

ListNodesCommand

Returns a list of nodes.

ListPackageImportJobsCommand

Returns a list of package import jobs.

ListPackagesCommand

Returns a list of packages.

ListTagsForResourceCommand

Returns a list of tags for a resource.

ProvisionDeviceCommand

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.

RegisterPackageVersionCommand

Registers a package version.

RemoveApplicationInstanceCommand

Removes an application instance.

SignalApplicationInstanceNodeInstancesCommand

Signal camera nodes to stop or resume.

TagResourceCommand

Tags a resource.

UntagResourceCommand

Removes tags from a resource.

UpdateDeviceMetadataCommand

Updates a device's metadata.

PanoramaClient Configuration

Parameter
Type
Description
defaultsMode
Optional
DefaultsMode | Provider<DefaultsMode>
The @smithy/smithy-client#DefaultsMode that will be used to determine how certain default configuration options are resolved in the SDK.
disableHostPrefix
Optional
boolean
Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation.
extensions
Optional
RuntimeExtension[]
Optional extensions
logger
Optional
Logger
Optional logger for logging debug/info/warn/error.
maxAttempts
Optional
number | Provider<number>
Value for how many times a request will be made at most in case of retry.
profile
Optional
string
Setting a client profile is similar to setting a value for the AWS_PROFILE environment variable. Setting a profile on a client in code only affects the single client instance, unlike AWS_PROFILE.When set, and only for environments where an AWS configuration file exists, fields configurable by this file will be retrieved from the specified profile within that file. Conflicting code configuration and environment variables will still have higher priority.For client credential resolution that involves checking the AWS configuration file, the client's profile (this value) will be used unless a different profile is set in the credential provider options.
region
Optional
string | Provider<string>
The AWS region to which this client will send requests
requestHandler
Optional
__HttpHandlerUserInput
The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs.
retryMode
Optional
string | Provider<string>
Specifies which retry algorithm to use.
useDualstackEndpoint
Optional
boolean | Provider<boolean>
Enables IPv6/IPv4 dualstack endpoint.
useFipsEndpoint
Optional
boolean | Provider<boolean>
Enables FIPS compatible endpoints.
Additional config fields are described in the full configuration type: PanoramaClientConfig