You are viewing the documentation for an older major version of the AWS SDK for JavaScript.
The modular AWS SDK for JavaScript (v3), the latest major version of AWS SDK for JavaScript, is now stable and recommended for general use. For more information, see the Migration Guide and API Reference.

Class: AWS.Panorama

Inherits:
AWS.Service show all
Identifier:
panorama
API Version:
2019-07-24
Defined in:
(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

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.

Sending a Request Using Panorama

var panorama = new AWS.Panorama();
panorama.createApplicationInstance(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the Panorama object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var panorama = new AWS.Panorama({apiVersion: '2019-07-24'});

You can also set the API version globally in AWS.config.apiVersions using the panorama service identifier:

AWS.config.apiVersions = {
  panorama: '2019-07-24',
  // other service API versions
};

var panorama = new AWS.Panorama();

Version:

  • 2019-07-24

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.Panorama(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a Panorama object

var panorama = new AWS.Panorama({apiVersion: '2019-07-24'});

Options Hash (options):

  • params (map) —

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String|AWS.Endpoint) —

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com' or an Endpoint object.

  • accessKeyId (String) —

    your AWS access key ID.

  • secretAccessKey (String) —

    your AWS secret access key.

  • sessionToken (AWS.Credentials) —

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials) —

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain) —

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String) —

    the region to send service requests to. See AWS.Panorama.region for more information.

  • maxRetries (Integer) —

    the maximum amount of retries to attempt with a request. See AWS.Panorama.maxRetries for more information.

  • maxRedirects (Integer) —

    the maximum amount of redirects to follow with a request. See AWS.Panorama.maxRedirects for more information.

  • sslEnabled (Boolean) —

    whether to enable SSL for requests.

  • paramValidation (Boolean|map) —

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean) —

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean) —

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean) —

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean) —

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean) —

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean) —

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • s3UsEast1RegionalEndpoint ('legacy'|'regional') —

    when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy

  • s3UseArnRegion (Boolean) —

    whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to true

  • retryDelayOptions (map) —

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied. The function is only called for retryable errors.
  • httpOptions (map) —

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date) —

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>) —

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log) —

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number) —

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String) —

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean) —

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean) —

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • useAccelerateEndpoint (Boolean) —

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean) —

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean|undefined) —

    whether to call operations with endpoints given by service dynamically. Setting this

  • endpointCacheSize (Number) —

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean) —

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

  • stsRegionalEndpoints ('legacy'|'regional') —

    whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

Property Details

endpoint ⇒ AWS.Endpoint (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

  • (AWS.Endpoint) —

    an Endpoint object representing the endpoint URL for service requests.

Method Details

createApplicationInstance(params = {}, callback) ⇒ AWS.Request

Creates an application instance and deploys it to a device.

Service Reference:

Examples:

Calling the createApplicationInstance operation

var params = {
  DefaultRuntimeContextDevice: 'STRING_VALUE', /* required */
  ManifestPayload: { /* required */
    PayloadData: 'STRING_VALUE'
  },
  ApplicationInstanceIdToReplace: 'STRING_VALUE',
  Description: 'STRING_VALUE',
  ManifestOverridesPayload: {
    PayloadData: 'STRING_VALUE'
  },
  Name: 'STRING_VALUE',
  RuntimeRoleArn: 'STRING_VALUE',
  Tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
panorama.createApplicationInstance(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Name — (String)

      A name for the application instance.

    • Description — (String)

      A description for the application instance.

    • ManifestPayload — (map)

      The application's manifest document.

      • PayloadData — (String)

        The application manifest.

    • ManifestOverridesPayload — (map)

      Setting overrides for the application manifest.

      • PayloadData — (String)

        The overrides document.

    • ApplicationInstanceIdToReplace — (String)

      The ID of an application instance to replace with the new instance.

    • RuntimeRoleArn — (String)

      The ARN of a runtime role for the application instance.

    • DefaultRuntimeContextDevice — (String)

      A device's ID.

    • Tags — (map<String>)

      Tags for the application instance.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ApplicationInstanceId — (String)

        The application instance's ID.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createJobForDevices(params = {}, callback) ⇒ AWS.Request

Creates a job to run on one or more devices.

Service Reference:

Examples:

Calling the createJobForDevices operation

var params = {
  DeviceIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  DeviceJobConfig: { /* required */
    OTAJobConfig: {
      ImageVersion: 'STRING_VALUE' /* required */
    }
  },
  JobType: OTA /* required */
};
panorama.createJobForDevices(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DeviceIds — (Array<String>)

      IDs of target devices.

    • DeviceJobConfig — (map)

      Configuration settings for the job.

      • OTAJobConfig — (map)

        A configuration for an over-the-air (OTA) upgrade. Required for OTA jobs.

        • ImageVersion — required — (String)

          The target version of the device software.

    • JobType — (String)

      The type of job to run.

      Possible values include:
      • "OTA"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Jobs — (Array<map>)

        A list of jobs.

        • JobId — (String)

          The job's ID.

        • DeviceId — (String)

          The target device's ID.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createNodeFromTemplateJob(params = {}, callback) ⇒ AWS.Request

Creates a camera stream node.

Service Reference:

Examples:

Calling the createNodeFromTemplateJob operation

var params = {
  NodeName: 'STRING_VALUE', /* required */
  OutputPackageName: 'STRING_VALUE', /* required */
  OutputPackageVersion: 'STRING_VALUE', /* required */
  TemplateParameters: { /* required */
    '<TemplateKey>': 'STRING_VALUE',
    /* '<TemplateKey>': ... */
  },
  TemplateType: RTSP_CAMERA_STREAM, /* required */
  JobTags: [
    {
      ResourceType: PACKAGE, /* required */
      Tags: { /* required */
        '<TagKey>': 'STRING_VALUE',
        /* '<TagKey>': ... */
      }
    },
    /* more items */
  ],
  NodeDescription: 'STRING_VALUE'
};
panorama.createNodeFromTemplateJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • TemplateType — (String)

      The type of node.

      Possible values include:
      • "RTSP_CAMERA_STREAM"
    • OutputPackageName — (String)

      An output package name for the node.

    • OutputPackageVersion — (String)

      An output package version for the node.

    • NodeName — (String)

      A name for the node.

    • NodeDescription — (String)

      A description for the node.

    • TemplateParameters — (map<String>)

      Template parameters for the node.

    • JobTags — (Array<map>)

      Tags for the job.

      • ResourceType — required — (String)

        The job's type.

        Possible values include:
        • "PACKAGE"
      • Tags — required — (map<String>)

        The job's tags.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • JobId — (String)

        The job's ID.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createPackage(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the createPackage operation

var params = {
  PackageName: 'STRING_VALUE', /* required */
  Tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
panorama.createPackage(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • PackageName — (String)

      A name for the package.

    • Tags — (map<String>)

      Tags for the package.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • PackageId — (String)

        The package's ID.

      • Arn — (String)

        The package's ARN.

      • StorageLocation — (map)

        The package's storage location.

        • Bucket — required — (String)

          The location's bucket.

        • RepoPrefixLocation — required — (String)

          The location's repo prefix.

        • GeneratedPrefixLocation — required — (String)

          The location's generated prefix.

        • BinaryPrefixLocation — required — (String)

          The location's binary prefix.

        • ManifestPrefixLocation — required — (String)

          The location's manifest prefix.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createPackageImportJob(params = {}, callback) ⇒ AWS.Request

Imports a node package.

Service Reference:

Examples:

Calling the createPackageImportJob operation

var params = {
  ClientToken: 'STRING_VALUE', /* required */
  InputConfig: { /* required */
    PackageVersionInputConfig: {
      S3Location: { /* required */
        BucketName: 'STRING_VALUE', /* required */
        ObjectKey: 'STRING_VALUE', /* required */
        Region: 'STRING_VALUE'
      }
    }
  },
  JobType: NODE_PACKAGE_VERSION, /* required */
  OutputConfig: { /* required */
    PackageVersionOutputConfig: {
      PackageName: 'STRING_VALUE', /* required */
      PackageVersion: 'STRING_VALUE', /* required */
      MarkLatest: true || false
    }
  },
  JobTags: [
    {
      ResourceType: PACKAGE, /* required */
      Tags: { /* required */
        '<TagKey>': 'STRING_VALUE',
        /* '<TagKey>': ... */
      }
    },
    /* more items */
  ]
};
panorama.createPackageImportJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • JobType — (String)

      A job type for the package import job.

      Possible values include:
      • "NODE_PACKAGE_VERSION"
    • InputConfig — (map)

      An input config for the package import job.

      • PackageVersionInputConfig — (map)

        The package version's input configuration.

        • S3Location — required — (map)

          A location in Amazon S3.

          • Region — (String)

            The bucket's Region.

          • BucketName — required — (String)

            A bucket name.

          • ObjectKey — required — (String)

            An object key.

    • OutputConfig — (map)

      An output config for the package import job.

      • PackageVersionOutputConfig — (map)

        The package version's output configuration.

        • PackageName — required — (String)

          The output's package name.

        • PackageVersion — required — (String)

          The output's package version.

        • MarkLatest — (Boolean)

          Indicates that the version is recommended for all users.

    • ClientToken — (String)

      A client token for the package import job.

    • JobTags — (Array<map>)

      Tags for the package import job.

      • ResourceType — required — (String)

        The job's type.

        Possible values include:
        • "PACKAGE"
      • Tags — required — (map<String>)

        The job's tags.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • JobId — (String)

        The job's ID.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteDevice(params = {}, callback) ⇒ AWS.Request

Deletes a device.

Service Reference:

Examples:

Calling the deleteDevice operation

var params = {
  DeviceId: 'STRING_VALUE' /* required */
};
panorama.deleteDevice(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DeviceId — (String)

      The device's ID.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • DeviceId — (String)

        The device's ID.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deletePackage(params = {}, callback) ⇒ AWS.Request

Deletes a package.

Service Reference:

Examples:

Calling the deletePackage operation

var params = {
  PackageId: 'STRING_VALUE', /* required */
  ForceDelete: true || false
};
panorama.deletePackage(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • PackageId — (String)

      The package's ID.

    • ForceDelete — (Boolean)

      Delete the package even if it has artifacts stored in its access point. Deletes the package's artifacts from Amazon S3.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deregisterPackageVersion(params = {}, callback) ⇒ AWS.Request

Deregisters a package version.

Service Reference:

Examples:

Calling the deregisterPackageVersion operation

var params = {
  PackageId: 'STRING_VALUE', /* required */
  PackageVersion: 'STRING_VALUE', /* required */
  PatchVersion: 'STRING_VALUE', /* required */
  OwnerAccount: 'STRING_VALUE',
  UpdatedLatestPatchVersion: 'STRING_VALUE'
};
panorama.deregisterPackageVersion(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • OwnerAccount — (String)

      An owner account.

    • PackageId — (String)

      A package ID.

    • PackageVersion — (String)

      A package version.

    • PatchVersion — (String)

      A patch version.

    • UpdatedLatestPatchVersion — (String)

      If the version was marked latest, the new version to maker as latest.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeApplicationInstance(params = {}, callback) ⇒ AWS.Request

Returns information about an application instance on a device.

Service Reference:

Examples:

Calling the describeApplicationInstance operation

var params = {
  ApplicationInstanceId: 'STRING_VALUE' /* required */
};
panorama.describeApplicationInstance(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationInstanceId — (String)

      The application instance's ID.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Name — (String)

        The application instance's name.

      • Description — (String)

        The application instance's description.

      • DefaultRuntimeContextDevice — (String)

        The device's ID.

      • DefaultRuntimeContextDeviceName — (String)

        The device's bane.

      • ApplicationInstanceIdToReplace — (String)

        The ID of the application instance that this instance replaced.

      • RuntimeRoleArn — (String)

        The application instance's runtime role ARN.

      • Status — (String)

        The application instance's status.

        Possible values include:
        • "DEPLOYMENT_PENDING"
        • "DEPLOYMENT_REQUESTED"
        • "DEPLOYMENT_IN_PROGRESS"
        • "DEPLOYMENT_ERROR"
        • "DEPLOYMENT_SUCCEEDED"
        • "REMOVAL_PENDING"
        • "REMOVAL_REQUESTED"
        • "REMOVAL_IN_PROGRESS"
        • "REMOVAL_FAILED"
        • "REMOVAL_SUCCEEDED"
      • HealthStatus — (String)

        The application instance's health status.

        Possible values include:
        • "RUNNING"
        • "ERROR"
        • "NOT_AVAILABLE"
      • StatusDescription — (String)

        The application instance's status description.

      • CreatedTime — (Date)

        When the application instance was created.

      • LastUpdatedTime — (Date)

        The application instance was updated.

      • ApplicationInstanceId — (String)

        The application instance's ID.

      • Arn — (String)

        The application instance's ARN.

      • Tags — (map<String>)

        The application instance's tags.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeApplicationInstanceDetails(params = {}, callback) ⇒ AWS.Request

Returns information about an application instance's configuration manifest.

Service Reference:

Examples:

Calling the describeApplicationInstanceDetails operation

var params = {
  ApplicationInstanceId: 'STRING_VALUE' /* required */
};
panorama.describeApplicationInstanceDetails(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationInstanceId — (String)

      The application instance's ID.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Name — (String)

        The application instance's name.

      • Description — (String)

        The application instance's description.

      • DefaultRuntimeContextDevice — (String)

        The application instance's default runtime context device.

      • ManifestPayload — (map)

        The application instance's configuration manifest.

        • PayloadData — (String)

          The application manifest.

      • ManifestOverridesPayload — (map)

        Parameter overrides for the configuration manifest.

        • PayloadData — (String)

          The overrides document.

      • ApplicationInstanceIdToReplace — (String)

        The ID of the application instance that this instance replaced.

      • CreatedTime — (Date)

        When the application instance was created.

      • ApplicationInstanceId — (String)

        The application instance's ID.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeDevice(params = {}, callback) ⇒ AWS.Request

Returns information about a device.

Service Reference:

Examples:

Calling the describeDevice operation

var params = {
  DeviceId: 'STRING_VALUE' /* required */
};
panorama.describeDevice(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DeviceId — (String)

      The device's ID.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • DeviceId — (String)

        The device's ID.

      • Name — (String)

        The device's name.

      • Arn — (String)

        The device's ARN.

      • Description — (String)

        The device's description.

      • Type — (String)

        The device's type.

        Possible values include:
        • "PANORAMA_APPLIANCE_DEVELOPER_KIT"
        • "PANORAMA_APPLIANCE"
      • DeviceConnectionStatus — (String)

        The device's connection status.

        Possible values include:
        • "ONLINE"
        • "OFFLINE"
        • "AWAITING_CREDENTIALS"
        • "NOT_AVAILABLE"
        • "ERROR"
      • CreatedTime — (Date)

        When the device was created.

      • ProvisioningStatus — (String)

        The device's provisioning status.

        Possible values include:
        • "AWAITING_PROVISIONING"
        • "PENDING"
        • "SUCCEEDED"
        • "FAILED"
        • "ERROR"
        • "DELETING"
      • LatestSoftware — (String)

        The latest software version available for the device.

      • CurrentSoftware — (String)

        The device's current software version.

      • SerialNumber — (String)

        The device's serial number.

      • Tags — (map<String>)

        The device's tags.

      • NetworkingConfiguration — (map)

        The device's networking configuration.

        • Ethernet0 — (map)

          Settings for Ethernet port 0.

          • ConnectionType — required — (String)

            How the device gets an IP address.

            Possible values include:
            • "STATIC_IP"
            • "DHCP"
          • StaticIpConnectionInfo — (map)

            Network configuration for a static IP connection.

            • IpAddress — required — (String)

              The connection's IP address.

            • Mask — required — (String)

              The connection's DNS mask.

            • Dns — required — (Array<String>)

              The connection's DNS address.

            • DefaultGateway — required — (String)

              The connection's default gateway.

        • Ethernet1 — (map)

          Settings for Ethernet port 1.

          • ConnectionType — required — (String)

            How the device gets an IP address.

            Possible values include:
            • "STATIC_IP"
            • "DHCP"
          • StaticIpConnectionInfo — (map)

            Network configuration for a static IP connection.

            • IpAddress — required — (String)

              The connection's IP address.

            • Mask — required — (String)

              The connection's DNS mask.

            • Dns — required — (Array<String>)

              The connection's DNS address.

            • DefaultGateway — required — (String)

              The connection's default gateway.

      • CurrentNetworkingStatus — (map)

        The device's networking status.

        • Ethernet0Status — (map)

          The status of Ethernet port 0.

          • IpAddress — (String)

            The device's IP address.

          • ConnectionStatus — (String)

            The device's connection status.

            Possible values include:
            • "CONNECTED"
            • "NOT_CONNECTED"
          • HwAddress — (String)

            The device's physical address.

        • Ethernet1Status — (map)

          The status of Ethernet port 1.

          • IpAddress — (String)

            The device's IP address.

          • ConnectionStatus — (String)

            The device's connection status.

            Possible values include:
            • "CONNECTED"
            • "NOT_CONNECTED"
          • HwAddress — (String)

            The device's physical address.

      • LeaseExpirationTime — (Date)

        The device's lease expiration time.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeDeviceJob(params = {}, callback) ⇒ AWS.Request

Returns information about a device job.

Service Reference:

Examples:

Calling the describeDeviceJob operation

var params = {
  JobId: 'STRING_VALUE' /* required */
};
panorama.describeDeviceJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • JobId — (String)

      The job's ID.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • JobId — (String)

        The job's ID.

      • DeviceId — (String)

        The device's ID.

      • DeviceArn — (String)

        The device's ARN.

      • DeviceName — (String)

        The device's name.

      • DeviceType — (String)

        The device's type.

        Possible values include:
        • "PANORAMA_APPLIANCE_DEVELOPER_KIT"
        • "PANORAMA_APPLIANCE"
      • ImageVersion — (String)

        For an OTA job, the target version of the device software.

      • Status — (String)

        The job's status.

        Possible values include:
        • "PENDING"
        • "IN_PROGRESS"
        • "VERIFYING"
        • "REBOOTING"
        • "DOWNLOADING"
        • "COMPLETED"
        • "FAILED"
      • CreatedTime — (Date)

        When the job was created.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeNode(params = {}, callback) ⇒ AWS.Request

Returns information about a node.

Service Reference:

Examples:

Calling the describeNode operation

var params = {
  NodeId: 'STRING_VALUE', /* required */
  OwnerAccount: 'STRING_VALUE'
};
panorama.describeNode(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • NodeId — (String)

      The node's ID.

    • OwnerAccount — (String)

      The account ID of the node's owner.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • NodeId — (String)

        The node's ID.

      • Name — (String)

        The node's name.

      • Category — (String)

        The node's category.

        Possible values include:
        • "BUSINESS_LOGIC"
        • "ML_MODEL"
        • "MEDIA_SOURCE"
        • "MEDIA_SINK"
      • OwnerAccount — (String)

        The account ID of the node's owner.

      • PackageName — (String)

        The node's package name.

      • PackageId — (String)

        The node's package ID.

      • PackageArn — (String)

        The node's ARN.

      • PackageVersion — (String)

        The node's package version.

      • PatchVersion — (String)

        The node's patch version.

      • NodeInterface — (map)

        The node's interface.

        • Inputs — required — (Array<map>)

          The node interface's inputs.

          • Name — (String)

            The input port's name.

          • Description — (String)

            The input port's description.

          • Type — (String)

            The input port's type.

            Possible values include:
            • "BOOLEAN"
            • "STRING"
            • "INT32"
            • "FLOAT32"
            • "MEDIA"
          • DefaultValue — (String)

            The input port's default value.

          • MaxConnections — (Integer)

            The input port's max connections.

        • Outputs — required — (Array<map>)

          The node interface's outputs.

          • Name — (String)

            The output port's name.

          • Description — (String)

            The output port's description.

          • Type — (String)

            The output port's type.

            Possible values include:
            • "BOOLEAN"
            • "STRING"
            • "INT32"
            • "FLOAT32"
            • "MEDIA"
      • AssetName — (String)

        The node's asset name.

      • Description — (String)

        The node's description.

      • CreatedTime — (Date)

        When the node was created.

      • LastUpdatedTime — (Date)

        When the node was updated.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeNodeFromTemplateJob(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the describeNodeFromTemplateJob operation

var params = {
  JobId: 'STRING_VALUE' /* required */
};
panorama.describeNodeFromTemplateJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • JobId — (String)

      The job's ID.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • JobId — (String)

        The job's ID.

      • Status — (String)

        The job's status.

        Possible values include:
        • "PENDING"
        • "SUCCEEDED"
        • "FAILED"
      • StatusMessage — (String)

        The job's status message.

      • CreatedTime — (Date)

        When the job was created.

      • LastUpdatedTime — (Date)

        When the job was updated.

      • OutputPackageName — (String)

        The job's output package name.

      • OutputPackageVersion — (String)

        The job's output package version.

      • NodeName — (String)

        The node's name.

      • NodeDescription — (String)

        The node's description.

      • TemplateType — (String)

        The job's template type.

        Possible values include:
        • "RTSP_CAMERA_STREAM"
      • TemplateParameters — (map<String>)

        The job's template parameters.

      • JobTags — (Array<map>)

        The job's tags.

        • ResourceType — required — (String)

          The job's type.

          Possible values include:
          • "PACKAGE"
        • Tags — required — (map<String>)

          The job's tags.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describePackage(params = {}, callback) ⇒ AWS.Request

Returns information about a package.

Service Reference:

Examples:

Calling the describePackage operation

var params = {
  PackageId: 'STRING_VALUE' /* required */
};
panorama.describePackage(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • PackageId — (String)

      The package's ID.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • PackageId — (String)

        The package's ID.

      • PackageName — (String)

        The package's name.

      • Arn — (String)

        The package's ARN.

      • StorageLocation — (map)

        The package's storage location.

        • Bucket — required — (String)

          The location's bucket.

        • RepoPrefixLocation — required — (String)

          The location's repo prefix.

        • GeneratedPrefixLocation — required — (String)

          The location's generated prefix.

        • BinaryPrefixLocation — required — (String)

          The location's binary prefix.

        • ManifestPrefixLocation — required — (String)

          The location's manifest prefix.

      • ReadAccessPrincipalArns — (Array<String>)

        ARNs of accounts that have read access to the package.

      • WriteAccessPrincipalArns — (Array<String>)

        ARNs of accounts that have write access to the package.

      • CreatedTime — (Date)

        When the package was created.

      • Tags — (map<String>)

        The package's tags.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describePackageImportJob(params = {}, callback) ⇒ AWS.Request

Returns information about a package import job.

Service Reference:

Examples:

Calling the describePackageImportJob operation

var params = {
  JobId: 'STRING_VALUE' /* required */
};
panorama.describePackageImportJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • JobId — (String)

      The job's ID.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • JobId — (String)

        The job's ID.

      • ClientToken — (String)

        The job's client token.

      • JobType — (String)

        The job's type.

        Possible values include:
        • "NODE_PACKAGE_VERSION"
      • InputConfig — (map)

        The job's input config.

        • PackageVersionInputConfig — (map)

          The package version's input configuration.

          • S3Location — required — (map)

            A location in Amazon S3.

            • Region — (String)

              The bucket's Region.

            • BucketName — required — (String)

              A bucket name.

            • ObjectKey — required — (String)

              An object key.

      • OutputConfig — (map)

        The job's output config.

        • PackageVersionOutputConfig — (map)

          The package version's output configuration.

          • PackageName — required — (String)

            The output's package name.

          • PackageVersion — required — (String)

            The output's package version.

          • MarkLatest — (Boolean)

            Indicates that the version is recommended for all users.

      • Output — (map)

        The job's output.

        • PackageId — required — (String)

          The package's ID.

        • PackageVersion — required — (String)

          The package's version.

        • PatchVersion — required — (String)

          The package's patch version.

        • OutputS3Location — required — (map)

          The package's output location.

          • BucketName — required — (String)

            The object's bucket.

          • ObjectKey — required — (String)

            The object's key.

      • CreatedTime — (Date)

        When the job was created.

      • LastUpdatedTime — (Date)

        When the job was updated.

      • Status — (String)

        The job's status.

        Possible values include:
        • "PENDING"
        • "SUCCEEDED"
        • "FAILED"
      • StatusMessage — (String)

        The job's status message.

      • JobTags — (Array<map>)

        The job's tags.

        • ResourceType — required — (String)

          The job's type.

          Possible values include:
          • "PACKAGE"
        • Tags — required — (map<String>)

          The job's tags.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describePackageVersion(params = {}, callback) ⇒ AWS.Request

Returns information about a package version.

Service Reference:

Examples:

Calling the describePackageVersion operation

var params = {
  PackageId: 'STRING_VALUE', /* required */
  PackageVersion: 'STRING_VALUE', /* required */
  OwnerAccount: 'STRING_VALUE',
  PatchVersion: 'STRING_VALUE'
};
panorama.describePackageVersion(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • OwnerAccount — (String)

      The version's owner account.

    • PackageId — (String)

      The version's ID.

    • PackageVersion — (String)

      The version's version.

    • PatchVersion — (String)

      The version's patch version.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • OwnerAccount — (String)

        The account ID of the version's owner.

      • PackageId — (String)

        The version's ID.

      • PackageArn — (String)

        The ARN of the package.

      • PackageName — (String)

        The version's name.

      • PackageVersion — (String)

        The version's version.

      • PatchVersion — (String)

        The version's patch version.

      • IsLatestPatch — (Boolean)

        Whether the version is the latest available.

      • Status — (String)

        The version's status.

        Possible values include:
        • "REGISTER_PENDING"
        • "REGISTER_COMPLETED"
        • "FAILED"
        • "DELETING"
      • StatusDescription — (String)

        The version's status description.

      • RegisteredTime — (Date)

        The version's registered time.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listApplicationInstanceDependencies(params = {}, callback) ⇒ AWS.Request

Returns a list of application instance dependencies.

Service Reference:

Examples:

Calling the listApplicationInstanceDependencies operation

var params = {
  ApplicationInstanceId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
panorama.listApplicationInstanceDependencies(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationInstanceId — (String)

      The application instance's ID.

    • MaxResults — (Integer)

      The maximum number of application instance dependencies to return in one page of results.

    • NextToken — (String)

      Specify the pagination token from a previous request to retrieve the next page of results.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • PackageObjects — (Array<map>)

        A list of package objects.

        • Name — required — (String)

          The object's name.

        • PackageVersion — required — (String)

          The object's package version.

        • PatchVersion — required — (String)

          The object's patch version.

      • NextToken — (String)

        A pagination token that's included if more results are available.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listApplicationInstanceNodeInstances(params = {}, callback) ⇒ AWS.Request

Returns a list of application node instances.

Service Reference:

Examples:

Calling the listApplicationInstanceNodeInstances operation

var params = {
  ApplicationInstanceId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
panorama.listApplicationInstanceNodeInstances(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationInstanceId — (String)

      The node instances' application instance ID.

    • MaxResults — (Integer)

      The maximum number of node instances to return in one page of results.

    • NextToken — (String)

      Specify the pagination token from a previous request to retrieve the next page of results.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • NodeInstances — (Array<map>)

        A list of node instances.

        • NodeInstanceId — required — (String)

          The instance's ID.

        • NodeId — (String)

          The node's ID.

        • PackageName — (String)

          The instance's package name.

        • PackageVersion — (String)

          The instance's package version.

        • PackagePatchVersion — (String)

          The instance's package patch version.

        • NodeName — (String)

          The instance's name.

        • CurrentStatus — required — (String)

          The instance's current status.

          Possible values include:
          • "RUNNING"
          • "ERROR"
          • "NOT_AVAILABLE"
      • NextToken — (String)

        A pagination token that's included if more results are available.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listApplicationInstances(params = {}, callback) ⇒ AWS.Request

Returns a list of application instances.

Service Reference:

Examples:

Calling the listApplicationInstances operation

var params = {
  DeviceId: 'STRING_VALUE',
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  StatusFilter: DEPLOYMENT_SUCCEEDED | DEPLOYMENT_ERROR | REMOVAL_SUCCEEDED | REMOVAL_FAILED | PROCESSING_DEPLOYMENT | PROCESSING_REMOVAL
};
panorama.listApplicationInstances(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DeviceId — (String)

      The application instances' device ID.

    • StatusFilter — (String)

      Only include instances with a specific status.

      Possible values include:
      • "DEPLOYMENT_SUCCEEDED"
      • "DEPLOYMENT_ERROR"
      • "REMOVAL_SUCCEEDED"
      • "REMOVAL_FAILED"
      • "PROCESSING_DEPLOYMENT"
      • "PROCESSING_REMOVAL"
    • MaxResults — (Integer)

      The maximum number of application instances to return in one page of results.

    • NextToken — (String)

      Specify the pagination token from a previous request to retrieve the next page of results.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ApplicationInstances — (Array<map>)

        A list of application instances.

        • Name — (String)

          The application instance's name.

        • ApplicationInstanceId — (String)

          The application instance's ID.

        • DefaultRuntimeContextDevice — (String)

          The device's ID.

        • DefaultRuntimeContextDeviceName — (String)

          The device's name.

        • Description — (String)

          The application instance's description.

        • Status — (String)

          The application instance's status.

          Possible values include:
          • "DEPLOYMENT_PENDING"
          • "DEPLOYMENT_REQUESTED"
          • "DEPLOYMENT_IN_PROGRESS"
          • "DEPLOYMENT_ERROR"
          • "DEPLOYMENT_SUCCEEDED"
          • "REMOVAL_PENDING"
          • "REMOVAL_REQUESTED"
          • "REMOVAL_IN_PROGRESS"
          • "REMOVAL_FAILED"
          • "REMOVAL_SUCCEEDED"
        • HealthStatus — (String)

          The application instance's health status.

          Possible values include:
          • "RUNNING"
          • "ERROR"
          • "NOT_AVAILABLE"
        • StatusDescription — (String)

          The application instance's status description.

        • CreatedTime — (Date)

          When the application instance was created.

        • Arn — (String)

          The application instance's ARN.

        • Tags — (map<String>)

          The application instance's tags.

      • NextToken — (String)

        A pagination token that's included if more results are available.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listDevices(params = {}, callback) ⇒ AWS.Request

Returns a list of devices.

Service Reference:

Examples:

Calling the listDevices operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
panorama.listDevices(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • NextToken — (String)

      Specify the pagination token from a previous request to retrieve the next page of results.

    • MaxResults — (Integer)

      The maximum number of devices to return in one page of results.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Devices — (Array<map>)

        A list of devices.

        • DeviceId — (String)

          The device's ID.

        • Name — (String)

          The device's name.

        • CreatedTime — (Date)

          When the device was created.

        • ProvisioningStatus — (String)

          The device's provisioning status.

          Possible values include:
          • "AWAITING_PROVISIONING"
          • "PENDING"
          • "SUCCEEDED"
          • "FAILED"
          • "ERROR"
          • "DELETING"
        • LastUpdatedTime — (Date)

          When the device was updated.

        • LeaseExpirationTime — (Date)

          The device's lease expiration time.

      • NextToken — (String)

        A pagination token that's included if more results are available.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listDevicesJobs(params = {}, callback) ⇒ AWS.Request

Returns a list of jobs.

Service Reference:

Examples:

Calling the listDevicesJobs operation

var params = {
  DeviceId: 'STRING_VALUE',
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
panorama.listDevicesJobs(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DeviceId — (String)

      Filter results by the job's target device ID.

    • NextToken — (String)

      Specify the pagination token from a previous request to retrieve the next page of results.

    • MaxResults — (Integer)

      The maximum number of device jobs to return in one page of results.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • DeviceJobs — (Array<map>)

        A list of jobs.

        • DeviceName — (String)

          The name of the target device

        • DeviceId — (String)

          The ID of the target device.

        • JobId — (String)

          The job's ID.

        • CreatedTime — (Date)

          When the job was created.

      • NextToken — (String)

        A pagination token that's included if more results are available.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listNodeFromTemplateJobs(params = {}, callback) ⇒ AWS.Request

Returns a list of camera stream node jobs.

Service Reference:

Examples:

Calling the listNodeFromTemplateJobs operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
panorama.listNodeFromTemplateJobs(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • NextToken — (String)

      Specify the pagination token from a previous request to retrieve the next page of results.

    • MaxResults — (Integer)

      The maximum number of node from template jobs to return in one page of results.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • NodeFromTemplateJobs — (Array<map>)

        A list of jobs.

        • JobId — (String)

          The job's ID.

        • TemplateType — (String)

          The job's template type.

          Possible values include:
          • "RTSP_CAMERA_STREAM"
        • Status — (String)

          The job's status.

          Possible values include:
          • "PENDING"
          • "SUCCEEDED"
          • "FAILED"
        • StatusMessage — (String)

          The job's status message.

        • CreatedTime — (Date)

          When the job was created.

        • NodeName — (String)

          The node's name.

      • NextToken — (String)

        A pagination token that's included if more results are available.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listNodes(params = {}, callback) ⇒ AWS.Request

Returns a list of nodes.

Service Reference:

Examples:

Calling the listNodes operation

var params = {
  Category: BUSINESS_LOGIC | ML_MODEL | MEDIA_SOURCE | MEDIA_SINK,
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  OwnerAccount: 'STRING_VALUE',
  PackageName: 'STRING_VALUE',
  PackageVersion: 'STRING_VALUE',
  PatchVersion: 'STRING_VALUE'
};
panorama.listNodes(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Category — (String)

      Search for nodes by category.

      Possible values include:
      • "BUSINESS_LOGIC"
      • "ML_MODEL"
      • "MEDIA_SOURCE"
      • "MEDIA_SINK"
    • OwnerAccount — (String)

      Search for nodes by the account ID of the nodes' owner.

    • PackageName — (String)

      Search for nodes by name.

    • PackageVersion — (String)

      Search for nodes by version.

    • PatchVersion — (String)

      Search for nodes by patch version.

    • NextToken — (String)

      Specify the pagination token from a previous request to retrieve the next page of results.

    • MaxResults — (Integer)

      The maximum number of nodes to return in one page of results.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Nodes — (Array<map>)

        A list of nodes.

        • NodeId — required — (String)

          The node's ID.

        • Name — required — (String)

          The node's name.

        • Category — required — (String)

          The node's category.

          Possible values include:
          • "BUSINESS_LOGIC"
          • "ML_MODEL"
          • "MEDIA_SOURCE"
          • "MEDIA_SINK"
        • OwnerAccount — (String)

          The account ID of the node's owner.

        • PackageName — required — (String)

          The node's package name.

        • PackageId — required — (String)

          The node's package ID.

        • PackageArn — (String)

          The node's ARN.

        • PackageVersion — required — (String)

          The node's package version.

        • PatchVersion — required — (String)

          The node's patch version.

        • Description — (String)

          The node's description.

        • CreatedTime — required — (Date)

          When the node was created.

      • NextToken — (String)

        A pagination token that's included if more results are available.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listPackageImportJobs(params = {}, callback) ⇒ AWS.Request

Returns a list of package import jobs.

Service Reference:

Examples:

Calling the listPackageImportJobs operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
panorama.listPackageImportJobs(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • NextToken — (String)

      Specify the pagination token from a previous request to retrieve the next page of results.

    • MaxResults — (Integer)

      The maximum number of package import jobs to return in one page of results.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • PackageImportJobs — (Array<map>)

        A list of package import jobs.

        • JobId — (String)

          The job's ID.

        • JobType — (String)

          The job's type.

          Possible values include:
          • "NODE_PACKAGE_VERSION"
        • Status — (String)

          The job's status.

          Possible values include:
          • "PENDING"
          • "SUCCEEDED"
          • "FAILED"
        • StatusMessage — (String)

          The job's status message.

        • CreatedTime — (Date)

          When the job was created.

        • LastUpdatedTime — (Date)

          When the job was updated.

      • NextToken — (String)

        A pagination token that's included if more results are available.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listPackages(params = {}, callback) ⇒ AWS.Request

Returns a list of packages.

Service Reference:

Examples:

Calling the listPackages operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
panorama.listPackages(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • MaxResults — (Integer)

      The maximum number of packages to return in one page of results.

    • NextToken — (String)

      Specify the pagination token from a previous request to retrieve the next page of results.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Packages — (Array<map>)

        A list of packages.

        • PackageId — (String)

          The package's ID.

        • PackageName — (String)

          The package's name.

        • Arn — (String)

          The package's ARN.

        • CreatedTime — (Date)

          When the package was created.

        • Tags — (map<String>)

          The package's tags.

      • NextToken — (String)

        A pagination token that's included if more results are available.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listTagsForResource(params = {}, callback) ⇒ AWS.Request

Returns a list of tags for a resource.

Service Reference:

Examples:

Calling the listTagsForResource operation

var params = {
  ResourceArn: 'STRING_VALUE' /* required */
};
panorama.listTagsForResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ResourceArn — (String)

      The resource's ARN.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Tags — (map<String>)

        A list of tags.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

provisionDevice(params = {}, callback) ⇒ AWS.Request

Creates a device and returns a configuration archive. The configuration archive is a ZIP file that contains a provisioning certificate that is valid for 5 minutes. Transfer the configuration archive to the device with the included USB storage device within 5 minutes.

Service Reference:

Examples:

Calling the provisionDevice operation

var params = {
  Name: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE',
  NetworkingConfiguration: {
    Ethernet0: {
      ConnectionType: STATIC_IP | DHCP, /* required */
      StaticIpConnectionInfo: {
        DefaultGateway: 'STRING_VALUE', /* required */
        Dns: [ /* required */
          'STRING_VALUE',
          /* more items */
        ],
        IpAddress: 'STRING_VALUE', /* required */
        Mask: 'STRING_VALUE' /* required */
      }
    },
    Ethernet1: {
      ConnectionType: STATIC_IP | DHCP, /* required */
      StaticIpConnectionInfo: {
        DefaultGateway: 'STRING_VALUE', /* required */
        Dns: [ /* required */
          'STRING_VALUE',
          /* more items */
        ],
        IpAddress: 'STRING_VALUE', /* required */
        Mask: 'STRING_VALUE' /* required */
      }
    }
  },
  Tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
panorama.provisionDevice(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Name — (String)

      A name for the device.

    • Description — (String)

      A description for the device.

    • Tags — (map<String>)

      Tags for the device.

    • NetworkingConfiguration — (map)

      A networking configuration for the device.

      • Ethernet0 — (map)

        Settings for Ethernet port 0.

        • ConnectionType — required — (String)

          How the device gets an IP address.

          Possible values include:
          • "STATIC_IP"
          • "DHCP"
        • StaticIpConnectionInfo — (map)

          Network configuration for a static IP connection.

          • IpAddress — required — (String)

            The connection's IP address.

          • Mask — required — (String)

            The connection's DNS mask.

          • Dns — required — (Array<String>)

            The connection's DNS address.

          • DefaultGateway — required — (String)

            The connection's default gateway.

      • Ethernet1 — (map)

        Settings for Ethernet port 1.

        • ConnectionType — required — (String)

          How the device gets an IP address.

          Possible values include:
          • "STATIC_IP"
          • "DHCP"
        • StaticIpConnectionInfo — (map)

          Network configuration for a static IP connection.

          • IpAddress — required — (String)

            The connection's IP address.

          • Mask — required — (String)

            The connection's DNS mask.

          • Dns — required — (Array<String>)

            The connection's DNS address.

          • DefaultGateway — required — (String)

            The connection's default gateway.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • DeviceId — (String)

        The device's ID.

      • Arn — (String)

        The device's ARN.

      • Status — (String)

        The device's status.

        Possible values include:
        • "AWAITING_PROVISIONING"
        • "PENDING"
        • "SUCCEEDED"
        • "FAILED"
        • "ERROR"
        • "DELETING"
      • Certificates — (Buffer(Node.js), Typed Array(Browser))

        The device's configuration bundle.

      • IotThingName — (String)

        The device's IoT thing name.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

registerPackageVersion(params = {}, callback) ⇒ AWS.Request

Registers a package version.

Service Reference:

Examples:

Calling the registerPackageVersion operation

var params = {
  PackageId: 'STRING_VALUE', /* required */
  PackageVersion: 'STRING_VALUE', /* required */
  PatchVersion: 'STRING_VALUE', /* required */
  MarkLatest: true || false,
  OwnerAccount: 'STRING_VALUE'
};
panorama.registerPackageVersion(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • OwnerAccount — (String)

      An owner account.

    • PackageId — (String)

      A package ID.

    • PackageVersion — (String)

      A package version.

    • PatchVersion — (String)

      A patch version.

    • MarkLatest — (Boolean)

      Whether to mark the new version as the latest version.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

removeApplicationInstance(params = {}, callback) ⇒ AWS.Request

Removes an application instance.

Service Reference:

Examples:

Calling the removeApplicationInstance operation

var params = {
  ApplicationInstanceId: 'STRING_VALUE' /* required */
};
panorama.removeApplicationInstance(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationInstanceId — (String)

      An application instance ID.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

tagResource(params = {}, callback) ⇒ AWS.Request

Tags a resource.

Service Reference:

Examples:

Calling the tagResource operation

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  Tags: { /* required */
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
panorama.tagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ResourceArn — (String)

      The resource's ARN.

    • Tags — (map<String>)

      Tags for the resource.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

untagResource(params = {}, callback) ⇒ AWS.Request

Removes tags from a resource.

Service Reference:

Examples:

Calling the untagResource operation

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  TagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
panorama.untagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ResourceArn — (String)

      The resource's ARN.

    • TagKeys — (Array<String>)

      Tag keys to remove.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

updateDeviceMetadata(params = {}, callback) ⇒ AWS.Request

Updates a device's metadata.

Service Reference:

Examples:

Calling the updateDeviceMetadata operation

var params = {
  DeviceId: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE'
};
panorama.updateDeviceMetadata(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DeviceId — (String)

      The device's ID.

    • Description — (String)

      A description for the device.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • DeviceId — (String)

        The device's ID.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.