DescribeNodeFromTemplateJobCommand

Suggest an Edit

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

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { PanoramaClient, DescribeNodeFromTemplateJobCommand } from "@aws-sdk/client-panorama"; // ES Modules import
// const { PanoramaClient, DescribeNodeFromTemplateJobCommand } = require("@aws-sdk/client-panorama"); // CommonJS import
const client = new PanoramaClient(config);
const input = { // DescribeNodeFromTemplateJobRequest
  JobId: "STRING_VALUE", // required
};
const command = new DescribeNodeFromTemplateJobCommand(input);
const response = await client.send(command);
// { // DescribeNodeFromTemplateJobResponse
//   JobId: "STRING_VALUE", // required
//   Status: "STRING_VALUE", // required
//   StatusMessage: "STRING_VALUE", // required
//   CreatedTime: new Date("TIMESTAMP"), // required
//   LastUpdatedTime: new Date("TIMESTAMP"), // required
//   OutputPackageName: "STRING_VALUE", // required
//   OutputPackageVersion: "STRING_VALUE", // required
//   NodeName: "STRING_VALUE", // required
//   NodeDescription: "STRING_VALUE",
//   TemplateType: "STRING_VALUE", // required
//   TemplateParameters: { // TemplateParametersMap // required
//     "<keys>": "STRING_VALUE",
//   },
//   JobTags: [ // JobTagsList
//     { // JobResourceTags
//       ResourceType: "STRING_VALUE", // required
//       Tags: { // TagMap // required
//         "<keys>": "STRING_VALUE",
//       },
//     },
//   ],
// };

DescribeNodeFromTemplateJobCommand Input

See DescribeNodeFromTemplateJobCommandInput for more details

Parameter
Type
Description
JobId
Required
string | undefined

The job's ID.

DescribeNodeFromTemplateJobCommand Output

See DescribeNodeFromTemplateJobCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
CreatedTime
Required
Date | undefined

When the job was created.

JobId
Required
string | undefined

The job's ID.

LastUpdatedTime
Required
Date | undefined

When the job was updated.

NodeName
Required
string | undefined

The node's name.

OutputPackageName
Required
string | undefined

The job's output package name.

OutputPackageVersion
Required
string | undefined

The job's output package version.

Status
Required
NodeFromTemplateJobStatus | undefined

The job's status.

StatusMessage
Required
string | undefined

The job's status message.

TemplateParameters
Required
Record<string, string> | undefined

The job's template parameters.

TemplateType
Required
TemplateType | undefined

The job's template type.

JobTags
JobResourceTags[] | undefined

The job's tags.

NodeDescription
string | undefined

The node's description.

Throws

Name
Fault
Details
AccessDeniedException
client

The requestor does not have permission to access the target action or resource.

ConflictException
client

The target resource is in use.

InternalServerException
server

An internal error occurred.

ValidationException
client

The request contains an invalid parameter value.

PanoramaServiceException
Base exception class for all service exceptions from Panorama service.