- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
DescribePackageVersionCommand
Returns information about a package version.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { PanoramaClient, DescribePackageVersionCommand } from "@aws-sdk/client-panorama"; // ES Modules import
// const { PanoramaClient, DescribePackageVersionCommand } = require("@aws-sdk/client-panorama"); // CommonJS import
const client = new PanoramaClient(config);
const input = { // DescribePackageVersionRequest
OwnerAccount: "STRING_VALUE",
PackageId: "STRING_VALUE", // required
PackageVersion: "STRING_VALUE", // required
PatchVersion: "STRING_VALUE",
};
const command = new DescribePackageVersionCommand(input);
const response = await client.send(command);
// { // DescribePackageVersionResponse
// OwnerAccount: "STRING_VALUE",
// PackageId: "STRING_VALUE", // required
// PackageArn: "STRING_VALUE",
// PackageName: "STRING_VALUE", // required
// PackageVersion: "STRING_VALUE", // required
// PatchVersion: "STRING_VALUE", // required
// IsLatestPatch: true || false, // required
// Status: "STRING_VALUE", // required
// StatusDescription: "STRING_VALUE",
// RegisteredTime: new Date("TIMESTAMP"),
// };
DescribePackageVersionCommand Input
See DescribePackageVersionCommandInput for more details
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
PackageId Required | string | undefined | The version's ID. |
PackageVersion Required | string | undefined | The version's version. |
OwnerAccount | string | undefined | The version's owner account. |
PatchVersion | string | undefined | The version's patch version. |
DescribePackageVersionCommand Output
See DescribePackageVersionCommandOutput for details
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
IsLatestPatch Required | boolean | undefined | Whether the version is the latest available. |
PackageId Required | string | undefined | The version's ID. |
PackageName Required | string | undefined | The version's name. |
PackageVersion Required | string | undefined | The version's version. |
PatchVersion Required | string | undefined | The version's patch version. |
Status Required | PackageVersionStatus | undefined | The version's status. |
OwnerAccount | string | undefined | The account ID of the version's owner. |
PackageArn | string | undefined | The ARN of the package. |
RegisteredTime | Date | undefined | The version's registered time. |
StatusDescription | string | undefined | The version's status description. |
Throws
Name | Fault | Details |
---|
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. |
ResourceNotFoundException | client | The target resource was not found. |
ValidationException | client | The request contains an invalid parameter value. |
PanoramaServiceException | Base exception class for all service exceptions from Panorama service. |