# Actions
<a name="API_Operations"></a>

The following actions are supported:
+  [CreateApplicationInstance](API_CreateApplicationInstance.md) 
+  [CreateJobForDevices](API_CreateJobForDevices.md) 
+  [CreateNodeFromTemplateJob](API_CreateNodeFromTemplateJob.md) 
+  [CreatePackage](API_CreatePackage.md) 
+  [CreatePackageImportJob](API_CreatePackageImportJob.md) 
+  [DeleteDevice](API_DeleteDevice.md) 
+  [DeletePackage](API_DeletePackage.md) 
+  [DeregisterPackageVersion](API_DeregisterPackageVersion.md) 
+  [DescribeApplicationInstance](API_DescribeApplicationInstance.md) 
+  [DescribeApplicationInstanceDetails](API_DescribeApplicationInstanceDetails.md) 
+  [DescribeDevice](API_DescribeDevice.md) 
+  [DescribeDeviceJob](API_DescribeDeviceJob.md) 
+  [DescribeNode](API_DescribeNode.md) 
+  [DescribeNodeFromTemplateJob](API_DescribeNodeFromTemplateJob.md) 
+  [DescribePackage](API_DescribePackage.md) 
+  [DescribePackageImportJob](API_DescribePackageImportJob.md) 
+  [DescribePackageVersion](API_DescribePackageVersion.md) 
+  [ListApplicationInstanceDependencies](API_ListApplicationInstanceDependencies.md) 
+  [ListApplicationInstanceNodeInstances](API_ListApplicationInstanceNodeInstances.md) 
+  [ListApplicationInstances](API_ListApplicationInstances.md) 
+  [ListDevices](API_ListDevices.md) 
+  [ListDevicesJobs](API_ListDevicesJobs.md) 
+  [ListNodeFromTemplateJobs](API_ListNodeFromTemplateJobs.md) 
+  [ListNodes](API_ListNodes.md) 
+  [ListPackageImportJobs](API_ListPackageImportJobs.md) 
+  [ListPackages](API_ListPackages.md) 
+  [ListTagsForResource](API_ListTagsForResource.md) 
+  [ProvisionDevice](API_ProvisionDevice.md) 
+  [RegisterPackageVersion](API_RegisterPackageVersion.md) 
+  [RemoveApplicationInstance](API_RemoveApplicationInstance.md) 
+  [SignalApplicationInstanceNodeInstances](API_SignalApplicationInstanceNodeInstances.md) 
+  [TagResource](API_TagResource.md) 
+  [UntagResource](API_UntagResource.md) 
+  [UpdateDeviceMetadata](API_UpdateDeviceMetadata.md) 

# CreateApplicationInstance
<a name="API_CreateApplicationInstance"></a>

**Important**  
End of support notice: On May 31, 2026, AWS will end support for AWS Panorama. After May 31, 2026, you will no longer be able to access the AWS Panorama console or AWS Panorama resources. For more information, see [AWS Panorama end of support](https://docs.aws.amazon.com/panorama/latest/dev/panorama-end-of-support.html). 

Creates an application instance and deploys it to a device.

## Request Syntax
<a name="API_CreateApplicationInstance_RequestSyntax"></a>

```
POST /application-instances HTTP/1.1
Content-type: application/json

{
   "ApplicationInstanceIdToReplace": "string",
   "DefaultRuntimeContextDevice": "string",
   "Description": "string",
   "ManifestOverridesPayload": { ... },
   "ManifestPayload": { ... },
   "Name": "string",
   "RuntimeRoleArn": "string",
   "Tags": { 
      "string" : "string" 
   }
}
```

## URI Request Parameters
<a name="API_CreateApplicationInstance_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_CreateApplicationInstance_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [ApplicationInstanceIdToReplace](#API_CreateApplicationInstance_RequestSyntax) **   <a name="panorama-CreateApplicationInstance-request-ApplicationInstanceIdToReplace"></a>
The ID of an application instance to replace with the new instance.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z0-9\-\_]+`   
Required: No

 ** [DefaultRuntimeContextDevice](#API_CreateApplicationInstance_RequestSyntax) **   <a name="panorama-CreateApplicationInstance-request-DefaultRuntimeContextDevice"></a>
A device's ID.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z0-9\-\_]+`   
Required: Yes

 ** [Description](#API_CreateApplicationInstance_RequestSyntax) **   <a name="panorama-CreateApplicationInstance-request-Description"></a>
A description for the application instance.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 255.  
Pattern: `.*`   
Required: No

 ** [ManifestOverridesPayload](#API_CreateApplicationInstance_RequestSyntax) **   <a name="panorama-CreateApplicationInstance-request-ManifestOverridesPayload"></a>
Setting overrides for the application manifest.  
Type: [ManifestOverridesPayload](API_ManifestOverridesPayload.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

 ** [ManifestPayload](#API_CreateApplicationInstance_RequestSyntax) **   <a name="panorama-CreateApplicationInstance-request-ManifestPayload"></a>
The application's manifest document.  
Type: [ManifestPayload](API_ManifestPayload.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: Yes

 ** [Name](#API_CreateApplicationInstance_RequestSyntax) **   <a name="panorama-CreateApplicationInstance-request-Name"></a>
A name for the application instance.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z0-9\-\_]+`   
Required: No

 ** [RuntimeRoleArn](#API_CreateApplicationInstance_RequestSyntax) **   <a name="panorama-CreateApplicationInstance-request-RuntimeRoleArn"></a>
The ARN of a runtime role for the application instance.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `arn:[a-z0-9][-.a-z0-9]{0,62}:iam::[0-9]{12}:role/.+`   
Required: No

 ** [Tags](#API_CreateApplicationInstance_RequestSyntax) **   <a name="panorama-CreateApplicationInstance-request-Tags"></a>
Tags for the application instance.  
Type: String to string map  
Map Entries: Minimum number of 0 items. Maximum number of 50 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `.+`   
Value Length Constraints: Minimum length of 0. Maximum length of 256.  
Value Pattern: `.*`   
Required: No

## Response Syntax
<a name="API_CreateApplicationInstance_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "ApplicationInstanceId": "string"
}
```

## Response Elements
<a name="API_CreateApplicationInstance_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ApplicationInstanceId](#API_CreateApplicationInstance_ResponseSyntax) **   <a name="panorama-CreateApplicationInstance-response-ApplicationInstanceId"></a>
The application instance's ID.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z0-9\-\_]+` 

## Errors
<a name="API_CreateApplicationInstance_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
The requestor does not have permission to access the target action or resource.  
HTTP Status Code: 403

 ** InternalServerException **   
An internal error occurred.    
 ** RetryAfterSeconds **   
The number of seconds a client should wait before retrying the call.
HTTP Status Code: 500

 ** ServiceQuotaExceededException **   
The request would cause a limit to be exceeded.    
 ** QuotaCode **   
The name of the limit.  
 ** ResourceId **   
The target resource's ID.  
 ** ResourceType **   
The target resource's type.  
 ** ServiceCode **   
The name of the service.
HTTP Status Code: 402

 ** ValidationException **   
The request contains an invalid parameter value.    
 ** ErrorArguments **   
A list of attributes that led to the exception and their values.  
 ** ErrorId **   
A unique ID for the error.  
 ** Fields **   
A list of request parameters that failed validation.  
 ** Reason **   
The reason that validation failed.
HTTP Status Code: 400

## See Also
<a name="API_CreateApplicationInstance_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/panorama-2019-07-24/CreateApplicationInstance) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/panorama-2019-07-24/CreateApplicationInstance) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/panorama-2019-07-24/CreateApplicationInstance) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/panorama-2019-07-24/CreateApplicationInstance) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/panorama-2019-07-24/CreateApplicationInstance) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/panorama-2019-07-24/CreateApplicationInstance) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/panorama-2019-07-24/CreateApplicationInstance) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/panorama-2019-07-24/CreateApplicationInstance) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/panorama-2019-07-24/CreateApplicationInstance) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/panorama-2019-07-24/CreateApplicationInstance) 

# CreateJobForDevices
<a name="API_CreateJobForDevices"></a>

**Important**  
End of support notice: On May 31, 2026, AWS will end support for AWS Panorama. After May 31, 2026, you will no longer be able to access the AWS Panorama console or AWS Panorama resources. For more information, see [AWS Panorama end of support](https://docs.aws.amazon.com/panorama/latest/dev/panorama-end-of-support.html). 

Creates a job to run on a device. A job can update a device's software or reboot it.

## Request Syntax
<a name="API_CreateJobForDevices_RequestSyntax"></a>

```
POST /jobs HTTP/1.1
Content-type: application/json

{
   "DeviceIds": [ "string" ],
   "DeviceJobConfig": { 
      "OTAJobConfig": { 
         "AllowMajorVersionUpdate": boolean,
         "ImageVersion": "string"
      }
   },
   "JobType": "string"
}
```

## URI Request Parameters
<a name="API_CreateJobForDevices_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_CreateJobForDevices_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [DeviceIds](#API_CreateJobForDevices_RequestSyntax) **   <a name="panorama-CreateJobForDevices-request-DeviceIds"></a>
ID of target device.  
Type: Array of strings  
Array Members: Fixed number of 1 item.  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z0-9\-\_]+`   
Required: Yes

 ** [DeviceJobConfig](#API_CreateJobForDevices_RequestSyntax) **   <a name="panorama-CreateJobForDevices-request-DeviceJobConfig"></a>
Configuration settings for a software update job.  
Type: [DeviceJobConfig](API_DeviceJobConfig.md) object  
Required: No

 ** [JobType](#API_CreateJobForDevices_RequestSyntax) **   <a name="panorama-CreateJobForDevices-request-JobType"></a>
The type of job to run.  
Type: String  
Valid Values: `OTA | REBOOT`   
Required: Yes

## Response Syntax
<a name="API_CreateJobForDevices_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Jobs": [ 
      { 
         "DeviceId": "string",
         "JobId": "string"
      }
   ]
}
```

## Response Elements
<a name="API_CreateJobForDevices_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Jobs](#API_CreateJobForDevices_ResponseSyntax) **   <a name="panorama-CreateJobForDevices-response-Jobs"></a>
A list of jobs.  
Type: Array of [Job](API_Job.md) objects

## Errors
<a name="API_CreateJobForDevices_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
The requestor does not have permission to access the target action or resource.  
HTTP Status Code: 403

 ** ConflictException **   
The target resource is in use.    
 ** ErrorArguments **   
A list of attributes that led to the exception and their values.  
 ** ErrorId **   
A unique ID for the error.  
 ** ResourceId **   
The resource's ID.  
 ** ResourceType **   
The resource's type.
HTTP Status Code: 409

 ** InternalServerException **   
An internal error occurred.    
 ** RetryAfterSeconds **   
The number of seconds a client should wait before retrying the call.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The target resource was not found.    
 ** ResourceId **   
The resource's ID.  
 ** ResourceType **   
The resource's type.
HTTP Status Code: 404

 ** ValidationException **   
The request contains an invalid parameter value.    
 ** ErrorArguments **   
A list of attributes that led to the exception and their values.  
 ** ErrorId **   
A unique ID for the error.  
 ** Fields **   
A list of request parameters that failed validation.  
 ** Reason **   
The reason that validation failed.
HTTP Status Code: 400

## See Also
<a name="API_CreateJobForDevices_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/panorama-2019-07-24/CreateJobForDevices) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/panorama-2019-07-24/CreateJobForDevices) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/panorama-2019-07-24/CreateJobForDevices) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/panorama-2019-07-24/CreateJobForDevices) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/panorama-2019-07-24/CreateJobForDevices) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/panorama-2019-07-24/CreateJobForDevices) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/panorama-2019-07-24/CreateJobForDevices) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/panorama-2019-07-24/CreateJobForDevices) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/panorama-2019-07-24/CreateJobForDevices) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/panorama-2019-07-24/CreateJobForDevices) 

# CreateNodeFromTemplateJob
<a name="API_CreateNodeFromTemplateJob"></a>

**Important**  
End of support notice: On May 31, 2026, AWS will end support for AWS Panorama. After May 31, 2026, you will no longer be able to access the AWS Panorama console or AWS Panorama resources. For more information, see [AWS Panorama end of support](https://docs.aws.amazon.com/panorama/latest/dev/panorama-end-of-support.html). 

Creates a camera stream node.

## Request Syntax
<a name="API_CreateNodeFromTemplateJob_RequestSyntax"></a>

```
POST /packages/template-job HTTP/1.1
Content-type: application/json

{
   "JobTags": [ 
      { 
         "ResourceType": "string",
         "Tags": { 
            "string" : "string" 
         }
      }
   ],
   "NodeDescription": "string",
   "NodeName": "string",
   "OutputPackageName": "string",
   "OutputPackageVersion": "string",
   "TemplateParameters": { 
      "string" : "string" 
   },
   "TemplateType": "string"
}
```

## URI Request Parameters
<a name="API_CreateNodeFromTemplateJob_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_CreateNodeFromTemplateJob_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [JobTags](#API_CreateNodeFromTemplateJob_RequestSyntax) **   <a name="panorama-CreateNodeFromTemplateJob-request-JobTags"></a>
Tags for the job.  
Type: Array of [JobResourceTags](API_JobResourceTags.md) objects  
Required: No

 ** [NodeDescription](#API_CreateNodeFromTemplateJob_RequestSyntax) **   <a name="panorama-CreateNodeFromTemplateJob-request-NodeDescription"></a>
A description for the node.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 255.  
Pattern: `.*`   
Required: No

 ** [NodeName](#API_CreateNodeFromTemplateJob_RequestSyntax) **   <a name="panorama-CreateNodeFromTemplateJob-request-NodeName"></a>
A name for the node.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[a-zA-Z0-9\-\_]+`   
Required: Yes

 ** [OutputPackageName](#API_CreateNodeFromTemplateJob_RequestSyntax) **   <a name="panorama-CreateNodeFromTemplateJob-request-OutputPackageName"></a>
An output package name for the node.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[a-zA-Z0-9\-\_]+`   
Required: Yes

 ** [OutputPackageVersion](#API_CreateNodeFromTemplateJob_RequestSyntax) **   <a name="panorama-CreateNodeFromTemplateJob-request-OutputPackageVersion"></a>
An output package version for the node.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `([0-9]+)\.([0-9]+)`   
Required: Yes

 ** [TemplateParameters](#API_CreateNodeFromTemplateJob_RequestSyntax) **   <a name="panorama-CreateNodeFromTemplateJob-request-TemplateParameters"></a>
Template parameters for the node.  
Type: String to string map  
Key Length Constraints: Minimum length of 1. Maximum length of 255.  
Key Pattern: `.+`   
Value Length Constraints: Minimum length of 1. Maximum length of 255.  
Value Pattern: `.+`   
Required: Yes

 ** [TemplateType](#API_CreateNodeFromTemplateJob_RequestSyntax) **   <a name="panorama-CreateNodeFromTemplateJob-request-TemplateType"></a>
The type of node.  
Type: String  
Valid Values: `RTSP_CAMERA_STREAM`   
Required: Yes

## Response Syntax
<a name="API_CreateNodeFromTemplateJob_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "JobId": "string"
}
```

## Response Elements
<a name="API_CreateNodeFromTemplateJob_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [JobId](#API_CreateNodeFromTemplateJob_ResponseSyntax) **   <a name="panorama-CreateNodeFromTemplateJob-response-JobId"></a>
The job's ID.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z0-9\-\_]+` 

## Errors
<a name="API_CreateNodeFromTemplateJob_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
The requestor does not have permission to access the target action or resource.  
HTTP Status Code: 403

 ** ConflictException **   
The target resource is in use.    
 ** ErrorArguments **   
A list of attributes that led to the exception and their values.  
 ** ErrorId **   
A unique ID for the error.  
 ** ResourceId **   
The resource's ID.  
 ** ResourceType **   
The resource's type.
HTTP Status Code: 409

 ** InternalServerException **   
An internal error occurred.    
 ** RetryAfterSeconds **   
The number of seconds a client should wait before retrying the call.
HTTP Status Code: 500

 ** ValidationException **   
The request contains an invalid parameter value.    
 ** ErrorArguments **   
A list of attributes that led to the exception and their values.  
 ** ErrorId **   
A unique ID for the error.  
 ** Fields **   
A list of request parameters that failed validation.  
 ** Reason **   
The reason that validation failed.
HTTP Status Code: 400

## See Also
<a name="API_CreateNodeFromTemplateJob_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/panorama-2019-07-24/CreateNodeFromTemplateJob) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/panorama-2019-07-24/CreateNodeFromTemplateJob) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/panorama-2019-07-24/CreateNodeFromTemplateJob) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/panorama-2019-07-24/CreateNodeFromTemplateJob) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/panorama-2019-07-24/CreateNodeFromTemplateJob) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/panorama-2019-07-24/CreateNodeFromTemplateJob) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/panorama-2019-07-24/CreateNodeFromTemplateJob) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/panorama-2019-07-24/CreateNodeFromTemplateJob) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/panorama-2019-07-24/CreateNodeFromTemplateJob) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/panorama-2019-07-24/CreateNodeFromTemplateJob) 

# CreatePackage
<a name="API_CreatePackage"></a>

**Important**  
End of support notice: On May 31, 2026, AWS will end support for AWS Panorama. After May 31, 2026, you will no longer be able to access the AWS Panorama console or AWS Panorama resources. For more information, see [AWS Panorama end of support](https://docs.aws.amazon.com/panorama/latest/dev/panorama-end-of-support.html). 

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

## Request Syntax
<a name="API_CreatePackage_RequestSyntax"></a>

```
POST /packages HTTP/1.1
Content-type: application/json

{
   "PackageName": "string",
   "Tags": { 
      "string" : "string" 
   }
}
```

## URI Request Parameters
<a name="API_CreatePackage_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_CreatePackage_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [PackageName](#API_CreatePackage_RequestSyntax) **   <a name="panorama-CreatePackage-request-PackageName"></a>
A name for the package.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[a-zA-Z0-9\-\_]+`   
Required: Yes

 ** [Tags](#API_CreatePackage_RequestSyntax) **   <a name="panorama-CreatePackage-request-Tags"></a>
Tags for the package.  
Type: String to string map  
Map Entries: Minimum number of 0 items. Maximum number of 50 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `.+`   
Value Length Constraints: Minimum length of 0. Maximum length of 256.  
Value Pattern: `.*`   
Required: No

## Response Syntax
<a name="API_CreatePackage_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Arn": "string",
   "PackageId": "string",
   "StorageLocation": { 
      "BinaryPrefixLocation": "string",
      "Bucket": "string",
      "GeneratedPrefixLocation": "string",
      "ManifestPrefixLocation": "string",
      "RepoPrefixLocation": "string"
   }
}
```

## Response Elements
<a name="API_CreatePackage_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Arn](#API_CreatePackage_ResponseSyntax) **   <a name="panorama-CreatePackage-response-Arn"></a>
The package's ARN.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.

 ** [PackageId](#API_CreatePackage_ResponseSyntax) **   <a name="panorama-CreatePackage-response-PackageId"></a>
The package's ID.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z0-9\-\_\/]+` 

 ** [StorageLocation](#API_CreatePackage_ResponseSyntax) **   <a name="panorama-CreatePackage-response-StorageLocation"></a>
The package's storage location.  
Type: [StorageLocation](API_StorageLocation.md) object

## Errors
<a name="API_CreatePackage_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
The requestor does not have permission to access the target action or resource.  
HTTP Status Code: 403

 ** ConflictException **   
The target resource is in use.    
 ** ErrorArguments **   
A list of attributes that led to the exception and their values.  
 ** ErrorId **   
A unique ID for the error.  
 ** ResourceId **   
The resource's ID.  
 ** ResourceType **   
The resource's type.
HTTP Status Code: 409

 ** InternalServerException **   
An internal error occurred.    
 ** RetryAfterSeconds **   
The number of seconds a client should wait before retrying the call.
HTTP Status Code: 500

 ** ValidationException **   
The request contains an invalid parameter value.    
 ** ErrorArguments **   
A list of attributes that led to the exception and their values.  
 ** ErrorId **   
A unique ID for the error.  
 ** Fields **   
A list of request parameters that failed validation.  
 ** Reason **   
The reason that validation failed.
HTTP Status Code: 400

## See Also
<a name="API_CreatePackage_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/panorama-2019-07-24/CreatePackage) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/panorama-2019-07-24/CreatePackage) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/panorama-2019-07-24/CreatePackage) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/panorama-2019-07-24/CreatePackage) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/panorama-2019-07-24/CreatePackage) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/panorama-2019-07-24/CreatePackage) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/panorama-2019-07-24/CreatePackage) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/panorama-2019-07-24/CreatePackage) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/panorama-2019-07-24/CreatePackage) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/panorama-2019-07-24/CreatePackage) 

# CreatePackageImportJob
<a name="API_CreatePackageImportJob"></a>

**Important**  
End of support notice: On May 31, 2026, AWS will end support for AWS Panorama. After May 31, 2026, you will no longer be able to access the AWS Panorama console or AWS Panorama resources. For more information, see [AWS Panorama end of support](https://docs.aws.amazon.com/panorama/latest/dev/panorama-end-of-support.html). 

Imports a node package.

## Request Syntax
<a name="API_CreatePackageImportJob_RequestSyntax"></a>

```
POST /packages/import-jobs HTTP/1.1
Content-type: application/json

{
   "ClientToken": "string",
   "InputConfig": { 
      "PackageVersionInputConfig": { 
         "S3Location": { 
            "BucketName": "string",
            "ObjectKey": "string",
            "Region": "string"
         }
      }
   },
   "JobTags": [ 
      { 
         "ResourceType": "string",
         "Tags": { 
            "string" : "string" 
         }
      }
   ],
   "JobType": "string",
   "OutputConfig": { 
      "PackageVersionOutputConfig": { 
         "MarkLatest": boolean,
         "PackageName": "string",
         "PackageVersion": "string"
      }
   }
}
```

## URI Request Parameters
<a name="API_CreatePackageImportJob_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_CreatePackageImportJob_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [ClientToken](#API_CreatePackageImportJob_RequestSyntax) **   <a name="panorama-CreatePackageImportJob-request-ClientToken"></a>
A client token for the package import job.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[a-zA-Z0-9\-\_]+`   
Required: Yes

 ** [InputConfig](#API_CreatePackageImportJob_RequestSyntax) **   <a name="panorama-CreatePackageImportJob-request-InputConfig"></a>
An input config for the package import job.  
Type: [PackageImportJobInputConfig](API_PackageImportJobInputConfig.md) object  
Required: Yes

 ** [JobTags](#API_CreatePackageImportJob_RequestSyntax) **   <a name="panorama-CreatePackageImportJob-request-JobTags"></a>
Tags for the package import job.  
Type: Array of [JobResourceTags](API_JobResourceTags.md) objects  
Required: No

 ** [JobType](#API_CreatePackageImportJob_RequestSyntax) **   <a name="panorama-CreatePackageImportJob-request-JobType"></a>
A job type for the package import job.  
Type: String  
Valid Values: `NODE_PACKAGE_VERSION | MARKETPLACE_NODE_PACKAGE_VERSION`   
Required: Yes

 ** [OutputConfig](#API_CreatePackageImportJob_RequestSyntax) **   <a name="panorama-CreatePackageImportJob-request-OutputConfig"></a>
An output config for the package import job.  
Type: [PackageImportJobOutputConfig](API_PackageImportJobOutputConfig.md) object  
Required: Yes

## Response Syntax
<a name="API_CreatePackageImportJob_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "JobId": "string"
}
```

## Response Elements
<a name="API_CreatePackageImportJob_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [JobId](#API_CreatePackageImportJob_ResponseSyntax) **   <a name="panorama-CreatePackageImportJob-response-JobId"></a>
The job's ID.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z0-9\-\_]+` 

## Errors
<a name="API_CreatePackageImportJob_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
The requestor does not have permission to access the target action or resource.  
HTTP Status Code: 403

 ** ConflictException **   
The target resource is in use.    
 ** ErrorArguments **   
A list of attributes that led to the exception and their values.  
 ** ErrorId **   
A unique ID for the error.  
 ** ResourceId **   
The resource's ID.  
 ** ResourceType **   
The resource's type.
HTTP Status Code: 409

 ** InternalServerException **   
An internal error occurred.    
 ** RetryAfterSeconds **   
The number of seconds a client should wait before retrying the call.
HTTP Status Code: 500

 ** ValidationException **   
The request contains an invalid parameter value.    
 ** ErrorArguments **   
A list of attributes that led to the exception and their values.  
 ** ErrorId **   
A unique ID for the error.  
 ** Fields **   
A list of request parameters that failed validation.  
 ** Reason **   
The reason that validation failed.
HTTP Status Code: 400

## See Also
<a name="API_CreatePackageImportJob_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/panorama-2019-07-24/CreatePackageImportJob) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/panorama-2019-07-24/CreatePackageImportJob) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/panorama-2019-07-24/CreatePackageImportJob) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/panorama-2019-07-24/CreatePackageImportJob) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/panorama-2019-07-24/CreatePackageImportJob) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/panorama-2019-07-24/CreatePackageImportJob) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/panorama-2019-07-24/CreatePackageImportJob) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/panorama-2019-07-24/CreatePackageImportJob) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/panorama-2019-07-24/CreatePackageImportJob) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/panorama-2019-07-24/CreatePackageImportJob) 

# DeleteDevice
<a name="API_DeleteDevice"></a>

**Important**  
End of support notice: On May 31, 2026, AWS will end support for AWS Panorama. After May 31, 2026, you will no longer be able to access the AWS Panorama console or AWS Panorama resources. For more information, see [AWS Panorama end of support](https://docs.aws.amazon.com/panorama/latest/dev/panorama-end-of-support.html). 

Deletes a device.

## Request Syntax
<a name="API_DeleteDevice_RequestSyntax"></a>

```
DELETE /devices/DeviceId HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteDevice_RequestParameters"></a>

The request uses the following URI parameters.

 ** [DeviceId](#API_DeleteDevice_RequestSyntax) **   <a name="panorama-DeleteDevice-request-uri-DeviceId"></a>
The device's ID.  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z0-9\-\_]+`   
Required: Yes

## Request Body
<a name="API_DeleteDevice_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteDevice_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "DeviceId": "string"
}
```

## Response Elements
<a name="API_DeleteDevice_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [DeviceId](#API_DeleteDevice_ResponseSyntax) **   <a name="panorama-DeleteDevice-response-DeviceId"></a>
The device's ID.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z0-9\-\_]+` 

## Errors
<a name="API_DeleteDevice_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
The requestor does not have permission to access the target action or resource.  
HTTP Status Code: 403

 ** ConflictException **   
The target resource is in use.    
 ** ErrorArguments **   
A list of attributes that led to the exception and their values.  
 ** ErrorId **   
A unique ID for the error.  
 ** ResourceId **   
The resource's ID.  
 ** ResourceType **   
The resource's type.
HTTP Status Code: 409

 ** InternalServerException **   
An internal error occurred.    
 ** RetryAfterSeconds **   
The number of seconds a client should wait before retrying the call.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The target resource was not found.    
 ** ResourceId **   
The resource's ID.  
 ** ResourceType **   
The resource's type.
HTTP Status Code: 404

 ** ValidationException **   
The request contains an invalid parameter value.    
 ** ErrorArguments **   
A list of attributes that led to the exception and their values.  
 ** ErrorId **   
A unique ID for the error.  
 ** Fields **   
A list of request parameters that failed validation.  
 ** Reason **   
The reason that validation failed.
HTTP Status Code: 400

## See Also
<a name="API_DeleteDevice_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/panorama-2019-07-24/DeleteDevice) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/panorama-2019-07-24/DeleteDevice) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/panorama-2019-07-24/DeleteDevice) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/panorama-2019-07-24/DeleteDevice) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/panorama-2019-07-24/DeleteDevice) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/panorama-2019-07-24/DeleteDevice) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/panorama-2019-07-24/DeleteDevice) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/panorama-2019-07-24/DeleteDevice) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/panorama-2019-07-24/DeleteDevice) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/panorama-2019-07-24/DeleteDevice) 

# DeletePackage
<a name="API_DeletePackage"></a>

**Important**  
End of support notice: On May 31, 2026, AWS will end support for AWS Panorama. After May 31, 2026, you will no longer be able to access the AWS Panorama console or AWS Panorama resources. For more information, see [AWS Panorama end of support](https://docs.aws.amazon.com/panorama/latest/dev/panorama-end-of-support.html). 

Deletes a package.

**Note**  
To delete a package, you need permission to call `s3:DeleteObject` in addition to permissions for the AWS Panorama API.

## Request Syntax
<a name="API_DeletePackage_RequestSyntax"></a>

```
DELETE /packages/PackageId?ForceDelete=ForceDelete HTTP/1.1
```

## URI Request Parameters
<a name="API_DeletePackage_RequestParameters"></a>

The request uses the following URI parameters.

 ** [ForceDelete](#API_DeletePackage_RequestSyntax) **   <a name="panorama-DeletePackage-request-uri-ForceDelete"></a>
Delete the package even if it has artifacts stored in its access point. Deletes the package's artifacts from Amazon S3.

 ** [PackageId](#API_DeletePackage_RequestSyntax) **   <a name="panorama-DeletePackage-request-uri-PackageId"></a>
The package's ID.  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z0-9\-\_\/]+`   
Required: Yes

## Request Body
<a name="API_DeletePackage_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeletePackage_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_DeletePackage_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeletePackage_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
The requestor does not have permission to access the target action or resource.  
HTTP Status Code: 403

 ** ConflictException **   
The target resource is in use.    
 ** ErrorArguments **   
A list of attributes that led to the exception and their values.  
 ** ErrorId **   
A unique ID for the error.  
 ** ResourceId **   
The resource's ID.  
 ** ResourceType **   
The resource's type.
HTTP Status Code: 409

 ** InternalServerException **   
An internal error occurred.    
 ** RetryAfterSeconds **   
The number of seconds a client should wait before retrying the call.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The target resource was not found.    
 ** ResourceId **   
The resource's ID.  
 ** ResourceType **   
The resource's type.
HTTP Status Code: 404

 ** ValidationException **   
The request contains an invalid parameter value.    
 ** ErrorArguments **   
A list of attributes that led to the exception and their values.  
 ** ErrorId **   
A unique ID for the error.  
 ** Fields **   
A list of request parameters that failed validation.  
 ** Reason **   
The reason that validation failed.
HTTP Status Code: 400

## See Also
<a name="API_DeletePackage_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/panorama-2019-07-24/DeletePackage) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/panorama-2019-07-24/DeletePackage) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/panorama-2019-07-24/DeletePackage) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/panorama-2019-07-24/DeletePackage) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/panorama-2019-07-24/DeletePackage) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/panorama-2019-07-24/DeletePackage) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/panorama-2019-07-24/DeletePackage) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/panorama-2019-07-24/DeletePackage) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/panorama-2019-07-24/DeletePackage) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/panorama-2019-07-24/DeletePackage) 

# DeregisterPackageVersion
<a name="API_DeregisterPackageVersion"></a>

**Important**  
End of support notice: On May 31, 2026, AWS will end support for AWS Panorama. After May 31, 2026, you will no longer be able to access the AWS Panorama console or AWS Panorama resources. For more information, see [AWS Panorama end of support](https://docs.aws.amazon.com/panorama/latest/dev/panorama-end-of-support.html). 

Deregisters a package version.

## Request Syntax
<a name="API_DeregisterPackageVersion_RequestSyntax"></a>

```
DELETE /packages/PackageId/versions/PackageVersion/patch/PatchVersion?OwnerAccount=OwnerAccount&UpdatedLatestPatchVersion=UpdatedLatestPatchVersion HTTP/1.1
```

## URI Request Parameters
<a name="API_DeregisterPackageVersion_RequestParameters"></a>

The request uses the following URI parameters.

 ** [OwnerAccount](#API_DeregisterPackageVersion_RequestSyntax) **   <a name="panorama-DeregisterPackageVersion-request-uri-OwnerAccount"></a>
An owner account.  
Length Constraints: Minimum length of 1. Maximum length of 12.  
Pattern: `[0-9a-z\_]+` 

 ** [PackageId](#API_DeregisterPackageVersion_RequestSyntax) **   <a name="panorama-DeregisterPackageVersion-request-uri-PackageId"></a>
A package ID.  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z0-9\-\_\/]+`   
Required: Yes

 ** [PackageVersion](#API_DeregisterPackageVersion_RequestSyntax) **   <a name="panorama-DeregisterPackageVersion-request-uri-PackageVersion"></a>
A package version.  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `([0-9]+)\.([0-9]+)`   
Required: Yes

 ** [PatchVersion](#API_DeregisterPackageVersion_RequestSyntax) **   <a name="panorama-DeregisterPackageVersion-request-uri-PatchVersion"></a>
A patch version.  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-z0-9]+`   
Required: Yes

 ** [UpdatedLatestPatchVersion](#API_DeregisterPackageVersion_RequestSyntax) **   <a name="panorama-DeregisterPackageVersion-request-uri-UpdatedLatestPatchVersion"></a>
If the version was marked latest, the new version to maker as latest.  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-z0-9]+` 

## Request Body
<a name="API_DeregisterPackageVersion_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeregisterPackageVersion_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_DeregisterPackageVersion_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeregisterPackageVersion_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
The requestor does not have permission to access the target action or resource.  
HTTP Status Code: 403

 ** ConflictException **   
The target resource is in use.    
 ** ErrorArguments **   
A list of attributes that led to the exception and their values.  
 ** ErrorId **   
A unique ID for the error.  
 ** ResourceId **   
The resource's ID.  
 ** ResourceType **   
The resource's type.
HTTP Status Code: 409

 ** InternalServerException **   
An internal error occurred.    
 ** RetryAfterSeconds **   
The number of seconds a client should wait before retrying the call.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The target resource was not found.    
 ** ResourceId **   
The resource's ID.  
 ** ResourceType **   
The resource's type.
HTTP Status Code: 404

 ** ValidationException **   
The request contains an invalid parameter value.    
 ** ErrorArguments **   
A list of attributes that led to the exception and their values.  
 ** ErrorId **   
A unique ID for the error.  
 ** Fields **   
A list of request parameters that failed validation.  
 ** Reason **   
The reason that validation failed.
HTTP Status Code: 400

## See Also
<a name="API_DeregisterPackageVersion_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/panorama-2019-07-24/DeregisterPackageVersion) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/panorama-2019-07-24/DeregisterPackageVersion) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/panorama-2019-07-24/DeregisterPackageVersion) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/panorama-2019-07-24/DeregisterPackageVersion) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/panorama-2019-07-24/DeregisterPackageVersion) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/panorama-2019-07-24/DeregisterPackageVersion) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/panorama-2019-07-24/DeregisterPackageVersion) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/panorama-2019-07-24/DeregisterPackageVersion) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/panorama-2019-07-24/DeregisterPackageVersion) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/panorama-2019-07-24/DeregisterPackageVersion) 

# DescribeApplicationInstance
<a name="API_DescribeApplicationInstance"></a>

**Important**  
End of support notice: On May 31, 2026, AWS will end support for AWS Panorama. After May 31, 2026, you will no longer be able to access the AWS Panorama console or AWS Panorama resources. For more information, see [AWS Panorama end of support](https://docs.aws.amazon.com/panorama/latest/dev/panorama-end-of-support.html). 

Returns information about an application instance on a device.

## Request Syntax
<a name="API_DescribeApplicationInstance_RequestSyntax"></a>

```
GET /application-instances/ApplicationInstanceId HTTP/1.1
```

## URI Request Parameters
<a name="API_DescribeApplicationInstance_RequestParameters"></a>

The request uses the following URI parameters.

 ** [ApplicationInstanceId](#API_DescribeApplicationInstance_RequestSyntax) **   <a name="panorama-DescribeApplicationInstance-request-uri-ApplicationInstanceId"></a>
The application instance's ID.  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z0-9\-\_]+`   
Required: Yes

## Request Body
<a name="API_DescribeApplicationInstance_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DescribeApplicationInstance_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "ApplicationInstanceId": "string",
   "ApplicationInstanceIdToReplace": "string",
   "Arn": "string",
   "CreatedTime": number,
   "DefaultRuntimeContextDevice": "string",
   "DefaultRuntimeContextDeviceName": "string",
   "Description": "string",
   "HealthStatus": "string",
   "LastUpdatedTime": number,
   "Name": "string",
   "RuntimeContextStates": [ 
      { 
         "DesiredState": "string",
         "DeviceReportedStatus": "string",
         "DeviceReportedTime": number,
         "RuntimeContextName": "string"
      }
   ],
   "RuntimeRoleArn": "string",
   "Status": "string",
   "StatusDescription": "string",
   "Tags": { 
      "string" : "string" 
   }
}
```

## Response Elements
<a name="API_DescribeApplicationInstance_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ApplicationInstanceId](#API_DescribeApplicationInstance_ResponseSyntax) **   <a name="panorama-DescribeApplicationInstance-response-ApplicationInstanceId"></a>
The application instance's ID.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z0-9\-\_]+` 

 ** [ApplicationInstanceIdToReplace](#API_DescribeApplicationInstance_ResponseSyntax) **   <a name="panorama-DescribeApplicationInstance-response-ApplicationInstanceIdToReplace"></a>
The ID of the application instance that this instance replaced.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z0-9\-\_]+` 

 ** [Arn](#API_DescribeApplicationInstance_ResponseSyntax) **   <a name="panorama-DescribeApplicationInstance-response-Arn"></a>
The application instance's ARN.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.

 ** [CreatedTime](#API_DescribeApplicationInstance_ResponseSyntax) **   <a name="panorama-DescribeApplicationInstance-response-CreatedTime"></a>
When the application instance was created.  
Type: Timestamp

 ** [DefaultRuntimeContextDevice](#API_DescribeApplicationInstance_ResponseSyntax) **   <a name="panorama-DescribeApplicationInstance-response-DefaultRuntimeContextDevice"></a>
The device's ID.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z0-9\-\_]+` 

 ** [DefaultRuntimeContextDeviceName](#API_DescribeApplicationInstance_ResponseSyntax) **   <a name="panorama-DescribeApplicationInstance-response-DefaultRuntimeContextDeviceName"></a>
The device's bane.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z0-9\-\_]+` 

 ** [Description](#API_DescribeApplicationInstance_ResponseSyntax) **   <a name="panorama-DescribeApplicationInstance-response-Description"></a>
The application instance's description.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 255.  
Pattern: `.*` 

 ** [HealthStatus](#API_DescribeApplicationInstance_ResponseSyntax) **   <a name="panorama-DescribeApplicationInstance-response-HealthStatus"></a>
The application instance's health status.  
Type: String  
Valid Values: `RUNNING | ERROR | NOT_AVAILABLE` 

 ** [LastUpdatedTime](#API_DescribeApplicationInstance_ResponseSyntax) **   <a name="panorama-DescribeApplicationInstance-response-LastUpdatedTime"></a>
The application instance was updated.  
Type: Timestamp

 ** [Name](#API_DescribeApplicationInstance_ResponseSyntax) **   <a name="panorama-DescribeApplicationInstance-response-Name"></a>
The application instance's name.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z0-9\-\_]+` 

 ** [RuntimeContextStates](#API_DescribeApplicationInstance_ResponseSyntax) **   <a name="panorama-DescribeApplicationInstance-response-RuntimeContextStates"></a>
The application instance's state.  
Type: Array of [ReportedRuntimeContextState](API_ReportedRuntimeContextState.md) objects

 ** [RuntimeRoleArn](#API_DescribeApplicationInstance_ResponseSyntax) **   <a name="panorama-DescribeApplicationInstance-response-RuntimeRoleArn"></a>
The application instance's runtime role ARN.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `arn:[a-z0-9][-.a-z0-9]{0,62}:iam::[0-9]{12}:role/.+` 

 ** [Status](#API_DescribeApplicationInstance_ResponseSyntax) **   <a name="panorama-DescribeApplicationInstance-response-Status"></a>
The application instance's status.  
Type: String  
Valid Values: `DEPLOYMENT_PENDING | DEPLOYMENT_REQUESTED | DEPLOYMENT_IN_PROGRESS | DEPLOYMENT_ERROR | DEPLOYMENT_SUCCEEDED | REMOVAL_PENDING | REMOVAL_REQUESTED | REMOVAL_IN_PROGRESS | REMOVAL_FAILED | REMOVAL_SUCCEEDED | DEPLOYMENT_FAILED` 

 ** [StatusDescription](#API_DescribeApplicationInstance_ResponseSyntax) **   <a name="panorama-DescribeApplicationInstance-response-StatusDescription"></a>
The application instance's status description.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.

 ** [Tags](#API_DescribeApplicationInstance_ResponseSyntax) **   <a name="panorama-DescribeApplicationInstance-response-Tags"></a>
The application instance's tags.  
Type: String to string map  
Map Entries: Minimum number of 0 items. Maximum number of 50 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `.+`   
Value Length Constraints: Minimum length of 0. Maximum length of 256.  
Value Pattern: `.*` 

## Errors
<a name="API_DescribeApplicationInstance_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
The requestor does not have permission to access the target action or resource.  
HTTP Status Code: 403

 ** ConflictException **   
The target resource is in use.    
 ** ErrorArguments **   
A list of attributes that led to the exception and their values.  
 ** ErrorId **   
A unique ID for the error.  
 ** ResourceId **   
The resource's ID.  
 ** ResourceType **   
The resource's type.
HTTP Status Code: 409

 ** InternalServerException **   
An internal error occurred.    
 ** RetryAfterSeconds **   
The number of seconds a client should wait before retrying the call.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The target resource was not found.    
 ** ResourceId **   
The resource's ID.  
 ** ResourceType **   
The resource's type.
HTTP Status Code: 404

 ** ValidationException **   
The request contains an invalid parameter value.    
 ** ErrorArguments **   
A list of attributes that led to the exception and their values.  
 ** ErrorId **   
A unique ID for the error.  
 ** Fields **   
A list of request parameters that failed validation.  
 ** Reason **   
The reason that validation failed.
HTTP Status Code: 400

## See Also
<a name="API_DescribeApplicationInstance_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/panorama-2019-07-24/DescribeApplicationInstance) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/panorama-2019-07-24/DescribeApplicationInstance) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/panorama-2019-07-24/DescribeApplicationInstance) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/panorama-2019-07-24/DescribeApplicationInstance) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/panorama-2019-07-24/DescribeApplicationInstance) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/panorama-2019-07-24/DescribeApplicationInstance) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/panorama-2019-07-24/DescribeApplicationInstance) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/panorama-2019-07-24/DescribeApplicationInstance) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/panorama-2019-07-24/DescribeApplicationInstance) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/panorama-2019-07-24/DescribeApplicationInstance) 

# DescribeApplicationInstanceDetails
<a name="API_DescribeApplicationInstanceDetails"></a>

**Important**  
End of support notice: On May 31, 2026, AWS will end support for AWS Panorama. After May 31, 2026, you will no longer be able to access the AWS Panorama console or AWS Panorama resources. For more information, see [AWS Panorama end of support](https://docs.aws.amazon.com/panorama/latest/dev/panorama-end-of-support.html). 

Returns information about an application instance's configuration manifest.

## Request Syntax
<a name="API_DescribeApplicationInstanceDetails_RequestSyntax"></a>

```
GET /application-instances/ApplicationInstanceId/details HTTP/1.1
```

## URI Request Parameters
<a name="API_DescribeApplicationInstanceDetails_RequestParameters"></a>

The request uses the following URI parameters.

 ** [ApplicationInstanceId](#API_DescribeApplicationInstanceDetails_RequestSyntax) **   <a name="panorama-DescribeApplicationInstanceDetails-request-uri-ApplicationInstanceId"></a>
The application instance's ID.  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z0-9\-\_]+`   
Required: Yes

## Request Body
<a name="API_DescribeApplicationInstanceDetails_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DescribeApplicationInstanceDetails_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "ApplicationInstanceId": "string",
   "ApplicationInstanceIdToReplace": "string",
   "CreatedTime": number,
   "DefaultRuntimeContextDevice": "string",
   "Description": "string",
   "ManifestOverridesPayload": { ... },
   "ManifestPayload": { ... },
   "Name": "string"
}
```

## Response Elements
<a name="API_DescribeApplicationInstanceDetails_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ApplicationInstanceId](#API_DescribeApplicationInstanceDetails_ResponseSyntax) **   <a name="panorama-DescribeApplicationInstanceDetails-response-ApplicationInstanceId"></a>
The application instance's ID.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z0-9\-\_]+` 

 ** [ApplicationInstanceIdToReplace](#API_DescribeApplicationInstanceDetails_ResponseSyntax) **   <a name="panorama-DescribeApplicationInstanceDetails-response-ApplicationInstanceIdToReplace"></a>
The ID of the application instance that this instance replaced.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z0-9\-\_]+` 

 ** [CreatedTime](#API_DescribeApplicationInstanceDetails_ResponseSyntax) **   <a name="panorama-DescribeApplicationInstanceDetails-response-CreatedTime"></a>
When the application instance was created.  
Type: Timestamp

 ** [DefaultRuntimeContextDevice](#API_DescribeApplicationInstanceDetails_ResponseSyntax) **   <a name="panorama-DescribeApplicationInstanceDetails-response-DefaultRuntimeContextDevice"></a>
The application instance's default runtime context device.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z0-9\-\_]+` 

 ** [Description](#API_DescribeApplicationInstanceDetails_ResponseSyntax) **   <a name="panorama-DescribeApplicationInstanceDetails-response-Description"></a>
The application instance's description.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 255.  
Pattern: `.*` 

 ** [ManifestOverridesPayload](#API_DescribeApplicationInstanceDetails_ResponseSyntax) **   <a name="panorama-DescribeApplicationInstanceDetails-response-ManifestOverridesPayload"></a>
Parameter overrides for the configuration manifest.  
Type: [ManifestOverridesPayload](API_ManifestOverridesPayload.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.

 ** [ManifestPayload](#API_DescribeApplicationInstanceDetails_ResponseSyntax) **   <a name="panorama-DescribeApplicationInstanceDetails-response-ManifestPayload"></a>
The application instance's configuration manifest.  
Type: [ManifestPayload](API_ManifestPayload.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.

 ** [Name](#API_DescribeApplicationInstanceDetails_ResponseSyntax) **   <a name="panorama-DescribeApplicationInstanceDetails-response-Name"></a>
The application instance's name.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z0-9\-\_]+` 

## Errors
<a name="API_DescribeApplicationInstanceDetails_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
The requestor does not have permission to access the target action or resource.  
HTTP Status Code: 403

 ** ConflictException **   
The target resource is in use.    
 ** ErrorArguments **   
A list of attributes that led to the exception and their values.  
 ** ErrorId **   
A unique ID for the error.  
 ** ResourceId **   
The resource's ID.  
 ** ResourceType **   
The resource's type.
HTTP Status Code: 409

 ** InternalServerException **   
An internal error occurred.    
 ** RetryAfterSeconds **   
The number of seconds a client should wait before retrying the call.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The target resource was not found.    
 ** ResourceId **   
The resource's ID.  
 ** ResourceType **   
The resource's type.
HTTP Status Code: 404

 ** ValidationException **   
The request contains an invalid parameter value.    
 ** ErrorArguments **   
A list of attributes that led to the exception and their values.  
 ** ErrorId **   
A unique ID for the error.  
 ** Fields **   
A list of request parameters that failed validation.  
 ** Reason **   
The reason that validation failed.
HTTP Status Code: 400

## See Also
<a name="API_DescribeApplicationInstanceDetails_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/panorama-2019-07-24/DescribeApplicationInstanceDetails) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/panorama-2019-07-24/DescribeApplicationInstanceDetails) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/panorama-2019-07-24/DescribeApplicationInstanceDetails) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/panorama-2019-07-24/DescribeApplicationInstanceDetails) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/panorama-2019-07-24/DescribeApplicationInstanceDetails) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/panorama-2019-07-24/DescribeApplicationInstanceDetails) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/panorama-2019-07-24/DescribeApplicationInstanceDetails) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/panorama-2019-07-24/DescribeApplicationInstanceDetails) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/panorama-2019-07-24/DescribeApplicationInstanceDetails) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/panorama-2019-07-24/DescribeApplicationInstanceDetails) 

# DescribeDevice
<a name="API_DescribeDevice"></a>

**Important**  
End of support notice: On May 31, 2026, AWS will end support for AWS Panorama. After May 31, 2026, you will no longer be able to access the AWS Panorama console or AWS Panorama resources. For more information, see [AWS Panorama end of support](https://docs.aws.amazon.com/panorama/latest/dev/panorama-end-of-support.html). 

Returns information about a device.

## Request Syntax
<a name="API_DescribeDevice_RequestSyntax"></a>

```
GET /devices/DeviceId HTTP/1.1
```

## URI Request Parameters
<a name="API_DescribeDevice_RequestParameters"></a>

The request uses the following URI parameters.

 ** [DeviceId](#API_DescribeDevice_RequestSyntax) **   <a name="panorama-DescribeDevice-request-uri-DeviceId"></a>
The device's ID.  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z0-9\-\_]+`   
Required: Yes

## Request Body
<a name="API_DescribeDevice_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DescribeDevice_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "AlternateSoftwares": [ 
      { 
         "Version": "string"
      }
   ],
   "Arn": "string",
   "Brand": "string",
   "CreatedTime": number,
   "CurrentNetworkingStatus": { 
      "Ethernet0Status": { 
         "ConnectionStatus": "string",
         "HwAddress": "string",
         "IpAddress": "string"
      },
      "Ethernet1Status": { 
         "ConnectionStatus": "string",
         "HwAddress": "string",
         "IpAddress": "string"
      },
      "LastUpdatedTime": number,
      "NtpStatus": { 
         "ConnectionStatus": "string",
         "IpAddress": "string",
         "NtpServerName": "string"
      }
   },
   "CurrentSoftware": "string",
   "Description": "string",
   "DeviceAggregatedStatus": "string",
   "DeviceConnectionStatus": "string",
   "DeviceId": "string",
   "LatestAlternateSoftware": "string",
   "LatestDeviceJob": { 
      "ImageVersion": "string",
      "JobType": "string",
      "Status": "string"
   },
   "LatestSoftware": "string",
   "LeaseExpirationTime": number,
   "Name": "string",
   "NetworkingConfiguration": { 
      "Ethernet0": { 
         "ConnectionType": "string",
         "StaticIpConnectionInfo": { 
            "DefaultGateway": "string",
            "Dns": [ "string" ],
            "IpAddress": "string",
            "Mask": "string"
         }
      },
      "Ethernet1": { 
         "ConnectionType": "string",
         "StaticIpConnectionInfo": { 
            "DefaultGateway": "string",
            "Dns": [ "string" ],
            "IpAddress": "string",
            "Mask": "string"
         }
      },
      "Ntp": { 
         "NtpServers": [ "string" ]
      }
   },
   "ProvisioningStatus": "string",
   "SerialNumber": "string",
   "Tags": { 
      "string" : "string" 
   },
   "Type": "string"
}
```

## Response Elements
<a name="API_DescribeDevice_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [AlternateSoftwares](#API_DescribeDevice_ResponseSyntax) **   <a name="panorama-DescribeDevice-response-AlternateSoftwares"></a>
Beta software releases available for the device.  
Type: Array of [AlternateSoftwareMetadata](API_AlternateSoftwareMetadata.md) objects

 ** [Arn](#API_DescribeDevice_ResponseSyntax) **   <a name="panorama-DescribeDevice-response-Arn"></a>
The device's ARN.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.

 ** [Brand](#API_DescribeDevice_ResponseSyntax) **   <a name="panorama-DescribeDevice-response-Brand"></a>
The device's maker.  
Type: String  
Valid Values: `AWS_PANORAMA | LENOVO` 

 ** [CreatedTime](#API_DescribeDevice_ResponseSyntax) **   <a name="panorama-DescribeDevice-response-CreatedTime"></a>
When the device was created.  
Type: Timestamp

 ** [CurrentNetworkingStatus](#API_DescribeDevice_ResponseSyntax) **   <a name="panorama-DescribeDevice-response-CurrentNetworkingStatus"></a>
The device's networking status.  
Type: [NetworkStatus](API_NetworkStatus.md) object

 ** [CurrentSoftware](#API_DescribeDevice_ResponseSyntax) **   <a name="panorama-DescribeDevice-response-CurrentSoftware"></a>
The device's current software version.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.

 ** [Description](#API_DescribeDevice_ResponseSyntax) **   <a name="panorama-DescribeDevice-response-Description"></a>
The device's description.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 255.  
Pattern: `.*` 

 ** [DeviceAggregatedStatus](#API_DescribeDevice_ResponseSyntax) **   <a name="panorama-DescribeDevice-response-DeviceAggregatedStatus"></a>
A device's aggregated status. Including the device's connection status, provisioning status, and lease status.  
Type: String  
Valid Values: `ERROR | AWAITING_PROVISIONING | PENDING | FAILED | DELETING | ONLINE | OFFLINE | LEASE_EXPIRED | UPDATE_NEEDED | REBOOTING` 

 ** [DeviceConnectionStatus](#API_DescribeDevice_ResponseSyntax) **   <a name="panorama-DescribeDevice-response-DeviceConnectionStatus"></a>
The device's connection status.  
Type: String  
Valid Values: `ONLINE | OFFLINE | AWAITING_CREDENTIALS | NOT_AVAILABLE | ERROR` 

 ** [DeviceId](#API_DescribeDevice_ResponseSyntax) **   <a name="panorama-DescribeDevice-response-DeviceId"></a>
The device's ID.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z0-9\-\_]+` 

 ** [LatestAlternateSoftware](#API_DescribeDevice_ResponseSyntax) **   <a name="panorama-DescribeDevice-response-LatestAlternateSoftware"></a>
The most recent beta software release.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.

 ** [LatestDeviceJob](#API_DescribeDevice_ResponseSyntax) **   <a name="panorama-DescribeDevice-response-LatestDeviceJob"></a>
A device's latest job. Includes the target image version, and the job status.  
Type: [LatestDeviceJob](API_LatestDeviceJob.md) object

 ** [LatestSoftware](#API_DescribeDevice_ResponseSyntax) **   <a name="panorama-DescribeDevice-response-LatestSoftware"></a>
The latest software version available for the device.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.

 ** [LeaseExpirationTime](#API_DescribeDevice_ResponseSyntax) **   <a name="panorama-DescribeDevice-response-LeaseExpirationTime"></a>
The device's lease expiration time.  
Type: Timestamp

 ** [Name](#API_DescribeDevice_ResponseSyntax) **   <a name="panorama-DescribeDevice-response-Name"></a>
The device's name.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z0-9\-\_]+` 

 ** [NetworkingConfiguration](#API_DescribeDevice_ResponseSyntax) **   <a name="panorama-DescribeDevice-response-NetworkingConfiguration"></a>
The device's networking configuration.  
Type: [NetworkPayload](API_NetworkPayload.md) object

 ** [ProvisioningStatus](#API_DescribeDevice_ResponseSyntax) **   <a name="panorama-DescribeDevice-response-ProvisioningStatus"></a>
The device's provisioning status.  
Type: String  
Valid Values: `AWAITING_PROVISIONING | PENDING | SUCCEEDED | FAILED | ERROR | DELETING` 

 ** [SerialNumber](#API_DescribeDevice_ResponseSyntax) **   <a name="panorama-DescribeDevice-response-SerialNumber"></a>
The device's serial number.  
Type: String  
Pattern: `[0-9]{1,20}` 

 ** [Tags](#API_DescribeDevice_ResponseSyntax) **   <a name="panorama-DescribeDevice-response-Tags"></a>
The device's tags.  
Type: String to string map  
Map Entries: Minimum number of 0 items. Maximum number of 50 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `.+`   
Value Length Constraints: Minimum length of 0. Maximum length of 256.  
Value Pattern: `.*` 

 ** [Type](#API_DescribeDevice_ResponseSyntax) **   <a name="panorama-DescribeDevice-response-Type"></a>
The device's type.  
Type: String  
Valid Values: `PANORAMA_APPLIANCE_DEVELOPER_KIT | PANORAMA_APPLIANCE` 

## Errors
<a name="API_DescribeDevice_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
The requestor does not have permission to access the target action or resource.  
HTTP Status Code: 403

 ** InternalServerException **   
An internal error occurred.    
 ** RetryAfterSeconds **   
The number of seconds a client should wait before retrying the call.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The target resource was not found.    
 ** ResourceId **   
The resource's ID.  
 ** ResourceType **   
The resource's type.
HTTP Status Code: 404

 ** ValidationException **   
The request contains an invalid parameter value.    
 ** ErrorArguments **   
A list of attributes that led to the exception and their values.  
 ** ErrorId **   
A unique ID for the error.  
 ** Fields **   
A list of request parameters that failed validation.  
 ** Reason **   
The reason that validation failed.
HTTP Status Code: 400

## See Also
<a name="API_DescribeDevice_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/panorama-2019-07-24/DescribeDevice) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/panorama-2019-07-24/DescribeDevice) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/panorama-2019-07-24/DescribeDevice) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/panorama-2019-07-24/DescribeDevice) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/panorama-2019-07-24/DescribeDevice) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/panorama-2019-07-24/DescribeDevice) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/panorama-2019-07-24/DescribeDevice) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/panorama-2019-07-24/DescribeDevice) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/panorama-2019-07-24/DescribeDevice) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/panorama-2019-07-24/DescribeDevice) 

# DescribeDeviceJob
<a name="API_DescribeDeviceJob"></a>

**Important**  
End of support notice: On May 31, 2026, AWS will end support for AWS Panorama. After May 31, 2026, you will no longer be able to access the AWS Panorama console or AWS Panorama resources. For more information, see [AWS Panorama end of support](https://docs.aws.amazon.com/panorama/latest/dev/panorama-end-of-support.html). 

Returns information about a device job.

## Request Syntax
<a name="API_DescribeDeviceJob_RequestSyntax"></a>

```
GET /jobs/JobId HTTP/1.1
```

## URI Request Parameters
<a name="API_DescribeDeviceJob_RequestParameters"></a>

The request uses the following URI parameters.

 ** [JobId](#API_DescribeDeviceJob_RequestSyntax) **   <a name="panorama-DescribeDeviceJob-request-uri-JobId"></a>
The job's ID.  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z0-9\-\_]+`   
Required: Yes

## Request Body
<a name="API_DescribeDeviceJob_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DescribeDeviceJob_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "CreatedTime": number,
   "DeviceArn": "string",
   "DeviceId": "string",
   "DeviceName": "string",
   "DeviceType": "string",
   "ImageVersion": "string",
   "JobId": "string",
   "JobType": "string",
   "Status": "string"
}
```

## Response Elements
<a name="API_DescribeDeviceJob_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [CreatedTime](#API_DescribeDeviceJob_ResponseSyntax) **   <a name="panorama-DescribeDeviceJob-response-CreatedTime"></a>
When the job was created.  
Type: Timestamp

 ** [DeviceArn](#API_DescribeDeviceJob_ResponseSyntax) **   <a name="panorama-DescribeDeviceJob-response-DeviceArn"></a>
The device's ARN.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.

 ** [DeviceId](#API_DescribeDeviceJob_ResponseSyntax) **   <a name="panorama-DescribeDeviceJob-response-DeviceId"></a>
The device's ID.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z0-9\-\_]+` 

 ** [DeviceName](#API_DescribeDeviceJob_ResponseSyntax) **   <a name="panorama-DescribeDeviceJob-response-DeviceName"></a>
The device's name.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z0-9\-\_]+` 

 ** [DeviceType](#API_DescribeDeviceJob_ResponseSyntax) **   <a name="panorama-DescribeDeviceJob-response-DeviceType"></a>
The device's type.  
Type: String  
Valid Values: `PANORAMA_APPLIANCE_DEVELOPER_KIT | PANORAMA_APPLIANCE` 

 ** [ImageVersion](#API_DescribeDeviceJob_ResponseSyntax) **   <a name="panorama-DescribeDeviceJob-response-ImageVersion"></a>
For an OTA job, the target version of the device software.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `.+` 

 ** [JobId](#API_DescribeDeviceJob_ResponseSyntax) **   <a name="panorama-DescribeDeviceJob-response-JobId"></a>
The job's ID.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z0-9\-\_]+` 

 ** [JobType](#API_DescribeDeviceJob_ResponseSyntax) **   <a name="panorama-DescribeDeviceJob-response-JobType"></a>
The job's type.  
Type: String  
Valid Values: `OTA | REBOOT` 

 ** [Status](#API_DescribeDeviceJob_ResponseSyntax) **   <a name="panorama-DescribeDeviceJob-response-Status"></a>
The job's status.  
Type: String  
Valid Values: `PENDING | IN_PROGRESS | VERIFYING | REBOOTING | DOWNLOADING | COMPLETED | FAILED` 

## Errors
<a name="API_DescribeDeviceJob_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
The requestor does not have permission to access the target action or resource.  
HTTP Status Code: 403

 ** ConflictException **   
The target resource is in use.    
 ** ErrorArguments **   
A list of attributes that led to the exception and their values.  
 ** ErrorId **   
A unique ID for the error.  
 ** ResourceId **   
The resource's ID.  
 ** ResourceType **   
The resource's type.
HTTP Status Code: 409

 ** InternalServerException **   
An internal error occurred.    
 ** RetryAfterSeconds **   
The number of seconds a client should wait before retrying the call.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The target resource was not found.    
 ** ResourceId **   
The resource's ID.  
 ** ResourceType **   
The resource's type.
HTTP Status Code: 404

 ** ValidationException **   
The request contains an invalid parameter value.    
 ** ErrorArguments **   
A list of attributes that led to the exception and their values.  
 ** ErrorId **   
A unique ID for the error.  
 ** Fields **   
A list of request parameters that failed validation.  
 ** Reason **   
The reason that validation failed.
HTTP Status Code: 400

## See Also
<a name="API_DescribeDeviceJob_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/panorama-2019-07-24/DescribeDeviceJob) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/panorama-2019-07-24/DescribeDeviceJob) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/panorama-2019-07-24/DescribeDeviceJob) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/panorama-2019-07-24/DescribeDeviceJob) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/panorama-2019-07-24/DescribeDeviceJob) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/panorama-2019-07-24/DescribeDeviceJob) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/panorama-2019-07-24/DescribeDeviceJob) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/panorama-2019-07-24/DescribeDeviceJob) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/panorama-2019-07-24/DescribeDeviceJob) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/panorama-2019-07-24/DescribeDeviceJob) 

# DescribeNode
<a name="API_DescribeNode"></a>

**Important**  
End of support notice: On May 31, 2026, AWS will end support for AWS Panorama. After May 31, 2026, you will no longer be able to access the AWS Panorama console or AWS Panorama resources. For more information, see [AWS Panorama end of support](https://docs.aws.amazon.com/panorama/latest/dev/panorama-end-of-support.html). 

Returns information about a node.

## Request Syntax
<a name="API_DescribeNode_RequestSyntax"></a>

```
GET /nodes/NodeId?OwnerAccount=OwnerAccount HTTP/1.1
```

## URI Request Parameters
<a name="API_DescribeNode_RequestParameters"></a>

The request uses the following URI parameters.

 ** [NodeId](#API_DescribeNode_RequestSyntax) **   <a name="panorama-DescribeNode-request-uri-NodeId"></a>
The node's ID.  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z0-9\-\_\.]+`   
Required: Yes

 ** [OwnerAccount](#API_DescribeNode_RequestSyntax) **   <a name="panorama-DescribeNode-request-uri-OwnerAccount"></a>
The account ID of the node's owner.  
Length Constraints: Minimum length of 1. Maximum length of 12.  
Pattern: `[0-9a-z\_]+` 

## Request Body
<a name="API_DescribeNode_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DescribeNode_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "AssetName": "string",
   "Category": "string",
   "CreatedTime": number,
   "Description": "string",
   "LastUpdatedTime": number,
   "Name": "string",
   "NodeId": "string",
   "NodeInterface": { 
      "Inputs": [ 
         { 
            "DefaultValue": "string",
            "Description": "string",
            "MaxConnections": number,
            "Name": "string",
            "Type": "string"
         }
      ],
      "Outputs": [ 
         { 
            "Description": "string",
            "Name": "string",
            "Type": "string"
         }
      ]
   },
   "OwnerAccount": "string",
   "PackageArn": "string",
   "PackageId": "string",
   "PackageName": "string",
   "PackageVersion": "string",
   "PatchVersion": "string"
}
```

## Response Elements
<a name="API_DescribeNode_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [AssetName](#API_DescribeNode_ResponseSyntax) **   <a name="panorama-DescribeNode-response-AssetName"></a>
The node's asset name.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z0-9\-\_]+` 

 ** [Category](#API_DescribeNode_ResponseSyntax) **   <a name="panorama-DescribeNode-response-Category"></a>
The node's category.  
Type: String  
Valid Values: `BUSINESS_LOGIC | ML_MODEL | MEDIA_SOURCE | MEDIA_SINK` 

 ** [CreatedTime](#API_DescribeNode_ResponseSyntax) **   <a name="panorama-DescribeNode-response-CreatedTime"></a>
When the node was created.  
Type: Timestamp

 ** [Description](#API_DescribeNode_ResponseSyntax) **   <a name="panorama-DescribeNode-response-Description"></a>
The node's description.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 255.  
Pattern: `.*` 

 ** [LastUpdatedTime](#API_DescribeNode_ResponseSyntax) **   <a name="panorama-DescribeNode-response-LastUpdatedTime"></a>
When the node was updated.  
Type: Timestamp

 ** [Name](#API_DescribeNode_ResponseSyntax) **   <a name="panorama-DescribeNode-response-Name"></a>
The node's name.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[a-zA-Z0-9\-\_]+` 

 ** [NodeId](#API_DescribeNode_ResponseSyntax) **   <a name="panorama-DescribeNode-response-NodeId"></a>
The node's ID.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z0-9\-\_\.]+` 

 ** [NodeInterface](#API_DescribeNode_ResponseSyntax) **   <a name="panorama-DescribeNode-response-NodeInterface"></a>
The node's interface.  
Type: [NodeInterface](API_NodeInterface.md) object

 ** [OwnerAccount](#API_DescribeNode_ResponseSyntax) **   <a name="panorama-DescribeNode-response-OwnerAccount"></a>
The account ID of the node's owner.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 12.  
Pattern: `[0-9a-z\_]+` 

 ** [PackageArn](#API_DescribeNode_ResponseSyntax) **   <a name="panorama-DescribeNode-response-PackageArn"></a>
The node's ARN.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.

 ** [PackageId](#API_DescribeNode_ResponseSyntax) **   <a name="panorama-DescribeNode-response-PackageId"></a>
The node's package ID.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z0-9\-\_\/]+` 

 ** [PackageName](#API_DescribeNode_ResponseSyntax) **   <a name="panorama-DescribeNode-response-PackageName"></a>
The node's package name.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[a-zA-Z0-9\-\_]+` 

 ** [PackageVersion](#API_DescribeNode_ResponseSyntax) **   <a name="panorama-DescribeNode-response-PackageVersion"></a>
The node's package version.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `([0-9]+)\.([0-9]+)` 

 ** [PatchVersion](#API_DescribeNode_ResponseSyntax) **   <a name="panorama-DescribeNode-response-PatchVersion"></a>
The node's patch version.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-z0-9]+` 

## Errors
<a name="API_DescribeNode_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
The requestor does not have permission to access the target action or resource.  
HTTP Status Code: 403

 ** ConflictException **   
The target resource is in use.    
 ** ErrorArguments **   
A list of attributes that led to the exception and their values.  
 ** ErrorId **   
A unique ID for the error.  
 ** ResourceId **   
The resource's ID.  
 ** ResourceType **   
The resource's type.
HTTP Status Code: 409

 ** InternalServerException **   
An internal error occurred.    
 ** RetryAfterSeconds **   
The number of seconds a client should wait before retrying the call.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The target resource was not found.    
 ** ResourceId **   
The resource's ID.  
 ** ResourceType **   
The resource's type.
HTTP Status Code: 404

 ** ValidationException **   
The request contains an invalid parameter value.    
 ** ErrorArguments **   
A list of attributes that led to the exception and their values.  
 ** ErrorId **   
A unique ID for the error.  
 ** Fields **   
A list of request parameters that failed validation.  
 ** Reason **   
The reason that validation failed.
HTTP Status Code: 400

## See Also
<a name="API_DescribeNode_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/panorama-2019-07-24/DescribeNode) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/panorama-2019-07-24/DescribeNode) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/panorama-2019-07-24/DescribeNode) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/panorama-2019-07-24/DescribeNode) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/panorama-2019-07-24/DescribeNode) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/panorama-2019-07-24/DescribeNode) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/panorama-2019-07-24/DescribeNode) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/panorama-2019-07-24/DescribeNode) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/panorama-2019-07-24/DescribeNode) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/panorama-2019-07-24/DescribeNode) 

# DescribeNodeFromTemplateJob
<a name="API_DescribeNodeFromTemplateJob"></a>

**Important**  
End of support notice: On May 31, 2026, AWS will end support for AWS Panorama. After May 31, 2026, you will no longer be able to access the AWS Panorama console or AWS Panorama resources. For more information, see [AWS Panorama end of support](https://docs.aws.amazon.com/panorama/latest/dev/panorama-end-of-support.html). 

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

## Request Syntax
<a name="API_DescribeNodeFromTemplateJob_RequestSyntax"></a>

```
GET /packages/template-job/JobId HTTP/1.1
```

## URI Request Parameters
<a name="API_DescribeNodeFromTemplateJob_RequestParameters"></a>

The request uses the following URI parameters.

 ** [JobId](#API_DescribeNodeFromTemplateJob_RequestSyntax) **   <a name="panorama-DescribeNodeFromTemplateJob-request-uri-JobId"></a>
The job's ID.  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z0-9\-\_]+`   
Required: Yes

## Request Body
<a name="API_DescribeNodeFromTemplateJob_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DescribeNodeFromTemplateJob_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "CreatedTime": number,
   "JobId": "string",
   "JobTags": [ 
      { 
         "ResourceType": "string",
         "Tags": { 
            "string" : "string" 
         }
      }
   ],
   "LastUpdatedTime": number,
   "NodeDescription": "string",
   "NodeName": "string",
   "OutputPackageName": "string",
   "OutputPackageVersion": "string",
   "Status": "string",
   "StatusMessage": "string",
   "TemplateParameters": { 
      "string" : "string" 
   },
   "TemplateType": "string"
}
```

## Response Elements
<a name="API_DescribeNodeFromTemplateJob_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [CreatedTime](#API_DescribeNodeFromTemplateJob_ResponseSyntax) **   <a name="panorama-DescribeNodeFromTemplateJob-response-CreatedTime"></a>
When the job was created.  
Type: Timestamp

 ** [JobId](#API_DescribeNodeFromTemplateJob_ResponseSyntax) **   <a name="panorama-DescribeNodeFromTemplateJob-response-JobId"></a>
The job's ID.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z0-9\-\_]+` 

 ** [JobTags](#API_DescribeNodeFromTemplateJob_ResponseSyntax) **   <a name="panorama-DescribeNodeFromTemplateJob-response-JobTags"></a>
The job's tags.  
Type: Array of [JobResourceTags](API_JobResourceTags.md) objects

 ** [LastUpdatedTime](#API_DescribeNodeFromTemplateJob_ResponseSyntax) **   <a name="panorama-DescribeNodeFromTemplateJob-response-LastUpdatedTime"></a>
When the job was updated.  
Type: Timestamp

 ** [NodeDescription](#API_DescribeNodeFromTemplateJob_ResponseSyntax) **   <a name="panorama-DescribeNodeFromTemplateJob-response-NodeDescription"></a>
The node's description.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 255.  
Pattern: `.*` 

 ** [NodeName](#API_DescribeNodeFromTemplateJob_ResponseSyntax) **   <a name="panorama-DescribeNodeFromTemplateJob-response-NodeName"></a>
The node's name.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[a-zA-Z0-9\-\_]+` 

 ** [OutputPackageName](#API_DescribeNodeFromTemplateJob_ResponseSyntax) **   <a name="panorama-DescribeNodeFromTemplateJob-response-OutputPackageName"></a>
The job's output package name.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[a-zA-Z0-9\-\_]+` 

 ** [OutputPackageVersion](#API_DescribeNodeFromTemplateJob_ResponseSyntax) **   <a name="panorama-DescribeNodeFromTemplateJob-response-OutputPackageVersion"></a>
The job's output package version.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `([0-9]+)\.([0-9]+)` 

 ** [Status](#API_DescribeNodeFromTemplateJob_ResponseSyntax) **   <a name="panorama-DescribeNodeFromTemplateJob-response-Status"></a>
The job's status.  
Type: String  
Valid Values: `PENDING | SUCCEEDED | FAILED` 

 ** [StatusMessage](#API_DescribeNodeFromTemplateJob_ResponseSyntax) **   <a name="panorama-DescribeNodeFromTemplateJob-response-StatusMessage"></a>
The job's status message.  
Type: String

 ** [TemplateParameters](#API_DescribeNodeFromTemplateJob_ResponseSyntax) **   <a name="panorama-DescribeNodeFromTemplateJob-response-TemplateParameters"></a>
The job's template parameters.  
Type: String to string map  
Key Length Constraints: Minimum length of 1. Maximum length of 255.  
Key Pattern: `.+`   
Value Length Constraints: Minimum length of 1. Maximum length of 255.  
Value Pattern: `.+` 

 ** [TemplateType](#API_DescribeNodeFromTemplateJob_ResponseSyntax) **   <a name="panorama-DescribeNodeFromTemplateJob-response-TemplateType"></a>
The job's template type.  
Type: String  
Valid Values: `RTSP_CAMERA_STREAM` 

## Errors
<a name="API_DescribeNodeFromTemplateJob_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
The requestor does not have permission to access the target action or resource.  
HTTP Status Code: 403

 ** ConflictException **   
The target resource is in use.    
 ** ErrorArguments **   
A list of attributes that led to the exception and their values.  
 ** ErrorId **   
A unique ID for the error.  
 ** ResourceId **   
The resource's ID.  
 ** ResourceType **   
The resource's type.
HTTP Status Code: 409

 ** InternalServerException **   
An internal error occurred.    
 ** RetryAfterSeconds **   
The number of seconds a client should wait before retrying the call.
HTTP Status Code: 500

 ** ValidationException **   
The request contains an invalid parameter value.    
 ** ErrorArguments **   
A list of attributes that led to the exception and their values.  
 ** ErrorId **   
A unique ID for the error.  
 ** Fields **   
A list of request parameters that failed validation.  
 ** Reason **   
The reason that validation failed.
HTTP Status Code: 400

## See Also
<a name="API_DescribeNodeFromTemplateJob_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/panorama-2019-07-24/DescribeNodeFromTemplateJob) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/panorama-2019-07-24/DescribeNodeFromTemplateJob) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/panorama-2019-07-24/DescribeNodeFromTemplateJob) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/panorama-2019-07-24/DescribeNodeFromTemplateJob) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/panorama-2019-07-24/DescribeNodeFromTemplateJob) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/panorama-2019-07-24/DescribeNodeFromTemplateJob) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/panorama-2019-07-24/DescribeNodeFromTemplateJob) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/panorama-2019-07-24/DescribeNodeFromTemplateJob) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/panorama-2019-07-24/DescribeNodeFromTemplateJob) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/panorama-2019-07-24/DescribeNodeFromTemplateJob) 

# DescribePackage
<a name="API_DescribePackage"></a>

**Important**  
End of support notice: On May 31, 2026, AWS will end support for AWS Panorama. After May 31, 2026, you will no longer be able to access the AWS Panorama console or AWS Panorama resources. For more information, see [AWS Panorama end of support](https://docs.aws.amazon.com/panorama/latest/dev/panorama-end-of-support.html). 

Returns information about a package.

## Request Syntax
<a name="API_DescribePackage_RequestSyntax"></a>

```
GET /packages/metadata/PackageId HTTP/1.1
```

## URI Request Parameters
<a name="API_DescribePackage_RequestParameters"></a>

The request uses the following URI parameters.

 ** [PackageId](#API_DescribePackage_RequestSyntax) **   <a name="panorama-DescribePackage-request-uri-PackageId"></a>
The package's ID.  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z0-9\-\_\/]+`   
Required: Yes

## Request Body
<a name="API_DescribePackage_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DescribePackage_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Arn": "string",
   "CreatedTime": number,
   "PackageId": "string",
   "PackageName": "string",
   "ReadAccessPrincipalArns": [ "string" ],
   "StorageLocation": { 
      "BinaryPrefixLocation": "string",
      "Bucket": "string",
      "GeneratedPrefixLocation": "string",
      "ManifestPrefixLocation": "string",
      "RepoPrefixLocation": "string"
   },
   "Tags": { 
      "string" : "string" 
   },
   "WriteAccessPrincipalArns": [ "string" ]
}
```

## Response Elements
<a name="API_DescribePackage_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Arn](#API_DescribePackage_ResponseSyntax) **   <a name="panorama-DescribePackage-response-Arn"></a>
The package's ARN.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.

 ** [CreatedTime](#API_DescribePackage_ResponseSyntax) **   <a name="panorama-DescribePackage-response-CreatedTime"></a>
When the package was created.  
Type: Timestamp

 ** [PackageId](#API_DescribePackage_ResponseSyntax) **   <a name="panorama-DescribePackage-response-PackageId"></a>
The package's ID.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z0-9\-\_\/]+` 

 ** [PackageName](#API_DescribePackage_ResponseSyntax) **   <a name="panorama-DescribePackage-response-PackageName"></a>
The package's name.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[a-zA-Z0-9\-\_]+` 

 ** [ReadAccessPrincipalArns](#API_DescribePackage_ResponseSyntax) **   <a name="panorama-DescribePackage-response-ReadAccessPrincipalArns"></a>
ARNs of accounts that have read access to the package.  
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `arn:[a-z0-9][-.a-z0-9]{0,62}:iam::[0-9]{12}:[a-zA-Z0-9+=,.@\-_/]+` 

 ** [StorageLocation](#API_DescribePackage_ResponseSyntax) **   <a name="panorama-DescribePackage-response-StorageLocation"></a>
The package's storage location.  
Type: [StorageLocation](API_StorageLocation.md) object

 ** [Tags](#API_DescribePackage_ResponseSyntax) **   <a name="panorama-DescribePackage-response-Tags"></a>
The package's tags.  
Type: String to string map  
Map Entries: Minimum number of 0 items. Maximum number of 50 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `.+`   
Value Length Constraints: Minimum length of 0. Maximum length of 256.  
Value Pattern: `.*` 

 ** [WriteAccessPrincipalArns](#API_DescribePackage_ResponseSyntax) **   <a name="panorama-DescribePackage-response-WriteAccessPrincipalArns"></a>
ARNs of accounts that have write access to the package.  
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `arn:[a-z0-9][-.a-z0-9]{0,62}:iam::[0-9]{12}:[a-zA-Z0-9+=,.@\-_/]+` 

## Errors
<a name="API_DescribePackage_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
The requestor does not have permission to access the target action or resource.  
HTTP Status Code: 403

 ** ConflictException **   
The target resource is in use.    
 ** ErrorArguments **   
A list of attributes that led to the exception and their values.  
 ** ErrorId **   
A unique ID for the error.  
 ** ResourceId **   
The resource's ID.  
 ** ResourceType **   
The resource's type.
HTTP Status Code: 409

 ** InternalServerException **   
An internal error occurred.    
 ** RetryAfterSeconds **   
The number of seconds a client should wait before retrying the call.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The target resource was not found.    
 ** ResourceId **   
The resource's ID.  
 ** ResourceType **   
The resource's type.
HTTP Status Code: 404

 ** ValidationException **   
The request contains an invalid parameter value.    
 ** ErrorArguments **   
A list of attributes that led to the exception and their values.  
 ** ErrorId **   
A unique ID for the error.  
 ** Fields **   
A list of request parameters that failed validation.  
 ** Reason **   
The reason that validation failed.
HTTP Status Code: 400

## See Also
<a name="API_DescribePackage_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/panorama-2019-07-24/DescribePackage) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/panorama-2019-07-24/DescribePackage) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/panorama-2019-07-24/DescribePackage) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/panorama-2019-07-24/DescribePackage) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/panorama-2019-07-24/DescribePackage) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/panorama-2019-07-24/DescribePackage) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/panorama-2019-07-24/DescribePackage) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/panorama-2019-07-24/DescribePackage) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/panorama-2019-07-24/DescribePackage) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/panorama-2019-07-24/DescribePackage) 

# DescribePackageImportJob
<a name="API_DescribePackageImportJob"></a>

**Important**  
End of support notice: On May 31, 2026, AWS will end support for AWS Panorama. After May 31, 2026, you will no longer be able to access the AWS Panorama console or AWS Panorama resources. For more information, see [AWS Panorama end of support](https://docs.aws.amazon.com/panorama/latest/dev/panorama-end-of-support.html). 

Returns information about a package import job.

## Request Syntax
<a name="API_DescribePackageImportJob_RequestSyntax"></a>

```
GET /packages/import-jobs/JobId HTTP/1.1
```

## URI Request Parameters
<a name="API_DescribePackageImportJob_RequestParameters"></a>

The request uses the following URI parameters.

 ** [JobId](#API_DescribePackageImportJob_RequestSyntax) **   <a name="panorama-DescribePackageImportJob-request-uri-JobId"></a>
The job's ID.  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z0-9\-\_]+`   
Required: Yes

## Request Body
<a name="API_DescribePackageImportJob_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DescribePackageImportJob_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "ClientToken": "string",
   "CreatedTime": number,
   "InputConfig": { 
      "PackageVersionInputConfig": { 
         "S3Location": { 
            "BucketName": "string",
            "ObjectKey": "string",
            "Region": "string"
         }
      }
   },
   "JobId": "string",
   "JobTags": [ 
      { 
         "ResourceType": "string",
         "Tags": { 
            "string" : "string" 
         }
      }
   ],
   "JobType": "string",
   "LastUpdatedTime": number,
   "Output": { 
      "OutputS3Location": { 
         "BucketName": "string",
         "ObjectKey": "string"
      },
      "PackageId": "string",
      "PackageVersion": "string",
      "PatchVersion": "string"
   },
   "OutputConfig": { 
      "PackageVersionOutputConfig": { 
         "MarkLatest": boolean,
         "PackageName": "string",
         "PackageVersion": "string"
      }
   },
   "Status": "string",
   "StatusMessage": "string"
}
```

## Response Elements
<a name="API_DescribePackageImportJob_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ClientToken](#API_DescribePackageImportJob_ResponseSyntax) **   <a name="panorama-DescribePackageImportJob-response-ClientToken"></a>
The job's client token.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[a-zA-Z0-9\-\_]+` 

 ** [CreatedTime](#API_DescribePackageImportJob_ResponseSyntax) **   <a name="panorama-DescribePackageImportJob-response-CreatedTime"></a>
When the job was created.  
Type: Timestamp

 ** [InputConfig](#API_DescribePackageImportJob_ResponseSyntax) **   <a name="panorama-DescribePackageImportJob-response-InputConfig"></a>
The job's input config.  
Type: [PackageImportJobInputConfig](API_PackageImportJobInputConfig.md) object

 ** [JobId](#API_DescribePackageImportJob_ResponseSyntax) **   <a name="panorama-DescribePackageImportJob-response-JobId"></a>
The job's ID.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z0-9\-\_]+` 

 ** [JobTags](#API_DescribePackageImportJob_ResponseSyntax) **   <a name="panorama-DescribePackageImportJob-response-JobTags"></a>
The job's tags.  
Type: Array of [JobResourceTags](API_JobResourceTags.md) objects

 ** [JobType](#API_DescribePackageImportJob_ResponseSyntax) **   <a name="panorama-DescribePackageImportJob-response-JobType"></a>
The job's type.  
Type: String  
Valid Values: `NODE_PACKAGE_VERSION | MARKETPLACE_NODE_PACKAGE_VERSION` 

 ** [LastUpdatedTime](#API_DescribePackageImportJob_ResponseSyntax) **   <a name="panorama-DescribePackageImportJob-response-LastUpdatedTime"></a>
When the job was updated.  
Type: Timestamp

 ** [Output](#API_DescribePackageImportJob_ResponseSyntax) **   <a name="panorama-DescribePackageImportJob-response-Output"></a>
The job's output.  
Type: [PackageImportJobOutput](API_PackageImportJobOutput.md) object

 ** [OutputConfig](#API_DescribePackageImportJob_ResponseSyntax) **   <a name="panorama-DescribePackageImportJob-response-OutputConfig"></a>
The job's output config.  
Type: [PackageImportJobOutputConfig](API_PackageImportJobOutputConfig.md) object

 ** [Status](#API_DescribePackageImportJob_ResponseSyntax) **   <a name="panorama-DescribePackageImportJob-response-Status"></a>
The job's status.  
Type: String  
Valid Values: `PENDING | SUCCEEDED | FAILED` 

 ** [StatusMessage](#API_DescribePackageImportJob_ResponseSyntax) **   <a name="panorama-DescribePackageImportJob-response-StatusMessage"></a>
The job's status message.  
Type: String

## Errors
<a name="API_DescribePackageImportJob_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
The requestor does not have permission to access the target action or resource.  
HTTP Status Code: 403

 ** ConflictException **   
The target resource is in use.    
 ** ErrorArguments **   
A list of attributes that led to the exception and their values.  
 ** ErrorId **   
A unique ID for the error.  
 ** ResourceId **   
The resource's ID.  
 ** ResourceType **   
The resource's type.
HTTP Status Code: 409

 ** InternalServerException **   
An internal error occurred.    
 ** RetryAfterSeconds **   
The number of seconds a client should wait before retrying the call.
HTTP Status Code: 500

 ** ValidationException **   
The request contains an invalid parameter value.    
 ** ErrorArguments **   
A list of attributes that led to the exception and their values.  
 ** ErrorId **   
A unique ID for the error.  
 ** Fields **   
A list of request parameters that failed validation.  
 ** Reason **   
The reason that validation failed.
HTTP Status Code: 400

## See Also
<a name="API_DescribePackageImportJob_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/panorama-2019-07-24/DescribePackageImportJob) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/panorama-2019-07-24/DescribePackageImportJob) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/panorama-2019-07-24/DescribePackageImportJob) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/panorama-2019-07-24/DescribePackageImportJob) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/panorama-2019-07-24/DescribePackageImportJob) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/panorama-2019-07-24/DescribePackageImportJob) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/panorama-2019-07-24/DescribePackageImportJob) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/panorama-2019-07-24/DescribePackageImportJob) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/panorama-2019-07-24/DescribePackageImportJob) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/panorama-2019-07-24/DescribePackageImportJob) 

# DescribePackageVersion
<a name="API_DescribePackageVersion"></a>

**Important**  
End of support notice: On May 31, 2026, AWS will end support for AWS Panorama. After May 31, 2026, you will no longer be able to access the AWS Panorama console or AWS Panorama resources. For more information, see [AWS Panorama end of support](https://docs.aws.amazon.com/panorama/latest/dev/panorama-end-of-support.html). 

Returns information about a package version.

## Request Syntax
<a name="API_DescribePackageVersion_RequestSyntax"></a>

```
GET /packages/metadata/PackageId/versions/PackageVersion?OwnerAccount=OwnerAccount&PatchVersion=PatchVersion HTTP/1.1
```

## URI Request Parameters
<a name="API_DescribePackageVersion_RequestParameters"></a>

The request uses the following URI parameters.

 ** [OwnerAccount](#API_DescribePackageVersion_RequestSyntax) **   <a name="panorama-DescribePackageVersion-request-uri-OwnerAccount"></a>
The version's owner account.  
Length Constraints: Minimum length of 1. Maximum length of 12.  
Pattern: `[0-9a-z\_]+` 

 ** [PackageId](#API_DescribePackageVersion_RequestSyntax) **   <a name="panorama-DescribePackageVersion-request-uri-PackageId"></a>
The version's ID.  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z0-9\-\_\/]+`   
Required: Yes

 ** [PackageVersion](#API_DescribePackageVersion_RequestSyntax) **   <a name="panorama-DescribePackageVersion-request-uri-PackageVersion"></a>
The version's version.  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `([0-9]+)\.([0-9]+)`   
Required: Yes

 ** [PatchVersion](#API_DescribePackageVersion_RequestSyntax) **   <a name="panorama-DescribePackageVersion-request-uri-PatchVersion"></a>
The version's patch version.  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-z0-9]+` 

## Request Body
<a name="API_DescribePackageVersion_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DescribePackageVersion_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "IsLatestPatch": boolean,
   "OwnerAccount": "string",
   "PackageArn": "string",
   "PackageId": "string",
   "PackageName": "string",
   "PackageVersion": "string",
   "PatchVersion": "string",
   "RegisteredTime": number,
   "Status": "string",
   "StatusDescription": "string"
}
```

## Response Elements
<a name="API_DescribePackageVersion_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [IsLatestPatch](#API_DescribePackageVersion_ResponseSyntax) **   <a name="panorama-DescribePackageVersion-response-IsLatestPatch"></a>
Whether the version is the latest available.  
Type: Boolean

 ** [OwnerAccount](#API_DescribePackageVersion_ResponseSyntax) **   <a name="panorama-DescribePackageVersion-response-OwnerAccount"></a>
The account ID of the version's owner.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 12.  
Pattern: `[0-9a-z\_]+` 

 ** [PackageArn](#API_DescribePackageVersion_ResponseSyntax) **   <a name="panorama-DescribePackageVersion-response-PackageArn"></a>
The ARN of the package.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.

 ** [PackageId](#API_DescribePackageVersion_ResponseSyntax) **   <a name="panorama-DescribePackageVersion-response-PackageId"></a>
The version's ID.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z0-9\-\_\/]+` 

 ** [PackageName](#API_DescribePackageVersion_ResponseSyntax) **   <a name="panorama-DescribePackageVersion-response-PackageName"></a>
The version's name.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[a-zA-Z0-9\-\_]+` 

 ** [PackageVersion](#API_DescribePackageVersion_ResponseSyntax) **   <a name="panorama-DescribePackageVersion-response-PackageVersion"></a>
The version's version.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `([0-9]+)\.([0-9]+)` 

 ** [PatchVersion](#API_DescribePackageVersion_ResponseSyntax) **   <a name="panorama-DescribePackageVersion-response-PatchVersion"></a>
The version's patch version.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-z0-9]+` 

 ** [RegisteredTime](#API_DescribePackageVersion_ResponseSyntax) **   <a name="panorama-DescribePackageVersion-response-RegisteredTime"></a>
The version's registered time.  
Type: Timestamp

 ** [Status](#API_DescribePackageVersion_ResponseSyntax) **   <a name="panorama-DescribePackageVersion-response-Status"></a>
The version's status.  
Type: String  
Valid Values: `REGISTER_PENDING | REGISTER_COMPLETED | FAILED | DELETING` 

 ** [StatusDescription](#API_DescribePackageVersion_ResponseSyntax) **   <a name="panorama-DescribePackageVersion-response-StatusDescription"></a>
The version's status description.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.

## Errors
<a name="API_DescribePackageVersion_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
The requestor does not have permission to access the target action or resource.  
HTTP Status Code: 403

 ** ConflictException **   
The target resource is in use.    
 ** ErrorArguments **   
A list of attributes that led to the exception and their values.  
 ** ErrorId **   
A unique ID for the error.  
 ** ResourceId **   
The resource's ID.  
 ** ResourceType **   
The resource's type.
HTTP Status Code: 409

 ** InternalServerException **   
An internal error occurred.    
 ** RetryAfterSeconds **   
The number of seconds a client should wait before retrying the call.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The target resource was not found.    
 ** ResourceId **   
The resource's ID.  
 ** ResourceType **   
The resource's type.
HTTP Status Code: 404

 ** ValidationException **   
The request contains an invalid parameter value.    
 ** ErrorArguments **   
A list of attributes that led to the exception and their values.  
 ** ErrorId **   
A unique ID for the error.  
 ** Fields **   
A list of request parameters that failed validation.  
 ** Reason **   
The reason that validation failed.
HTTP Status Code: 400

## See Also
<a name="API_DescribePackageVersion_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/panorama-2019-07-24/DescribePackageVersion) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/panorama-2019-07-24/DescribePackageVersion) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/panorama-2019-07-24/DescribePackageVersion) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/panorama-2019-07-24/DescribePackageVersion) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/panorama-2019-07-24/DescribePackageVersion) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/panorama-2019-07-24/DescribePackageVersion) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/panorama-2019-07-24/DescribePackageVersion) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/panorama-2019-07-24/DescribePackageVersion) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/panorama-2019-07-24/DescribePackageVersion) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/panorama-2019-07-24/DescribePackageVersion) 

# ListApplicationInstanceDependencies
<a name="API_ListApplicationInstanceDependencies"></a>

**Important**  
End of support notice: On May 31, 2026, AWS will end support for AWS Panorama. After May 31, 2026, you will no longer be able to access the AWS Panorama console or AWS Panorama resources. For more information, see [AWS Panorama end of support](https://docs.aws.amazon.com/panorama/latest/dev/panorama-end-of-support.html). 

Returns a list of application instance dependencies.

## Request Syntax
<a name="API_ListApplicationInstanceDependencies_RequestSyntax"></a>

```
GET /application-instances/ApplicationInstanceId/package-dependencies?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_ListApplicationInstanceDependencies_RequestParameters"></a>

The request uses the following URI parameters.

 ** [ApplicationInstanceId](#API_ListApplicationInstanceDependencies_RequestSyntax) **   <a name="panorama-ListApplicationInstanceDependencies-request-uri-ApplicationInstanceId"></a>
The application instance's ID.  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z0-9\-\_]+`   
Required: Yes

 ** [MaxResults](#API_ListApplicationInstanceDependencies_RequestSyntax) **   <a name="panorama-ListApplicationInstanceDependencies-request-uri-MaxResults"></a>
The maximum number of application instance dependencies to return in one page of results.  
Valid Range: Minimum value of 0. Maximum value of 25.

 ** [NextToken](#API_ListApplicationInstanceDependencies_RequestSyntax) **   <a name="panorama-ListApplicationInstanceDependencies-request-uri-NextToken"></a>
Specify the pagination token from a previous request to retrieve the next page of results.  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Pattern: `.+` 

## Request Body
<a name="API_ListApplicationInstanceDependencies_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListApplicationInstanceDependencies_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "PackageObjects": [ 
      { 
         "Name": "string",
         "PackageVersion": "string",
         "PatchVersion": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListApplicationInstanceDependencies_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextToken](#API_ListApplicationInstanceDependencies_ResponseSyntax) **   <a name="panorama-ListApplicationInstanceDependencies-response-NextToken"></a>
A pagination token that's included if more results are available.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Pattern: `.+` 

 ** [PackageObjects](#API_ListApplicationInstanceDependencies_ResponseSyntax) **   <a name="panorama-ListApplicationInstanceDependencies-response-PackageObjects"></a>
A list of package objects.  
Type: Array of [PackageObject](API_PackageObject.md) objects

## Errors
<a name="API_ListApplicationInstanceDependencies_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
The requestor does not have permission to access the target action or resource.  
HTTP Status Code: 403

 ** InternalServerException **   
An internal error occurred.    
 ** RetryAfterSeconds **   
The number of seconds a client should wait before retrying the call.
HTTP Status Code: 500

## See Also
<a name="API_ListApplicationInstanceDependencies_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/panorama-2019-07-24/ListApplicationInstanceDependencies) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/panorama-2019-07-24/ListApplicationInstanceDependencies) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/panorama-2019-07-24/ListApplicationInstanceDependencies) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/panorama-2019-07-24/ListApplicationInstanceDependencies) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/panorama-2019-07-24/ListApplicationInstanceDependencies) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/panorama-2019-07-24/ListApplicationInstanceDependencies) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/panorama-2019-07-24/ListApplicationInstanceDependencies) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/panorama-2019-07-24/ListApplicationInstanceDependencies) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/panorama-2019-07-24/ListApplicationInstanceDependencies) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/panorama-2019-07-24/ListApplicationInstanceDependencies) 

# ListApplicationInstanceNodeInstances
<a name="API_ListApplicationInstanceNodeInstances"></a>

**Important**  
End of support notice: On May 31, 2026, AWS will end support for AWS Panorama. After May 31, 2026, you will no longer be able to access the AWS Panorama console or AWS Panorama resources. For more information, see [AWS Panorama end of support](https://docs.aws.amazon.com/panorama/latest/dev/panorama-end-of-support.html). 

Returns a list of application node instances.

## Request Syntax
<a name="API_ListApplicationInstanceNodeInstances_RequestSyntax"></a>

```
GET /application-instances/ApplicationInstanceId/node-instances?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_ListApplicationInstanceNodeInstances_RequestParameters"></a>

The request uses the following URI parameters.

 ** [ApplicationInstanceId](#API_ListApplicationInstanceNodeInstances_RequestSyntax) **   <a name="panorama-ListApplicationInstanceNodeInstances-request-uri-ApplicationInstanceId"></a>
The node instances' application instance ID.  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z0-9\-\_]+`   
Required: Yes

 ** [MaxResults](#API_ListApplicationInstanceNodeInstances_RequestSyntax) **   <a name="panorama-ListApplicationInstanceNodeInstances-request-uri-MaxResults"></a>
The maximum number of node instances to return in one page of results.  
Valid Range: Minimum value of 0. Maximum value of 25.

 ** [NextToken](#API_ListApplicationInstanceNodeInstances_RequestSyntax) **   <a name="panorama-ListApplicationInstanceNodeInstances-request-uri-NextToken"></a>
Specify the pagination token from a previous request to retrieve the next page of results.  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Pattern: `.+` 

## Request Body
<a name="API_ListApplicationInstanceNodeInstances_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListApplicationInstanceNodeInstances_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "NodeInstances": [ 
      { 
         "CurrentStatus": "string",
         "NodeId": "string",
         "NodeInstanceId": "string",
         "NodeName": "string",
         "PackageName": "string",
         "PackagePatchVersion": "string",
         "PackageVersion": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListApplicationInstanceNodeInstances_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextToken](#API_ListApplicationInstanceNodeInstances_ResponseSyntax) **   <a name="panorama-ListApplicationInstanceNodeInstances-response-NextToken"></a>
A pagination token that's included if more results are available.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Pattern: `.+` 

 ** [NodeInstances](#API_ListApplicationInstanceNodeInstances_ResponseSyntax) **   <a name="panorama-ListApplicationInstanceNodeInstances-response-NodeInstances"></a>
A list of node instances.  
Type: Array of [NodeInstance](API_NodeInstance.md) objects

## Errors
<a name="API_ListApplicationInstanceNodeInstances_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
The requestor does not have permission to access the target action or resource.  
HTTP Status Code: 403

 ** InternalServerException **   
An internal error occurred.    
 ** RetryAfterSeconds **   
The number of seconds a client should wait before retrying the call.
HTTP Status Code: 500

## See Also
<a name="API_ListApplicationInstanceNodeInstances_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/panorama-2019-07-24/ListApplicationInstanceNodeInstances) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/panorama-2019-07-24/ListApplicationInstanceNodeInstances) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/panorama-2019-07-24/ListApplicationInstanceNodeInstances) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/panorama-2019-07-24/ListApplicationInstanceNodeInstances) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/panorama-2019-07-24/ListApplicationInstanceNodeInstances) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/panorama-2019-07-24/ListApplicationInstanceNodeInstances) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/panorama-2019-07-24/ListApplicationInstanceNodeInstances) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/panorama-2019-07-24/ListApplicationInstanceNodeInstances) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/panorama-2019-07-24/ListApplicationInstanceNodeInstances) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/panorama-2019-07-24/ListApplicationInstanceNodeInstances) 

# ListApplicationInstances
<a name="API_ListApplicationInstances"></a>

**Important**  
End of support notice: On May 31, 2026, AWS will end support for AWS Panorama. After May 31, 2026, you will no longer be able to access the AWS Panorama console or AWS Panorama resources. For more information, see [AWS Panorama end of support](https://docs.aws.amazon.com/panorama/latest/dev/panorama-end-of-support.html). 

Returns a list of application instances.

## Request Syntax
<a name="API_ListApplicationInstances_RequestSyntax"></a>

```
GET /application-instances?deviceId=DeviceId&maxResults=MaxResults&nextToken=NextToken&statusFilter=StatusFilter HTTP/1.1
```

## URI Request Parameters
<a name="API_ListApplicationInstances_RequestParameters"></a>

The request uses the following URI parameters.

 ** [DeviceId](#API_ListApplicationInstances_RequestSyntax) **   <a name="panorama-ListApplicationInstances-request-uri-DeviceId"></a>
The application instances' device ID.  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z0-9\-\_]+` 

 ** [MaxResults](#API_ListApplicationInstances_RequestSyntax) **   <a name="panorama-ListApplicationInstances-request-uri-MaxResults"></a>
The maximum number of application instances to return in one page of results.  
Valid Range: Minimum value of 0. Maximum value of 25.

 ** [NextToken](#API_ListApplicationInstances_RequestSyntax) **   <a name="panorama-ListApplicationInstances-request-uri-NextToken"></a>
Specify the pagination token from a previous request to retrieve the next page of results.  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Pattern: `.+` 

 ** [StatusFilter](#API_ListApplicationInstances_RequestSyntax) **   <a name="panorama-ListApplicationInstances-request-uri-StatusFilter"></a>
Only include instances with a specific status.  
Valid Values: `DEPLOYMENT_SUCCEEDED | DEPLOYMENT_ERROR | REMOVAL_SUCCEEDED | REMOVAL_FAILED | PROCESSING_DEPLOYMENT | PROCESSING_REMOVAL | DEPLOYMENT_FAILED` 

## Request Body
<a name="API_ListApplicationInstances_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListApplicationInstances_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "ApplicationInstances": [ 
      { 
         "ApplicationInstanceId": "string",
         "Arn": "string",
         "CreatedTime": number,
         "DefaultRuntimeContextDevice": "string",
         "DefaultRuntimeContextDeviceName": "string",
         "Description": "string",
         "HealthStatus": "string",
         "Name": "string",
         "RuntimeContextStates": [ 
            { 
               "DesiredState": "string",
               "DeviceReportedStatus": "string",
               "DeviceReportedTime": number,
               "RuntimeContextName": "string"
            }
         ],
         "Status": "string",
         "StatusDescription": "string",
         "Tags": { 
            "string" : "string" 
         }
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_ListApplicationInstances_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ApplicationInstances](#API_ListApplicationInstances_ResponseSyntax) **   <a name="panorama-ListApplicationInstances-response-ApplicationInstances"></a>
A list of application instances.  
Type: Array of [ApplicationInstance](API_ApplicationInstance.md) objects

 ** [NextToken](#API_ListApplicationInstances_ResponseSyntax) **   <a name="panorama-ListApplicationInstances-response-NextToken"></a>
A pagination token that's included if more results are available.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Pattern: `.+` 

## Errors
<a name="API_ListApplicationInstances_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
The requestor does not have permission to access the target action or resource.  
HTTP Status Code: 403

 ** InternalServerException **   
An internal error occurred.    
 ** RetryAfterSeconds **   
The number of seconds a client should wait before retrying the call.
HTTP Status Code: 500

## See Also
<a name="API_ListApplicationInstances_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/panorama-2019-07-24/ListApplicationInstances) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/panorama-2019-07-24/ListApplicationInstances) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/panorama-2019-07-24/ListApplicationInstances) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/panorama-2019-07-24/ListApplicationInstances) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/panorama-2019-07-24/ListApplicationInstances) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/panorama-2019-07-24/ListApplicationInstances) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/panorama-2019-07-24/ListApplicationInstances) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/panorama-2019-07-24/ListApplicationInstances) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/panorama-2019-07-24/ListApplicationInstances) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/panorama-2019-07-24/ListApplicationInstances) 

# ListDevices
<a name="API_ListDevices"></a>

**Important**  
End of support notice: On May 31, 2026, AWS will end support for AWS Panorama. After May 31, 2026, you will no longer be able to access the AWS Panorama console or AWS Panorama resources. For more information, see [AWS Panorama end of support](https://docs.aws.amazon.com/panorama/latest/dev/panorama-end-of-support.html). 

Returns a list of devices.

## Request Syntax
<a name="API_ListDevices_RequestSyntax"></a>

```
GET /devices?DeviceAggregatedStatusFilter=DeviceAggregatedStatusFilter&MaxResults=MaxResults&NameFilter=NameFilter&NextToken=NextToken&SortBy=SortBy&SortOrder=SortOrder HTTP/1.1
```

## URI Request Parameters
<a name="API_ListDevices_RequestParameters"></a>

The request uses the following URI parameters.

 ** [DeviceAggregatedStatusFilter](#API_ListDevices_RequestSyntax) **   <a name="panorama-ListDevices-request-uri-DeviceAggregatedStatusFilter"></a>
Filter based on a device's status.  
Valid Values: `ERROR | AWAITING_PROVISIONING | PENDING | FAILED | DELETING | ONLINE | OFFLINE | LEASE_EXPIRED | UPDATE_NEEDED | REBOOTING` 

 ** [MaxResults](#API_ListDevices_RequestSyntax) **   <a name="panorama-ListDevices-request-uri-MaxResults"></a>
The maximum number of devices to return in one page of results.  
Valid Range: Minimum value of 0. Maximum value of 25.

 ** [NameFilter](#API_ListDevices_RequestSyntax) **   <a name="panorama-ListDevices-request-uri-NameFilter"></a>
Filter based on device's name. Prefixes supported.

 ** [NextToken](#API_ListDevices_RequestSyntax) **   <a name="panorama-ListDevices-request-uri-NextToken"></a>
Specify the pagination token from a previous request to retrieve the next page of results.  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Pattern: `.+` 

 ** [SortBy](#API_ListDevices_RequestSyntax) **   <a name="panorama-ListDevices-request-uri-SortBy"></a>
The target column to be sorted on. Default column sort is CREATED\$1TIME.  
Valid Values: `DEVICE_ID | CREATED_TIME | NAME | DEVICE_AGGREGATED_STATUS` 

 ** [SortOrder](#API_ListDevices_RequestSyntax) **   <a name="panorama-ListDevices-request-uri-SortOrder"></a>
The sorting order for the returned list. SortOrder is DESCENDING by default based on CREATED\$1TIME. Otherwise, SortOrder is ASCENDING.  
Valid Values: `ASCENDING | DESCENDING` 

## Request Body
<a name="API_ListDevices_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListDevices_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Devices": [ 
      { 
         "Brand": "string",
         "CreatedTime": number,
         "CurrentSoftware": "string",
         "Description": "string",
         "DeviceAggregatedStatus": "string",
         "DeviceId": "string",
         "LastUpdatedTime": number,
         "LatestDeviceJob": { 
            "ImageVersion": "string",
            "JobType": "string",
            "Status": "string"
         },
         "LeaseExpirationTime": number,
         "Name": "string",
         "ProvisioningStatus": "string",
         "Tags": { 
            "string" : "string" 
         },
         "Type": "string"
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_ListDevices_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Devices](#API_ListDevices_ResponseSyntax) **   <a name="panorama-ListDevices-response-Devices"></a>
A list of devices.  
Type: Array of [Device](API_Device.md) objects

 ** [NextToken](#API_ListDevices_ResponseSyntax) **   <a name="panorama-ListDevices-response-NextToken"></a>
A pagination token that's included if more results are available.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Pattern: `.+` 

## Errors
<a name="API_ListDevices_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
The requestor does not have permission to access the target action or resource.  
HTTP Status Code: 403

 ** ConflictException **   
The target resource is in use.    
 ** ErrorArguments **   
A list of attributes that led to the exception and their values.  
 ** ErrorId **   
A unique ID for the error.  
 ** ResourceId **   
The resource's ID.  
 ** ResourceType **   
The resource's type.
HTTP Status Code: 409

 ** InternalServerException **   
An internal error occurred.    
 ** RetryAfterSeconds **   
The number of seconds a client should wait before retrying the call.
HTTP Status Code: 500

 ** ValidationException **   
The request contains an invalid parameter value.    
 ** ErrorArguments **   
A list of attributes that led to the exception and their values.  
 ** ErrorId **   
A unique ID for the error.  
 ** Fields **   
A list of request parameters that failed validation.  
 ** Reason **   
The reason that validation failed.
HTTP Status Code: 400

## See Also
<a name="API_ListDevices_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/panorama-2019-07-24/ListDevices) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/panorama-2019-07-24/ListDevices) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/panorama-2019-07-24/ListDevices) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/panorama-2019-07-24/ListDevices) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/panorama-2019-07-24/ListDevices) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/panorama-2019-07-24/ListDevices) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/panorama-2019-07-24/ListDevices) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/panorama-2019-07-24/ListDevices) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/panorama-2019-07-24/ListDevices) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/panorama-2019-07-24/ListDevices) 

# ListDevicesJobs
<a name="API_ListDevicesJobs"></a>

**Important**  
End of support notice: On May 31, 2026, AWS will end support for AWS Panorama. After May 31, 2026, you will no longer be able to access the AWS Panorama console or AWS Panorama resources. For more information, see [AWS Panorama end of support](https://docs.aws.amazon.com/panorama/latest/dev/panorama-end-of-support.html). 

Returns a list of jobs.

## Request Syntax
<a name="API_ListDevicesJobs_RequestSyntax"></a>

```
GET /jobs?DeviceId=DeviceId&MaxResults=MaxResults&NextToken=NextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_ListDevicesJobs_RequestParameters"></a>

The request uses the following URI parameters.

 ** [DeviceId](#API_ListDevicesJobs_RequestSyntax) **   <a name="panorama-ListDevicesJobs-request-uri-DeviceId"></a>
Filter results by the job's target device ID.  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z0-9\-\_]+` 

 ** [MaxResults](#API_ListDevicesJobs_RequestSyntax) **   <a name="panorama-ListDevicesJobs-request-uri-MaxResults"></a>
The maximum number of device jobs to return in one page of results.  
Valid Range: Minimum value of 0. Maximum value of 25.

 ** [NextToken](#API_ListDevicesJobs_RequestSyntax) **   <a name="panorama-ListDevicesJobs-request-uri-NextToken"></a>
Specify the pagination token from a previous request to retrieve the next page of results.  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Pattern: `.+` 

## Request Body
<a name="API_ListDevicesJobs_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListDevicesJobs_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "DeviceJobs": [ 
      { 
         "CreatedTime": number,
         "DeviceId": "string",
         "DeviceName": "string",
         "JobId": "string",
         "JobType": "string"
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_ListDevicesJobs_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [DeviceJobs](#API_ListDevicesJobs_ResponseSyntax) **   <a name="panorama-ListDevicesJobs-response-DeviceJobs"></a>
A list of jobs.  
Type: Array of [DeviceJob](API_DeviceJob.md) objects

 ** [NextToken](#API_ListDevicesJobs_ResponseSyntax) **   <a name="panorama-ListDevicesJobs-response-NextToken"></a>
A pagination token that's included if more results are available.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Pattern: `.+` 

## Errors
<a name="API_ListDevicesJobs_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
The requestor does not have permission to access the target action or resource.  
HTTP Status Code: 403

 ** ConflictException **   
The target resource is in use.    
 ** ErrorArguments **   
A list of attributes that led to the exception and their values.  
 ** ErrorId **   
A unique ID for the error.  
 ** ResourceId **   
The resource's ID.  
 ** ResourceType **   
The resource's type.
HTTP Status Code: 409

 ** InternalServerException **   
An internal error occurred.    
 ** RetryAfterSeconds **   
The number of seconds a client should wait before retrying the call.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The target resource was not found.    
 ** ResourceId **   
The resource's ID.  
 ** ResourceType **   
The resource's type.
HTTP Status Code: 404

 ** ValidationException **   
The request contains an invalid parameter value.    
 ** ErrorArguments **   
A list of attributes that led to the exception and their values.  
 ** ErrorId **   
A unique ID for the error.  
 ** Fields **   
A list of request parameters that failed validation.  
 ** Reason **   
The reason that validation failed.
HTTP Status Code: 400

## See Also
<a name="API_ListDevicesJobs_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/panorama-2019-07-24/ListDevicesJobs) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/panorama-2019-07-24/ListDevicesJobs) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/panorama-2019-07-24/ListDevicesJobs) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/panorama-2019-07-24/ListDevicesJobs) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/panorama-2019-07-24/ListDevicesJobs) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/panorama-2019-07-24/ListDevicesJobs) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/panorama-2019-07-24/ListDevicesJobs) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/panorama-2019-07-24/ListDevicesJobs) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/panorama-2019-07-24/ListDevicesJobs) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/panorama-2019-07-24/ListDevicesJobs) 

# ListNodeFromTemplateJobs
<a name="API_ListNodeFromTemplateJobs"></a>

**Important**  
End of support notice: On May 31, 2026, AWS will end support for AWS Panorama. After May 31, 2026, you will no longer be able to access the AWS Panorama console or AWS Panorama resources. For more information, see [AWS Panorama end of support](https://docs.aws.amazon.com/panorama/latest/dev/panorama-end-of-support.html). 

Returns a list of camera stream node jobs.

## Request Syntax
<a name="API_ListNodeFromTemplateJobs_RequestSyntax"></a>

```
GET /packages/template-job?MaxResults=MaxResults&NextToken=NextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_ListNodeFromTemplateJobs_RequestParameters"></a>

The request uses the following URI parameters.

 ** [MaxResults](#API_ListNodeFromTemplateJobs_RequestSyntax) **   <a name="panorama-ListNodeFromTemplateJobs-request-uri-MaxResults"></a>
The maximum number of node from template jobs to return in one page of results.  
Valid Range: Minimum value of 0. Maximum value of 25.

 ** [NextToken](#API_ListNodeFromTemplateJobs_RequestSyntax) **   <a name="panorama-ListNodeFromTemplateJobs-request-uri-NextToken"></a>
Specify the pagination token from a previous request to retrieve the next page of results.  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Pattern: `.+` 

## Request Body
<a name="API_ListNodeFromTemplateJobs_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListNodeFromTemplateJobs_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "NodeFromTemplateJobs": [ 
      { 
         "CreatedTime": number,
         "JobId": "string",
         "NodeName": "string",
         "Status": "string",
         "StatusMessage": "string",
         "TemplateType": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListNodeFromTemplateJobs_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextToken](#API_ListNodeFromTemplateJobs_ResponseSyntax) **   <a name="panorama-ListNodeFromTemplateJobs-response-NextToken"></a>
A pagination token that's included if more results are available.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Pattern: `.+` 

 ** [NodeFromTemplateJobs](#API_ListNodeFromTemplateJobs_ResponseSyntax) **   <a name="panorama-ListNodeFromTemplateJobs-response-NodeFromTemplateJobs"></a>
A list of jobs.  
Type: Array of [NodeFromTemplateJob](API_NodeFromTemplateJob.md) objects

## Errors
<a name="API_ListNodeFromTemplateJobs_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
The requestor does not have permission to access the target action or resource.  
HTTP Status Code: 403

 ** ConflictException **   
The target resource is in use.    
 ** ErrorArguments **   
A list of attributes that led to the exception and their values.  
 ** ErrorId **   
A unique ID for the error.  
 ** ResourceId **   
The resource's ID.  
 ** ResourceType **   
The resource's type.
HTTP Status Code: 409

 ** InternalServerException **   
An internal error occurred.    
 ** RetryAfterSeconds **   
The number of seconds a client should wait before retrying the call.
HTTP Status Code: 500

 ** ValidationException **   
The request contains an invalid parameter value.    
 ** ErrorArguments **   
A list of attributes that led to the exception and their values.  
 ** ErrorId **   
A unique ID for the error.  
 ** Fields **   
A list of request parameters that failed validation.  
 ** Reason **   
The reason that validation failed.
HTTP Status Code: 400

## See Also
<a name="API_ListNodeFromTemplateJobs_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/panorama-2019-07-24/ListNodeFromTemplateJobs) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/panorama-2019-07-24/ListNodeFromTemplateJobs) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/panorama-2019-07-24/ListNodeFromTemplateJobs) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/panorama-2019-07-24/ListNodeFromTemplateJobs) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/panorama-2019-07-24/ListNodeFromTemplateJobs) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/panorama-2019-07-24/ListNodeFromTemplateJobs) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/panorama-2019-07-24/ListNodeFromTemplateJobs) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/panorama-2019-07-24/ListNodeFromTemplateJobs) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/panorama-2019-07-24/ListNodeFromTemplateJobs) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/panorama-2019-07-24/ListNodeFromTemplateJobs) 

# ListNodes
<a name="API_ListNodes"></a>

**Important**  
End of support notice: On May 31, 2026, AWS will end support for AWS Panorama. After May 31, 2026, you will no longer be able to access the AWS Panorama console or AWS Panorama resources. For more information, see [AWS Panorama end of support](https://docs.aws.amazon.com/panorama/latest/dev/panorama-end-of-support.html). 

Returns a list of nodes.

## Request Syntax
<a name="API_ListNodes_RequestSyntax"></a>

```
GET /nodes?category=Category&maxResults=MaxResults&nextToken=NextToken&ownerAccount=OwnerAccount&packageName=PackageName&packageVersion=PackageVersion&patchVersion=PatchVersion HTTP/1.1
```

## URI Request Parameters
<a name="API_ListNodes_RequestParameters"></a>

The request uses the following URI parameters.

 ** [Category](#API_ListNodes_RequestSyntax) **   <a name="panorama-ListNodes-request-uri-Category"></a>
Search for nodes by category.  
Valid Values: `BUSINESS_LOGIC | ML_MODEL | MEDIA_SOURCE | MEDIA_SINK` 

 ** [MaxResults](#API_ListNodes_RequestSyntax) **   <a name="panorama-ListNodes-request-uri-MaxResults"></a>
The maximum number of nodes to return in one page of results.  
Valid Range: Minimum value of 0. Maximum value of 25.

 ** [NextToken](#API_ListNodes_RequestSyntax) **   <a name="panorama-ListNodes-request-uri-NextToken"></a>
Specify the pagination token from a previous request to retrieve the next page of results.  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Pattern: `.+` 

 ** [OwnerAccount](#API_ListNodes_RequestSyntax) **   <a name="panorama-ListNodes-request-uri-OwnerAccount"></a>
Search for nodes by the account ID of the nodes' owner.  
Length Constraints: Minimum length of 1. Maximum length of 12.  
Pattern: `[0-9a-z\_]+` 

 ** [PackageName](#API_ListNodes_RequestSyntax) **   <a name="panorama-ListNodes-request-uri-PackageName"></a>
Search for nodes by name.  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[a-zA-Z0-9\-\_]+` 

 ** [PackageVersion](#API_ListNodes_RequestSyntax) **   <a name="panorama-ListNodes-request-uri-PackageVersion"></a>
Search for nodes by version.  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `([0-9]+)\.([0-9]+)` 

 ** [PatchVersion](#API_ListNodes_RequestSyntax) **   <a name="panorama-ListNodes-request-uri-PatchVersion"></a>
Search for nodes by patch version.  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-z0-9]+` 

## Request Body
<a name="API_ListNodes_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListNodes_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "Nodes": [ 
      { 
         "Category": "string",
         "CreatedTime": number,
         "Description": "string",
         "Name": "string",
         "NodeId": "string",
         "OwnerAccount": "string",
         "PackageArn": "string",
         "PackageId": "string",
         "PackageName": "string",
         "PackageVersion": "string",
         "PatchVersion": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListNodes_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextToken](#API_ListNodes_ResponseSyntax) **   <a name="panorama-ListNodes-response-NextToken"></a>
A pagination token that's included if more results are available.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Pattern: `.+` 

 ** [Nodes](#API_ListNodes_ResponseSyntax) **   <a name="panorama-ListNodes-response-Nodes"></a>
A list of nodes.  
Type: Array of [Node](API_Node.md) objects

## Errors
<a name="API_ListNodes_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConflictException **   
The target resource is in use.    
 ** ErrorArguments **   
A list of attributes that led to the exception and their values.  
 ** ErrorId **   
A unique ID for the error.  
 ** ResourceId **   
The resource's ID.  
 ** ResourceType **   
The resource's type.
HTTP Status Code: 409

 ** InternalServerException **   
An internal error occurred.    
 ** RetryAfterSeconds **   
The number of seconds a client should wait before retrying the call.
HTTP Status Code: 500

 ** ValidationException **   
The request contains an invalid parameter value.    
 ** ErrorArguments **   
A list of attributes that led to the exception and their values.  
 ** ErrorId **   
A unique ID for the error.  
 ** Fields **   
A list of request parameters that failed validation.  
 ** Reason **   
The reason that validation failed.
HTTP Status Code: 400

## See Also
<a name="API_ListNodes_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/panorama-2019-07-24/ListNodes) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/panorama-2019-07-24/ListNodes) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/panorama-2019-07-24/ListNodes) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/panorama-2019-07-24/ListNodes) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/panorama-2019-07-24/ListNodes) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/panorama-2019-07-24/ListNodes) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/panorama-2019-07-24/ListNodes) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/panorama-2019-07-24/ListNodes) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/panorama-2019-07-24/ListNodes) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/panorama-2019-07-24/ListNodes) 

# ListPackageImportJobs
<a name="API_ListPackageImportJobs"></a>

**Important**  
End of support notice: On May 31, 2026, AWS will end support for AWS Panorama. After May 31, 2026, you will no longer be able to access the AWS Panorama console or AWS Panorama resources. For more information, see [AWS Panorama end of support](https://docs.aws.amazon.com/panorama/latest/dev/panorama-end-of-support.html). 

Returns a list of package import jobs.

## Request Syntax
<a name="API_ListPackageImportJobs_RequestSyntax"></a>

```
GET /packages/import-jobs?MaxResults=MaxResults&NextToken=NextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_ListPackageImportJobs_RequestParameters"></a>

The request uses the following URI parameters.

 ** [MaxResults](#API_ListPackageImportJobs_RequestSyntax) **   <a name="panorama-ListPackageImportJobs-request-uri-MaxResults"></a>
The maximum number of package import jobs to return in one page of results.  
Valid Range: Minimum value of 0. Maximum value of 25.

 ** [NextToken](#API_ListPackageImportJobs_RequestSyntax) **   <a name="panorama-ListPackageImportJobs-request-uri-NextToken"></a>
Specify the pagination token from a previous request to retrieve the next page of results.  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Pattern: `.+` 

## Request Body
<a name="API_ListPackageImportJobs_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListPackageImportJobs_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "PackageImportJobs": [ 
      { 
         "CreatedTime": number,
         "JobId": "string",
         "JobType": "string",
         "LastUpdatedTime": number,
         "Status": "string",
         "StatusMessage": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListPackageImportJobs_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextToken](#API_ListPackageImportJobs_ResponseSyntax) **   <a name="panorama-ListPackageImportJobs-response-NextToken"></a>
A pagination token that's included if more results are available.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Pattern: `.+` 

 ** [PackageImportJobs](#API_ListPackageImportJobs_ResponseSyntax) **   <a name="panorama-ListPackageImportJobs-response-PackageImportJobs"></a>
A list of package import jobs.  
Type: Array of [PackageImportJob](API_PackageImportJob.md) objects

## Errors
<a name="API_ListPackageImportJobs_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
The requestor does not have permission to access the target action or resource.  
HTTP Status Code: 403

 ** ConflictException **   
The target resource is in use.    
 ** ErrorArguments **   
A list of attributes that led to the exception and their values.  
 ** ErrorId **   
A unique ID for the error.  
 ** ResourceId **   
The resource's ID.  
 ** ResourceType **   
The resource's type.
HTTP Status Code: 409

 ** InternalServerException **   
An internal error occurred.    
 ** RetryAfterSeconds **   
The number of seconds a client should wait before retrying the call.
HTTP Status Code: 500

 ** ValidationException **   
The request contains an invalid parameter value.    
 ** ErrorArguments **   
A list of attributes that led to the exception and their values.  
 ** ErrorId **   
A unique ID for the error.  
 ** Fields **   
A list of request parameters that failed validation.  
 ** Reason **   
The reason that validation failed.
HTTP Status Code: 400

## See Also
<a name="API_ListPackageImportJobs_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/panorama-2019-07-24/ListPackageImportJobs) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/panorama-2019-07-24/ListPackageImportJobs) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/panorama-2019-07-24/ListPackageImportJobs) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/panorama-2019-07-24/ListPackageImportJobs) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/panorama-2019-07-24/ListPackageImportJobs) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/panorama-2019-07-24/ListPackageImportJobs) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/panorama-2019-07-24/ListPackageImportJobs) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/panorama-2019-07-24/ListPackageImportJobs) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/panorama-2019-07-24/ListPackageImportJobs) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/panorama-2019-07-24/ListPackageImportJobs) 

# ListPackages
<a name="API_ListPackages"></a>

**Important**  
End of support notice: On May 31, 2026, AWS will end support for AWS Panorama. After May 31, 2026, you will no longer be able to access the AWS Panorama console or AWS Panorama resources. For more information, see [AWS Panorama end of support](https://docs.aws.amazon.com/panorama/latest/dev/panorama-end-of-support.html). 

Returns a list of packages.

## Request Syntax
<a name="API_ListPackages_RequestSyntax"></a>

```
GET /packages?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_ListPackages_RequestParameters"></a>

The request uses the following URI parameters.

 ** [MaxResults](#API_ListPackages_RequestSyntax) **   <a name="panorama-ListPackages-request-uri-MaxResults"></a>
The maximum number of packages to return in one page of results.  
Valid Range: Minimum value of 0. Maximum value of 25.

 ** [NextToken](#API_ListPackages_RequestSyntax) **   <a name="panorama-ListPackages-request-uri-NextToken"></a>
Specify the pagination token from a previous request to retrieve the next page of results.  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Pattern: `.+` 

## Request Body
<a name="API_ListPackages_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListPackages_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "Packages": [ 
      { 
         "Arn": "string",
         "CreatedTime": number,
         "PackageId": "string",
         "PackageName": "string",
         "Tags": { 
            "string" : "string" 
         }
      }
   ]
}
```

## Response Elements
<a name="API_ListPackages_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextToken](#API_ListPackages_ResponseSyntax) **   <a name="panorama-ListPackages-response-NextToken"></a>
A pagination token that's included if more results are available.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Pattern: `.+` 

 ** [Packages](#API_ListPackages_ResponseSyntax) **   <a name="panorama-ListPackages-response-Packages"></a>
A list of packages.  
Type: Array of [PackageListItem](API_PackageListItem.md) objects

## Errors
<a name="API_ListPackages_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
The requestor does not have permission to access the target action or resource.  
HTTP Status Code: 403

 ** ConflictException **   
The target resource is in use.    
 ** ErrorArguments **   
A list of attributes that led to the exception and their values.  
 ** ErrorId **   
A unique ID for the error.  
 ** ResourceId **   
The resource's ID.  
 ** ResourceType **   
The resource's type.
HTTP Status Code: 409

 ** InternalServerException **   
An internal error occurred.    
 ** RetryAfterSeconds **   
The number of seconds a client should wait before retrying the call.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The target resource was not found.    
 ** ResourceId **   
The resource's ID.  
 ** ResourceType **   
The resource's type.
HTTP Status Code: 404

 ** ValidationException **   
The request contains an invalid parameter value.    
 ** ErrorArguments **   
A list of attributes that led to the exception and their values.  
 ** ErrorId **   
A unique ID for the error.  
 ** Fields **   
A list of request parameters that failed validation.  
 ** Reason **   
The reason that validation failed.
HTTP Status Code: 400

## See Also
<a name="API_ListPackages_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/panorama-2019-07-24/ListPackages) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/panorama-2019-07-24/ListPackages) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/panorama-2019-07-24/ListPackages) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/panorama-2019-07-24/ListPackages) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/panorama-2019-07-24/ListPackages) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/panorama-2019-07-24/ListPackages) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/panorama-2019-07-24/ListPackages) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/panorama-2019-07-24/ListPackages) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/panorama-2019-07-24/ListPackages) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/panorama-2019-07-24/ListPackages) 

# ListTagsForResource
<a name="API_ListTagsForResource"></a>

**Important**  
End of support notice: On May 31, 2026, AWS will end support for AWS Panorama. After May 31, 2026, you will no longer be able to access the AWS Panorama console or AWS Panorama resources. For more information, see [AWS Panorama end of support](https://docs.aws.amazon.com/panorama/latest/dev/panorama-end-of-support.html). 

Returns a list of tags for a resource.

## Request Syntax
<a name="API_ListTagsForResource_RequestSyntax"></a>

```
GET /tags/ResourceArn HTTP/1.1
```

## URI Request Parameters
<a name="API_ListTagsForResource_RequestParameters"></a>

The request uses the following URI parameters.

 ** [ResourceArn](#API_ListTagsForResource_RequestSyntax) **   <a name="panorama-ListTagsForResource-request-uri-ResourceArn"></a>
The resource's ARN.  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `.+`   
Required: Yes

## Request Body
<a name="API_ListTagsForResource_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListTagsForResource_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Tags": { 
      "string" : "string" 
   }
}
```

## Response Elements
<a name="API_ListTagsForResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Tags](#API_ListTagsForResource_ResponseSyntax) **   <a name="panorama-ListTagsForResource-response-Tags"></a>
A list of tags.  
Type: String to string map  
Map Entries: Minimum number of 0 items. Maximum number of 50 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `.+`   
Value Length Constraints: Minimum length of 0. Maximum length of 256.  
Value Pattern: `.*` 

## Errors
<a name="API_ListTagsForResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerException **   
An internal error occurred.    
 ** RetryAfterSeconds **   
The number of seconds a client should wait before retrying the call.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The target resource was not found.    
 ** ResourceId **   
The resource's ID.  
 ** ResourceType **   
The resource's type.
HTTP Status Code: 404

 ** ValidationException **   
The request contains an invalid parameter value.    
 ** ErrorArguments **   
A list of attributes that led to the exception and their values.  
 ** ErrorId **   
A unique ID for the error.  
 ** Fields **   
A list of request parameters that failed validation.  
 ** Reason **   
The reason that validation failed.
HTTP Status Code: 400

## See Also
<a name="API_ListTagsForResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/panorama-2019-07-24/ListTagsForResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/panorama-2019-07-24/ListTagsForResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/panorama-2019-07-24/ListTagsForResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/panorama-2019-07-24/ListTagsForResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/panorama-2019-07-24/ListTagsForResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/panorama-2019-07-24/ListTagsForResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/panorama-2019-07-24/ListTagsForResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/panorama-2019-07-24/ListTagsForResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/panorama-2019-07-24/ListTagsForResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/panorama-2019-07-24/ListTagsForResource) 

# ProvisionDevice
<a name="API_ProvisionDevice"></a>

**Important**  
End of support notice: On May 31, 2026, AWS will end support for AWS Panorama. After May 31, 2026, you will no longer be able to access the AWS Panorama console or AWS Panorama resources. For more information, see [AWS Panorama end of support](https://docs.aws.amazon.com/panorama/latest/dev/panorama-end-of-support.html). 

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.

## Request Syntax
<a name="API_ProvisionDevice_RequestSyntax"></a>

```
POST /devices HTTP/1.1
Content-type: application/json

{
   "Description": "string",
   "Name": "string",
   "NetworkingConfiguration": { 
      "Ethernet0": { 
         "ConnectionType": "string",
         "StaticIpConnectionInfo": { 
            "DefaultGateway": "string",
            "Dns": [ "string" ],
            "IpAddress": "string",
            "Mask": "string"
         }
      },
      "Ethernet1": { 
         "ConnectionType": "string",
         "StaticIpConnectionInfo": { 
            "DefaultGateway": "string",
            "Dns": [ "string" ],
            "IpAddress": "string",
            "Mask": "string"
         }
      },
      "Ntp": { 
         "NtpServers": [ "string" ]
      }
   },
   "Tags": { 
      "string" : "string" 
   }
}
```

## URI Request Parameters
<a name="API_ProvisionDevice_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_ProvisionDevice_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [Description](#API_ProvisionDevice_RequestSyntax) **   <a name="panorama-ProvisionDevice-request-Description"></a>
A description for the device.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 255.  
Pattern: `.*`   
Required: No

 ** [Name](#API_ProvisionDevice_RequestSyntax) **   <a name="panorama-ProvisionDevice-request-Name"></a>
A name for the device.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z0-9\-\_]+`   
Required: Yes

 ** [NetworkingConfiguration](#API_ProvisionDevice_RequestSyntax) **   <a name="panorama-ProvisionDevice-request-NetworkingConfiguration"></a>
A networking configuration for the device.  
Type: [NetworkPayload](API_NetworkPayload.md) object  
Required: No

 ** [Tags](#API_ProvisionDevice_RequestSyntax) **   <a name="panorama-ProvisionDevice-request-Tags"></a>
Tags for the device.  
Type: String to string map  
Map Entries: Minimum number of 0 items. Maximum number of 50 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `.+`   
Value Length Constraints: Minimum length of 0. Maximum length of 256.  
Value Pattern: `.*`   
Required: No

## Response Syntax
<a name="API_ProvisionDevice_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Arn": "string",
   "Certificates": blob,
   "DeviceId": "string",
   "IotThingName": "string",
   "Status": "string"
}
```

## Response Elements
<a name="API_ProvisionDevice_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Arn](#API_ProvisionDevice_ResponseSyntax) **   <a name="panorama-ProvisionDevice-response-Arn"></a>
The device's ARN.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.

 ** [Certificates](#API_ProvisionDevice_ResponseSyntax) **   <a name="panorama-ProvisionDevice-response-Certificates"></a>
The device's configuration bundle.  
Type: Base64-encoded binary data object

 ** [DeviceId](#API_ProvisionDevice_ResponseSyntax) **   <a name="panorama-ProvisionDevice-response-DeviceId"></a>
The device's ID.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z0-9\-\_]+` 

 ** [IotThingName](#API_ProvisionDevice_ResponseSyntax) **   <a name="panorama-ProvisionDevice-response-IotThingName"></a>
The device's IoT thing name.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.

 ** [Status](#API_ProvisionDevice_ResponseSyntax) **   <a name="panorama-ProvisionDevice-response-Status"></a>
The device's status.  
Type: String  
Valid Values: `AWAITING_PROVISIONING | PENDING | SUCCEEDED | FAILED | ERROR | DELETING` 

## Errors
<a name="API_ProvisionDevice_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
The requestor does not have permission to access the target action or resource.  
HTTP Status Code: 403

 ** ConflictException **   
The target resource is in use.    
 ** ErrorArguments **   
A list of attributes that led to the exception and their values.  
 ** ErrorId **   
A unique ID for the error.  
 ** ResourceId **   
The resource's ID.  
 ** ResourceType **   
The resource's type.
HTTP Status Code: 409

 ** InternalServerException **   
An internal error occurred.    
 ** RetryAfterSeconds **   
The number of seconds a client should wait before retrying the call.
HTTP Status Code: 500

 ** ServiceQuotaExceededException **   
The request would cause a limit to be exceeded.    
 ** QuotaCode **   
The name of the limit.  
 ** ResourceId **   
The target resource's ID.  
 ** ResourceType **   
The target resource's type.  
 ** ServiceCode **   
The name of the service.
HTTP Status Code: 402

 ** ValidationException **   
The request contains an invalid parameter value.    
 ** ErrorArguments **   
A list of attributes that led to the exception and their values.  
 ** ErrorId **   
A unique ID for the error.  
 ** Fields **   
A list of request parameters that failed validation.  
 ** Reason **   
The reason that validation failed.
HTTP Status Code: 400

## See Also
<a name="API_ProvisionDevice_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/panorama-2019-07-24/ProvisionDevice) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/panorama-2019-07-24/ProvisionDevice) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/panorama-2019-07-24/ProvisionDevice) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/panorama-2019-07-24/ProvisionDevice) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/panorama-2019-07-24/ProvisionDevice) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/panorama-2019-07-24/ProvisionDevice) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/panorama-2019-07-24/ProvisionDevice) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/panorama-2019-07-24/ProvisionDevice) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/panorama-2019-07-24/ProvisionDevice) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/panorama-2019-07-24/ProvisionDevice) 

# RegisterPackageVersion
<a name="API_RegisterPackageVersion"></a>

**Important**  
End of support notice: On May 31, 2026, AWS will end support for AWS Panorama. After May 31, 2026, you will no longer be able to access the AWS Panorama console or AWS Panorama resources. For more information, see [AWS Panorama end of support](https://docs.aws.amazon.com/panorama/latest/dev/panorama-end-of-support.html). 

Registers a package version.

## Request Syntax
<a name="API_RegisterPackageVersion_RequestSyntax"></a>

```
PUT /packages/PackageId/versions/PackageVersion/patch/PatchVersion HTTP/1.1
Content-type: application/json

{
   "MarkLatest": boolean,
   "OwnerAccount": "string"
}
```

## URI Request Parameters
<a name="API_RegisterPackageVersion_RequestParameters"></a>

The request uses the following URI parameters.

 ** [PackageId](#API_RegisterPackageVersion_RequestSyntax) **   <a name="panorama-RegisterPackageVersion-request-uri-PackageId"></a>
A package ID.  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z0-9\-\_\/]+`   
Required: Yes

 ** [PackageVersion](#API_RegisterPackageVersion_RequestSyntax) **   <a name="panorama-RegisterPackageVersion-request-uri-PackageVersion"></a>
A package version.  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `([0-9]+)\.([0-9]+)`   
Required: Yes

 ** [PatchVersion](#API_RegisterPackageVersion_RequestSyntax) **   <a name="panorama-RegisterPackageVersion-request-uri-PatchVersion"></a>
A patch version.  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-z0-9]+`   
Required: Yes

## Request Body
<a name="API_RegisterPackageVersion_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [MarkLatest](#API_RegisterPackageVersion_RequestSyntax) **   <a name="panorama-RegisterPackageVersion-request-MarkLatest"></a>
Whether to mark the new version as the latest version.  
Type: Boolean  
Required: No

 ** [OwnerAccount](#API_RegisterPackageVersion_RequestSyntax) **   <a name="panorama-RegisterPackageVersion-request-OwnerAccount"></a>
An owner account.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 12.  
Pattern: `[0-9a-z\_]+`   
Required: No

## Response Syntax
<a name="API_RegisterPackageVersion_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_RegisterPackageVersion_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_RegisterPackageVersion_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
The requestor does not have permission to access the target action or resource.  
HTTP Status Code: 403

 ** ConflictException **   
The target resource is in use.    
 ** ErrorArguments **   
A list of attributes that led to the exception and their values.  
 ** ErrorId **   
A unique ID for the error.  
 ** ResourceId **   
The resource's ID.  
 ** ResourceType **   
The resource's type.
HTTP Status Code: 409

 ** InternalServerException **   
An internal error occurred.    
 ** RetryAfterSeconds **   
The number of seconds a client should wait before retrying the call.
HTTP Status Code: 500

 ** ValidationException **   
The request contains an invalid parameter value.    
 ** ErrorArguments **   
A list of attributes that led to the exception and their values.  
 ** ErrorId **   
A unique ID for the error.  
 ** Fields **   
A list of request parameters that failed validation.  
 ** Reason **   
The reason that validation failed.
HTTP Status Code: 400

## See Also
<a name="API_RegisterPackageVersion_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/panorama-2019-07-24/RegisterPackageVersion) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/panorama-2019-07-24/RegisterPackageVersion) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/panorama-2019-07-24/RegisterPackageVersion) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/panorama-2019-07-24/RegisterPackageVersion) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/panorama-2019-07-24/RegisterPackageVersion) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/panorama-2019-07-24/RegisterPackageVersion) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/panorama-2019-07-24/RegisterPackageVersion) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/panorama-2019-07-24/RegisterPackageVersion) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/panorama-2019-07-24/RegisterPackageVersion) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/panorama-2019-07-24/RegisterPackageVersion) 

# RemoveApplicationInstance
<a name="API_RemoveApplicationInstance"></a>

**Important**  
End of support notice: On May 31, 2026, AWS will end support for AWS Panorama. After May 31, 2026, you will no longer be able to access the AWS Panorama console or AWS Panorama resources. For more information, see [AWS Panorama end of support](https://docs.aws.amazon.com/panorama/latest/dev/panorama-end-of-support.html). 

Removes an application instance.

## Request Syntax
<a name="API_RemoveApplicationInstance_RequestSyntax"></a>

```
DELETE /application-instances/ApplicationInstanceId HTTP/1.1
```

## URI Request Parameters
<a name="API_RemoveApplicationInstance_RequestParameters"></a>

The request uses the following URI parameters.

 ** [ApplicationInstanceId](#API_RemoveApplicationInstance_RequestSyntax) **   <a name="panorama-RemoveApplicationInstance-request-uri-ApplicationInstanceId"></a>
An application instance ID.  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z0-9\-\_]+`   
Required: Yes

## Request Body
<a name="API_RemoveApplicationInstance_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_RemoveApplicationInstance_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_RemoveApplicationInstance_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_RemoveApplicationInstance_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
The requestor does not have permission to access the target action or resource.  
HTTP Status Code: 403

 ** ConflictException **   
The target resource is in use.    
 ** ErrorArguments **   
A list of attributes that led to the exception and their values.  
 ** ErrorId **   
A unique ID for the error.  
 ** ResourceId **   
The resource's ID.  
 ** ResourceType **   
The resource's type.
HTTP Status Code: 409

 ** InternalServerException **   
An internal error occurred.    
 ** RetryAfterSeconds **   
The number of seconds a client should wait before retrying the call.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The target resource was not found.    
 ** ResourceId **   
The resource's ID.  
 ** ResourceType **   
The resource's type.
HTTP Status Code: 404

 ** ValidationException **   
The request contains an invalid parameter value.    
 ** ErrorArguments **   
A list of attributes that led to the exception and their values.  
 ** ErrorId **   
A unique ID for the error.  
 ** Fields **   
A list of request parameters that failed validation.  
 ** Reason **   
The reason that validation failed.
HTTP Status Code: 400

## See Also
<a name="API_RemoveApplicationInstance_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/panorama-2019-07-24/RemoveApplicationInstance) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/panorama-2019-07-24/RemoveApplicationInstance) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/panorama-2019-07-24/RemoveApplicationInstance) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/panorama-2019-07-24/RemoveApplicationInstance) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/panorama-2019-07-24/RemoveApplicationInstance) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/panorama-2019-07-24/RemoveApplicationInstance) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/panorama-2019-07-24/RemoveApplicationInstance) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/panorama-2019-07-24/RemoveApplicationInstance) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/panorama-2019-07-24/RemoveApplicationInstance) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/panorama-2019-07-24/RemoveApplicationInstance) 

# SignalApplicationInstanceNodeInstances
<a name="API_SignalApplicationInstanceNodeInstances"></a>

**Important**  
End of support notice: On May 31, 2026, AWS will end support for AWS Panorama. After May 31, 2026, you will no longer be able to access the AWS Panorama console or AWS Panorama resources. For more information, see [AWS Panorama end of support](https://docs.aws.amazon.com/panorama/latest/dev/panorama-end-of-support.html). 

Signal camera nodes to stop or resume.

## Request Syntax
<a name="API_SignalApplicationInstanceNodeInstances_RequestSyntax"></a>

```
PUT /application-instances/ApplicationInstanceId/node-signals HTTP/1.1
Content-type: application/json

{
   "NodeSignals": [ 
      { 
         "NodeInstanceId": "string",
         "Signal": "string"
      }
   ]
}
```

## URI Request Parameters
<a name="API_SignalApplicationInstanceNodeInstances_RequestParameters"></a>

The request uses the following URI parameters.

 ** [ApplicationInstanceId](#API_SignalApplicationInstanceNodeInstances_RequestSyntax) **   <a name="panorama-SignalApplicationInstanceNodeInstances-request-uri-ApplicationInstanceId"></a>
An application instance ID.  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z0-9\-\_]+`   
Required: Yes

## Request Body
<a name="API_SignalApplicationInstanceNodeInstances_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [NodeSignals](#API_SignalApplicationInstanceNodeInstances_RequestSyntax) **   <a name="panorama-SignalApplicationInstanceNodeInstances-request-NodeSignals"></a>
A list of signals.  
Type: Array of [NodeSignal](API_NodeSignal.md) objects  
Array Members: Minimum number of 1 item.  
Required: Yes

## Response Syntax
<a name="API_SignalApplicationInstanceNodeInstances_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "ApplicationInstanceId": "string"
}
```

## Response Elements
<a name="API_SignalApplicationInstanceNodeInstances_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ApplicationInstanceId](#API_SignalApplicationInstanceNodeInstances_ResponseSyntax) **   <a name="panorama-SignalApplicationInstanceNodeInstances-response-ApplicationInstanceId"></a>
An application instance ID.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z0-9\-\_]+` 

## Errors
<a name="API_SignalApplicationInstanceNodeInstances_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
The requestor does not have permission to access the target action or resource.  
HTTP Status Code: 403

 ** InternalServerException **   
An internal error occurred.    
 ** RetryAfterSeconds **   
The number of seconds a client should wait before retrying the call.
HTTP Status Code: 500

 ** ServiceQuotaExceededException **   
The request would cause a limit to be exceeded.    
 ** QuotaCode **   
The name of the limit.  
 ** ResourceId **   
The target resource's ID.  
 ** ResourceType **   
The target resource's type.  
 ** ServiceCode **   
The name of the service.
HTTP Status Code: 402

 ** ValidationException **   
The request contains an invalid parameter value.    
 ** ErrorArguments **   
A list of attributes that led to the exception and their values.  
 ** ErrorId **   
A unique ID for the error.  
 ** Fields **   
A list of request parameters that failed validation.  
 ** Reason **   
The reason that validation failed.
HTTP Status Code: 400

## See Also
<a name="API_SignalApplicationInstanceNodeInstances_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/panorama-2019-07-24/SignalApplicationInstanceNodeInstances) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/panorama-2019-07-24/SignalApplicationInstanceNodeInstances) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/panorama-2019-07-24/SignalApplicationInstanceNodeInstances) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/panorama-2019-07-24/SignalApplicationInstanceNodeInstances) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/panorama-2019-07-24/SignalApplicationInstanceNodeInstances) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/panorama-2019-07-24/SignalApplicationInstanceNodeInstances) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/panorama-2019-07-24/SignalApplicationInstanceNodeInstances) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/panorama-2019-07-24/SignalApplicationInstanceNodeInstances) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/panorama-2019-07-24/SignalApplicationInstanceNodeInstances) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/panorama-2019-07-24/SignalApplicationInstanceNodeInstances) 

# TagResource
<a name="API_TagResource"></a>

**Important**  
End of support notice: On May 31, 2026, AWS will end support for AWS Panorama. After May 31, 2026, you will no longer be able to access the AWS Panorama console or AWS Panorama resources. For more information, see [AWS Panorama end of support](https://docs.aws.amazon.com/panorama/latest/dev/panorama-end-of-support.html). 

Tags a resource.

## Request Syntax
<a name="API_TagResource_RequestSyntax"></a>

```
POST /tags/ResourceArn HTTP/1.1
Content-type: application/json

{
   "Tags": { 
      "string" : "string" 
   }
}
```

## URI Request Parameters
<a name="API_TagResource_RequestParameters"></a>

The request uses the following URI parameters.

 ** [ResourceArn](#API_TagResource_RequestSyntax) **   <a name="panorama-TagResource-request-uri-ResourceArn"></a>
The resource's ARN.  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `.+`   
Required: Yes

## Request Body
<a name="API_TagResource_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [Tags](#API_TagResource_RequestSyntax) **   <a name="panorama-TagResource-request-Tags"></a>
Tags for the resource.  
Type: String to string map  
Map Entries: Minimum number of 0 items. Maximum number of 50 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `.+`   
Value Length Constraints: Minimum length of 0. Maximum length of 256.  
Value Pattern: `.*`   
Required: Yes

## Response Syntax
<a name="API_TagResource_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_TagResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_TagResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerException **   
An internal error occurred.    
 ** RetryAfterSeconds **   
The number of seconds a client should wait before retrying the call.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The target resource was not found.    
 ** ResourceId **   
The resource's ID.  
 ** ResourceType **   
The resource's type.
HTTP Status Code: 404

 ** ValidationException **   
The request contains an invalid parameter value.    
 ** ErrorArguments **   
A list of attributes that led to the exception and their values.  
 ** ErrorId **   
A unique ID for the error.  
 ** Fields **   
A list of request parameters that failed validation.  
 ** Reason **   
The reason that validation failed.
HTTP Status Code: 400

## See Also
<a name="API_TagResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/panorama-2019-07-24/TagResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/panorama-2019-07-24/TagResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/panorama-2019-07-24/TagResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/panorama-2019-07-24/TagResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/panorama-2019-07-24/TagResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/panorama-2019-07-24/TagResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/panorama-2019-07-24/TagResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/panorama-2019-07-24/TagResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/panorama-2019-07-24/TagResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/panorama-2019-07-24/TagResource) 

# UntagResource
<a name="API_UntagResource"></a>

**Important**  
End of support notice: On May 31, 2026, AWS will end support for AWS Panorama. After May 31, 2026, you will no longer be able to access the AWS Panorama console or AWS Panorama resources. For more information, see [AWS Panorama end of support](https://docs.aws.amazon.com/panorama/latest/dev/panorama-end-of-support.html). 

Removes tags from a resource.

## Request Syntax
<a name="API_UntagResource_RequestSyntax"></a>

```
DELETE /tags/ResourceArn?tagKeys=TagKeys HTTP/1.1
```

## URI Request Parameters
<a name="API_UntagResource_RequestParameters"></a>

The request uses the following URI parameters.

 ** [ResourceArn](#API_UntagResource_RequestSyntax) **   <a name="panorama-UntagResource-request-uri-ResourceArn"></a>
The resource's ARN.  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `.+`   
Required: Yes

 ** [TagKeys](#API_UntagResource_RequestSyntax) **   <a name="panorama-UntagResource-request-uri-TagKeys"></a>
Tag keys to remove.  
Array Members: Minimum number of 1 item. Maximum number of 50 items.  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `.+`   
Required: Yes

## Request Body
<a name="API_UntagResource_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_UntagResource_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_UntagResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_UntagResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerException **   
An internal error occurred.    
 ** RetryAfterSeconds **   
The number of seconds a client should wait before retrying the call.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The target resource was not found.    
 ** ResourceId **   
The resource's ID.  
 ** ResourceType **   
The resource's type.
HTTP Status Code: 404

 ** ValidationException **   
The request contains an invalid parameter value.    
 ** ErrorArguments **   
A list of attributes that led to the exception and their values.  
 ** ErrorId **   
A unique ID for the error.  
 ** Fields **   
A list of request parameters that failed validation.  
 ** Reason **   
The reason that validation failed.
HTTP Status Code: 400

## See Also
<a name="API_UntagResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/panorama-2019-07-24/UntagResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/panorama-2019-07-24/UntagResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/panorama-2019-07-24/UntagResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/panorama-2019-07-24/UntagResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/panorama-2019-07-24/UntagResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/panorama-2019-07-24/UntagResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/panorama-2019-07-24/UntagResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/panorama-2019-07-24/UntagResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/panorama-2019-07-24/UntagResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/panorama-2019-07-24/UntagResource) 

# UpdateDeviceMetadata
<a name="API_UpdateDeviceMetadata"></a>

**Important**  
End of support notice: On May 31, 2026, AWS will end support for AWS Panorama. After May 31, 2026, you will no longer be able to access the AWS Panorama console or AWS Panorama resources. For more information, see [AWS Panorama end of support](https://docs.aws.amazon.com/panorama/latest/dev/panorama-end-of-support.html). 

Updates a device's metadata.

## Request Syntax
<a name="API_UpdateDeviceMetadata_RequestSyntax"></a>

```
PUT /devices/DeviceId HTTP/1.1
Content-type: application/json

{
   "Description": "string"
}
```

## URI Request Parameters
<a name="API_UpdateDeviceMetadata_RequestParameters"></a>

The request uses the following URI parameters.

 ** [DeviceId](#API_UpdateDeviceMetadata_RequestSyntax) **   <a name="panorama-UpdateDeviceMetadata-request-uri-DeviceId"></a>
The device's ID.  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z0-9\-\_]+`   
Required: Yes

## Request Body
<a name="API_UpdateDeviceMetadata_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [Description](#API_UpdateDeviceMetadata_RequestSyntax) **   <a name="panorama-UpdateDeviceMetadata-request-Description"></a>
A description for the device.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 255.  
Pattern: `.*`   
Required: No

## Response Syntax
<a name="API_UpdateDeviceMetadata_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "DeviceId": "string"
}
```

## Response Elements
<a name="API_UpdateDeviceMetadata_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [DeviceId](#API_UpdateDeviceMetadata_ResponseSyntax) **   <a name="panorama-UpdateDeviceMetadata-response-DeviceId"></a>
The device's ID.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z0-9\-\_]+` 

## Errors
<a name="API_UpdateDeviceMetadata_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
The requestor does not have permission to access the target action or resource.  
HTTP Status Code: 403

 ** ConflictException **   
The target resource is in use.    
 ** ErrorArguments **   
A list of attributes that led to the exception and their values.  
 ** ErrorId **   
A unique ID for the error.  
 ** ResourceId **   
The resource's ID.  
 ** ResourceType **   
The resource's type.
HTTP Status Code: 409

 ** InternalServerException **   
An internal error occurred.    
 ** RetryAfterSeconds **   
The number of seconds a client should wait before retrying the call.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The target resource was not found.    
 ** ResourceId **   
The resource's ID.  
 ** ResourceType **   
The resource's type.
HTTP Status Code: 404

 ** ValidationException **   
The request contains an invalid parameter value.    
 ** ErrorArguments **   
A list of attributes that led to the exception and their values.  
 ** ErrorId **   
A unique ID for the error.  
 ** Fields **   
A list of request parameters that failed validation.  
 ** Reason **   
The reason that validation failed.
HTTP Status Code: 400

## See Also
<a name="API_UpdateDeviceMetadata_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/panorama-2019-07-24/UpdateDeviceMetadata) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/panorama-2019-07-24/UpdateDeviceMetadata) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/panorama-2019-07-24/UpdateDeviceMetadata) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/panorama-2019-07-24/UpdateDeviceMetadata) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/panorama-2019-07-24/UpdateDeviceMetadata) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/panorama-2019-07-24/UpdateDeviceMetadata) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/panorama-2019-07-24/UpdateDeviceMetadata) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/panorama-2019-07-24/UpdateDeviceMetadata) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/panorama-2019-07-24/UpdateDeviceMetadata) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/panorama-2019-07-24/UpdateDeviceMetadata)