Panorama class
This is the AWS Panorama API Reference. For an introduction to the service, see What is AWS Panorama? in the AWS Panorama Developer Guide.
Constructors
- Panorama({required String region, AwsClientCredentials? credentials, AwsClientCredentialsProvider? credentialsProvider, Client? client, String? endpointUrl})
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
close(
) → void - Closes the internal HTTP client if none was provided at creation. If a client was passed as a constructor argument, this becomes a noop.
-
createApplicationInstance(
{required String defaultRuntimeContextDevice, required ManifestPayload manifestPayload, String? applicationInstanceIdToReplace, String? description, ManifestOverridesPayload? manifestOverridesPayload, String? name, String? runtimeRoleArn, Map< String, String> ? tags}) → Future<CreateApplicationInstanceResponse> - Creates an application instance and deploys it to a device.
-
createJobForDevices(
{required List< String> deviceIds, required JobType jobType, DeviceJobConfig? deviceJobConfig}) → Future<CreateJobForDevicesResponse> - Creates a job to run on a device. A job can update a device's software or reboot it.
-
createNodeFromTemplateJob(
{required String nodeName, required String outputPackageName, required String outputPackageVersion, required Map< String, String> templateParameters, required TemplateType templateType, List<JobResourceTags> ? jobTags, String? nodeDescription}) → Future<CreateNodeFromTemplateJobResponse> - Creates a camera stream node.
-
createPackage(
{required String packageName, Map< String, String> ? tags}) → Future<CreatePackageResponse> - Creates a package and storage location in an Amazon S3 access point.
-
createPackageImportJob(
{required String clientToken, required PackageImportJobInputConfig inputConfig, required PackageImportJobType jobType, required PackageImportJobOutputConfig outputConfig, List< JobResourceTags> ? jobTags}) → Future<CreatePackageImportJobResponse> - Imports a node package.
-
deleteDevice(
{required String deviceId}) → Future< DeleteDeviceResponse> - Deletes a device.
-
deletePackage(
{required String packageId, bool? forceDelete}) → Future< void> - Deletes a package.
-
deregisterPackageVersion(
{required String packageId, required String packageVersion, required String patchVersion, String? ownerAccount, String? updatedLatestPatchVersion}) → Future< void> - Deregisters a package version.
-
describeApplicationInstance(
{required String applicationInstanceId}) → Future< DescribeApplicationInstanceResponse> - Returns information about an application instance on a device.
-
describeApplicationInstanceDetails(
{required String applicationInstanceId}) → Future< DescribeApplicationInstanceDetailsResponse> - Returns information about an application instance's configuration manifest.
-
describeDevice(
{required String deviceId}) → Future< DescribeDeviceResponse> - Returns information about a device.
-
describeDeviceJob(
{required String jobId}) → Future< DescribeDeviceJobResponse> - Returns information about a device job.
-
describeNode(
{required String nodeId, String? ownerAccount}) → Future< DescribeNodeResponse> - Returns information about a node.
-
describeNodeFromTemplateJob(
{required String jobId}) → Future< DescribeNodeFromTemplateJobResponse> - Returns information about a job to create a camera stream node.
-
describePackage(
{required String packageId}) → Future< DescribePackageResponse> - Returns information about a package.
-
describePackageImportJob(
{required String jobId}) → Future< DescribePackageImportJobResponse> - Returns information about a package import job.
-
describePackageVersion(
{required String packageId, required String packageVersion, String? ownerAccount, String? patchVersion}) → Future< DescribePackageVersionResponse> - Returns information about a package version.
-
listApplicationInstanceDependencies(
{required String applicationInstanceId, int? maxResults, String? nextToken}) → Future< ListApplicationInstanceDependenciesResponse> - Returns a list of application instance dependencies.
-
listApplicationInstanceNodeInstances(
{required String applicationInstanceId, int? maxResults, String? nextToken}) → Future< ListApplicationInstanceNodeInstancesResponse> - Returns a list of application node instances.
-
listApplicationInstances(
{String? deviceId, int? maxResults, String? nextToken, StatusFilter? statusFilter}) → Future< ListApplicationInstancesResponse> - Returns a list of application instances.
-
listDevices(
{DeviceAggregatedStatus? deviceAggregatedStatusFilter, int? maxResults, String? nameFilter, String? nextToken, ListDevicesSortBy? sortBy, SortOrder? sortOrder}) → Future< ListDevicesResponse> - Returns a list of devices.
-
listDevicesJobs(
{String? deviceId, int? maxResults, String? nextToken}) → Future< ListDevicesJobsResponse> - Returns a list of jobs.
-
listNodeFromTemplateJobs(
{int? maxResults, String? nextToken}) → Future< ListNodeFromTemplateJobsResponse> - Returns a list of camera stream node jobs.
-
listNodes(
{NodeCategory? category, int? maxResults, String? nextToken, String? ownerAccount, String? packageName, String? packageVersion, String? patchVersion}) → Future< ListNodesResponse> - Returns a list of nodes.
-
listPackageImportJobs(
{int? maxResults, String? nextToken}) → Future< ListPackageImportJobsResponse> - Returns a list of package import jobs.
-
listPackages(
{int? maxResults, String? nextToken}) → Future< ListPackagesResponse> - Returns a list of packages.
-
listTagsForResource(
{required String resourceArn}) → Future< ListTagsForResourceResponse> - Returns a list of tags for a resource.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
provisionDevice(
{required String name, String? description, NetworkPayload? networkingConfiguration, Map< String, String> ? tags}) → Future<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.zipand 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. -
registerPackageVersion(
{required String packageId, required String packageVersion, required String patchVersion, bool? markLatest, String? ownerAccount}) → Future< void> - Registers a package version.
-
removeApplicationInstance(
{required String applicationInstanceId}) → Future< void> - Removes an application instance.
-
signalApplicationInstanceNodeInstances(
{required String applicationInstanceId, required List< NodeSignal> nodeSignals}) → Future<SignalApplicationInstanceNodeInstancesResponse> - Signal camera nodes to stop or resume.
-
tagResource(
{required String resourceArn, required Map< String, String> tags}) → Future<void> - Tags a resource.
-
toString(
) → String -
A string representation of this object.
inherited
-
untagResource(
{required String resourceArn, required List< String> tagKeys}) → Future<void> - Removes tags from a resource.
-
updateDeviceMetadata(
{required String deviceId, String? description}) → Future< UpdateDeviceMetadataResponse> - Updates a device's metadata.
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited