AWS Panorama
API Reference
API Version 2019-07-24
AWS Panorama: API Reference
Copyright © Amazon Web Services, Inc. and/or its affiliates. All rights reserved.
Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who may or may not be affiliated with, connected to, or sponsored by Amazon.
Table of Contents
Welcome ... 1
Actions ... 2
CreateApplicationInstance ... 3
Request Syntax ... 3
URI Request Parameters ... 3
Request Body ... 3
Response Syntax ... 5
Response Elements ... 5
Errors ... 5
See Also ... 5
CreateJobForDevices ... 7
Request Syntax ... 7
URI Request Parameters ... 7
Request Body ... 7
Response Syntax ... 8
Response Elements ... 8
Errors ... 8
See Also ... 9
CreateNodeFromTemplateJob ... 10
Request Syntax ... 10
URI Request Parameters ... 10
Request Body ... 10
Response Syntax ... 11
Response Elements ... 12
Errors ... 12
See Also ... 12
CreatePackage ... 14
Request Syntax ... 14
URI Request Parameters ... 14
Request Body ... 14
Response Syntax ... 14
Response Elements ... 15
Errors ... 15
See Also ... 16
CreatePackageImportJob ... 17
Request Syntax ... 17
URI Request Parameters ... 17
Request Body ... 17
Response Syntax ... 18
Response Elements ... 18
Errors ... 19
See Also ... 19
DeleteDevice ... 20
Request Syntax ... 20
URI Request Parameters ... 20
Request Body ... 20
Response Syntax ... 20
Response Elements ... 20
Errors ... 20
See Also ... 21
DeletePackage ... 22
Request Syntax ... 22
URI Request Parameters ... 22
Request Body ... 22
Response Syntax ... 22
Response Elements ... 22
Errors ... 22
See Also ... 23
DeregisterPackageVersion ... 24
Request Syntax ... 24
URI Request Parameters ... 24
Request Body ... 25
Response Syntax ... 25
Response Elements ... 25
Errors ... 25
See Also ... 25
DescribeApplicationInstance ... 27
Request Syntax ... 27
URI Request Parameters ... 27
Request Body ... 27
Response Syntax ... 27
Response Elements ... 27
Errors ... 30
See Also ... 30
DescribeApplicationInstanceDetails ... 31
Request Syntax ... 31
URI Request Parameters ... 31
Request Body ... 31
Response Syntax ... 31
Response Elements ... 31
Errors ... 32
See Also ... 33
DescribeDevice ... 34
Request Syntax ... 34
URI Request Parameters ... 34
Request Body ... 34
Response Syntax ... 34
Response Elements ... 35
Errors ... 37
See Also ... 38
DescribeDeviceJob ... 39
Request Syntax ... 39
URI Request Parameters ... 39
Request Body ... 39
Response Syntax ... 39
Response Elements ... 39
Errors ... 41
See Also ... 41
DescribeNode ... 42
Request Syntax ... 42
URI Request Parameters ... 42
Request Body ... 42
Response Syntax ... 42
Response Elements ... 43
Errors ... 45
See Also ... 45
DescribeNodeFromTemplateJob ... 47
Request Syntax ... 47
URI Request Parameters ... 47
Request Body ... 47
Response Syntax ... 47
Response Elements ... 48
Errors ... 49
See Also ... 50
DescribePackage ... 51
Request Syntax ... 51
URI Request Parameters ... 51
Request Body ... 51
Response Syntax ... 51
Response Elements ... 51
Errors ... 53
See Also ... 53
DescribePackageImportJob ... 54
Request Syntax ... 54
URI Request Parameters ... 54
Request Body ... 54
Response Syntax ... 54
Response Elements ... 55
Errors ... 56
See Also ... 56
DescribePackageVersion ... 58
Request Syntax ... 58
URI Request Parameters ... 58
Request Body ... 58
Response Syntax ... 58
Response Elements ... 59
Errors ... 60
See Also ... 61
ListApplicationInstanceDependencies ... 62
Request Syntax ... 62
URI Request Parameters ... 62
Request Body ... 62
Response Syntax ... 62
Response Elements ... 63
Errors ... 63
See Also ... 63
ListApplicationInstanceNodeInstances ... 64
Request Syntax ... 64
URI Request Parameters ... 64
Request Body ... 64
Response Syntax ... 64
Response Elements ... 65
Errors ... 65
See Also ... 65
ListApplicationInstances ... 67
Request Syntax ... 67
URI Request Parameters ... 67
Request Body ... 67
Response Syntax ... 67
Response Elements ... 68
Errors ... 68
See Also ... 68
ListDevices ... 70
Request Syntax ... 70
URI Request Parameters ... 70
Request Body ... 70
Response Syntax ... 70
Response Elements ... 70
Errors ... 71
See Also ... 71
ListDevicesJobs ... 72
Request Syntax ... 72
URI Request Parameters ... 72
Request Body ... 72
Response Syntax ... 72
Response Elements ... 73
Errors ... 73
See Also ... 73
ListNodeFromTemplateJobs ... 75
Request Syntax ... 75
URI Request Parameters ... 75
Request Body ... 75
Response Syntax ... 75
Response Elements ... 75
Errors ... 76
See Also ... 76
ListNodes ... 77
Request Syntax ... 77
URI Request Parameters ... 77
Request Body ... 78
Response Syntax ... 78
Response Elements ... 78
Errors ... 78
See Also ... 79
ListPackageImportJobs ... 80
Request Syntax ... 80
URI Request Parameters ... 80
Request Body ... 80
Response Syntax ... 80
Response Elements ... 80
Errors ... 81
See Also ... 81
ListPackages ... 82
Request Syntax ... 82
URI Request Parameters ... 82
Request Body ... 82
Response Syntax ... 82
Response Elements ... 82
Errors ... 83
See Also ... 83
ListTagsForResource ... 85
Request Syntax ... 85
URI Request Parameters ... 85
Request Body ... 85
Response Syntax ... 85
Response Elements ... 85
Errors ... 86
See Also ... 86
ProvisionDevice ... 87
Request Syntax ... 87
URI Request Parameters ... 87
Request Body ... 87
Response Syntax ... 88
Response Elements ... 88
Errors ... 89
See Also ... 90
RegisterPackageVersion ... 91
Request Syntax ... 91
URI Request Parameters ... 91
Request Body ... 91
Response Syntax ... 92
Response Elements ... 92
Errors ... 92
See Also ... 92
RemoveApplicationInstance ... 94
Request Syntax ... 94
URI Request Parameters ... 94
Request Body ... 94
Response Syntax ... 94
Response Elements ... 94
Errors ... 94
See Also ... 95
TagResource ... 96
Request Syntax ... 96
URI Request Parameters ... 96
Request Body ... 96
Response Syntax ... 96
Response Elements ... 97
Errors ... 97
See Also ... 97
UntagResource ... 98
Request Syntax ... 98
URI Request Parameters ... 98
Request Body ... 98
Response Syntax ... 98
Response Elements ... 98
Errors ... 98
See Also ... 99
UpdateDeviceMetadata ... 100
Request Syntax ... 100
URI Request Parameters ... 100
Request Body ... 100
Response Syntax ... 100
Response Elements ... 100
Errors ... 101
See Also ... 101
Data Types ... 103
AlternateSoftwareMetadata ... 105
Contents ... 105
See Also ... 105
ApplicationInstance ... 106
Contents ... 106
See Also ... 108
ConflictExceptionErrorArgument ... 109
Contents ... 109
See Also ... 109
Device ... 110
Contents ... 110
See Also ... 111
DeviceJob ... 112
Contents ... 112
See Also ... 112
DeviceJobConfig ... 114
Contents ... 114
See Also ... 114
EthernetPayload ... 115
Contents ... 115
See Also ... 115
EthernetStatus ... 116
Contents ... 116
See Also ... 116
Job ... 117
Contents ... 117
See Also ... 117
JobResourceTags ... 118
Contents ... 118
See Also ... 118
ManifestOverridesPayload ... 119
Contents ... 119
See Also ... 119
ManifestPayload ... 120
Contents ... 120
See Also ... 120
NetworkPayload ... 121
Contents ... 121
See Also ... 121
NetworkStatus ... 122
Contents ... 122
See Also ... 122
Node ... 123
Contents ... 123
See Also ... 125
NodeFromTemplateJob ... 126
Contents ... 126
See Also ... 127
NodeInputPort ... 128
Contents ... 128
See Also ... 128
NodeInstance ... 130
Contents ... 130
See Also ... 131
NodeInterface ... 132
Contents ... 132
See Also ... 132
NodeOutputPort ... 133
Contents ... 133
See Also ... 133
NtpPayload ... 134
Contents ... 134
See Also ... 134
NtpStatus ... 135
Contents ... 135
See Also ... 135
OTAJobConfig ... 136
Contents ... 136
See Also ... 136
OutPutS3Location ... 137
Contents ... 137
See Also ... 137
PackageImportJob ... 138
Contents ... 138
See Also ... 139
PackageImportJobInputConfig ... 140
Contents ... 140
See Also ... 140
PackageImportJobOutput ... 141
Contents ... 141
See Also ... 141
PackageImportJobOutputConfig ... 143
Contents ... 143
See Also ... 143
PackageListItem ... 144
Contents ... 144
See Also ... 145
PackageObject ... 146
Contents ... 146
See Also ... 146
PackageVersionInputConfig ... 147
Contents ... 147
See Also ... 147
PackageVersionOutputConfig ... 148
Contents ... 148
See Also ... 148
S3Location ... 149
Contents ... 149
See Also ... 149
StaticIpConnectionInfo ... 150
Contents ... 150
See Also ... 150
StorageLocation ... 152
Contents ... 152
See Also ... 152
ValidationExceptionErrorArgument ... 153
Contents ... 153
See Also ... 153
ValidationExceptionField ... 154
Contents ... 154
See Also ... 154
Common Parameters ... 155
Common Errors ... 157
Welcome
Overview
This is the AWS Panorama API Reference. For an introduction to the service, see What is AWS Panorama?
in the AWS Panorama Developer Guide.
This document was last published on March 6, 2022.
Actions
The following actions are supported:
• CreateApplicationInstance (p. 3)
• CreateJobForDevices (p. 7)
• CreateNodeFromTemplateJob (p. 10)
• CreatePackage (p. 14)
• CreatePackageImportJob (p. 17)
• DeleteDevice (p. 20)
• DeletePackage (p. 22)
• DeregisterPackageVersion (p. 24)
• DescribeApplicationInstance (p. 27)
• DescribeApplicationInstanceDetails (p. 31)
• DescribeDevice (p. 34)
• DescribeDeviceJob (p. 39)
• DescribeNode (p. 42)
• DescribeNodeFromTemplateJob (p. 47)
• DescribePackage (p. 51)
• DescribePackageImportJob (p. 54)
• DescribePackageVersion (p. 58)
• ListApplicationInstanceDependencies (p. 62)
• ListApplicationInstanceNodeInstances (p. 64)
• ListApplicationInstances (p. 67)
• ListDevices (p. 70)
• ListDevicesJobs (p. 72)
• ListNodeFromTemplateJobs (p. 75)
• ListNodes (p. 77)
• ListPackageImportJobs (p. 80)
• ListPackages (p. 82)
• ListTagsForResource (p. 85)
• ProvisionDevice (p. 87)
• RegisterPackageVersion (p. 91)
• RemoveApplicationInstance (p. 94)
• TagResource (p. 96)
• UntagResource (p. 98)
• UpdateDeviceMetadata (p. 100)
CreateApplicationInstance
CreateApplicationInstance
Creates an application instance and deploys it to a device.
Request Syntax
POST /application-instances HTTP/1.1 Content-type: application/json {
"ApplicationInstanceIdToReplace": "string", "DefaultRuntimeContextDevice": "string", "Description": "string",
"ManifestOverridesPayload": { "PayloadData": "string"
},
"ManifestPayload": { "PayloadData": "string"
},
"Name": "string",
"RuntimeRoleArn": "string", "Tags": {
"string" : "string"
}}
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
ApplicationInstanceIdToReplace (p. 3)
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 (p. 3) A device's ID.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern: ^[a-zA-Z0-9\-\_]+$
Required: Yes
Request Body
Description (p. 3)
A description for the application instance.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 255.
Pattern: ^.*$
Required: No
ManifestOverridesPayload (p. 3)
Setting overrides for the application manifest.
Type: ManifestOverridesPayload (p. 119) object Required: No
ManifestPayload (p. 3)
The application's manifest document.
Type: ManifestPayload (p. 120) object Required: Yes
Name (p. 3)
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 (p. 3)
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 (p. 3)
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: ^.*$
Response Syntax
Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json { "ApplicationInstanceId": "string"
}
Response Elements
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 (p. 5) The application instance's ID.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern: ^[a-zA-Z0-9\-\_]+$
Errors
For information about the errors that are common to all actions, see Common Errors (p. 157).
AccessDeniedException
The requestor does not have permission to access the target action or resource.
HTTP Status Code: 403 InternalServerException
An internal error occurred.
HTTP Status Code: 500 ServiceQuotaExceededException
The request would cause a limit to be exceeded.
HTTP Status Code: 402 ValidationException
The request contains an invalid parameter value.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
See Also
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
CreateJobForDevices
CreateJobForDevices
Creates a job to run on one or more devices.
Request Syntax
POST /jobs HTTP/1.1
Content-type: application/json { "DeviceIds": [ "string" ], "DeviceJobConfig": { "OTAJobConfig": {
"ImageVersion": "string"
} },
"JobType": "string"
}
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
DeviceIds (p. 7)
IDs of target devices.
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 (p. 7)
Configuration settings for the job.
Type: DeviceJobConfig (p. 114) object Required: Yes
JobType (p. 7)
The type of job to run.
Type: String Valid Values: OTA Required: Yes
Response Syntax
Response Syntax
HTTP/1.1 200
Content-type: application/json {
"Jobs": [ {
"DeviceId": "string", "JobId": "string"
} ]}
Response Elements
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 (p. 8) A list of jobs.
Type: Array of Job (p. 117) objects
Errors
For information about the errors that are common to all actions, see Common Errors (p. 157).
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.
HTTP Status Code: 409 InternalServerException
An internal error occurred.
HTTP Status Code: 500 ResourceNotFoundException
The target resource was not found.
HTTP Status Code: 404 ValidationException
The request contains an invalid parameter value.
HTTP Status Code: 400
See Also
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
CreateNodeFromTemplateJob
CreateNodeFromTemplateJob
Creates a camera stream node.
Request Syntax
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
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
JobTags (p. 10) Tags for the job.
Type: Array of JobResourceTags (p. 118) objects Required: No
NodeDescription (p. 10) A description for the node.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 255.
Pattern: ^.*$
Required: No NodeName (p. 10)
A name for the node.
Response Syntax
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: ^[a-zA-Z0-9\-\_]+$
Required: Yes
OutputPackageName (p. 10)
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 (p. 10)
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 (p. 10)
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 (p. 10)
The type of node.
Type: String
Valid Values: RTSP_CAMERA_STREAM Required: Yes
Response Syntax
HTTP/1.1 200
Content-type: application/json
Response Elements
{
"JobId": "string"
}
Response Elements
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 (p. 11) The job's ID.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern: ^[a-zA-Z0-9\-\_]+$
Errors
For information about the errors that are common to all actions, see Common Errors (p. 157).
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.
HTTP Status Code: 409 InternalServerException
An internal error occurred.
HTTP Status Code: 500 ValidationException
The request contains an invalid parameter value.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
See Also
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
CreatePackage
CreatePackage
Creates a package and storage location in an Amazon S3 access point.
Request Syntax
POST /packages HTTP/1.1
Content-type: application/json { "PackageName": "string", "Tags": {
"string" : "string"
} }
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
PackageName (p. 14) 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 (p. 14)
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
HTTP/1.1 200
Response Elements
Content-type: application/json { "Arn": "string",
"PackageId": "string", "StorageLocation": {
"BinaryPrefixLocation": "string", "Bucket": "string",
"GeneratedPrefixLocation": "string", "ManifestPrefixLocation": "string", "RepoPrefixLocation": "string"
}}
Response Elements
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 (p. 14)
The package's ARN.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
PackageId (p. 14) The package's ID.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern: ^[a-zA-Z0-9\-\_\/]+$
StorageLocation (p. 14)
The package's storage location.
Type: StorageLocation (p. 152) object
Errors
For information about the errors that are common to all actions, see Common Errors (p. 157).
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.
HTTP Status Code: 409 InternalServerException
An internal error occurred.
See Also
HTTP Status Code: 500 ValidationException
The request contains an invalid parameter value.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
CreatePackageImportJob
CreatePackageImportJob
Imports a node package.
Request Syntax
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
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
ClientToken (p. 17)
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
Response Syntax
InputConfig (p. 17)
An input config for the package import job.
Type: PackageImportJobInputConfig (p. 140) object Required: Yes
JobTags (p. 17)
Tags for the package import job.
Type: Array of JobResourceTags (p. 118) objects Required: No
JobType (p. 17)
A job type for the package import job.
Type: String
Valid Values: NODE_PACKAGE_VERSION | MARKETPLACE_NODE_PACKAGE_VERSION Required: Yes
OutputConfig (p. 17)
An output config for the package import job.
Type: PackageImportJobOutputConfig (p. 143) object Required: Yes
Response Syntax
HTTP/1.1 200
Content-type: application/json { "JobId": "string"
}
Response Elements
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 (p. 18)
The job's ID.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern: ^[a-zA-Z0-9\-\_]+$
Errors
Errors
For information about the errors that are common to all actions, see Common Errors (p. 157).
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.
HTTP Status Code: 409 InternalServerException
An internal error occurred.
HTTP Status Code: 500 ValidationException
The request contains an invalid parameter value.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
DeleteDevice
DeleteDevice
Deletes a device.
Request Syntax
DELETE /devices/DeviceId HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
DeviceId (p. 20) The device's ID.
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern: ^[a-zA-Z0-9\-\_]+$
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json {
"DeviceId": "string"
}
Response Elements
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 (p. 20) The device's ID.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern: ^[a-zA-Z0-9\-\_]+$
Errors
For information about the errors that are common to all actions, see Common Errors (p. 157).
See Also
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.
HTTP Status Code: 409 InternalServerException
An internal error occurred.
HTTP Status Code: 500 ResourceNotFoundException
The target resource was not found.
HTTP Status Code: 404 ValidationException
The request contains an invalid parameter value.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
DeletePackage
DeletePackage
Deletes a package.
NoteTo delete a package, you need permission to call s3:DeleteObject in addition to permissions for the AWS Panorama API.
Request Syntax
DELETE /packages/PackageId?ForceDelete=ForceDelete HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
ForceDelete (p. 22)
Delete the package even if it has artifacts stored in its access point. Deletes the package's artifacts from Amazon S3.
PackageId (p. 22) The package's ID.
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern: ^[a-zA-Z0-9\-\_\/]+$
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors (p. 157).
AccessDeniedException
The requestor does not have permission to access the target action or resource.
HTTP Status Code: 403
See Also
ConflictException
The target resource is in use.
HTTP Status Code: 409 InternalServerException
An internal error occurred.
HTTP Status Code: 500 ResourceNotFoundException
The target resource was not found.
HTTP Status Code: 404 ValidationException
The request contains an invalid parameter value.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
DeregisterPackageVersion
DeregisterPackageVersion
Deregisters a package version.
Request Syntax
DELETE /packages/PackageId/versions/PackageVersion/patch/PatchVersion?
OwnerAccount=OwnerAccount&UpdatedLatestPatchVersion=UpdatedLatestPatchVersion HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
OwnerAccount (p. 24)
An owner account.
Length Constraints: Minimum length of 1. Maximum length of 12.
Pattern: ^[0-9a-z\_]+$
PackageId (p. 24)
A package ID.
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern: ^[a-zA-Z0-9\-\_\/]+$
Required: Yes PackageVersion (p. 24)
A package version.
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern: ^([0-9]+)\.([0-9]+)$
Required: Yes PatchVersion (p. 24)
A patch version.
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern: ^[a-z0-9]+$
Required: Yes
UpdatedLatestPatchVersion (p. 24)
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
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors (p. 157).
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.
HTTP Status Code: 409 InternalServerException
An internal error occurred.
HTTP Status Code: 500 ResourceNotFoundException
The target resource was not found.
HTTP Status Code: 404 ValidationException
The request contains an invalid parameter value.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
See Also
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
DescribeApplicationInstance
DescribeApplicationInstance
Returns information about an application instance on a device.
Request Syntax
GET /application-instances/ApplicationInstanceId HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
ApplicationInstanceId (p. 27) The application instance's ID.
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern: ^[a-zA-Z0-9\-\_]+$
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
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",
"RuntimeRoleArn": "string", "Status": "string",
"StatusDescription": "string", "Tags": {
"string" : "string"
} }
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
Response Elements
The following data is returned in JSON format by the service.
ApplicationInstanceId (p. 27) The application instance's ID.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern: ^[a-zA-Z0-9\-\_]+$
ApplicationInstanceIdToReplace (p. 27)
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 (p. 27)
The application instance's ARN.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
CreatedTime (p. 27)
When the application instance was created.
Type: Timestamp
DefaultRuntimeContextDevice (p. 27) The device's ID.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern: ^[a-zA-Z0-9\-\_]+$
DefaultRuntimeContextDeviceName (p. 27) The device's bane.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern: ^[a-zA-Z0-9\-\_]+$
Description (p. 27)
The application instance's description.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 255.
Pattern: ^.*$
Response Elements
HealthStatus (p. 27)
The application instance's health status.
Type: String
Valid Values: RUNNING | ERROR | NOT_AVAILABLE LastUpdatedTime (p. 27)
The application instance was updated.
Type: Timestamp Name (p. 27)
The application instance's name.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern: ^[a-zA-Z0-9\-\_]+$
RuntimeRoleArn (p. 27)
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 (p. 27)
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
StatusDescription (p. 27)
The application instance's status description.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Tags (p. 27)
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.
Errors
Value Pattern: ^.*$
Errors
For information about the errors that are common to all actions, see Common Errors (p. 157).
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.
HTTP Status Code: 409 InternalServerException
An internal error occurred.
HTTP Status Code: 500 ResourceNotFoundException
The target resource was not found.
HTTP Status Code: 404 ValidationException
The request contains an invalid parameter value.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
DescribeApplicationInstanceDetails
DescribeApplicationInstanceDetails
Returns information about an application instance's configuration manifest.
Request Syntax
GET /application-instances/ApplicationInstanceId/details HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
ApplicationInstanceId (p. 31) The application instance's ID.
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern: ^[a-zA-Z0-9\-\_]+$
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json {
"ApplicationInstanceId": "string",
"ApplicationInstanceIdToReplace": "string", "CreatedTime": number,
"DefaultRuntimeContextDevice": "string", "Description": "string",
"ManifestOverridesPayload": { "PayloadData": "string"
},
"ManifestPayload": { "PayloadData": "string"
},
"Name": "string"
}
Response Elements
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 (p. 31) The application instance's ID.
Errors
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern: ^[a-zA-Z0-9\-\_]+$
ApplicationInstanceIdToReplace (p. 31)
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 (p. 31)
When the application instance was created.
Type: Timestamp
DefaultRuntimeContextDevice (p. 31)
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 (p. 31)
The application instance's description.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 255.
Pattern: ^.*$
ManifestOverridesPayload (p. 31)
Parameter overrides for the configuration manifest.
Type: ManifestOverridesPayload (p. 119) object ManifestPayload (p. 31)
The application instance's configuration manifest.
Type: ManifestPayload (p. 120) object Name (p. 31)
The application instance's name.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern: ^[a-zA-Z0-9\-\_]+$
Errors
For information about the errors that are common to all actions, see Common Errors (p. 157).
See Also
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.
HTTP Status Code: 409 InternalServerException
An internal error occurred.
HTTP Status Code: 500 ResourceNotFoundException
The target resource was not found.
HTTP Status Code: 404 ValidationException
The request contains an invalid parameter value.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
DescribeDevice
DescribeDevice
Returns information about a device.
Request Syntax
GET /devices/DeviceId HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
DeviceId (p. 34) The device's ID.
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern: ^[a-zA-Z0-9\-\_]+$
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json {
"AlternateSoftwares": [ {
"Version": "string"
} ],
"Arn": "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"
} },
Response Elements
"CurrentSoftware": "string", "Description": "string",
"DeviceConnectionStatus": "string", "DeviceId": "string",
"LatestAlternateSoftware": "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
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 (p. 34)
Beta software releases available for the device.
Type: Array of AlternateSoftwareMetadata (p. 105) objects Arn (p. 34)
The device's ARN.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
CreatedTime (p. 34)
When the device was created.
Type: Timestamp
Response Elements
CurrentNetworkingStatus (p. 34) The device's networking status.
Type: NetworkStatus (p. 122) object CurrentSoftware (p. 34)
The device's current software version.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Description (p. 34)
The device's description.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 255.
Pattern: ^.*$
DeviceConnectionStatus (p. 34) The device's connection status.
Type: String
Valid Values: ONLINE | OFFLINE | AWAITING_CREDENTIALS | NOT_AVAILABLE | ERROR DeviceId (p. 34)
The device's ID.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern: ^[a-zA-Z0-9\-\_]+$
LatestAlternateSoftware (p. 34)
The most recent beta software release.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
LatestSoftware (p. 34)
The latest software version available for the device.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
LeaseExpirationTime (p. 34)
The device's lease expiration time.
Type: Timestamp Name (p. 34)
The device's name.
Type: String
Errors
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern: ^[a-zA-Z0-9\-\_]+$
NetworkingConfiguration (p. 34)
The device's networking configuration.
Type: NetworkPayload (p. 121) object ProvisioningStatus (p. 34)
The device's provisioning status.
Type: String
Valid Values: AWAITING_PROVISIONING | PENDING | SUCCEEDED | FAILED | ERROR | DELETING
SerialNumber (p. 34)
The device's serial number.
Type: String
Pattern: ^[0-9]{1,20}$
Tags (p. 34)
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 (p. 34)
The device's type.
Type: String
Valid Values: PANORAMA_APPLIANCE_DEVELOPER_KIT | PANORAMA_APPLIANCE
Errors
For information about the errors that are common to all actions, see Common Errors (p. 157).
AccessDeniedException
The requestor does not have permission to access the target action or resource.
HTTP Status Code: 403 InternalServerException
An internal error occurred.
See Also
HTTP Status Code: 500 ResourceNotFoundException
The target resource was not found.
HTTP Status Code: 404 ValidationException
The request contains an invalid parameter value.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
DescribeDeviceJob
DescribeDeviceJob
Returns information about a device job.
Request Syntax
GET /jobs/JobId HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
JobId (p. 39) The job's ID.
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern: ^[a-zA-Z0-9\-\_]+$
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json {
"CreatedTime": number, "DeviceArn": "string", "DeviceId": "string", "DeviceName": "string", "DeviceType": "string", "ImageVersion": "string", "JobId": "string", "Status": "string"
}
Response Elements
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 (p. 39)
When the job was created.
Type: Timestamp
Response Elements
DeviceArn (p. 39) The device's ARN.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
DeviceId (p. 39) The device's ID.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern: ^[a-zA-Z0-9\-\_]+$
DeviceName (p. 39) The device's name.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern: ^[a-zA-Z0-9\-\_]+$
DeviceType (p. 39) The device's type.
Type: String
Valid Values: PANORAMA_APPLIANCE_DEVELOPER_KIT | PANORAMA_APPLIANCE ImageVersion (p. 39)
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 (p. 39) The job's ID.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern: ^[a-zA-Z0-9\-\_]+$
Status (p. 39) The job's status.
Type: String
Valid Values: PENDING | IN_PROGRESS | VERIFYING | REBOOTING | DOWNLOADING | COMPLETED | FAILED
Errors
Errors
For information about the errors that are common to all actions, see Common Errors (p. 157).
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.
HTTP Status Code: 409 InternalServerException
An internal error occurred.
HTTP Status Code: 500 ResourceNotFoundException
The target resource was not found.
HTTP Status Code: 404 ValidationException
The request contains an invalid parameter value.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
DescribeNode
DescribeNode
Returns information about a node.
Request Syntax
GET /nodes/NodeId?OwnerAccount=OwnerAccount HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
NodeId (p. 42) The node's ID.
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern: ^[a-zA-Z0-9\-\_\.]+$
Required: Yes OwnerAccount (p. 42)
The account ID of the node's owner.
Length Constraints: Minimum length of 1. Maximum length of 12.
Pattern: ^[0-9a-z\_]+$
Request Body
The request does not have a request body.
Response Syntax
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"
} ],
Response Elements
"Outputs": [ {
"Description": "string", "Name": "string",
"Type": "string"
} ] },
"OwnerAccount": "string", "PackageArn": "string", "PackageId": "string", "PackageName": "string", "PackageVersion": "string", "PatchVersion": "string"
}
Response Elements
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 (p. 42)
The node's asset name.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern: ^[a-zA-Z0-9\-\_]+$
Category (p. 42)
The node's category.
Type: String
Valid Values: BUSINESS_LOGIC | ML_MODEL | MEDIA_SOURCE | MEDIA_SINK CreatedTime (p. 42)
When the node was created.
Type: Timestamp Description (p. 42)
The node's description.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 255.
Pattern: ^.*$
LastUpdatedTime (p. 42) When the node was updated.
Type: Timestamp Name (p. 42)
The node's name.
Response Elements
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: ^[a-zA-Z0-9\-\_]+$
NodeId (p. 42) The node's ID.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern: ^[a-zA-Z0-9\-\_\.]+$
NodeInterface (p. 42) The node's interface.
Type: NodeInterface (p. 132) object OwnerAccount (p. 42)
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 (p. 42) The node's ARN.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
PackageId (p. 42)
The node's package ID.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern: ^[a-zA-Z0-9\-\_\/]+$
PackageName (p. 42)
The node's package name.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: ^[a-zA-Z0-9\-\_]+$
PackageVersion (p. 42)
The node's package version.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Errors
Pattern: ^([0-9]+)\.([0-9]+)$
PatchVersion (p. 42)
The node's patch version.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern: ^[a-z0-9]+$
Errors
For information about the errors that are common to all actions, see Common Errors (p. 157).
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.
HTTP Status Code: 409 InternalServerException
An internal error occurred.
HTTP Status Code: 500 ResourceNotFoundException
The target resource was not found.
HTTP Status Code: 404 ValidationException
The request contains an invalid parameter value.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
See Also
DescribeNodeFromTemplateJob
DescribeNodeFromTemplateJob
Returns information about a job to create a camera stream node.
Request Syntax
GET /packages/template-job/JobId HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
JobId (p. 47)
The job's ID.
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern: ^[a-zA-Z0-9\-\_]+$
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
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
Response Elements
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 (p. 47)
When the job was created.
Type: Timestamp JobId (p. 47)
The job's ID.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern: ^[a-zA-Z0-9\-\_]+$
JobTags (p. 47) The job's tags.
Type: Array of JobResourceTags (p. 118) objects LastUpdatedTime (p. 47)
When the job was updated.
Type: Timestamp NodeDescription (p. 47)
The node's description.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 255.
Pattern: ^.*$
NodeName (p. 47) The node's name.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: ^[a-zA-Z0-9\-\_]+$
OutputPackageName (p. 47) The job's output package name.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: ^[a-zA-Z0-9\-\_]+$
OutputPackageVersion (p. 47) The job's output package version.
Errors
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern: ^([0-9]+)\.([0-9]+)$
Status (p. 47) The job's status.
Type: String
Valid Values: PENDING | SUCCEEDED | FAILED StatusMessage (p. 47)
The job's status message.
Type: String
TemplateParameters (p. 47) 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 (p. 47) The job's template type.
Type: String
Valid Values: RTSP_CAMERA_STREAM
Errors
For information about the errors that are common to all actions, see Common Errors (p. 157).
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.
HTTP Status Code: 409 InternalServerException
An internal error occurred.
HTTP Status Code: 500
See Also
ValidationException
The request contains an invalid parameter value.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
DescribePackage
DescribePackage
Returns information about a package.
Request Syntax
GET /packages/metadata/PackageId HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
PackageId (p. 51) The package's ID.
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern: ^[a-zA-Z0-9\-\_\/]+$
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
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
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
Response Elements
Arn (p. 51)
The package's ARN.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
CreatedTime (p. 51)
When the package was created.
Type: Timestamp PackageId (p. 51)
The package's ID.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern: ^[a-zA-Z0-9\-\_\/]+$
PackageName (p. 51) The package's name.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: ^[a-zA-Z0-9\-\_]+$
ReadAccessPrincipalArns (p. 51)
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 (p. 51)
The package's storage location.
Type: StorageLocation (p. 152) object Tags (p. 51)
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: ^.*$
