@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AWSPanorama
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAWSPanorama
instead.
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.
Modifier and Type | Field and Description |
---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
Modifier and Type | Method and Description |
---|---|
CreateApplicationInstanceResult |
createApplicationInstance(CreateApplicationInstanceRequest createApplicationInstanceRequest)
Creates an application instance and deploys it to a device.
|
CreateJobForDevicesResult |
createJobForDevices(CreateJobForDevicesRequest createJobForDevicesRequest)
Creates a job to run on a device.
|
CreateNodeFromTemplateJobResult |
createNodeFromTemplateJob(CreateNodeFromTemplateJobRequest createNodeFromTemplateJobRequest)
Creates a camera stream node.
|
CreatePackageResult |
createPackage(CreatePackageRequest createPackageRequest)
Creates a package and storage location in an Amazon S3 access point.
|
CreatePackageImportJobResult |
createPackageImportJob(CreatePackageImportJobRequest createPackageImportJobRequest)
Imports a node package.
|
DeleteDeviceResult |
deleteDevice(DeleteDeviceRequest deleteDeviceRequest)
Deletes a device.
|
DeletePackageResult |
deletePackage(DeletePackageRequest deletePackageRequest)
Deletes a package.
|
DeregisterPackageVersionResult |
deregisterPackageVersion(DeregisterPackageVersionRequest deregisterPackageVersionRequest)
Deregisters a package version.
|
DescribeApplicationInstanceResult |
describeApplicationInstance(DescribeApplicationInstanceRequest describeApplicationInstanceRequest)
Returns information about an application instance on a device.
|
DescribeApplicationInstanceDetailsResult |
describeApplicationInstanceDetails(DescribeApplicationInstanceDetailsRequest describeApplicationInstanceDetailsRequest)
Returns information about an application instance's configuration manifest.
|
DescribeDeviceResult |
describeDevice(DescribeDeviceRequest describeDeviceRequest)
Returns information about a device.
|
DescribeDeviceJobResult |
describeDeviceJob(DescribeDeviceJobRequest describeDeviceJobRequest)
Returns information about a device job.
|
DescribeNodeResult |
describeNode(DescribeNodeRequest describeNodeRequest)
Returns information about a node.
|
DescribeNodeFromTemplateJobResult |
describeNodeFromTemplateJob(DescribeNodeFromTemplateJobRequest describeNodeFromTemplateJobRequest)
Returns information about a job to create a camera stream node.
|
DescribePackageResult |
describePackage(DescribePackageRequest describePackageRequest)
Returns information about a package.
|
DescribePackageImportJobResult |
describePackageImportJob(DescribePackageImportJobRequest describePackageImportJobRequest)
Returns information about a package import job.
|
DescribePackageVersionResult |
describePackageVersion(DescribePackageVersionRequest describePackageVersionRequest)
Returns information about a package version.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
ListApplicationInstanceDependenciesResult |
listApplicationInstanceDependencies(ListApplicationInstanceDependenciesRequest listApplicationInstanceDependenciesRequest)
Returns a list of application instance dependencies.
|
ListApplicationInstanceNodeInstancesResult |
listApplicationInstanceNodeInstances(ListApplicationInstanceNodeInstancesRequest listApplicationInstanceNodeInstancesRequest)
Returns a list of application node instances.
|
ListApplicationInstancesResult |
listApplicationInstances(ListApplicationInstancesRequest listApplicationInstancesRequest)
Returns a list of application instances.
|
ListDevicesResult |
listDevices(ListDevicesRequest listDevicesRequest)
Returns a list of devices.
|
ListDevicesJobsResult |
listDevicesJobs(ListDevicesJobsRequest listDevicesJobsRequest)
Returns a list of jobs.
|
ListNodeFromTemplateJobsResult |
listNodeFromTemplateJobs(ListNodeFromTemplateJobsRequest listNodeFromTemplateJobsRequest)
Returns a list of camera stream node jobs.
|
ListNodesResult |
listNodes(ListNodesRequest listNodesRequest)
Returns a list of nodes.
|
ListPackageImportJobsResult |
listPackageImportJobs(ListPackageImportJobsRequest listPackageImportJobsRequest)
Returns a list of package import jobs.
|
ListPackagesResult |
listPackages(ListPackagesRequest listPackagesRequest)
Returns a list of packages.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Returns a list of tags for a resource.
|
ProvisionDeviceResult |
provisionDevice(ProvisionDeviceRequest provisionDeviceRequest)
Creates a device and returns a configuration archive.
|
RegisterPackageVersionResult |
registerPackageVersion(RegisterPackageVersionRequest registerPackageVersionRequest)
Registers a package version.
|
RemoveApplicationInstanceResult |
removeApplicationInstance(RemoveApplicationInstanceRequest removeApplicationInstanceRequest)
Removes an application instance.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
SignalApplicationInstanceNodeInstancesResult |
signalApplicationInstanceNodeInstances(SignalApplicationInstanceNodeInstancesRequest signalApplicationInstanceNodeInstancesRequest)
Signal camera nodes to stop or resume.
|
TagResourceResult |
tagResource(TagResourceRequest tagResourceRequest)
Tags a resource.
|
UntagResourceResult |
untagResource(UntagResourceRequest untagResourceRequest)
Removes tags from a resource.
|
UpdateDeviceMetadataResult |
updateDeviceMetadata(UpdateDeviceMetadataRequest updateDeviceMetadataRequest)
Updates a device's metadata.
|
static final String ENDPOINT_PREFIX
CreateApplicationInstanceResult createApplicationInstance(CreateApplicationInstanceRequest createApplicationInstanceRequest)
Creates an application instance and deploys it to a device.
createApplicationInstanceRequest
- ValidationException
- The request contains an invalid parameter value.AccessDeniedException
- The requestor does not have permission to access the target action or resource.ServiceQuotaExceededException
- The request would cause a limit to be exceeded.InternalServerException
- An internal error occurred.CreateJobForDevicesResult createJobForDevices(CreateJobForDevicesRequest createJobForDevicesRequest)
Creates a job to run on a device. A job can update a device's software or reboot it.
createJobForDevicesRequest
- ConflictException
- The target resource is in use.ValidationException
- The request contains an invalid parameter value.AccessDeniedException
- The requestor does not have permission to access the target action or resource.ResourceNotFoundException
- The target resource was not found.InternalServerException
- An internal error occurred.CreateNodeFromTemplateJobResult createNodeFromTemplateJob(CreateNodeFromTemplateJobRequest createNodeFromTemplateJobRequest)
Creates a camera stream node.
createNodeFromTemplateJobRequest
- ConflictException
- The target resource is in use.ValidationException
- The request contains an invalid parameter value.AccessDeniedException
- The requestor does not have permission to access the target action or resource.InternalServerException
- An internal error occurred.CreatePackageResult createPackage(CreatePackageRequest createPackageRequest)
Creates a package and storage location in an Amazon S3 access point.
createPackageRequest
- ConflictException
- The target resource is in use.ValidationException
- The request contains an invalid parameter value.AccessDeniedException
- The requestor does not have permission to access the target action or resource.InternalServerException
- An internal error occurred.CreatePackageImportJobResult createPackageImportJob(CreatePackageImportJobRequest createPackageImportJobRequest)
Imports a node package.
createPackageImportJobRequest
- ConflictException
- The target resource is in use.ValidationException
- The request contains an invalid parameter value.AccessDeniedException
- The requestor does not have permission to access the target action or resource.InternalServerException
- An internal error occurred.DeleteDeviceResult deleteDevice(DeleteDeviceRequest deleteDeviceRequest)
Deletes a device.
deleteDeviceRequest
- ConflictException
- The target resource is in use.ValidationException
- The request contains an invalid parameter value.AccessDeniedException
- The requestor does not have permission to access the target action or resource.ResourceNotFoundException
- The target resource was not found.InternalServerException
- An internal error occurred.DeletePackageResult deletePackage(DeletePackageRequest deletePackageRequest)
Deletes a package.
To delete a package, you need permission to call s3:DeleteObject
in addition to permissions for the
AWS Panorama API.
deletePackageRequest
- ConflictException
- The target resource is in use.ValidationException
- The request contains an invalid parameter value.AccessDeniedException
- The requestor does not have permission to access the target action or resource.ResourceNotFoundException
- The target resource was not found.InternalServerException
- An internal error occurred.DeregisterPackageVersionResult deregisterPackageVersion(DeregisterPackageVersionRequest deregisterPackageVersionRequest)
Deregisters a package version.
deregisterPackageVersionRequest
- ConflictException
- The target resource is in use.ValidationException
- The request contains an invalid parameter value.AccessDeniedException
- The requestor does not have permission to access the target action or resource.ResourceNotFoundException
- The target resource was not found.InternalServerException
- An internal error occurred.DescribeApplicationInstanceResult describeApplicationInstance(DescribeApplicationInstanceRequest describeApplicationInstanceRequest)
Returns information about an application instance on a device.
describeApplicationInstanceRequest
- ConflictException
- The target resource is in use.ValidationException
- The request contains an invalid parameter value.AccessDeniedException
- The requestor does not have permission to access the target action or resource.ResourceNotFoundException
- The target resource was not found.InternalServerException
- An internal error occurred.DescribeApplicationInstanceDetailsResult describeApplicationInstanceDetails(DescribeApplicationInstanceDetailsRequest describeApplicationInstanceDetailsRequest)
Returns information about an application instance's configuration manifest.
describeApplicationInstanceDetailsRequest
- ConflictException
- The target resource is in use.ValidationException
- The request contains an invalid parameter value.AccessDeniedException
- The requestor does not have permission to access the target action or resource.ResourceNotFoundException
- The target resource was not found.InternalServerException
- An internal error occurred.DescribeDeviceResult describeDevice(DescribeDeviceRequest describeDeviceRequest)
Returns information about a device.
describeDeviceRequest
- ValidationException
- The request contains an invalid parameter value.AccessDeniedException
- The requestor does not have permission to access the target action or resource.ResourceNotFoundException
- The target resource was not found.InternalServerException
- An internal error occurred.DescribeDeviceJobResult describeDeviceJob(DescribeDeviceJobRequest describeDeviceJobRequest)
Returns information about a device job.
describeDeviceJobRequest
- ConflictException
- The target resource is in use.ValidationException
- The request contains an invalid parameter value.AccessDeniedException
- The requestor does not have permission to access the target action or resource.ResourceNotFoundException
- The target resource was not found.InternalServerException
- An internal error occurred.DescribeNodeResult describeNode(DescribeNodeRequest describeNodeRequest)
Returns information about a node.
describeNodeRequest
- ConflictException
- The target resource is in use.ValidationException
- The request contains an invalid parameter value.AccessDeniedException
- The requestor does not have permission to access the target action or resource.ResourceNotFoundException
- The target resource was not found.InternalServerException
- An internal error occurred.DescribeNodeFromTemplateJobResult describeNodeFromTemplateJob(DescribeNodeFromTemplateJobRequest describeNodeFromTemplateJobRequest)
Returns information about a job to create a camera stream node.
describeNodeFromTemplateJobRequest
- ConflictException
- The target resource is in use.ValidationException
- The request contains an invalid parameter value.AccessDeniedException
- The requestor does not have permission to access the target action or resource.InternalServerException
- An internal error occurred.DescribePackageResult describePackage(DescribePackageRequest describePackageRequest)
Returns information about a package.
describePackageRequest
- ConflictException
- The target resource is in use.ValidationException
- The request contains an invalid parameter value.AccessDeniedException
- The requestor does not have permission to access the target action or resource.ResourceNotFoundException
- The target resource was not found.InternalServerException
- An internal error occurred.DescribePackageImportJobResult describePackageImportJob(DescribePackageImportJobRequest describePackageImportJobRequest)
Returns information about a package import job.
describePackageImportJobRequest
- ConflictException
- The target resource is in use.ValidationException
- The request contains an invalid parameter value.AccessDeniedException
- The requestor does not have permission to access the target action or resource.InternalServerException
- An internal error occurred.DescribePackageVersionResult describePackageVersion(DescribePackageVersionRequest describePackageVersionRequest)
Returns information about a package version.
describePackageVersionRequest
- ConflictException
- The target resource is in use.ValidationException
- The request contains an invalid parameter value.AccessDeniedException
- The requestor does not have permission to access the target action or resource.ResourceNotFoundException
- The target resource was not found.InternalServerException
- An internal error occurred.ListApplicationInstanceDependenciesResult listApplicationInstanceDependencies(ListApplicationInstanceDependenciesRequest listApplicationInstanceDependenciesRequest)
Returns a list of application instance dependencies.
listApplicationInstanceDependenciesRequest
- AccessDeniedException
- The requestor does not have permission to access the target action or resource.InternalServerException
- An internal error occurred.ListApplicationInstanceNodeInstancesResult listApplicationInstanceNodeInstances(ListApplicationInstanceNodeInstancesRequest listApplicationInstanceNodeInstancesRequest)
Returns a list of application node instances.
listApplicationInstanceNodeInstancesRequest
- AccessDeniedException
- The requestor does not have permission to access the target action or resource.InternalServerException
- An internal error occurred.ListApplicationInstancesResult listApplicationInstances(ListApplicationInstancesRequest listApplicationInstancesRequest)
Returns a list of application instances.
listApplicationInstancesRequest
- AccessDeniedException
- The requestor does not have permission to access the target action or resource.InternalServerException
- An internal error occurred.ListDevicesResult listDevices(ListDevicesRequest listDevicesRequest)
Returns a list of devices.
listDevicesRequest
- ConflictException
- The target resource is in use.ValidationException
- The request contains an invalid parameter value.AccessDeniedException
- The requestor does not have permission to access the target action or resource.InternalServerException
- An internal error occurred.ListDevicesJobsResult listDevicesJobs(ListDevicesJobsRequest listDevicesJobsRequest)
Returns a list of jobs.
listDevicesJobsRequest
- ConflictException
- The target resource is in use.ValidationException
- The request contains an invalid parameter value.AccessDeniedException
- The requestor does not have permission to access the target action or resource.ResourceNotFoundException
- The target resource was not found.InternalServerException
- An internal error occurred.ListNodeFromTemplateJobsResult listNodeFromTemplateJobs(ListNodeFromTemplateJobsRequest listNodeFromTemplateJobsRequest)
Returns a list of camera stream node jobs.
listNodeFromTemplateJobsRequest
- ConflictException
- The target resource is in use.ValidationException
- The request contains an invalid parameter value.AccessDeniedException
- The requestor does not have permission to access the target action or resource.InternalServerException
- An internal error occurred.ListNodesResult listNodes(ListNodesRequest listNodesRequest)
Returns a list of nodes.
listNodesRequest
- ConflictException
- The target resource is in use.ValidationException
- The request contains an invalid parameter value.InternalServerException
- An internal error occurred.ListPackageImportJobsResult listPackageImportJobs(ListPackageImportJobsRequest listPackageImportJobsRequest)
Returns a list of package import jobs.
listPackageImportJobsRequest
- ConflictException
- The target resource is in use.ValidationException
- The request contains an invalid parameter value.AccessDeniedException
- The requestor does not have permission to access the target action or resource.InternalServerException
- An internal error occurred.ListPackagesResult listPackages(ListPackagesRequest listPackagesRequest)
Returns a list of packages.
listPackagesRequest
- ConflictException
- The target resource is in use.ValidationException
- The request contains an invalid parameter value.AccessDeniedException
- The requestor does not have permission to access the target action or resource.ResourceNotFoundException
- The target resource was not found.InternalServerException
- An internal error occurred.ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Returns a list of tags for a resource.
listTagsForResourceRequest
- ValidationException
- The request contains an invalid parameter value.ResourceNotFoundException
- The target resource was not found.InternalServerException
- An internal error occurred.ProvisionDeviceResult provisionDevice(ProvisionDeviceRequest provisionDeviceRequest)
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.
provisionDeviceRequest
- ConflictException
- The target resource is in use.ValidationException
- The request contains an invalid parameter value.AccessDeniedException
- The requestor does not have permission to access the target action or resource.ServiceQuotaExceededException
- The request would cause a limit to be exceeded.InternalServerException
- An internal error occurred.RegisterPackageVersionResult registerPackageVersion(RegisterPackageVersionRequest registerPackageVersionRequest)
Registers a package version.
registerPackageVersionRequest
- ConflictException
- The target resource is in use.ValidationException
- The request contains an invalid parameter value.AccessDeniedException
- The requestor does not have permission to access the target action or resource.InternalServerException
- An internal error occurred.RemoveApplicationInstanceResult removeApplicationInstance(RemoveApplicationInstanceRequest removeApplicationInstanceRequest)
Removes an application instance.
removeApplicationInstanceRequest
- ConflictException
- The target resource is in use.ValidationException
- The request contains an invalid parameter value.AccessDeniedException
- The requestor does not have permission to access the target action or resource.ResourceNotFoundException
- The target resource was not found.InternalServerException
- An internal error occurred.SignalApplicationInstanceNodeInstancesResult signalApplicationInstanceNodeInstances(SignalApplicationInstanceNodeInstancesRequest signalApplicationInstanceNodeInstancesRequest)
Signal camera nodes to stop or resume.
signalApplicationInstanceNodeInstancesRequest
- ValidationException
- The request contains an invalid parameter value.AccessDeniedException
- The requestor does not have permission to access the target action or resource.ServiceQuotaExceededException
- The request would cause a limit to be exceeded.InternalServerException
- An internal error occurred.TagResourceResult tagResource(TagResourceRequest tagResourceRequest)
Tags a resource.
tagResourceRequest
- ValidationException
- The request contains an invalid parameter value.ResourceNotFoundException
- The target resource was not found.InternalServerException
- An internal error occurred.UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
Removes tags from a resource.
untagResourceRequest
- ValidationException
- The request contains an invalid parameter value.ResourceNotFoundException
- The target resource was not found.InternalServerException
- An internal error occurred.UpdateDeviceMetadataResult updateDeviceMetadata(UpdateDeviceMetadataRequest updateDeviceMetadataRequest)
Updates a device's metadata.
updateDeviceMetadataRequest
- ConflictException
- The target resource is in use.ValidationException
- The request contains an invalid parameter value.AccessDeniedException
- The requestor does not have permission to access the target action or resource.ResourceNotFoundException
- The target resource was not found.InternalServerException
- An internal error occurred.void shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
request
- The originally executed request.