@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_METRIC
ENDPOINT_PREFIX
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset
public static AWSPanoramaClientBuilder builder()
public CreateApplicationInstanceResult createApplicationInstance(CreateApplicationInstanceRequest request)
Creates an application instance and deploys it to a device.
createApplicationInstance
in interface AWSPanorama
createApplicationInstanceRequest
- ValidationException
- The request contains an invalid parameter value.InternalServerException
- An internal error occurred.AccessDeniedException
- The requestor does not have permission to access the target action or resource.ServiceQuotaExceededException
- The request would cause a limit to be exceeded.public CreateJobForDevicesResult createJobForDevices(CreateJobForDevicesRequest request)
Creates a job to run on one or more devices.
createJobForDevices
in interface AWSPanorama
createJobForDevicesRequest
- ConflictException
- The target resource is in use.ValidationException
- The request contains an invalid parameter value.InternalServerException
- An internal error occurred.AccessDeniedException
- The requestor does not have permission to access the target action or resource.ResourceNotFoundException
- The target resource was not found.public CreateNodeFromTemplateJobResult createNodeFromTemplateJob(CreateNodeFromTemplateJobRequest request)
Creates a camera stream node.
createNodeFromTemplateJob
in interface AWSPanorama
createNodeFromTemplateJobRequest
- ValidationException
- The request contains an invalid parameter value.InternalServerException
- An internal error occurred.AccessDeniedException
- The requestor does not have permission to access the target action or resource.ConflictException
- The target resource is in use.public CreatePackageResult createPackage(CreatePackageRequest request)
Creates a package and storage location in an Amazon S3 access point.
createPackage
in interface AWSPanorama
createPackageRequest
- ValidationException
- The request contains an invalid parameter value.InternalServerException
- An internal error occurred.AccessDeniedException
- The requestor does not have permission to access the target action or resource.ConflictException
- The target resource is in use.public CreatePackageImportJobResult createPackageImportJob(CreatePackageImportJobRequest request)
Imports a node package.
createPackageImportJob
in interface AWSPanorama
createPackageImportJobRequest
- ValidationException
- The request contains an invalid parameter value.InternalServerException
- An internal error occurred.AccessDeniedException
- The requestor does not have permission to access the target action or resource.ConflictException
- The target resource is in use.public DeleteDeviceResult deleteDevice(DeleteDeviceRequest request)
Deletes a device.
deleteDevice
in interface AWSPanorama
deleteDeviceRequest
- ConflictException
- The target resource is in use.ValidationException
- The request contains an invalid parameter value.InternalServerException
- An internal error occurred.AccessDeniedException
- The requestor does not have permission to access the target action or resource.ResourceNotFoundException
- The target resource was not found.public DeletePackageResult deletePackage(DeletePackageRequest request)
Deletes a package.
deletePackage
in interface AWSPanorama
deletePackageRequest
- ValidationException
- The request contains an invalid parameter value.InternalServerException
- An internal error occurred.AccessDeniedException
- The requestor does not have permission to access the target action or resource.ConflictException
- The target resource is in use.ResourceNotFoundException
- The target resource was not found.public DeregisterPackageVersionResult deregisterPackageVersion(DeregisterPackageVersionRequest request)
Deregisters a package version.
deregisterPackageVersion
in interface AWSPanorama
deregisterPackageVersionRequest
- ValidationException
- The request contains an invalid parameter value.InternalServerException
- An internal error occurred.AccessDeniedException
- The requestor does not have permission to access the target action or resource.ConflictException
- The target resource is in use.ResourceNotFoundException
- The target resource was not found.public DescribeApplicationInstanceResult describeApplicationInstance(DescribeApplicationInstanceRequest request)
Returns information about an application instance on a device.
describeApplicationInstance
in interface AWSPanorama
describeApplicationInstanceRequest
- ConflictException
- The target resource is in use.ValidationException
- The request contains an invalid parameter value.InternalServerException
- An internal error occurred.AccessDeniedException
- The requestor does not have permission to access the target action or resource.ResourceNotFoundException
- The target resource was not found.public DescribeApplicationInstanceDetailsResult describeApplicationInstanceDetails(DescribeApplicationInstanceDetailsRequest request)
Returns information about an application instance's configuration manifest.
describeApplicationInstanceDetails
in interface AWSPanorama
describeApplicationInstanceDetailsRequest
- ConflictException
- The target resource is in use.ValidationException
- The request contains an invalid parameter value.InternalServerException
- An internal error occurred.AccessDeniedException
- The requestor does not have permission to access the target action or resource.ResourceNotFoundException
- The target resource was not found.public DescribeDeviceResult describeDevice(DescribeDeviceRequest request)
Returns information about a device.
describeDevice
in interface AWSPanorama
describeDeviceRequest
- ValidationException
- The request contains an invalid parameter value.InternalServerException
- An internal error occurred.AccessDeniedException
- The requestor does not have permission to access the target action or resource.ResourceNotFoundException
- The target resource was not found.public DescribeDeviceJobResult describeDeviceJob(DescribeDeviceJobRequest request)
Returns information about a device job.
describeDeviceJob
in interface AWSPanorama
describeDeviceJobRequest
- ConflictException
- The target resource is in use.ValidationException
- The request contains an invalid parameter value.InternalServerException
- An internal error occurred.AccessDeniedException
- The requestor does not have permission to access the target action or resource.ResourceNotFoundException
- The target resource was not found.public DescribeNodeResult describeNode(DescribeNodeRequest request)
Returns information about a node.
describeNode
in interface AWSPanorama
describeNodeRequest
- ConflictException
- The target resource is in use.ValidationException
- The request contains an invalid parameter value.InternalServerException
- An internal error occurred.AccessDeniedException
- The requestor does not have permission to access the target action or resource.ResourceNotFoundException
- The target resource was not found.public DescribeNodeFromTemplateJobResult describeNodeFromTemplateJob(DescribeNodeFromTemplateJobRequest request)
Returns information about a job to create a camera stream node.
describeNodeFromTemplateJob
in interface AWSPanorama
describeNodeFromTemplateJobRequest
- ValidationException
- The request contains an invalid parameter value.InternalServerException
- An internal error occurred.AccessDeniedException
- The requestor does not have permission to access the target action or resource.ConflictException
- The target resource is in use.public DescribePackageResult describePackage(DescribePackageRequest request)
Returns information about a package.
describePackage
in interface AWSPanorama
describePackageRequest
- ValidationException
- The request contains an invalid parameter value.InternalServerException
- An internal error occurred.AccessDeniedException
- The requestor does not have permission to access the target action or resource.ConflictException
- The target resource is in use.ResourceNotFoundException
- The target resource was not found.public DescribePackageImportJobResult describePackageImportJob(DescribePackageImportJobRequest request)
Returns information about a package import job.
describePackageImportJob
in interface AWSPanorama
describePackageImportJobRequest
- ValidationException
- The request contains an invalid parameter value.InternalServerException
- An internal error occurred.AccessDeniedException
- The requestor does not have permission to access the target action or resource.ConflictException
- The target resource is in use.public DescribePackageVersionResult describePackageVersion(DescribePackageVersionRequest request)
Returns information about a package version.
describePackageVersion
in interface AWSPanorama
describePackageVersionRequest
- ValidationException
- The request contains an invalid parameter value.InternalServerException
- An internal error occurred.AccessDeniedException
- The requestor does not have permission to access the target action or resource.ConflictException
- The target resource is in use.ResourceNotFoundException
- The target resource was not found.public ListApplicationInstanceDependenciesResult listApplicationInstanceDependencies(ListApplicationInstanceDependenciesRequest request)
Returns a list of application instance dependencies.
listApplicationInstanceDependencies
in interface AWSPanorama
listApplicationInstanceDependenciesRequest
- 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 AWSPanorama
listApplicationInstanceNodeInstancesRequest
- 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 AWSPanorama
listApplicationInstancesRequest
- 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 AWSPanorama
listDevicesRequest
- ConflictException
- The target resource is in use.ValidationException
- The request contains an invalid parameter value.InternalServerException
- An internal error occurred.AccessDeniedException
- The requestor does not have permission to access the target action or resource.public ListDevicesJobsResult listDevicesJobs(ListDevicesJobsRequest request)
Returns a list of jobs.
listDevicesJobs
in interface AWSPanorama
listDevicesJobsRequest
- ConflictException
- The target resource is in use.ValidationException
- The request contains an invalid parameter value.InternalServerException
- An internal error occurred.AccessDeniedException
- The requestor does not have permission to access the target action or resource.ResourceNotFoundException
- The target resource was not found.public ListNodeFromTemplateJobsResult listNodeFromTemplateJobs(ListNodeFromTemplateJobsRequest request)
Returns a list of camera stream node jobs.
listNodeFromTemplateJobs
in interface AWSPanorama
listNodeFromTemplateJobsRequest
- ValidationException
- The request contains an invalid parameter value.InternalServerException
- An internal error occurred.AccessDeniedException
- The requestor does not have permission to access the target action or resource.ConflictException
- The target resource is in use.public ListNodesResult listNodes(ListNodesRequest request)
Returns a list of nodes.
listNodes
in interface AWSPanorama
listNodesRequest
- 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 AWSPanorama
listPackageImportJobsRequest
- ValidationException
- The request contains an invalid parameter value.InternalServerException
- An internal error occurred.AccessDeniedException
- The requestor does not have permission to access the target action or resource.ConflictException
- The target resource is in use.public ListPackagesResult listPackages(ListPackagesRequest request)
Returns a list of packages.
listPackages
in interface AWSPanorama
listPackagesRequest
- ValidationException
- The request contains an invalid parameter value.InternalServerException
- An internal error occurred.AccessDeniedException
- The requestor does not have permission to access the target action or resource.ConflictException
- The target resource is in use.ResourceNotFoundException
- The target resource was not found.public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
Returns a list of tags for a resource.
listTagsForResource
in interface AWSPanorama
listTagsForResourceRequest
- ResourceNotFoundException
- The target resource was not found.ValidationException
- The request contains an invalid parameter value.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. Transfer the configuration archive to the device with the included USB storage device within 5 minutes.
provisionDevice
in interface AWSPanorama
provisionDeviceRequest
- ConflictException
- The target resource is in use.ValidationException
- The request contains an invalid parameter value.InternalServerException
- An internal error occurred.AccessDeniedException
- The requestor does not have permission to access the target action or resource.ServiceQuotaExceededException
- The request would cause a limit to be exceeded.public RegisterPackageVersionResult registerPackageVersion(RegisterPackageVersionRequest request)
Registers a package version.
registerPackageVersion
in interface AWSPanorama
registerPackageVersionRequest
- ValidationException
- The request contains an invalid parameter value.InternalServerException
- An internal error occurred.AccessDeniedException
- The requestor does not have permission to access the target action or resource.ConflictException
- The target resource is in use.public RemoveApplicationInstanceResult removeApplicationInstance(RemoveApplicationInstanceRequest request)
Removes an application instance.
removeApplicationInstance
in interface AWSPanorama
removeApplicationInstanceRequest
- ConflictException
- The target resource is in use.ValidationException
- The request contains an invalid parameter value.InternalServerException
- An internal error occurred.AccessDeniedException
- The requestor does not have permission to access the target action or resource.ResourceNotFoundException
- The target resource was not found.public TagResourceResult tagResource(TagResourceRequest request)
Tags a resource.
tagResource
in interface AWSPanorama
tagResourceRequest
- ResourceNotFoundException
- The target resource was not found.ValidationException
- The request contains an invalid parameter value.InternalServerException
- An internal error occurred.public UntagResourceResult untagResource(UntagResourceRequest request)
Removes tags from a resource.
untagResource
in interface AWSPanorama
untagResourceRequest
- ResourceNotFoundException
- The target resource was not found.ValidationException
- The request contains an invalid parameter value.InternalServerException
- An internal error occurred.public UpdateDeviceMetadataResult updateDeviceMetadata(UpdateDeviceMetadataRequest request)
Updates a device's metadata.
updateDeviceMetadata
in interface AWSPanorama
updateDeviceMetadataRequest
- ConflictException
- The target resource is in use.ValidationException
- The request contains an invalid parameter value.InternalServerException
- An internal error occurred.AccessDeniedException
- The requestor does not have permission to access the target action or resource.ResourceNotFoundException
- The target resource was not found.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 AWSPanorama
request
- The originally executed requestpublic void shutdown()
AmazonWebServiceClient
shutdown
in interface AWSPanorama
shutdown
in class AmazonWebServiceClient