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.

Properties

Link copied to clipboard
abstract override val config: PanoramaClient.Config

PanoramaClient's configuration

Functions

Link copied to clipboard

Creates an application instance and deploys it to a device.

Link copied to clipboard

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

Link copied to clipboard

Creates a camera stream node.

Link copied to clipboard

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

Link copied to clipboard

Imports a node package.

Link copied to clipboard

Deletes a device.

Link copied to clipboard

Deletes a package.

Link copied to clipboard

Deregisters a package version.

Link copied to clipboard

Returns information about an application instance on a device.

Link copied to clipboard

Returns information about an application instance's configuration manifest.

Link copied to clipboard

Returns information about a device.

Link copied to clipboard

Returns information about a device job.

Link copied to clipboard

Returns information about a node.

Link copied to clipboard

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

Link copied to clipboard

Returns information about a package.

Link copied to clipboard

Returns information about a package import job.

Link copied to clipboard

Returns information about a package version.

Link copied to clipboard

Returns a list of application instance dependencies.

Link copied to clipboard
abstract suspend fun listApplicationInstances(input: ListApplicationInstancesRequest = ListApplicationInstancesRequest { }): ListApplicationInstancesResponse

Returns a list of application instances.

Link copied to clipboard
abstract suspend fun listDevices(input: ListDevicesRequest = ListDevicesRequest { }): ListDevicesResponse

Returns a list of devices.

Link copied to clipboard
abstract suspend fun listDevicesJobs(input: ListDevicesJobsRequest = ListDevicesJobsRequest { }): ListDevicesJobsResponse

Returns a list of jobs.

Link copied to clipboard
abstract suspend fun listNodeFromTemplateJobs(input: ListNodeFromTemplateJobsRequest = ListNodeFromTemplateJobsRequest { }): ListNodeFromTemplateJobsResponse

Returns a list of camera stream node jobs.

Link copied to clipboard
abstract suspend fun listNodes(input: ListNodesRequest = ListNodesRequest { }): ListNodesResponse

Returns a list of nodes.

Link copied to clipboard
abstract suspend fun listPackageImportJobs(input: ListPackageImportJobsRequest = ListPackageImportJobsRequest { }): ListPackageImportJobsResponse

Returns a list of package import jobs.

Link copied to clipboard
abstract suspend fun listPackages(input: ListPackagesRequest = ListPackagesRequest { }): ListPackagesResponse

Returns a list of packages.

Link copied to clipboard

Returns a list of tags for a resource.

Link copied to clipboard

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_<i>device-name</i>.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 copied to clipboard

Registers a package version.

Link copied to clipboard

Removes an application instance.

Link copied to clipboard
abstract suspend fun tagResource(input: TagResourceRequest): TagResourceResponse

Tags a resource.

Link copied to clipboard

Removes tags from a resource.

Link copied to clipboard

Updates a device's metadata.

Inherited functions

Link copied to clipboard
expect abstract fun close()
Link copied to clipboard

Creates an application instance and deploys it to a device.

Link copied to clipboard

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

Link copied to clipboard

Creates a camera stream node.

Link copied to clipboard

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

Link copied to clipboard

Imports a node package.

Link copied to clipboard

Deletes a device.

Link copied to clipboard

Deletes a package.

Link copied to clipboard

Deregisters a package version.

Link copied to clipboard

Returns information about an application instance on a device.

Link copied to clipboard

Returns information about an application instance's configuration manifest.

Link copied to clipboard

Returns information about a device.

Link copied to clipboard

Returns information about a device job.

Link copied to clipboard

Returns information about a node.

Link copied to clipboard

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

Link copied to clipboard

Returns information about a package.

Link copied to clipboard

Returns information about a package import job.

Link copied to clipboard

Returns information about a package version.

Link copied to clipboard

Returns a list of application instance dependencies.

Link copied to clipboard

Returns a list of application instances.

Link copied to clipboard
inline suspend fun PanoramaClient.listDevices(crossinline block: ListDevicesRequest.Builder.() -> Unit): ListDevicesResponse

Returns a list of devices.

Link copied to clipboard

Returns a list of jobs.

Link copied to clipboard
Link copied to clipboard

Returns a list of camera stream node jobs.

Link copied to clipboard
inline suspend fun PanoramaClient.listNodes(crossinline block: ListNodesRequest.Builder.() -> Unit): ListNodesResponse

Returns a list of nodes.

Link copied to clipboard
fun PanoramaClient.listNodesPaginated(initialRequest: ListNodesRequest = ListNodesRequest { }): Flow<ListNodesResponse>

Paginate over ListNodesResponse results.

Link copied to clipboard

Returns a list of package import jobs.

Link copied to clipboard

Returns a list of packages.

Link copied to clipboard
Link copied to clipboard

Returns a list of tags for a resource.

Link copied to clipboard

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_<i>device-name</i>.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 copied to clipboard

Registers a package version.

Link copied to clipboard

Removes an application instance.

Link copied to clipboard
inline suspend fun PanoramaClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

Tags a resource.

Link copied to clipboard

Removes tags from a resource.

Link copied to clipboard

Updates a device's metadata.

Link copied to clipboard

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.