@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AWSPanoramaClient extends AmazonWebServiceClient implements AWSPanorama
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.
LOGGING_AWS_REQUEST_METRICENDPOINT_PREFIXaddRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffsetpublic static AWSPanoramaClientBuilder builder()
public CreateApplicationInstanceResult createApplicationInstance(CreateApplicationInstanceRequest request)
Creates an application instance and deploys it to a device.
createApplicationInstance in interface AWSPanoramacreateApplicationInstanceRequest - 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.public CreateJobForDevicesResult createJobForDevices(CreateJobForDevicesRequest request)
Creates a job to run on a device. A job can update a device's software or reboot it.
createJobForDevices in interface AWSPanoramacreateJobForDevicesRequest - 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.public CreateNodeFromTemplateJobResult createNodeFromTemplateJob(CreateNodeFromTemplateJobRequest request)
Creates a camera stream node.
createNodeFromTemplateJob in interface AWSPanoramacreateNodeFromTemplateJobRequest - 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.public CreatePackageResult createPackage(CreatePackageRequest request)
Creates a package and storage location in an Amazon S3 access point.
createPackage in interface AWSPanoramacreatePackageRequest - 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.public CreatePackageImportJobResult createPackageImportJob(CreatePackageImportJobRequest request)
Imports a node package.
createPackageImportJob in interface AWSPanoramacreatePackageImportJobRequest - 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.public DeleteDeviceResult deleteDevice(DeleteDeviceRequest request)
Deletes a device.
deleteDevice in interface AWSPanoramadeleteDeviceRequest - 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.public DeletePackageResult deletePackage(DeletePackageRequest request)
Deletes a package.
To delete a package, you need permission to call s3:DeleteObject in addition to permissions for the
AWS Panorama API.
deletePackage in interface AWSPanoramadeletePackageRequest - 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.public DeregisterPackageVersionResult deregisterPackageVersion(DeregisterPackageVersionRequest request)
Deregisters a package version.
deregisterPackageVersion in interface AWSPanoramaderegisterPackageVersionRequest - 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.public DescribeApplicationInstanceResult describeApplicationInstance(DescribeApplicationInstanceRequest request)
Returns information about an application instance on a device.
describeApplicationInstance in interface AWSPanoramadescribeApplicationInstanceRequest - 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.public DescribeApplicationInstanceDetailsResult describeApplicationInstanceDetails(DescribeApplicationInstanceDetailsRequest request)
Returns information about an application instance's configuration manifest.
describeApplicationInstanceDetails in interface AWSPanoramadescribeApplicationInstanceDetailsRequest - 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.public DescribeDeviceResult describeDevice(DescribeDeviceRequest request)
Returns information about a device.
describeDevice in interface AWSPanoramadescribeDeviceRequest - 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.public DescribeDeviceJobResult describeDeviceJob(DescribeDeviceJobRequest request)
Returns information about a device job.
describeDeviceJob in interface AWSPanoramadescribeDeviceJobRequest - 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.public DescribeNodeResult describeNode(DescribeNodeRequest request)
Returns information about a node.
describeNode in interface AWSPanoramadescribeNodeRequest - 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.public DescribeNodeFromTemplateJobResult describeNodeFromTemplateJob(DescribeNodeFromTemplateJobRequest request)
Returns information about a job to create a camera stream node.
describeNodeFromTemplateJob in interface AWSPanoramadescribeNodeFromTemplateJobRequest - 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.public DescribePackageResult describePackage(DescribePackageRequest request)
Returns information about a package.
describePackage in interface AWSPanoramadescribePackageRequest - 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.public DescribePackageImportJobResult describePackageImportJob(DescribePackageImportJobRequest request)
Returns information about a package import job.
describePackageImportJob in interface AWSPanoramadescribePackageImportJobRequest - 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.public DescribePackageVersionResult describePackageVersion(DescribePackageVersionRequest request)
Returns information about a package version.
describePackageVersion in interface AWSPanoramadescribePackageVersionRequest - 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.public ListApplicationInstanceDependenciesResult listApplicationInstanceDependencies(ListApplicationInstanceDependenciesRequest request)
Returns a list of application instance dependencies.
listApplicationInstanceDependencies in interface AWSPanoramalistApplicationInstanceDependenciesRequest - AccessDeniedException - The requestor does not have permission to access the target action or resource.InternalServerException - An internal error occurred.public ListApplicationInstanceNodeInstancesResult listApplicationInstanceNodeInstances(ListApplicationInstanceNodeInstancesRequest request)
Returns a list of application node instances.
listApplicationInstanceNodeInstances in interface AWSPanoramalistApplicationInstanceNodeInstancesRequest - AccessDeniedException - The requestor does not have permission to access the target action or resource.InternalServerException - An internal error occurred.public ListApplicationInstancesResult listApplicationInstances(ListApplicationInstancesRequest request)
Returns a list of application instances.
listApplicationInstances in interface AWSPanoramalistApplicationInstancesRequest - AccessDeniedException - The requestor does not have permission to access the target action or resource.InternalServerException - An internal error occurred.public ListDevicesResult listDevices(ListDevicesRequest request)
Returns a list of devices.
listDevices in interface AWSPanoramalistDevicesRequest - 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.public ListDevicesJobsResult listDevicesJobs(ListDevicesJobsRequest request)
Returns a list of jobs.
listDevicesJobs in interface AWSPanoramalistDevicesJobsRequest - 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.public ListNodeFromTemplateJobsResult listNodeFromTemplateJobs(ListNodeFromTemplateJobsRequest request)
Returns a list of camera stream node jobs.
listNodeFromTemplateJobs in interface AWSPanoramalistNodeFromTemplateJobsRequest - 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.public ListNodesResult listNodes(ListNodesRequest request)
Returns a list of nodes.
listNodes in interface AWSPanoramalistNodesRequest - ConflictException - The target resource is in use.ValidationException - The request contains an invalid parameter value.InternalServerException - An internal error occurred.public ListPackageImportJobsResult listPackageImportJobs(ListPackageImportJobsRequest request)
Returns a list of package import jobs.
listPackageImportJobs in interface AWSPanoramalistPackageImportJobsRequest - 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.public ListPackagesResult listPackages(ListPackagesRequest request)
Returns a list of packages.
listPackages in interface AWSPanoramalistPackagesRequest - 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.public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
Returns a list of tags for a resource.
listTagsForResource in interface AWSPanoramalistTagsForResourceRequest - ValidationException - The request contains an invalid parameter value.ResourceNotFoundException - The target resource was not found.InternalServerException - An internal error occurred.public ProvisionDeviceResult provisionDevice(ProvisionDeviceRequest request)
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.
provisionDevice in interface AWSPanoramaprovisionDeviceRequest - 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.public RegisterPackageVersionResult registerPackageVersion(RegisterPackageVersionRequest request)
Registers a package version.
registerPackageVersion in interface AWSPanoramaregisterPackageVersionRequest - 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.public RemoveApplicationInstanceResult removeApplicationInstance(RemoveApplicationInstanceRequest request)
Removes an application instance.
removeApplicationInstance in interface AWSPanoramaremoveApplicationInstanceRequest - 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.public SignalApplicationInstanceNodeInstancesResult signalApplicationInstanceNodeInstances(SignalApplicationInstanceNodeInstancesRequest request)
Signal camera nodes to stop or resume.
signalApplicationInstanceNodeInstances in interface AWSPanoramasignalApplicationInstanceNodeInstancesRequest - 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.public TagResourceResult tagResource(TagResourceRequest request)
Tags a resource.
tagResource in interface AWSPanoramatagResourceRequest - ValidationException - The request contains an invalid parameter value.ResourceNotFoundException - The target resource was not found.InternalServerException - An internal error occurred.public UntagResourceResult untagResource(UntagResourceRequest request)
Removes tags from a resource.
untagResource in interface AWSPanoramauntagResourceRequest - ValidationException - The request contains an invalid parameter value.ResourceNotFoundException - The target resource was not found.InternalServerException - An internal error occurred.public UpdateDeviceMetadataResult updateDeviceMetadata(UpdateDeviceMetadataRequest request)
Updates a device's metadata.
updateDeviceMetadata in interface AWSPanoramaupdateDeviceMetadataRequest - 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.public 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 the request.
getCachedResponseMetadata in interface AWSPanoramarequest - The originally executed requestpublic void shutdown()
AmazonWebServiceClientshutdown in interface AWSPanoramashutdown in class AmazonWebServiceClient