DescribePackageImportJobCommand

Suggest an Edit

Returns information about a package import job.

Example Syntax

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

import { PanoramaClient, DescribePackageImportJobCommand } from "@aws-sdk/client-panorama"; // ES Modules import
// const { PanoramaClient, DescribePackageImportJobCommand } = require("@aws-sdk/client-panorama"); // CommonJS import
const client = new PanoramaClient(config);
const input = { // DescribePackageImportJobRequest
  JobId: "STRING_VALUE", // required
};
const command = new DescribePackageImportJobCommand(input);
const response = await client.send(command);
// { // DescribePackageImportJobResponse
//   JobId: "STRING_VALUE", // required
//   ClientToken: "STRING_VALUE",
//   JobType: "STRING_VALUE", // required
//   InputConfig: { // PackageImportJobInputConfig
//     PackageVersionInputConfig: { // PackageVersionInputConfig
//       S3Location: { // S3Location
//         Region: "STRING_VALUE",
//         BucketName: "STRING_VALUE", // required
//         ObjectKey: "STRING_VALUE", // required
//       },
//     },
//   },
//   OutputConfig: { // PackageImportJobOutputConfig
//     PackageVersionOutputConfig: { // PackageVersionOutputConfig
//       PackageName: "STRING_VALUE", // required
//       PackageVersion: "STRING_VALUE", // required
//       MarkLatest: true || false,
//     },
//   },
//   Output: { // PackageImportJobOutput
//     PackageId: "STRING_VALUE", // required
//     PackageVersion: "STRING_VALUE", // required
//     PatchVersion: "STRING_VALUE", // required
//     OutputS3Location: { // OutPutS3Location
//       BucketName: "STRING_VALUE", // required
//       ObjectKey: "STRING_VALUE", // required
//     },
//   },
//   CreatedTime: new Date("TIMESTAMP"), // required
//   LastUpdatedTime: new Date("TIMESTAMP"), // required
//   Status: "STRING_VALUE", // required
//   StatusMessage: "STRING_VALUE", // required
//   JobTags: [ // JobTagsList
//     { // JobResourceTags
//       ResourceType: "STRING_VALUE", // required
//       Tags: { // TagMap // required
//         "<keys>": "STRING_VALUE",
//       },
//     },
//   ],
// };

DescribePackageImportJobCommand Input

See DescribePackageImportJobCommandInput for more details

Parameter
Type
Description
JobId
Required
string | undefined

The job's ID.

DescribePackageImportJobCommand Output

See DescribePackageImportJobCommandOutput for details

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

When the job was created.

InputConfig
Required
PackageImportJobInputConfig | undefined

The job's input config.

JobId
Required
string | undefined

The job's ID.

JobType
Required
PackageImportJobType | undefined

The job's type.

LastUpdatedTime
Required
Date | undefined

When the job was updated.

Output
Required
PackageImportJobOutput | undefined

The job's output.

OutputConfig
Required
PackageImportJobOutputConfig | undefined

The job's output config.

Status
Required
PackageImportJobStatus | undefined

The job's status.

StatusMessage
Required
string | undefined

The job's status message.

ClientToken
string | undefined

The job's client token.

JobTags
JobResourceTags[] | undefined

The job's tags.

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.