DescribePackageCommand

Suggest an Edit

Returns information about a package.

Example Syntax

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

import { PanoramaClient, DescribePackageCommand } from "@aws-sdk/client-panorama"; // ES Modules import
// const { PanoramaClient, DescribePackageCommand } = require("@aws-sdk/client-panorama"); // CommonJS import
const client = new PanoramaClient(config);
const input = { // DescribePackageRequest
  PackageId: "STRING_VALUE", // required
};
const command = new DescribePackageCommand(input);
const response = await client.send(command);
// { // DescribePackageResponse
//   PackageId: "STRING_VALUE", // required
//   PackageName: "STRING_VALUE", // required
//   Arn: "STRING_VALUE", // required
//   StorageLocation: { // StorageLocation
//     Bucket: "STRING_VALUE", // required
//     RepoPrefixLocation: "STRING_VALUE", // required
//     GeneratedPrefixLocation: "STRING_VALUE", // required
//     BinaryPrefixLocation: "STRING_VALUE", // required
//     ManifestPrefixLocation: "STRING_VALUE", // required
//   },
//   ReadAccessPrincipalArns: [ // PrincipalArnsList
//     "STRING_VALUE",
//   ],
//   WriteAccessPrincipalArns: [
//     "STRING_VALUE",
//   ],
//   CreatedTime: new Date("TIMESTAMP"), // required
//   Tags: { // TagMap // required
//     "<keys>": "STRING_VALUE",
//   },
// };

DescribePackageCommand Input

See DescribePackageCommandInput for more details

Parameter
Type
Description
PackageId
Required
string | undefined

The package's ID.

DescribePackageCommand Output

See DescribePackageCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
Arn
Required
string | undefined

The package's ARN.

CreatedTime
Required
Date | undefined

When the package was created.

PackageId
Required
string | undefined

The package's ID.

PackageName
Required
string | undefined

The package's name.

StorageLocation
Required
StorageLocation | undefined

The package's storage location.

Tags
Required
Record<string, string> | undefined

The package's tags.

ReadAccessPrincipalArns
string[] | undefined

ARNs of accounts that have read access to the package.

WriteAccessPrincipalArns
string[] | undefined

ARNs of accounts that have write access to the package.

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.

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.