- 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.
DescribeApplicationInstanceDetailsCommand
Returns information about an application instance's configuration manifest.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { PanoramaClient, DescribeApplicationInstanceDetailsCommand } from "@aws-sdk/client-panorama"; // ES Modules import
// const { PanoramaClient, DescribeApplicationInstanceDetailsCommand } = require("@aws-sdk/client-panorama"); // CommonJS import
const client = new PanoramaClient(config);
const input = { // DescribeApplicationInstanceDetailsRequest
ApplicationInstanceId: "STRING_VALUE", // required
};
const command = new DescribeApplicationInstanceDetailsCommand(input);
const response = await client.send(command);
// { // DescribeApplicationInstanceDetailsResponse
// Name: "STRING_VALUE",
// Description: "STRING_VALUE",
// DefaultRuntimeContextDevice: "STRING_VALUE",
// ManifestPayload: { // ManifestPayload Union: only one key present
// PayloadData: "STRING_VALUE",
// },
// ManifestOverridesPayload: { // ManifestOverridesPayload Union: only one key present
// PayloadData: "STRING_VALUE",
// },
// ApplicationInstanceIdToReplace: "STRING_VALUE",
// CreatedTime: new Date("TIMESTAMP"),
// ApplicationInstanceId: "STRING_VALUE",
// };
DescribeApplicationInstanceDetailsCommand Input
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
ApplicationInstanceIdRequired | string | undefined | The application instance's ID. |
DescribeApplicationInstanceDetailsCommand Output
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
$metadataRequired | ResponseMetadata | Metadata pertaining to this request. |
ApplicationInstanceId | string | undefined | The application instance's ID. |
ApplicationInstanceIdToReplace | string | undefined | The ID of the application instance that this instance replaced. |
CreatedTime | Date | undefined | When the application instance was created. |
DefaultRuntimeContextDevice | string | undefined | The application instance's default runtime context device. |
Description | string | undefined | The application instance's description. |
ManifestOverridesPayload | ManifestOverridesPayload | undefined | Parameter overrides for the configuration manifest. |
ManifestPayload | ManifestPayload | undefined | The application instance's configuration manifest. |
Name | string | undefined | The application instance's name. |
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. |