}
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": {
"JobType": "string", "OutputConfig": {
"PackageVersionOutputConfig": { "MarkLatest": boolean,
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": {
"LastUpdatedTime": number, "NtpStatus": {
Response Elements
"CurrentSoftware": "string", "Description": "string",
"DeviceConnectionStatus": "string", "DeviceId": "string",
"LatestAlternateSoftware": "string", "LatestSoftware": "string",
"LeaseExpirationTime": number, "Name": "string",
"NetworkingConfiguration": { "Ethernet0": {
"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": {
Response Elements
"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
Type: String