com.amazonaws.services.panorama

Interface AWSPanorama

All Known Subinterfaces:

AWSPanoramaAsync

All Known Implementing Classes:

AbstractAWSPanorama, AbstractAWSPanoramaAsync, AWSPanoramaAsyncClient, AWSPanoramaClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSPanorama

Interface for accessing Panorama.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSPanorama instead.

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.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

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 one or more devices.
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.
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.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

createApplicationInstance

CreateApplicationInstanceResult createApplicationInstance(CreateApplicationInstanceRequest createApplicationInstanceRequest)

Creates an application instance and deploys it to a device.

Parameters:

createApplicationInstanceRequest -

Returns:

Result of the CreateApplicationInstance operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

createJobForDevices

CreateJobForDevicesResult createJobForDevices(CreateJobForDevicesRequest createJobForDevicesRequest)

Creates a job to run on one or more devices.

Parameters:

createJobForDevicesRequest -

Returns:

Result of the CreateJobForDevices operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

createNodeFromTemplateJob

CreateNodeFromTemplateJobResult createNodeFromTemplateJob(CreateNodeFromTemplateJobRequest createNodeFromTemplateJobRequest)

Creates a camera stream node.

Parameters:

createNodeFromTemplateJobRequest -

Returns:

Result of the CreateNodeFromTemplateJob operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

createPackage

CreatePackageResult createPackage(CreatePackageRequest createPackageRequest)

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

Parameters:

createPackageRequest -

Returns:

Result of the CreatePackage operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

createPackageImportJob

CreatePackageImportJobResult createPackageImportJob(CreatePackageImportJobRequest createPackageImportJobRequest)

Imports a node package.

Parameters:

createPackageImportJobRequest -

Returns:

Result of the CreatePackageImportJob operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

deleteDevice

DeleteDeviceResult deleteDevice(DeleteDeviceRequest deleteDeviceRequest)

Deletes a device.

Parameters:

deleteDeviceRequest -

Returns:

Result of the DeleteDevice operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

deletePackage

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.

Parameters:

deletePackageRequest -

Returns:

Result of the DeletePackage operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

deregisterPackageVersion

DeregisterPackageVersionResult deregisterPackageVersion(DeregisterPackageVersionRequest deregisterPackageVersionRequest)

Deregisters a package version.

Parameters:

deregisterPackageVersionRequest -

Returns:

Result of the DeregisterPackageVersion operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

describeApplicationInstance

DescribeApplicationInstanceResult describeApplicationInstance(DescribeApplicationInstanceRequest describeApplicationInstanceRequest)

Returns information about an application instance on a device.

Parameters:

describeApplicationInstanceRequest -

Returns:

Result of the DescribeApplicationInstance operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

describeApplicationInstanceDetails

DescribeApplicationInstanceDetailsResult describeApplicationInstanceDetails(DescribeApplicationInstanceDetailsRequest describeApplicationInstanceDetailsRequest)

Returns information about an application instance's configuration manifest.

Parameters:

describeApplicationInstanceDetailsRequest -

Returns:

Result of the DescribeApplicationInstanceDetails operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

describeDevice

DescribeDeviceResult describeDevice(DescribeDeviceRequest describeDeviceRequest)

Returns information about a device.

Parameters:

describeDeviceRequest -

Returns:

Result of the DescribeDevice operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

describeDeviceJob

DescribeDeviceJobResult describeDeviceJob(DescribeDeviceJobRequest describeDeviceJobRequest)

Returns information about a device job.

Parameters:

describeDeviceJobRequest -

Returns:

Result of the DescribeDeviceJob operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

describeNode

DescribeNodeResult describeNode(DescribeNodeRequest describeNodeRequest)

Returns information about a node.

Parameters:

describeNodeRequest -

Returns:

Result of the DescribeNode operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

describeNodeFromTemplateJob

DescribeNodeFromTemplateJobResult describeNodeFromTemplateJob(DescribeNodeFromTemplateJobRequest describeNodeFromTemplateJobRequest)

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

Parameters:

describeNodeFromTemplateJobRequest -

Returns:

Result of the DescribeNodeFromTemplateJob operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

describePackage

DescribePackageResult describePackage(DescribePackageRequest describePackageRequest)

Returns information about a package.

Parameters:

describePackageRequest -

Returns:

Result of the DescribePackage operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

describePackageImportJob

DescribePackageImportJobResult describePackageImportJob(DescribePackageImportJobRequest describePackageImportJobRequest)

Returns information about a package import job.

Parameters:

describePackageImportJobRequest -

Returns:

Result of the DescribePackageImportJob operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

describePackageVersion

DescribePackageVersionResult describePackageVersion(DescribePackageVersionRequest describePackageVersionRequest)

Returns information about a package version.

Parameters:

describePackageVersionRequest -

Returns:

Result of the DescribePackageVersion operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listApplicationInstanceDependencies

ListApplicationInstanceDependenciesResult listApplicationInstanceDependencies(ListApplicationInstanceDependenciesRequest listApplicationInstanceDependenciesRequest)

Returns a list of application instance dependencies.

Parameters:

listApplicationInstanceDependenciesRequest -

Returns:

Result of the ListApplicationInstanceDependencies operation returned by the service.

Throws:

AccessDeniedException - The requestor does not have permission to access the target action or resource.

InternalServerException - An internal error occurred.

See Also:

AWS API Documentation

listApplicationInstanceNodeInstances

ListApplicationInstanceNodeInstancesResult listApplicationInstanceNodeInstances(ListApplicationInstanceNodeInstancesRequest listApplicationInstanceNodeInstancesRequest)

Returns a list of application node instances.

Parameters:

listApplicationInstanceNodeInstancesRequest -

Returns:

Result of the ListApplicationInstanceNodeInstances operation returned by the service.

Throws:

AccessDeniedException - The requestor does not have permission to access the target action or resource.

InternalServerException - An internal error occurred.

See Also:

AWS API Documentation

listApplicationInstances

ListApplicationInstancesResult listApplicationInstances(ListApplicationInstancesRequest listApplicationInstancesRequest)

Returns a list of application instances.

Parameters:

listApplicationInstancesRequest -

Returns:

Result of the ListApplicationInstances operation returned by the service.

Throws:

AccessDeniedException - The requestor does not have permission to access the target action or resource.

InternalServerException - An internal error occurred.

See Also:

AWS API Documentation

listDevices

ListDevicesResult listDevices(ListDevicesRequest listDevicesRequest)

Returns a list of devices.

Parameters:

listDevicesRequest -

Returns:

Result of the ListDevices operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listDevicesJobs

ListDevicesJobsResult listDevicesJobs(ListDevicesJobsRequest listDevicesJobsRequest)

Returns a list of jobs.

Parameters:

listDevicesJobsRequest -

Returns:

Result of the ListDevicesJobs operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listNodeFromTemplateJobs

ListNodeFromTemplateJobsResult listNodeFromTemplateJobs(ListNodeFromTemplateJobsRequest listNodeFromTemplateJobsRequest)

Returns a list of camera stream node jobs.

Parameters:

listNodeFromTemplateJobsRequest -

Returns:

Result of the ListNodeFromTemplateJobs operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listNodes

ListNodesResult listNodes(ListNodesRequest listNodesRequest)

Returns a list of nodes.

Parameters:

listNodesRequest -

Returns:

Result of the ListNodes operation returned by the service.

Throws:

ConflictException - The target resource is in use.

ValidationException - The request contains an invalid parameter value.

InternalServerException - An internal error occurred.

See Also:

AWS API Documentation

listPackageImportJobs

ListPackageImportJobsResult listPackageImportJobs(ListPackageImportJobsRequest listPackageImportJobsRequest)

Returns a list of package import jobs.

Parameters:

listPackageImportJobsRequest -

Returns:

Result of the ListPackageImportJobs operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listPackages

ListPackagesResult listPackages(ListPackagesRequest listPackagesRequest)

Returns a list of packages.

Parameters:

listPackagesRequest -

Returns:

Result of the ListPackages operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listTagsForResource

ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

Returns a list of tags for a resource.

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

Throws:

ValidationException - The request contains an invalid parameter value.

ResourceNotFoundException - The target resource was not found.

InternalServerException - An internal error occurred.

See Also:

AWS API Documentation

provisionDevice

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.

Parameters:

provisionDeviceRequest -

Returns:

Result of the ProvisionDevice operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

registerPackageVersion

RegisterPackageVersionResult registerPackageVersion(RegisterPackageVersionRequest registerPackageVersionRequest)

Registers a package version.

Parameters:

registerPackageVersionRequest -

Returns:

Result of the RegisterPackageVersion operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

removeApplicationInstance

RemoveApplicationInstanceResult removeApplicationInstance(RemoveApplicationInstanceRequest removeApplicationInstanceRequest)

Removes an application instance.

Parameters:

removeApplicationInstanceRequest -

Returns:

Result of the RemoveApplicationInstance operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

tagResource

TagResourceResult tagResource(TagResourceRequest tagResourceRequest)

Tags a resource.

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

Throws:

ValidationException - The request contains an invalid parameter value.

ResourceNotFoundException - The target resource was not found.

InternalServerException - An internal error occurred.

See Also:

AWS API Documentation

untagResource

UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)

Removes tags from a resource.

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

Throws:

ValidationException - The request contains an invalid parameter value.

ResourceNotFoundException - The target resource was not found.

InternalServerException - An internal error occurred.

See Also:

AWS API Documentation

updateDeviceMetadata

UpdateDeviceMetadataResult updateDeviceMetadata(UpdateDeviceMetadataRequest updateDeviceMetadataRequest)

Updates a device's metadata.

Parameters:

updateDeviceMetadataRequest -

Returns:

Result of the UpdateDeviceMetadata operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

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. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

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.

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.