Class: AWS.Panorama

var params = {
  DeviceIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  JobType: OTA | REBOOT, /* required */
  DeviceJobConfig: {
    OTAJobConfig: {
      ImageVersion: 'STRING_VALUE', /* required */
      AllowMajorVersionUpdate: true || false
    }
  }
};
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>)

    ID of target device.

  • DeviceJobConfig — (map)

    Configuration settings for a software update job.

    • OTAJobConfig — (map)

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

      • AllowMajorVersionUpdate — (Boolean)

        Whether to apply the update if it is a major version change.

      • ImageVersion — required — (String)

        The target version of the device software.

  • JobType — (String)

    The type of job to run.

    Possible values include:
    • "OTA"
    • "REBOOT"

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.

      • DeviceId — (String)

        The target device's ID.

      • JobId — (String)

        The job's ID.

Returns:

• (AWS.Request) —

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

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: {}) —
  • 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.

  • NodeDescription — (String)

    A description for the node.

  • NodeName — (String)

    A name for the node.

  • OutputPackageName — (String)

    An output package name for the node.

  • OutputPackageVersion — (String)

    An output package version for the node.

  • TemplateParameters — (map<String>)

    Template parameters for the node.

  • TemplateType — (String)

    The type of node.

    Possible values include:
    • "RTSP_CAMERA_STREAM"

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.

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:

    • Arn — (String)

      The package's ARN.

    • PackageId — (String)

      The package's ID.

    • StorageLocation — (map)

      The package's storage location.

      • BinaryPrefixLocation — required — (String)

        The location's binary prefix.

      • Bucket — required — (String)

        The location's bucket.

      • GeneratedPrefixLocation — required — (String)

        The location's generated prefix.

      • ManifestPrefixLocation — required — (String)

        The location's manifest prefix.

      • RepoPrefixLocation — required — (String)

        The location's repo prefix.

Returns:

• (AWS.Request) —

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

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 | MARKETPLACE_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: {}) —
  • ClientToken — (String)

    A client token for the package import job.

  • 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.

        • BucketName — required — (String)

          A bucket name.

        • ObjectKey — required — (String)

          An object key.

        • Region — (String)

          The bucket's Region.

  • 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.

  • JobType — (String)

    A job type for the package import job.

    Possible values include:
    • "NODE_PACKAGE_VERSION"
    • "MARKETPLACE_NODE_PACKAGE_VERSION"
  • OutputConfig — (map)

    An output config for the package import job.

    • PackageVersionOutputConfig — (map)

      The package version's output configuration.

      • MarkLatest — (Boolean)

        Indicates that the version is recommended for all users.

      • PackageName — required — (String)

        The output's package name.

      • PackageVersion — required — (String)

        The output's package 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:

    • JobId — (String)

      The job's ID.

Returns:

• (AWS.Request) —

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

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.

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: {}) —
  • ForceDelete — (Boolean)

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

  • 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.

Returns:

• (AWS.Request) —

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

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.

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:

    • ApplicationInstanceId — (String)

      The application instance's ID.

    • ApplicationInstanceIdToReplace — (String)

      The ID of the application instance that this instance replaced.

    • Arn — (String)

      The application instance's ARN.

    • CreatedTime — (Date)

      When the application instance was created.

    • DefaultRuntimeContextDevice — (String)

      The device's ID.

    • DefaultRuntimeContextDeviceName — (String)

      The device's bane.

    • Description — (String)

      The application instance's description.

    • HealthStatus — (String)

      The application instance's health status.

      Possible values include:
      • "RUNNING"
      • "ERROR"
      • "NOT_AVAILABLE"
    • LastUpdatedTime — (Date)

      The application instance was updated.

    • Name — (String)

      The application instance's name.

    • RuntimeContextStates — (Array<map>)

      The application instance's state.

      • DesiredState — required — (String)

        The application's desired state.

        Possible values include:
        • "RUNNING"
        • "STOPPED"
        • "REMOVED"
      • DeviceReportedStatus — required — (String)

        The application's reported status.

        Possible values include:
        • "STOPPING"
        • "STOPPED"
        • "STOP_ERROR"
        • "REMOVAL_FAILED"
        • "REMOVAL_IN_PROGRESS"
        • "STARTING"
        • "RUNNING"
        • "INSTALL_ERROR"
        • "LAUNCHED"
        • "LAUNCH_ERROR"
        • "INSTALL_IN_PROGRESS"
      • DeviceReportedTime — required — (Date)

        When the device reported the application's state.

      • RuntimeContextName — required — (String)

        The device's name.

    • 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"
      • "DEPLOYMENT_FAILED"
    • StatusDescription — (String)

      The application instance's status description.

    • Tags — (map<String>)

      The application instance's tags.

Returns:

• (AWS.Request) —

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

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:

    • ApplicationInstanceId — (String)

      The application instance's ID.

    • ApplicationInstanceIdToReplace — (String)

      The ID of the application instance that this instance replaced.

    • CreatedTime — (Date)

      When the application instance was created.

    • DefaultRuntimeContextDevice — (String)

      The application instance's default runtime context device.

    • Description — (String)

      The application instance's description.

    • ManifestOverridesPayload — (map)

      Parameter overrides for the configuration manifest.

      • PayloadData — (String)

        The overrides document.

    • ManifestPayload — (map)

      The application instance's configuration manifest.

      • PayloadData — (String)

        The application manifest.

    • Name — (String)

      The application instance's name.

Returns:

• (AWS.Request) —

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

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:

    • AlternateSoftwares — (Array<map>)

      Beta software releases available for the device.

      • Version — (String)

        The appliance software version.

    • Arn — (String)

      The device's ARN.

    • Brand — (String)

      The device's maker.

      Possible values include:
      • "AWS_PANORAMA"
      • "LENOVO"
    • CreatedTime — (Date)

      When the device was created.

    • CurrentNetworkingStatus — (map)

      The device's networking status.

      • Ethernet0Status — (map)

        The status of Ethernet port 0.

        • ConnectionStatus — (String)

          The device's connection status.

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

          The device's physical address.

        • IpAddress — (String)

          The device's IP address.

      • Ethernet1Status — (map)

        The status of Ethernet port 1.

        • ConnectionStatus — (String)

          The device's connection status.

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

          The device's physical address.

        • IpAddress — (String)

          The device's IP address.

      • LastUpdatedTime — (Date)

        When the network status changed.

      • NtpStatus — (map)

        Details about a network time protocol (NTP) server connection.

        • ConnectionStatus — (String)

          The connection's status.

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

          The IP address of the server.

        • NtpServerName — (String)

          The domain name of the server.

    • CurrentSoftware — (String)

      The device's current software version.

    • Description — (String)

      The device's description.

    • DeviceAggregatedStatus — (String)

      A device's aggregated status. Including the device's connection status, provisioning status, and lease status.

      Possible values include:
      • "ERROR"
      • "AWAITING_PROVISIONING"
      • "PENDING"
      • "FAILED"
      • "DELETING"
      • "ONLINE"
      • "OFFLINE"
      • "LEASE_EXPIRED"
      • "UPDATE_NEEDED"
      • "REBOOTING"
    • DeviceConnectionStatus — (String)

      The device's connection status.

      Possible values include:
      • "ONLINE"
      • "OFFLINE"
      • "AWAITING_CREDENTIALS"
      • "NOT_AVAILABLE"
      • "ERROR"
    • DeviceId — (String)

      The device's ID.

    • LatestAlternateSoftware — (String)

      The most recent beta software release.

    • LatestDeviceJob — (map)

      A device's latest job. Includes the target image version, and the job status.

      • ImageVersion — (String)

        The target version of the device software.

      • JobType — (String)

        The job's type.

        Possible values include:
        • "OTA"
        • "REBOOT"
      • Status — (String)

        Status of the latest device job.

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

      The latest software version available for the device.

    • LeaseExpirationTime — (Date)

      The device's lease expiration time.

    • Name — (String)

      The device's name.

    • 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.

          • DefaultGateway — required — (String)

            The connection's default gateway.

          • Dns — required — (Array<String>)

            The connection's DNS address.

          • IpAddress — required — (String)

            The connection's IP address.

          • Mask — required — (String)

            The connection's DNS mask.

      • 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.

          • DefaultGateway — required — (String)

            The connection's default gateway.

          • Dns — required — (Array<String>)

            The connection's DNS address.

          • IpAddress — required — (String)

            The connection's IP address.

          • Mask — required — (String)

            The connection's DNS mask.

      • Ntp — (map)

        Network time protocol (NTP) server settings.

        • NtpServers — required — (Array<String>)

          NTP servers to use, in order of preference.

    • ProvisioningStatus — (String)

      The device's provisioning status.

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

      The device's serial number.

    • Tags — (map<String>)

      The device's tags.

    • Type — (String)

      The device's type.

      Possible values include:
      • "PANORAMA_APPLIANCE_DEVELOPER_KIT"
      • "PANORAMA_APPLIANCE"

Returns:

• (AWS.Request) —

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

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:

    • CreatedTime — (Date)

      When the job was created.

    • DeviceArn — (String)

      The device's ARN.

    • DeviceId — (String)

      The device's ID.

    • 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.

    • JobId — (String)

      The job's ID.

    • JobType — (String)

      The job's type.

      Possible values include:
      • "OTA"
      • "REBOOT"
    • Status — (String)

      The job's status.

      Possible values include:
      • "PENDING"
      • "IN_PROGRESS"
      • "VERIFYING"
      • "REBOOTING"
      • "DOWNLOADING"
      • "COMPLETED"
      • "FAILED"

Returns:

• (AWS.Request) —

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

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:

    • AssetName — (String)

      The node's asset name.

    • Category — (String)

      The node's category.

      Possible values include:
      • "BUSINESS_LOGIC"
      • "ML_MODEL"
      • "MEDIA_SOURCE"
      • "MEDIA_SINK"
    • CreatedTime — (Date)

      When the node was created.

    • Description — (String)

      The node's description.

    • LastUpdatedTime — (Date)

      When the node was updated.

    • Name — (String)

      The node's name.

    • NodeId — (String)

      The node's ID.

    • NodeInterface — (map)

      The node's interface.

      • Inputs — required — (Array<map>)

        The node interface's inputs.

        • DefaultValue — (String)

          The input port's default value.

        • Description — (String)

          The input port's description.

        • MaxConnections — (Integer)

          The input port's max connections.

        • Name — (String)

          The input port's name.

        • Type — (String)

          The input port's type.

          Possible values include:
          • "BOOLEAN"
          • "STRING"
          • "INT32"
          • "FLOAT32"
          • "MEDIA"
      • Outputs — required — (Array<map>)

        The node interface's outputs.

        • Description — (String)

          The output port's description.

        • Name — (String)

          The output port's name.

        • Type — (String)

          The output port's type.

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

      The account ID of the node's owner.

    • PackageArn — (String)

      The node's ARN.

    • PackageId — (String)

      The node's package ID.

    • PackageName — (String)

      The node's package name.

    • PackageVersion — (String)

      The node's package version.

    • PatchVersion — (String)

      The node's patch version.

Returns:

• (AWS.Request) —

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

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:

    • CreatedTime — (Date)

      When the job was created.

    • JobId — (String)

      The job's ID.

    • 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.

    • LastUpdatedTime — (Date)

      When the job was updated.

    • NodeDescription — (String)

      The node's description.

    • NodeName — (String)

      The node's name.

    • OutputPackageName — (String)

      The job's output package name.

    • OutputPackageVersion — (String)

      The job's output package version.

    • Status — (String)

      The job's status.

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

      The job's status message.

    • TemplateParameters — (map<String>)

      The job's template parameters.

    • TemplateType — (String)

      The job's template type.

      Possible values include:
      • "RTSP_CAMERA_STREAM"

Returns:

• (AWS.Request) —

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

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:

    • Arn — (String)

      The package's ARN.

    • CreatedTime — (Date)

      When the package was created.

    • PackageId — (String)

      The package's ID.

    • PackageName — (String)

      The package's name.

    • ReadAccessPrincipalArns — (Array<String>)

      ARNs of accounts that have read access to the package.

    • StorageLocation — (map)

      The package's storage location.

      • BinaryPrefixLocation — required — (String)

        The location's binary prefix.

      • Bucket — required — (String)

        The location's bucket.

      • GeneratedPrefixLocation — required — (String)

        The location's generated prefix.

      • ManifestPrefixLocation — required — (String)

        The location's manifest prefix.

      • RepoPrefixLocation — required — (String)

        The location's repo prefix.

    • Tags — (map<String>)

      The package's tags.

    • WriteAccessPrincipalArns — (Array<String>)

      ARNs of accounts that have write access to the package.

Returns:

• (AWS.Request) —

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

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:

    • ClientToken — (String)

      The job's client token.

    • CreatedTime — (Date)

      When the job was created.

    • InputConfig — (map)

      The job's input config.

      • PackageVersionInputConfig — (map)

        The package version's input configuration.

        • S3Location — required — (map)

          A location in Amazon S3.

          • BucketName — required — (String)

            A bucket name.

          • ObjectKey — required — (String)

            An object key.

          • Region — (String)

            The bucket's Region.

    • JobId — (String)

      The job's ID.

    • 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.

    • JobType — (String)

      The job's type.

      Possible values include:
      • "NODE_PACKAGE_VERSION"
      • "MARKETPLACE_NODE_PACKAGE_VERSION"
    • LastUpdatedTime — (Date)

      When the job was updated.

    • Output — (map)

      The job's output.

      • OutputS3Location — required — (map)

        The package's output location.

        • BucketName — required — (String)

          The object's bucket.

        • ObjectKey — required — (String)

          The object's key.

      • PackageId — required — (String)

        The package's ID.

      • PackageVersion — required — (String)

        The package's version.

      • PatchVersion — required — (String)

        The package's patch version.

    • OutputConfig — (map)

      The job's output config.

      • PackageVersionOutputConfig — (map)

        The package version's output configuration.

        • MarkLatest — (Boolean)

          Indicates that the version is recommended for all users.

        • PackageName — required — (String)

          The output's package name.

        • PackageVersion — required — (String)

          The output's package version.

    • Status — (String)

      The job's status.

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

      The job's status message.

Returns:

• (AWS.Request) —

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

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:

    • IsLatestPatch — (Boolean)

      Whether the version is the latest available.

    • OwnerAccount — (String)

      The account ID of the version's owner.

    • PackageArn — (String)

      The ARN of the package.

    • PackageId — (String)

      The version's ID.

    • PackageName — (String)

      The version's name.

    • PackageVersion — (String)

      The version's version.

    • PatchVersion — (String)

      The version's patch version.

    • RegisteredTime — (Date)

      The version's registered time.

    • Status — (String)

      The version's status.

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

      The version's status description.

Returns:

• (AWS.Request) —

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

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:

    • NextToken — (String)

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

    • 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.

Returns:

• (AWS.Request) —

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

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:

    • NextToken — (String)

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

    • NodeInstances — (Array<map>)

      A list of node instances.

      • CurrentStatus — required — (String)

        The instance's current status.

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

        The node's ID.

      • NodeInstanceId — required — (String)

        The instance's ID.

      • NodeName — (String)

        The instance's name.

      • PackageName — (String)

        The instance's package name.

      • PackagePatchVersion — (String)

        The instance's package patch version.

      • PackageVersion — (String)

        The instance's package version.

Returns:

• (AWS.Request) —

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

var params = {
  DeviceId: 'STRING_VALUE',
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  StatusFilter: DEPLOYMENT_SUCCEEDED | DEPLOYMENT_ERROR | REMOVAL_SUCCEEDED | REMOVAL_FAILED | PROCESSING_DEPLOYMENT | PROCESSING_REMOVAL | DEPLOYMENT_FAILED
};
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.

  • 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.

  • StatusFilter — (String)

    Only include instances with a specific status.

    Possible values include:
    • "DEPLOYMENT_SUCCEEDED"
    • "DEPLOYMENT_ERROR"
    • "REMOVAL_SUCCEEDED"
    • "REMOVAL_FAILED"
    • "PROCESSING_DEPLOYMENT"
    • "PROCESSING_REMOVAL"
    • "DEPLOYMENT_FAILED"

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.

      • ApplicationInstanceId — (String)

        The application instance's ID.

      • Arn — (String)

        The application instance's ARN.

      • CreatedTime — (Date)

        When the application instance was created.

      • DefaultRuntimeContextDevice — (String)

        The device's ID.

      • DefaultRuntimeContextDeviceName — (String)

        The device's name.

      • Description — (String)

        The application instance's description.

      • HealthStatus — (String)

        The application instance's health status.

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

        The application instance's name.

      • RuntimeContextStates — (Array<map>)

        The application's state.

        • DesiredState — required — (String)

          The application's desired state.

          Possible values include:
          • "RUNNING"
          • "STOPPED"
          • "REMOVED"
        • DeviceReportedStatus — required — (String)

          The application's reported status.

          Possible values include:
          • "STOPPING"
          • "STOPPED"
          • "STOP_ERROR"
          • "REMOVAL_FAILED"
          • "REMOVAL_IN_PROGRESS"
          • "STARTING"
          • "RUNNING"
          • "INSTALL_ERROR"
          • "LAUNCHED"
          • "LAUNCH_ERROR"
          • "INSTALL_IN_PROGRESS"
        • DeviceReportedTime — required — (Date)

          When the device reported the application's state.

        • RuntimeContextName — required — (String)

          The device's name.

      • 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"
        • "DEPLOYMENT_FAILED"
      • StatusDescription — (String)

        The application instance's status description.

      • 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.

var params = {
  DeviceAggregatedStatusFilter: ERROR | AWAITING_PROVISIONING | PENDING | FAILED | DELETING | ONLINE | OFFLINE | LEASE_EXPIRED | UPDATE_NEEDED | REBOOTING,
  MaxResults: 'NUMBER_VALUE',
  NameFilter: 'STRING_VALUE',
  NextToken: 'STRING_VALUE',
  SortBy: DEVICE_ID | CREATED_TIME | NAME | DEVICE_AGGREGATED_STATUS,
  SortOrder: ASCENDING | DESCENDING
};
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: {}) —
  • DeviceAggregatedStatusFilter — (String)

    Filter based on a device's status.

    Possible values include:
    • "ERROR"
    • "AWAITING_PROVISIONING"
    • "PENDING"
    • "FAILED"
    • "DELETING"
    • "ONLINE"
    • "OFFLINE"
    • "LEASE_EXPIRED"
    • "UPDATE_NEEDED"
    • "REBOOTING"
  • MaxResults — (Integer)

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

  • NameFilter — (String)

    Filter based on device's name. Prefixes supported.

  • NextToken — (String)

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

  • SortBy — (String)

    The target column to be sorted on. Default column sort is CREATED_TIME.

    Possible values include:
    • "DEVICE_ID"
    • "CREATED_TIME"
    • "NAME"
    • "DEVICE_AGGREGATED_STATUS"
  • SortOrder — (String)

    The sorting order for the returned list. SortOrder is DESCENDING by default based on CREATED_TIME. Otherwise, SortOrder is ASCENDING.

    Possible values include:
    • "ASCENDING"
    • "DESCENDING"

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.

      • Brand — (String)

        The device's maker.

        Possible values include:
        • "AWS_PANORAMA"
        • "LENOVO"
      • CreatedTime — (Date)

        When the device was created.

      • CurrentSoftware — (String)

        A device's current software.

      • Description — (String)

        A description for the device.

      • DeviceAggregatedStatus — (String)

        A device's aggregated status. Including the device's connection status, provisioning status, and lease status.

        Possible values include:
        • "ERROR"
        • "AWAITING_PROVISIONING"
        • "PENDING"
        • "FAILED"
        • "DELETING"
        • "ONLINE"
        • "OFFLINE"
        • "LEASE_EXPIRED"
        • "UPDATE_NEEDED"
        • "REBOOTING"
      • DeviceId — (String)

        The device's ID.

      • LastUpdatedTime — (Date)

        When the device was updated.

      • LatestDeviceJob — (map)

        A device's latest job. Includes the target image version, and the update job status.

        • ImageVersion — (String)

          The target version of the device software.

        • JobType — (String)

          The job's type.

          Possible values include:
          • "OTA"
          • "REBOOT"
        • Status — (String)

          Status of the latest device job.

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

        The device's lease expiration time.

      • Name — (String)

        The device's name.

      • ProvisioningStatus — (String)

        The device's provisioning status.

        Possible values include:
        • "AWAITING_PROVISIONING"
        • "PENDING"
        • "SUCCEEDED"
        • "FAILED"
        • "ERROR"
        • "DELETING"
      • Tags — (map<String>)

        The device's tags.

      • Type — (String)

        The device's type.

        Possible values include:
        • "PANORAMA_APPLIANCE_DEVELOPER_KIT"
        • "PANORAMA_APPLIANCE"
    • 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.

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.

  • MaxResults — (Integer)

    The maximum number of device jobs 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:

    • DeviceJobs — (Array<map>)

      A list of jobs.

      • CreatedTime — (Date)

        When the job was created.

      • DeviceId — (String)

        The ID of the target device.

      • DeviceName — (String)

        The name of the target device

      • JobId — (String)

        The job's ID.

      • JobType — (String)

        The job's type.

        Possible values include:
        • "OTA"
        • "REBOOT"
    • 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.

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: {}) —
  • MaxResults — (Integer)

    The maximum number of node from template jobs 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:

    • NextToken — (String)

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

    • NodeFromTemplateJobs — (Array<map>)

      A list of jobs.

      • CreatedTime — (Date)

        When the job was created.

      • JobId — (String)

        The job's ID.

      • NodeName — (String)

        The node's name.

      • Status — (String)

        The job's status.

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

        The job's status message.

      • TemplateType — (String)

        The job's template type.

        Possible values include:
        • "RTSP_CAMERA_STREAM"

Returns:

• (AWS.Request) —

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

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"
  • MaxResults — (Integer)

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

  • NextToken — (String)

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

  • 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.

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:

    • NextToken — (String)

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

    • Nodes — (Array<map>)

      A list of nodes.

      • Category — required — (String)

        The node's category.

        Possible values include:
        • "BUSINESS_LOGIC"
        • "ML_MODEL"
        • "MEDIA_SOURCE"
        • "MEDIA_SINK"
      • CreatedTime — required — (Date)

        When the node was created.

      • Description — (String)

        The node's description.

      • Name — required — (String)

        The node's name.

      • NodeId — required — (String)

        The node's ID.

      • OwnerAccount — (String)

        The account ID of the node's owner.

      • PackageArn — (String)

        The node's ARN.

      • PackageId — required — (String)

        The node's package ID.

      • PackageName — required — (String)

        The node's package name.

      • PackageVersion — required — (String)

        The node's package version.

      • PatchVersion — required — (String)

        The node's patch version.

Returns:

• (AWS.Request) —

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

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: {}) —
  • MaxResults — (Integer)

    The maximum number of package import jobs 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:

    • NextToken — (String)

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

    • PackageImportJobs — (Array<map>)

      A list of package import jobs.

      • CreatedTime — (Date)

        When the job was created.

      • JobId — (String)

        The job's ID.

      • JobType — (String)

        The job's type.

        Possible values include:
        • "NODE_PACKAGE_VERSION"
        • "MARKETPLACE_NODE_PACKAGE_VERSION"
      • 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.

Returns:

• (AWS.Request) —

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

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:

    • NextToken — (String)

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

    • Packages — (Array<map>)

      A list of packages.

      • Arn — (String)

        The package's ARN.

      • CreatedTime — (Date)

        When the package was created.

      • PackageId — (String)

        The package's ID.

      • PackageName — (String)

        The package's name.

      • Tags — (map<String>)

        The package's tags.

Returns:

• (AWS.Request) —

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

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.

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 */
      }
    },
    Ntp: {
      NtpServers: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    }
  },
  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: {}) —
  • Description — (String)

    A description for the device.

  • Name — (String)

    A name 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.

        • DefaultGateway — required — (String)

          The connection's default gateway.

        • Dns — required — (Array<String>)

          The connection's DNS address.

        • IpAddress — required — (String)

          The connection's IP address.

        • Mask — required — (String)

          The connection's DNS mask.

    • 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.

        • DefaultGateway — required — (String)

          The connection's default gateway.

        • Dns — required — (Array<String>)

          The connection's DNS address.

        • IpAddress — required — (String)

          The connection's IP address.

        • Mask — required — (String)

          The connection's DNS mask.

    • Ntp — (map)

      Network time protocol (NTP) server settings.

      • NtpServers — required — (Array<String>)

        NTP servers to use, in order of preference.

  • Tags — (map<String>)

    Tags 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:

    • Arn — (String)

      The device's ARN.

    • Certificates — (Buffer(Node.js), Typed Array(Browser))

      The device's configuration bundle.

    • DeviceId — (String)

      The device's ID.

    • IotThingName — (String)

      The device's IoT thing name.

    • Status — (String)

      The device's status.

      Possible values include:
      • "AWAITING_PROVISIONING"
      • "PENDING"
      • "SUCCEEDED"
      • "FAILED"
      • "ERROR"
      • "DELETING"

Returns:

• (AWS.Request) —

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

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: {}) —
  • MarkLatest — (Boolean)

    Whether to mark the new version as the latest version.

  • OwnerAccount — (String)

    An owner account.

  • PackageId — (String)

    A package ID.

  • PackageVersion — (String)

    A package version.

  • PatchVersion — (String)

    A 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.

Returns:

• (AWS.Request) —

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

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.

var params = {
  ApplicationInstanceId: 'STRING_VALUE', /* required */
  NodeSignals: [ /* required */
    {
      NodeInstanceId: 'STRING_VALUE', /* required */
      Signal: PAUSE | RESUME /* required */
    },
    /* more items */
  ]
};
panorama.signalApplicationInstanceNodeInstances(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.

  • NodeSignals — (Array<map>)

    A list of signals.

    • NodeInstanceId — required — (String)

      The camera node's name, from the application manifest.

    • Signal — required — (String)

      The signal value.

      Possible values include:
      • "PAUSE"
      • "RESUME"

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)

      An application instance ID.

Returns:

• (AWS.Request) —

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

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.

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.

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: {}) —
  • Description — (String)

    A description for the device.

  • 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.